Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@ericmatte
ericmatte committed Jan 2, 2021
1 parent 09932db commit 59c4aad
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 34 deletions.
35 changes: 18 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,31 +49,32 @@ media_lights_sync:
module: media_lights_sync
class: MediaLightsSync
media_player: media_player.tv
lights:
- light.left_theatre_light
- light.right_theatre_light
ha_url: !secret ha_url
reset_lights_after: true
use_saturated_colors: false
use_current_brightness: false
condition:
entity: input_boolean.sync_tv_lights
state: "on"
lights:
- light.left_theatre_light
- light.right_theatre_light
```
| key | optional | type | default | description |
| ------------------------ | -------- | -------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `module` | False | string | `media_lights_sync` | The module name of the app. |
| `class` | False | string | `MediaLightsSync` | The name of the Class. |
| `media_player` | False | string or list | | The entity_id(s) of the media player(s) to sync from<sup id="ha-url">[1](#ha-url-note)</sup>. |
| `ha_url` | True | string | `null` | The URL to your Home Assistant. Only useful if `photo_attribute` is a relative URL<sup id="ha-url">[1](#ha-url-note)</sup>. Examples: `https://my-ha.duckdns.org`, `http://192.168.1.123:8123`. |
| `reset_lights_after` | True | bool | `false` | Reset lights to their initial state after turning off a `medial_player`. Will not reset lights if `false`. |
| `use_saturated_colors` | True | bool | `false` | Increase the saturation and brightness of the colors. |
| `use_current_brightness` | True | bool | `false` | Do not change lights brightness. If `false`, it will always sets all lights to maximum brightness. |
| `transition` | True | number | `null` | Number that represents the time (in seconds) the light should take to transition to new states. |
| `condition` | True | object | | Sync lights only if the state of the condition entity is valid. |
| `condition.entity` | False | string | | The entity_id of the condition. |
| `condition.state` | False | string | | The state to match in order for the lights to sync. |
| `lights` | False | list | | The list of all the lights entity_id to sync to. |
| key | optional | type | default | description |
| ------------------------ | -------- | -------------- | ------------------- | ---------------------------------------------------------------------------------------------------------- |
| `module` | False | string | `media_lights_sync` | The module name of the app. |
| `class` | False | string | `MediaLightsSync` | The name of the Class. |
| `media_player` | False | string or list | | The entity_id(s) of the media player(s) to sync from<sup id="ha-url">[1](#ha-url-note)</sup>. |
| `lights` | False | list | | The list of all the lights entity_id to sync to. |
| `ha_url` | True | string | `null` | The URL to your Home Assistant. Examples: `https://my-ha.duckdns.org`, `http://192.168.1.123:8123`. |
| `reset_lights_after` | True | bool | `false` | Reset lights to their initial state after turning off a `medial_player`. Will not reset lights if `false`. |
| `use_saturated_colors` | True | bool | `false` | Increase the saturation and brightness of the colors. |
| `use_current_brightness` | True | bool | `false` | Do not change lights brightness. If `false`, it will always sets all lights to maximum brightness. |
| `transition` | True | number | `null` | Number that represents the time (in seconds) the light should take to transition to new states. |
| `condition` | True | object | | Sync lights only if the state of the condition entity is valid. |
| `condition.entity` | False | string | | The entity_id of the condition. |
| `condition.state` | False | string | | The state to match in order for the lights to sync. |

<b id="ha-url-note">[1](#ha-url)</b>: See `/developer-tools/state` in your Home Assistant instance. This app will listen to changes on `entity_picture_local` and/or `entity_picture` attributes of your `media_player` entities.

Expand Down
35 changes: 18 additions & 17 deletions info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,31 @@ media_lights_sync:
module: media_lights_sync
class: MediaLightsSync
media_player: media_player.tv
lights:
- light.left_theatre_light
- light.right_theatre_light
ha_url: !secret ha_url
reset_lights_after: true
use_saturated_colors: false
use_current_brightness: false
condition:
entity: input_boolean.sync_tv_lights
state: "on"
lights:
- light.left_theatre_light
- light.right_theatre_light
```
| key | optional | type | default | description |
| ------------------------ | -------- | -------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `module` | False | string | `media_lights_sync` | The module name of the app. |
| `class` | False | string | `MediaLightsSync` | The name of the Class. |
| `media_player` | False | string or list | | The entity_id(s) of the media player(s) to sync from<sup id="ha-url">[1](#ha-url-note)</sup>. |
| `ha_url` | True | string | `null` | The URL to your Home Assistant. Only useful if `photo_attribute` is a relative URL<sup id="ha-url">[1](#ha-url-note)</sup>. Examples: `https://my-ha.duckdns.org`, `http://192.168.1.123:8123`. |
| `reset_lights_after` | True | bool | `false` | Reset lights to their initial state after turning off a `medial_player`. Will not reset lights if `false`. |
| `use_saturated_colors` | True | bool | `false` | Increase the saturation and brightness of the colors. |
| `use_current_brightness` | True | bool | `false` | Do not change lights brightness. If `false`, it will always sets all lights to maximum brightness. |
| `transition` | True | number | `null` | Number that represents the time (in seconds) the light should take to transition to new states. |
| `condition` | True | object | | Sync lights only if the state of the condition entity is valid. |
| `condition.entity` | False | string | | The entity_id of the condition. |
| `condition.state` | False | string | | The state to match in order for the lights to sync. |
| `lights` | False | list | | The list of all the lights entity_id to sync to. |
| key | optional | type | default | description |
| ------------------------ | -------- | -------------- | ------------------- | ---------------------------------------------------------------------------------------------------------- |
| `module` | False | string | `media_lights_sync` | The module name of the app. |
| `class` | False | string | `MediaLightsSync` | The name of the Class. |
| `media_player` | False | string or list | | The entity_id(s) of the media player(s) to sync from<sup id="ha-url">[1](#ha-url-note)</sup>. |
| `lights` | False | list | | The list of all the lights entity_id to sync to. |
| `ha_url` | True | string | `null` | The URL to your Home Assistant. Examples: `https://my-ha.duckdns.org`, `http://192.168.1.123:8123`. |
| `reset_lights_after` | True | bool | `false` | Reset lights to their initial state after turning off a `medial_player`. Will not reset lights if `false`. |
| `use_saturated_colors` | True | bool | `false` | Increase the saturation and brightness of the colors. |
| `use_current_brightness` | True | bool | `false` | Do not change lights brightness. If `false`, it will always sets all lights to maximum brightness. |
| `transition` | True | number | `null` | Number that represents the time (in seconds) the light should take to transition to new states. |
| `condition` | True | object | | Sync lights only if the state of the condition entity is valid. |
| `condition.entity` | False | string | | The entity_id of the condition. |
| `condition.state` | False | string | | The state to match in order for the lights to sync. |

<b id="ha-url-note">[1](#ha-url)</b>: See `/developer-tools/state` in your Home Assistant instance. This app will listen to changes on `entity_picture_local` and/or `entity_picture` attributes of your `media_player` entities.

0 comments on commit 59c4aad

Please sign in to comment.