Merge pull request #564 from UncleRus/bugfix/pcf8563-add-bm8563

fix: describe support for bm8563 in pcf8563 driver
UncleRus · Aug 18, 2023 · f72ffcf · f72ffcf
2 parents b9d8b5e + 2733b9e
commit f72ffcf
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -254,7 +254,7 @@ or [GitLab examples](https://gitlab.com/UncleRus/esp-idf-lib/tree/master/example
 | **ds1302**               | Driver for DS1302 RTC module                                                     | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no            |
 | **ds1307**               | Driver for DS1307 RTC module                                                     | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes           |
 | **ds3231**               | Driver for DS1337 RTC and DS3231 high precision RTC module                       | MIT     | esp32, esp8266, esp32s2, esp32c3 | yes           |
-| **pcf8563**              | Driver for PCF8563 real-time clock/calendar                                      | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes           |
+| **pcf8563**              | Driver for PCF8563 (BM8563) real-time clock/calendar                             | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes           |
 
 
 ### Temperature sensors

diff --git a/components/pcf8563/.eil.yml b/components/pcf8563/.eil.yml
@@ -1,5 +1,5 @@
 name: pcf8563
-description: Driver for PCF8563 real-time clock/calendar
+description: Driver for PCF8563 (BM8563) real-time clock/calendar
 version: 1.0.0
 groups:
   - rtc

diff --git a/components/pcf8563/pcf8563.c b/components/pcf8563/pcf8563.c
@@ -28,7 +28,7 @@
 /**
  * @file pcf8563.c
  *
- * ESP-IDF driver for PCF8563 real-time clock/calendar
+ * ESP-IDF driver for PCF8563 (BM8563) real-time clock/calendar
  *
  * Copyright (c) 2020 Ruslan V. Uss <[email protected]>
  *

diff --git a/components/pcf8563/pcf8563.h b/components/pcf8563/pcf8563.h
@@ -30,7 +30,7 @@
  * @defgroup pcf8563 pcf8563
  * @{
  *
- * ESP-IDF driver for PCF8563 real-time clock/calendar
+ * ESP-IDF driver for PCF8563 (BM8563) real-time clock/calendar
  *
  * Copyright (c) 2020 Ruslan V. Uss <[email protected]>
  *

diff --git a/docs/source/chips.rst b/docs/source/chips.rst
@@ -115,6 +115,8 @@ Supported devices
 +---------------+----------------------------------------+----------------------+
 | PCF8563       | NXP                                    | :ref:`pcf8563`       |
 +---------------+----------------------------------------+----------------------+
+| BM8563        | GATEMODE                               | :ref:`pcf8563`       |
++---------------+----------------------------------------+----------------------+
 | PCF8574       | NXP                                    | :ref:`pcf8574`       |
 +---------------+----------------------------------------+----------------------+
 | PCF8575       | NXP                                    | :ref:`pcf8575`       |

diff --git a/docs/source/groups/pcf8563.rst b/docs/source/groups/pcf8563.rst
@@ -1,8 +1,7 @@
 .. _pcf8563:
 
-pcf8563 - Driver for PCF8563 real-time clock/calendar
-=====================================================
+pcf8563 - Driver for PCF8563 (BM8563) real-time clock/calendar
+==============================================================
 
 .. doxygengroup:: pcf8563
    :members:
-