Skip to content

Commit dc06462

Browse files
committed
ci(bthome): fix docs build warnings
1 parent a4a43c2 commit dc06462

File tree

6 files changed

+19
-101
lines changed

6 files changed

+19
-101
lines changed

.gitlab/ci/build.yml

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1066,35 +1066,18 @@ build_components_bluetooth_ble_hci_test_apps:
10661066
extends:
10671067
- .build_examples_template
10681068
- .rules:build:components_bluetooth_ble_hci_test_apps
1069-
parallel:
1070-
matrix:
1071-
- IMAGE: espressif/idf:release-v4.4
1072-
- IMAGE: espressif/idf:release-v5.0
1069+
- .build_idf_version_greater_equal_v5_0
10731070
variables:
10741071
EXAMPLE_DIR: components/bluetooth/ble_hci/test_apps
10751072

10761073
build_components_bluetooth_ble_adv_bthome_test_apps:
10771074
extends:
10781075
- .build_examples_template
10791076
- .rules:build:components_bluetooth_ble_adv_bthome_test_apps
1080-
parallel:
1081-
matrix:
1082-
- IMAGE: espressif/idf:release-v5.0
1083-
- IMAGE: espressif/idf:release-v5.1
1084-
- IMAGE: espressif/idf:release-v5.2
1077+
- .build_idf_version_greater_equal_v5_0
10851078
variables:
10861079
EXAMPLE_DIR: components/bluetooth/ble_adv/bthome/test_apps
10871080

1088-
build_components_button_test_apps:
1089-
extends:
1090-
- .build_examples_template
1091-
- .rules:build:components_bluetooth_ble_hci_test_apps
1092-
parallel:
1093-
matrix:
1094-
- IMAGE: espressif/idf:release-v5.2
1095-
variables:
1096-
EXAMPLE_DIR: components/bluetooth/ble_hci/test_apps
1097-
10981081
build_components_button_test_apps:
10991082
extends:
11001083
- .build_examples_template

components/.build-rules.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ components/sensors/power_monitor/ina236/test_apps:
231231

232232
components/bluetooth/ble_hci/test_apps:
233233
enable:
234-
- if: IDF_TARGET in ["esp32","esp32c3","esp32s3"] and (IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR == 3)
234+
- if: IDF_TARGET in ["esp32","esp32c3","esp32s3"] and IDF_VERSION_MAJOR >= 5
235235

236236
components/bluetooth/ble_adv/bthome/test_apps:
237237
enable:

docs/doxygen-known-warnings.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
bldc_control.h:line: warning: parameters of member bldc_control_config_t::@49 are not (all) documented
2-
bldc_control.h:line: warning: parameters of member bldc_control_config_t::@51 are not (all) documented
3-
sensor_type.h:line: warning: parameters of member sensor_data_t::@53 are not (all) documented
1+
bldc_control.h:line: warning: parameters of member bldc_control_config_t::@50 are not (all) documented
2+
bldc_control.h:line: warning: parameters of member bldc_control_config_t::@52 are not (all) documented
3+
sensor_type.h:line: warning: parameters of member sensor_data_t::@54 are not (all) documented
44

docs/en/sensors/power_measure.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Code Snippets
4949
-------------
5050

5151
BL0937 (GPIO)
52-
~~~~~~~~~~~~
52+
^^^^^^^^^^^^^
5353

5454
.. code-block:: c
5555
@@ -85,7 +85,7 @@ BL0937 (GPIO)
8585
power_measure_delete(h);
8686
8787
INA236 (I2C)
88-
~~~~~~~~~~~~
88+
^^^^^^^^^^^^
8989

9090
.. code-block:: c
9191
@@ -133,13 +133,13 @@ Troubleshooting
133133
---------------
134134

135135
BL0937 Issues:
136-
~~~~~~~~~~~~~~
136+
^^^^^^^^^^^^^^
137137

138138
1. **Failed Initialization** : If the initialization fails, ensure that all GPIO pins are correctly defined and connected to the **BL0937** chip.
139139
2. **Measurement Failures** : If the measurements fail (e.g., voltage, current), verify that the **BL0937** chip is properly powered and communicating with your ESP32 series chips.
140140

141141
INA236 Issues:
142-
~~~~~~~~~~~~~~
142+
^^^^^^^^^^^^^^
143143

144144
1. **I2C Bus Initialization Failed** : Check that the I2C pins (SDA/SCL) are correctly connected and not conflicting with other peripherals.
145145
2. **INA236 Not Detected** : Verify the I2C address (default 0x41) and ensure the chip is properly powered.

docs/sphinx-known-warnings.txt

Lines changed: 1 addition & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
lightbulb.inc:line: WARNING: Duplicate C++ declaration, also defined at electrical_lighting_solution/lightbulb_driver:line.
22
Declaration is '.. cpp:member:: lightbulb_color_mapping_data_t * table'.
33
lightbulb.inc:line: WARNING: Duplicate C++ declaration, also defined at electrical_lighting_solution/lightbulb_driver:line.
4-
Declaration is '.. cpp:member:: struct lightbulb_config_t::@40::@44 precise'.
4+
Declaration is '.. cpp:member:: struct lightbulb_config_t::@41::@45 precise'.
55
lightbulb.inc:line: WARNING: Duplicate C++ declaration, also defined at electrical_lighting_solution/lightbulb_driver:line.
66
Declaration is '.. cpp:member:: lightbulb_chip_out_pin_t red'.
77
lightbulb.inc:line: WARNING: Duplicate C++ declaration, also defined at electrical_lighting_solution/lightbulb_driver:line.
@@ -52,68 +52,3 @@ If the function has a return type:
5252
SLIST_ENTRY (ir_learn_list_t) next
5353
----------------------------^
5454

