diff --git a/source/_components/graphite.markdown b/source/_components/graphite.markdown new file mode 100644 index 00000000000..89e7209984d --- /dev/null +++ b/source/_components/graphite.markdown @@ -0,0 +1,28 @@ +--- +layout: page +title: "Graphite" +description: "Instructions on how to record Home Assistant history in Graphite." +date: 2016-02-10 17:11 +sidebar: true +comments: false +sharing: true +footer: true +logo: +ha_category: History +--- + +Component that records all events and state changes and feeds the data to +a graphite installation. +Example configuration: + +```yaml +# Example configuration.yaml entry +graphite: + host: foobar + port: 2003 + prefix: ha +``` + +All config elements are optional, and assumed to be on localhost at the +default port if not specified. Prefix is the metric prefix in graphite, +and defaults to 'ha'. diff --git a/source/_components/group.markdown b/source/_components/group.markdown index a33a3afd88a..902596f3471 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -18,6 +18,13 @@ Check the **Set State** page from the **Developer Tools** and browse the **Curre ```yaml # Example configuration.yaml entry group: + # If you name an entry default_view it will REPLACE the contents of the "Home" tab + default_view: + view: yes + entities: + - group.awesome_people + - group.climate + kitchen: name: Kitchen entities: diff --git a/source/_components/light.mysensors.markdown b/source/_components/light.mysensors.markdown new file mode 100644 index 00000000000..409c913564e --- /dev/null +++ b/source/_components/light.mysensors.markdown @@ -0,0 +1,15 @@ +--- +layout: page +title: "MySensors Light" +description: "Instructions how to integrate MySensors lights into Home Assistant." +date: 2016-01-17 15:49 +sidebar: true +comments: false +sharing: true +footer: true +logo: mysensors.png +ha_category: Light +featured: false +--- + +Integrates MySensors lights into Home Assistant. See the [main component] for configuration instructions. diff --git a/source/_components/light.scsgate.markdown b/source/_components/light.scsgate.markdown index 1a684ee06c4..11b3a3fca9d 100644 --- a/source/_components/light.scsgate.markdown +++ b/source/_components/light.scsgate.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "SCSGate light" +title: "SCSGate Light" description: "Instructions how to integrate SCSGate lights into Home Assistant." date: 2016-01-31 19:30 sidebar: true diff --git a/source/_components/media_player.snapcast.markdown b/source/_components/media_player.snapcast.markdown new file mode 100644 index 00000000000..bb2b8ea4fa0 --- /dev/null +++ b/source/_components/media_player.snapcast.markdown @@ -0,0 +1,23 @@ +--- +layout: page +title: "snapcast" +description: "Instructions how to integrate a snapcast in Home Assistant." +date: 2016-02-01 19:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: +ha_category: Media Player +featured: false +--- + +The `snapcast` platform allows you to control [Snapcast](https://github.com/badaix/snapcast). + +To add Snapcast to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +media_player: + platform: snapcast +``` diff --git a/source/_components/mqtt.markdown b/source/_components/mqtt.markdown index 62ff402749f..de0a8573cc8 100644 --- a/source/_components/mqtt.markdown +++ b/source/_components/mqtt.markdown @@ -118,7 +118,25 @@ Home Assistant will automatically load the correct certificate if you connect to - [OwnTracks Device Tracker](/components/device_tracker.owntracks/) - [MQTT automation rule](/components/automation/#mqtt-based-automation) - [MQTT alarm](/components/alarm_control_panel.mqtt/) - - Integrating it into own component. See the [MQTT example component](https://github.com/balloob/home-assistant/blob/dev/config/custom_components/mqtt_example.py) how to do this. + - Integrating it into own component. See the [MQTT example component](/cookbook/python_component_mqtt_basic/) how to do this. + +### {% linkable_title Publish service %} + +The MQTT component will register the service `publish` which allows publishing messages to MQTT topics. There are two ways of specifiying your payload. You can either use `payload` to hard-code a payload or use `payload_template` to specify a [template](/getting-started/templating/) that will be rendered to generate the payload. + +```json +{ + "topic": "home-assistant/light/1/command", + "payload": "on" +} +``` + +```json +{ + "topic": "home-assistant/light/1/state", + "payload_template": "{% raw %}{{ states('device_tracker.paulus') }}{% endraw %}" +} +``` ## {% linkable_title Testing your setup %} diff --git a/source/_components/switch.scsgate.markdown b/source/_components/switch.scsgate.markdown index 234f02247ac..1dac1db633e 100644 --- a/source/_components/switch.scsgate.markdown +++ b/source/_components/switch.scsgate.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "SCSGate switch" +title: "SCSGate Switch" description: "Instructions how to integrate SCSGate switches into Home Assistant." date: 2016-01-31 22:15 sidebar: true diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown index 7cb6744faf4..5f17e0512cb 100644 --- a/source/_components/zwave.markdown +++ b/source/_components/zwave.markdown @@ -15,7 +15,7 @@ ha_category: Hub There is currently support for switches, lights and sensors. All will be picked up automatically after configuring this platform. -### Installation +### {% linkable_title Installation %} To allow Home Assistant to talk to your Z-Wave USB stick you will have to compile Python Open Z-Wave. This can be done using [this script](https://github.com/balloob/home-assistant/blob/dev/script/build_python_openzwave). _(The Home Assistant docker image has support for Z-Wave built-in)_ @@ -26,7 +26,7 @@ $ apt-get install cython3 libudev-dev python-sphinx python3-setuptools $ pip3 install "cython<0.23" ``` -### Configuration +### {% linkable_title Configuration %} ```yaml # Example configuration.yaml entry @@ -53,7 +53,7 @@ To find the path of your Z-Wave stick, run: $ ls /dev/ttyUSB* ``` -#### Events +#### {% linkable_title Events %} Some devices can also trigger scene activation events, which can be used in automation scripts (for example the press of a button on a wall switch): diff --git a/source/_cookbook/automation_for_rainy_days.markdown b/source/_cookbook/automation_for_rainy_days.markdown index 52baa7a70b4..1a264c7bfaa 100644 --- a/source/_cookbook/automation_for_rainy_days.markdown +++ b/source/_cookbook/automation_for_rainy_days.markdown @@ -10,8 +10,6 @@ footer: true ha_category: Automation Examples --- -### {% linkable_title Rainy Day Light %} - This requires a [forecast.io](components/sensor.forecast/) sensor with the condition `weather_precip` that tells if it's raining or not. Turn on a light in the living room when it starts raining, someone is home, and it's afternoon or later. diff --git a/source/_cookbook/automation_sun.markdown b/source/_cookbook/automation_sun.markdown index 3e9e058b22d..73878464180 100644 --- a/source/_cookbook/automation_sun.markdown +++ b/source/_cookbook/automation_sun.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Automation examples using the sun" +title: "Examples using the sun" description: "Automation examples that use the sun." date: 2015-10-08 19:05 sidebar: true diff --git a/source/_cookbook/basic_example_use_trigger_values.markdown b/source/_cookbook/basic_example_use_trigger_values.markdown index 149177b85c3..7c062317aac 100644 --- a/source/_cookbook/basic_example_use_trigger_values.markdown +++ b/source/_cookbook/basic_example_use_trigger_values.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Automation: use_trigger_values" +title: "Example using use_trigger_values" description: "Basic example how to use use_trigger_values in automation" date: 2015-10-08 19:05 sidebar: true @@ -10,8 +10,6 @@ footer: true ha_category: Automation Examples --- -### {% linkable_title Basic example for use_trigger_values %} - Turn on lights during daytime when it's dark enough < 200 lux. ```yaml diff --git a/source/_cookbook/configuration_yaml_by_carlo_costanzo.markdown b/source/_cookbook/configuration_yaml_by_carlo_costanzo.markdown index e20885eb7f3..e60659cb24d 100644 --- a/source/_cookbook/configuration_yaml_by_carlo_costanzo.markdown +++ b/source/_cookbook/configuration_yaml_by_carlo_costanzo.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Full configuration.yaml Examples +ha_category: Example configuration.yaml ha_external_link: https://gist.github.com/CCOSTAN/9934de973a293b809868 --- diff --git a/source/_cookbook/configuration_yaml_by_happyleavesaoc.markdown b/source/_cookbook/configuration_yaml_by_happyleavesaoc.markdown index 774b2c093c9..33fc4f05040 100644 --- a/source/_cookbook/configuration_yaml_by_happyleavesaoc.markdown +++ b/source/_cookbook/configuration_yaml_by_happyleavesaoc.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Full configuration.yaml Examples +ha_category: Example configuration.yaml ha_external_link: https://github.com/happyleavesaoc/my-home-automation/tree/master/homeassistant --- diff --git a/source/_cookbook/customize_polling_interval.markdown b/source/_cookbook/customize_polling_interval.markdown new file mode 100644 index 00000000000..e6aff18ebe8 --- /dev/null +++ b/source/_cookbook/customize_polling_interval.markdown @@ -0,0 +1,20 @@ +--- +layout: page +title: "Customize polling interval for any component" +description: "Shows how to customize polling interval for any component via configuration.yaml." +date: 2016-02-12 23:17 -0800 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Example configuration.yaml +--- + +Platforms that require polling will be polled in an interval specified by the main component. For example a light will check every 30 seconds for a changed state. It is possible to overwrite this scan interval for any platform that is being polled by specifying a `scan_interval` config key. In the example below we setup the Philips Hue lights but tell Home Assistant to poll the devices every 10 seconds instead of the default 30 seconds. + +```yaml +# Example configuration.yaml entry to poll Hue lights every 10 seconds. +light: + platform: hue + scan_interval: 10 +``` diff --git a/source/_cookbook/send_a_reminder.markdown b/source/_cookbook/send_a_reminder.markdown index 6207af196ab..e08d2c9767d 100644 --- a/source/_cookbook/send_a_reminder.markdown +++ b/source/_cookbook/send_a_reminder.markdown @@ -10,10 +10,9 @@ footer: true ha_category: Automation Examples --- -#### {% linkable_title Send a reminder %} Always forget to eat lunch? Let Home Assistant send you a reminder. -Add a [notify platform](/components/notify/) of your choice +Add a [notify platform](/components/notify/) of your choice. ```yaml notify: diff --git a/source/_cookbook/track_battery_level.markdown b/source/_cookbook/track_battery_level.markdown index 1ea9b0d65ca..905ae5f30fa 100644 --- a/source/_cookbook/track_battery_level.markdown +++ b/source/_cookbook/track_battery_level.markdown @@ -10,8 +10,6 @@ footer: true ha_category: Automation Examples --- -### {% linkable_title Battery level %} - The [iCloud](/components/device_tracker.icloud/) is gathering various details about your device including the battery level. To display it in the Frontend use a [template sensor](/components/sensor.template/). ```yaml diff --git a/source/_cookbook/turn_on_light_for_10_minutes_when_motion_detected.markdown b/source/_cookbook/turn_on_light_for_10_minutes_when_motion_detected.markdown index 4cb2e40c971..1cbdbdde6e1 100644 --- a/source/_cookbook/turn_on_light_for_10_minutes_when_motion_detected.markdown +++ b/source/_cookbook/turn_on_light_for_10_minutes_when_motion_detected.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Motion detected light" +title: "Turn on lights for 10 minutes after motion detected" description: "Turn on lights for 10 minutes when motion detected." date: 2015-10-08 19:05 sidebar: true @@ -12,11 +12,11 @@ ha_category: Automation Examples #### {% linkable_title Turn on lights with a resettable off timer %} -This recipe will turn on a light when there is motion and turn off the light when ten minutes has passed without any motion events . +This recipe will turn on a light when there is motion and turn off the light when ten minutes has passed without any motion events. ```yaml automation: - alias: Turn on kitchen lights when there is movement + alias: Turn on kitchen lights when there is movement trigger: - platform: state entity_id: sensor.motion_sensor @@ -29,14 +29,14 @@ script: timed_lamp: alias: "Turn on lamp and set timer" sequence: - # Cancel ev. old timers + # Cancel ev. old timers - execute_service: script.turn_off - service_data: + service_data: entity_id: script.timer_off - execute_service: light.turn_on service_data: entity_id: light.kitchen - # Set new timer + # Set new timer - execute_service: script.turn_on service_data: entity_id: script.timer_off @@ -47,6 +47,6 @@ script: - delay: minutes: 10 - execute_service: light.turn_off - service_data: + service_data: entity_id: light.kitchen ``` diff --git a/source/_includes/asides/cookbook_navigation.html b/source/_includes/asides/cookbook_navigation.html index def8baf9f1f..7b6287c0565 100644 --- a/source/_includes/asides/cookbook_navigation.html +++ b/source/_includes/asides/cookbook_navigation.html @@ -14,6 +14,8 @@
  • {% if recipe.url == page.url %} {{recipe.title}} + {% elsif recipe.ha_external_link %} + {{recipe.title}} {% else %} {{recipe.title}} {% endif %} diff --git a/source/cookbook/index.markdown b/source/cookbook/index.markdown index 2170e6127c1..bcc852d9453 100644 --- a/source/cookbook/index.markdown +++ b/source/cookbook/index.markdown @@ -30,7 +30,7 @@ Some users keep a public scrubbed copy of their `configuration.yaml` to learn fr {% for recipe in site.cookbook %} {% if recipe.ha_category == category %} {% if recipe.ha_external_link %} - * [{{recipe.title}}]({{recipe.ha_external_link}}) + * [{{recipe.title}} ]({{recipe.ha_external_link}}) {% else %} * [{{recipe.title}}]({{recipe.url}}) {% endif %} diff --git a/source/images/supported_brands/splunk.png b/source/images/supported_brands/splunk.png index 3f30171db7b..062ae1503ee 100644 Binary files a/source/images/supported_brands/splunk.png and b/source/images/supported_brands/splunk.png differ