Minimize the config sample

This commit is contained in:
Fabian Affolter 2016-12-03 14:03:39 +01:00
parent 08e2b25f6c
commit 950457b2e9
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336

View File

@ -33,46 +33,35 @@ remote:
name: Bedroom
host: 10.168.1.13
port: 5222
activity: BedroomTV
scan_interval: 45
- platform: harmony
name: Family Room
host: 10.168.1.16
port: 5222
activity: Kodi
scan_interval: 60
```
**Configuration variables**:
Configuration variables:
- **name** (*Required*): The hub's name to display in the front end.
- **host** (*Required*): The Harmony device's IP address.
- **port** (*Required*): The Harmony device's port, 5222 is default.
- **port** (*Required*): The Harmony device's port. 5222 is default.
- **activity** (*Optional*): Activity to use when turnon service is called without any data.
- **scan_interval** (*Optional*): Amount in seconds in between polling for device's current activity, defaults to 30 seconds
**Configuration File**:
Upon startup one file will be written to your HASS configuration directory per device in the following format: harmony_REMOTENAME.conf. The file will contain:
- **scan_interval** (*Optional*): Amount in seconds in between polling for device's current activity. Defaults to 30 seconds.
Configuration file:
Upon startup one file will be written to your HASS configuration directory per device in the following format: `harmony_REMOTENAME.conf`. The file will contain:
- List of all programmed activity names and ID numbers
- List of all programmed device names and ID numbers
- List of all available commands per programmed device
**Supported services**:
Supported services:
- **Turn Off**: Turn off all devices that were switched on from the start of the current activity
- **Turn On**: Start an activity, will start the default activity from configuration.yaml if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your HASS config directory. The service will respond faster if the activity ID is passed instead of the name
- **Send Command**: Send a command to one device, device ID and available commands are written to the configuration file at startup
- **Sync**: Synchronizes the Harmony device with the Harmony web service if any changes are made from the web portal or app
**Examples**
### {% linkable_title Examples %}
- *Template sensors can be utilized to display current activity in the frontend.*
Template sensors can be utilized to display current activity in the frontend.
```yaml
sensor:
@ -87,28 +76,28 @@ sensor:
```
- *The example below shows how to control an `input_boolean` switch using the Harmony remote's current activity. The switch will turn on when the remote's state changes and the Kodi activity is started and off when the remote's state changes and the current activity is PowerOff.*
The example below shows how to control an `input_boolean` switch using the Harmony remote's current activity. The switch will turn on when the remote's state changes and the Kodi activity is started and off when the remote's state changes and the current activity is PowerOff.
```yaml
automation:
- alias: "Watch TV started from harmony hub"
trigger:
platform: state
entity_id: remote.family_room
condition:
condition: template
value_template: {% raw %}'{{ trigger.to_state.attributes.current_activity == "Kodi" }}'{% endraw %}
action:
service: input_boolean.turn_on
entity_id: input_boolean.notify
- alias: "PowerOff started from harmony hub"
trigger:
platform: state
entity_id: remote.family_room
condition:
condition: template
value_template: {% raw %}'{{ trigger.to_state.attributes.current_activity == "PowerOff" }}'{% endraw %}
action:
service: input_boolean.turn_off
entity_id: input_boolean.notify
- alias: "Watch TV started from harmony hub"
trigger:
platform: state
entity_id: remote.family_room
condition:
condition: template
value_template: {% raw %}'{{ trigger.to_state.attributes.current_activity == "Kodi" }}'{% endraw %}
action:
service: input_boolean.turn_on
entity_id: input_boolean.notify
- alias: "PowerOff started from harmony hub"
trigger:
platform: state
entity_id: remote.family_room
condition:
condition: template
value_template: {% raw %}'{{ trigger.to_state.attributes.current_activity == "PowerOff" }}'{% endraw %}
action:
service: input_boolean.turn_off
entity_id: input_boolean.notify
````