From 2109e1f9175dfb2b364ef7ae0fdb127ac1bf4075 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Sun, 4 Oct 2015 10:53:11 -0700 Subject: [PATCH] Actual zone docs --- source/components/zone.markdown | 60 +++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 source/components/zone.markdown diff --git a/source/components/zone.markdown b/source/components/zone.markdown new file mode 100644 index 00000000000..b0fc01587d8 --- /dev/null +++ b/source/components/zone.markdown @@ -0,0 +1,60 @@ +--- +layout: page +title: "Zone" +description: "Instructions how to setup zones within Home Assistant." +date: 2015-10-04 09:23 +sidebar: false +comments: false +sharing: true +footer: true +--- + +Zones allow you to specify certain regions on earth (for now). When a device tracker sees a device +to be within a zone, the state will take the name from the zone. Zones can also be used as a +[trigger](/components/automation.html#zone-trigger) or [condition](/components/automation.html#zone-condition) +inside automation setups. + +Zones support the usual method to specify multiple zones, use keys `zone:`, `zone 2:` etc. + +```yaml +# Example configuration.yaml entry +zone: + name: School + latitude: 32.8773367 + longitude: -117.2494053 + # Optional radius in meters (default: 100) + radius: 250 + # Optional icon to show instead of name + icon: group-work + +zone 2: + name: Work + latitude: 32.8753367 + longitude: -117.2474053 + +# This will override the default home zone +zone 3: + name: Home + latitude: 32.8793367 + longitude: -117.2474053 + radius: 100 + icon: social:people +``` + +#### {% linkable_title Home zone %} + +If no configuration is given, the zone component will create a zone for home. This zone will use +location given in the `configuration.yaml` file and have a radius of 100 meters. To override this, +create a zone configuration and name it 'Home'. + +#### {% linkable_title Icons %} + +It is preferred to pick an icon to use for your zone. By default, Home Assistant includes most of the +[material icons](https://www.google.com/design/icons/). See [the source][icon-source] for a specific list which +categories are included. + +For all but the action category you will need to prefix the icon name with its category. For example +`social:people` or `av:radio`. For the action category, you will not need to do this, examples are +`home`, `work,`, `group-work` and `shopping-cart`. + +[icon-source]: https://github.com/balloob/home-assistant-polymer/blob/master/src/resources/home-assistant-icons.html#L3