3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: note changes to bound service init 

When "initial_state" is configured, bound services will be
initialzed based on that state...stopped if the state is
"off", started if its "on.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2023-11-15 17:35:02 -05:00
parent 6c6b7dcff0
commit e3cf9b2aa9
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/changelog.md
View File

@ -61,6 +61,8 @@ The format is based on [Keep a Changelog].
- **update_manager**: APIs that return status report additional fields. - **update_manager**: APIs that return status report additional fields.
See the [API Documentation](./web_api.md#get-update-status) for details. See the [API Documentation](./web_api.md#get-update-status) for details.
- **proc_stats**: Improved performance of Raspberry Pi CPU throttle detection. - **proc_stats**: Improved performance of Raspberry Pi CPU throttle detection.
- **power**: Bound services are now processed during initialization when
`initial_state` is configured.
## [0.8.0] - 2023-02-23 ## [0.8.0] - 2023-02-23

15
docs/configuration.md
View File

@ -616,6 +616,9 @@ type:
# tplink_smartplug, tasmota, shelly, homeseer, homeassistant, loxonev1, # tplink_smartplug, tasmota, shelly, homeseer, homeassistant, loxonev1,
# smartthings, mqtt or hue. # smartthings, mqtt or hue.
# This parameter must be provided. # This parameter must be provided.
initial_state: off
# The state the power device should be initialized to. May be on or
# off. When this option is not specifed no initial state will be set.
off_when_shutdown: False off_when_shutdown: False
# If set to True the device will be powered off when Klipper enters # If set to True the device will be powered off when Klipper enters
# the "shutdown" state. This option applies to all device types. # the "shutdown" state. This option applies to all device types.
@ -654,6 +657,10 @@ bound_services:
# the Moonraker service can not be bound to a power device. Note that # the Moonraker service can not be bound to a power device. Note that
# service names are case sensitive. # service names are case sensitive.
# #
# When the "initial_state" option is explcitly configured bound services
# will be synced with the current state. For example, if the initial_state
# is "off", all bound services will be stopped after device initialization.
#
# The default is no services are bound to the device. # The default is no services are bound to the device.
``` ```
@ -679,10 +686,6 @@ pin: gpiochip0/gpio26
# !gpiochip0/gpio26 # !gpiochip0/gpio26
# !gpio26 # !gpio26
# This parameter must be provided for "gpio" type devices # This parameter must be provided for "gpio" type devices
initial_state: off
# The initial state for GPIO type devices. May be on or
# off. When moonraker starts the device will be set to this
# state. Default is off.
timer: timer:
# A time (in seconds) after which the device will power off after being. # A time (in seconds) after which the device will power off after being.
# switched on. This effectively turns the device into a momentary switch. # switched on. This effectively turns the device into a momentary switch.
@ -833,10 +836,6 @@ pin: gpiochip0/gpio26
# !gpiochip0/gpio26 # !gpiochip0/gpio26
# !gpio26 # !gpio26
# This parameter must be provided for "gpio" type devices # This parameter must be provided for "gpio" type devices
initial_state: off
# The initial state for GPIO type devices. May be on or
# off. When moonraker starts the device will be set to this
# state. Default is off.
timer: timer:
# A time (in seconds) after which the device will power off after being. # A time (in seconds) after which the device will power off after being.
# switched on. This effectively turns the device into a momentary switch. # switched on. This effectively turns the device into a momentary switch.