Heartbeats section added #1730
Merged
Heartbeats section added #1730
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added basic documentation of smartSleep functionality within HA based on receiving a heartbeat signal form MySensor node.
|
@brahmafear, thanks for your PR! By analyzing the history of the files in this pull request, we identified @MartinHjelmare and @balloob to be potential reviewers. |
MartinHjelmare
requested changes
Jan 6, 2017
| @@ -171,6 +171,14 @@ void receive(const MyMessage &message) { | |||
| } | |||
| ``` | |||
|
|
|||
| ### {% linkable_title Heartbeats %} | |||
|
|
|||
| Sending a heartbeat from the MySensors sketch to home assistant activates the smartSleep functionality in home assistant. This means that messages are buffered and only sent to the device upon receiving a heartbeat from the device. State changes are stored so that only the last requested state change is sent to the device. Other types of messages are queued in a FIFO queue. SmartSleep is useful if you want to sleep a device, eg to be able to have it battery powered. See the MySensors library API for information on how to send heartbeats and sleep device. | |||
There was a problem hiding this comment.
- I think you should write: "Sending a heartbeat from the MySensors device to Home Assistant activates...".
- I think we write home assistant with capital H and A in the docs: Home Assistant. Please check that we're consistent with the rest of the docs.
- SmartSleep is specifically useful for actuator devices, that expects incoming messages. Sensors that only send messages do not really need to be "smartSleeping" but can use normal "sleep". Please clarify this.
Heartbeat section updated based on comments.
MartinHjelmare
approved these changes
Jan 7, 2017
MartinHjelmare
requested changes
Jan 7, 2017
| Visit the [library api] of MySensors for more information. | ||
|
|
||
| [library api]: https://www.mysensors.org/download/sensor_api_15 | ||
| [MySensors 1.x library api]: https://www.mysensors.org/download/sensor_api_15 |
There was a problem hiding this comment.
You can remove this link cause the old page has been removed so link leads to a 404 page.
Single link to access all versions of MySensors code and API reference.
MartinHjelmare
approved these changes
Jan 7, 2017
|
Thanks again! |
fabaff
pushed a commit
that referenced
this pull request
Jan 14, 2017
* Heartbeats section added Added basic documentation of smartSleep functionality within HA based on receiving a heartbeat signal form MySensor node. * Heartbeat info clarified. Heartbeat section updated based on comments. * MyS library api link updated Single link to access all versions of MySensors code and API reference.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added basic documentation of smartSleep functionality within HA based on receiving a heartbeat signal form MySensor node.
Description:
Pull request in home-assistant (if applicable): home-assistant/home-assistant#