55-
power_measure.rst:line: WARNING: Title underline too short.
56-
57-
BL0937 (GPIO)
58-
~~~~~~~~~~~~
59-
power_measure.inc:line: CRITICAL: Title level inconsistent:
60-
61-
Header File
62-
^^^^^^^^^^^
63-
power_measure.inc:line: CRITICAL: Title level inconsistent:
64-
65-
Functions
66-
^^^^^^^^^
67-
power_measure.inc:line: CRITICAL: Title level inconsistent:
68-
69-
Structures
70-
^^^^^^^^^^
71-
power_measure.inc:line: CRITICAL: Title level inconsistent:
72-
73-
Type Definitions
74-
^^^^^^^^^^^^^^^^
75-
76-
power_measure.rst:line: WARNING: Inline interpreted text or phrase reference start-string without end-string.
77-
power_measure.rst:line: WARNING: Inline interpreted text or phrase reference start-string without end-string.
78-
power_measure.rst:line: WARNING: Inline interpreted text or phrase reference start-string without end-string.
79-
power_measure.rst:line: WARNING: Title underline too short.
80-
81-
BL0937(GPIO)
82-
~~~~~~~~~~~~
83-
power_measure.rst:line: WARNING: Title underline too short.
84-
85-
INA236(I2C)
86-
~~~~~~~~~~~~
87-
power_measure.rst:line: WARNING: Title underline too short.
88-
89-
INA236(I2C)
90-
~~~~~~~~~~~~
91-
power_measure.rst:line: WARNING: Title underline too short.
92-
93-
BL0937 问题:
94-
~~~~~~~~~~~~
95-
power_measure.rst:line: WARNING: Title underline too short.
96-
97-
INA236 问题:
98-
~~~~~~~~~~~~
99-
power_measure.rst:line: WARNING: Title underline too short.
100-
101-
INA236 问题:
102-
~~~~~~~~~~~~
103-
power_measure.inc:line: CRITICAL: Title level inconsistent:
104-
105-
Header File
106-
^^^^^^^^^^^
107-
power_measure.inc:line: CRITICAL: Title level inconsistent:
108-
109-
Functions
110-
^^^^^^^^^
111-
power_measure.inc:line: CRITICAL: Title level inconsistent:
112-
113-
Structures
114-
^^^^^^^^^^
115-
power_measure.inc:line: CRITICAL: Title level inconsistent:
116-
117-
Type Definitions
118-
^^^^^^^^^^^^^^^^
119-

docs/zh_CN/sensors/power_measure.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@
2525

2626
1. **(可选)初始化 I2C 总线(仅 INA236)**:
2727

28-
- 使用 `i2c_bus_create()` 按 `I2C_MASTER_SCL_IO`/`I2C_MASTER_SDA_IO` 创建 I2C 总线。
28+
- 使用 `i2c_bus_create()` 按 `I2C_MASTER_SCL_IO` / `I2C_MASTER_SDA_IO` 创建 I2C 总线。
2929
2. **创建功率测量设备**:
3030

31-
- 准备通用配置 `power_measure_config_t`(过流/过压/欠压阈值、是否启用能量检测)。
32-
- 对 BL0937,准备 `power_measure_bl0937_config_t`(CF/CF1/SEL、分压/采样电阻、KI/KU/KP)。
33-
- 对 INA236,准备 `power_measure_ina236_config_t`(I2C 句柄、地址、告警配置)。
31+
- 准备通用配置 `power_measure_config_t` (过流/过压/欠压阈值、是否启用能量检测)。
32+
- 对 BL0937,准备 `power_measure_bl0937_config_t` (CF/CF1/SEL、分压/采样电阻、KI/KU/KP)。
33+
- 对 INA236,准备 `power_measure_ina236_config_t` (I2C 句柄、地址、告警配置)。
3434
- 使用 `power_measure_new_bl0937_device()` 或 `power_measure_new_ina236_device()` 创建设备并获得 `power_measure_handle_t` 句柄。
3535
3. **周期读取测量值**:
3636

@@ -49,7 +49,7 @@
4949
--------
5050

5151
BL0937(GPIO)
52-
~~~~~~~~~~~~
52+
^^^^^^^^^^^^^^^^^^^^
5353

5454
.. code-block:: c
5555
@@ -85,7 +85,7 @@ BL0937(GPIO)
8585
power_measure_delete(h);
8686
8787
INA236(I2C)
88-
~~~~~~~~~~~~
88+
^^^^^^^^^^^^^^^^^^^^
8989

9090
.. code-block:: c
9191
@@ -133,13 +133,13 @@ INA236(I2C)
133133
--------
134134

135135
BL0937 问题:
136-
~~~~~~~~~~~~
136+
^^^^^^^^^^^^^^^^^^^^
137137

138138
1. **初始化失败**:如果初始化失败,请确保所有 GPIO 引脚都已正确定义并连接到 **BL0937** 芯片。
139139
2. **测量失败**:如果测量失败(如电压、电流),请检查 **BL0937** 芯片是否正确供电并与 ESP32系列芯片 通信。
140140

141141
INA236 问题:
142-
~~~~~~~~~~~~
142+
^^^^^^^^^^^^^^^^^^^^
143143

144144
1. **I2C 总线初始化失败**:检查 I2C 引脚(SDA/SCL)是否正确连接且未与其他外设冲突。
145145
2. **INA236 未检测到**:验证 I2C 地址(默认 0x41)并确保芯片正确供电。

0 commit comments

Comments
 (0)