added documentation for monoprice_snapshot/monoprice_restore services. (#3874)

* added documentation for monoprice_snapshot/monoprice_restore services.

* ✏️ Tiny spelling & grammar fixes

* minor changes

* Changed service names to snapshot and restore

* fixed minor typo
This commit is contained in:
Egor Tsinko 2017-12-28 10:16:26 -07:00 committed by Franck Nijhof
parent d3b1bd6431
commit 4db836f80a

View File

@ -47,3 +47,25 @@ Configuration variables:
- **port** (*Required*): The serial port to which Monoprice amplifier is connected - **port** (*Required*): The serial port to which Monoprice amplifier is connected
- **zones** (*Required*): This is the list of zones available. Valid zones are 11,12,13,14,15,16. In case multiple Monoprice devices are stacked together the list of valid zones is extended by 21,22,23,24,25,26 for the second device and 31,32,33,34,35,36 for the third device. Each zone must have a name assigned to it. - **zones** (*Required*): This is the list of zones available. Valid zones are 11,12,13,14,15,16. In case multiple Monoprice devices are stacked together the list of valid zones is extended by 21,22,23,24,25,26 for the second device and 31,32,33,34,35,36 for the third device. Each zone must have a name assigned to it.
- **sources** (*Required*): The list of sources available. Valid source numbers are 1,2,3,4,5,6. Each source number corresponds to the input number on the Monoprice amplifier. Similar to zones, each source must have a name assigned to it. - **sources** (*Required*): The list of sources available. Valid source numbers are 1,2,3,4,5,6. Each source number corresponds to the input number on the Monoprice amplifier. Similar to zones, each source must have a name assigned to it.
### {% linkable_title Service `snapshot` %}
Take a snapshot of one or more zones' states. This service, and the following one are useful if you want to play a doorbell or notification sound and resume playback afterward. If no `entity_id` is provided, all zones are snapshotted.
The following attributes are stored in a snapshot:
- Power status (On/Off)
- Mute status (On/Off)
- Volume level
- Source
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of zones.
### {% linkable_title Service `restore` %}
Restore a previously taken snapshot of one or more speakers. If no `entity_id` is provided, all zones are restored.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of zones.