Skip to content

Commit c493d83

Browse files
committed
Add docs
1 parent 01610a3 commit c493d83

File tree

3 files changed

+30
-6
lines changed

3 files changed

+30
-6
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,25 @@ adaptive_lighting:
176176
| `turn_on_lights` | Whether to turn on lights that are currently off. 🔆 | ❌ | bool |
177177

178178
<!-- END_OUTPUT -->
179+
180+
181+
#### `adaptive_lighting.turn_on`, `adaptive_lighting.turn_off`, `adaptive_lighting.toggle`
182+
183+
`adaptive_lighting.turn_on`, `adaptive_lighting.turn_off`, `adaptive_lighting.toggle` turn Adaptive Lighting on or off.
184+
185+
TODO: ...
186+
187+
<!-- START_CODE -->
188+
<!-- from homeassistant.components.adaptive_lighting import _docs_helpers -->
189+
<!-- print(_docs_helpers.generate_turn_on_markdown_table()) -->
190+
<!-- END_CODE -->
191+
192+
<!-- START_OUTPUT -->
193+
<!-- THIS CONTENT IS AUTOMATICALLY GENERATED -->
194+
195+
<!-- END_OUTPUT -->
196+
197+
179198
#### `adaptive_lighting.set_manual_control`
180199

181200
`adaptive_lighting.set_manual_control` can mark (or unmark) whether a light is "manually controlled", meaning that when a light has `manual_control`, the light is not adapted.

custom_components/adaptive_lighting/_docs_helpers.py

+5
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
DOCS,
1010
DOCS_APPLY,
1111
DOCS_MANUAL_CONTROL,
12+
SERVICE_TOGGLE_SCHEMA,
1213
SET_MANUAL_CONTROL_SCHEMA,
1314
VALIDATION_TUPLES,
1415
apply_service_schema,
@@ -110,6 +111,10 @@ def generate_apply_markdown_table():
110111
return _generate_service_markdown_table(apply_service_schema(), DOCS_APPLY)
111112

112113

114+
def generate_turn_on_markdown_table():
115+
return _generate_service_markdown_table(SERVICE_TOGGLE_SCHEMA, DOCS_APPLY)
116+
117+
113118
def generate_set_manual_control_markdown_table():
114119
return _generate_service_markdown_table(
115120
SET_MANUAL_CONTROL_SCHEMA, DOCS_MANUAL_CONTROL

custom_components/adaptive_lighting/const.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -211,12 +211,12 @@
211211
"Which switch to target in this service call. Options: "
212212
'"main" (default, targets the main switch), "sleep", "brightness", "color"'
213213
)
214-
DOCS[
215-
SERVICE_TURN_ON
216-
] = "Turn on an Adaptive Lighting main/sleep/brightness/color switch"
217-
DOCS[
218-
SERVICE_TURN_OFF
219-
] = "Turn off an Adaptive Lighting main/sleep/brightness/color switch"
214+
DOCS[SERVICE_TURN_ON] = (
215+
"Turn on an Adaptive Lighting" " main/sleep/brightness/color switch"
216+
)
217+
DOCS[SERVICE_TURN_OFF] = (
218+
"Turn off an Adaptive Lighting" " main/sleep/brightness/color switch"
219+
)
220220
DOCS[SERVICE_TOGGLE] = "Toggle an Adaptive Lighting main/sleep/brightness/color switch"
221221

222222
TURNING_OFF_DELAY = 5

0 commit comments

Comments
 (0)