From 2d7d7cbeaab7fe1603cfe23fa3a9be8c8e691c22 Mon Sep 17 00:00:00 2001 From: Travis CI Date: Sun, 5 Jun 2016 14:12:13 +0000 Subject: [PATCH] Site updated at 2016-06-05 14:12:13 UTC --- atom.xml | 2 +- blog/categories/community/atom.xml | 2 +- blog/categories/device-tracking/atom.xml | 2 +- blog/categories/esp8266/atom.xml | 2 +- blog/categories/how-to/atom.xml | 2 +- blog/categories/ibeacons/atom.xml | 2 +- blog/categories/internet-of-things/atom.xml | 2 +- blog/categories/mqtt/atom.xml | 2 +- blog/categories/organisation/atom.xml | 2 +- blog/categories/owntracks/atom.xml | 2 +- blog/categories/presence-detection/atom.xml | 2 +- .../public-service-announcement/atom.xml | 2 +- blog/categories/release-notes/atom.xml | 2 +- blog/categories/survey/atom.xml | 2 +- blog/categories/talks/atom.xml | 2 +- blog/categories/technology/atom.xml | 2 +- blog/categories/user-stories/atom.xml | 2 +- blog/categories/video/atom.xml | 2 +- blog/categories/website/atom.xml | 2 +- getting-started/android/index.html | 7 +- getting-started/automation-action/index.html | 7 +- .../automation-condition/index.html | 7 +- .../automation-create-first/index.html | 7 +- .../automation-examples/index.html | 7 +- .../automation-templating/index.html | 7 +- getting-started/automation-trigger/index.html | 7 +- .../automation-troubleshooting/index.html | 7 +- getting-started/automation/index.html | 7 +- getting-started/autostart-macos/index.html | 21 +- getting-started/autostart-synology/index.html | 7 +- getting-started/autostart-systemd/index.html | 7 +- getting-started/autostart-upstart/index.html | 7 +- getting-started/autostart/index.html | 9 +- getting-started/basic/index.html | 246 +++++++++++++++++ getting-started/browsers/index.html | 7 +- getting-started/configuration/index.html | 117 +------- .../customizing-devices/index.html | 17 +- getting-started/devices/index.html | 7 +- getting-started/index.html | 9 +- .../installation-docker/index.html | 7 +- .../index.html | 7 +- .../installation-raspberry-pi/index.html | 7 +- .../installation-synology/index.html | 7 +- .../installation-virtualenv/index.html | 28 +- getting-started/presence-detection/index.html | 7 +- getting-started/scripts-conditions/index.html | 7 +- .../scripts-service-calls/index.html | 7 +- getting-started/scripts/index.html | 7 +- .../troubleshooting-configuration/index.html | 7 +- getting-started/troubleshooting/index.html | 7 +- getting-started/updating/index.html | 7 +- getting-started/yaml/index.html | 253 ++++++++++++++++++ sitemap.xml | 18 +- 53 files changed, 679 insertions(+), 252 deletions(-) create mode 100644 getting-started/basic/index.html create mode 100644 getting-started/yaml/index.html diff --git a/atom.xml b/atom.xml index 20b1b10c6b..ef1a2e62b8 100644 --- a/atom.xml +++ b/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/community/atom.xml b/blog/categories/community/atom.xml index a862382fa3..4a2814c740 100644 --- a/blog/categories/community/atom.xml +++ b/blog/categories/community/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Community | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/device-tracking/atom.xml b/blog/categories/device-tracking/atom.xml index 8f6ed9afa9..eac9ae5521 100644 --- a/blog/categories/device-tracking/atom.xml +++ b/blog/categories/device-tracking/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Device-Tracking | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/esp8266/atom.xml b/blog/categories/esp8266/atom.xml index 2cf0f338ff..483e2098cd 100644 --- a/blog/categories/esp8266/atom.xml +++ b/blog/categories/esp8266/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: ESP8266 | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/how-to/atom.xml b/blog/categories/how-to/atom.xml index df1a94ba40..329b2067fd 100644 --- a/blog/categories/how-to/atom.xml +++ b/blog/categories/how-to/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: How-To | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/ibeacons/atom.xml b/blog/categories/ibeacons/atom.xml index c826113db6..32b71b76b1 100644 --- a/blog/categories/ibeacons/atom.xml +++ b/blog/categories/ibeacons/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: iBeacons | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/internet-of-things/atom.xml b/blog/categories/internet-of-things/atom.xml index ae3fb59282..c68a8f1285 100644 --- a/blog/categories/internet-of-things/atom.xml +++ b/blog/categories/internet-of-things/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Internet-of-Things | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/mqtt/atom.xml b/blog/categories/mqtt/atom.xml index d265755ec1..751433c2ad 100644 --- a/blog/categories/mqtt/atom.xml +++ b/blog/categories/mqtt/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: MQTT | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/organisation/atom.xml b/blog/categories/organisation/atom.xml index 4a90ecf516..60bd4cfab2 100644 --- a/blog/categories/organisation/atom.xml +++ b/blog/categories/organisation/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Organisation | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/owntracks/atom.xml b/blog/categories/owntracks/atom.xml index ce18ce7d6c..5560d3094e 100644 --- a/blog/categories/owntracks/atom.xml +++ b/blog/categories/owntracks/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: OwnTracks | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/presence-detection/atom.xml b/blog/categories/presence-detection/atom.xml index 9273fdaa66..3ea14dd7f8 100644 --- a/blog/categories/presence-detection/atom.xml +++ b/blog/categories/presence-detection/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Presence-Detection | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/public-service-announcement/atom.xml b/blog/categories/public-service-announcement/atom.xml index 0d8e12049b..5d3893a6cb 100644 --- a/blog/categories/public-service-announcement/atom.xml +++ b/blog/categories/public-service-announcement/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Public-Service-Announcement | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/release-notes/atom.xml b/blog/categories/release-notes/atom.xml index 0452c95ed4..689f480d07 100644 --- a/blog/categories/release-notes/atom.xml +++ b/blog/categories/release-notes/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Release-Notes | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/survey/atom.xml b/blog/categories/survey/atom.xml index 177a771a36..7b93a39625 100644 --- a/blog/categories/survey/atom.xml +++ b/blog/categories/survey/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Survey | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/talks/atom.xml b/blog/categories/talks/atom.xml index 0d6cd0c407..4af1e6fe71 100644 --- a/blog/categories/talks/atom.xml +++ b/blog/categories/talks/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Talks | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/technology/atom.xml b/blog/categories/technology/atom.xml index 6984247b55..7ecfeca91a 100644 --- a/blog/categories/technology/atom.xml +++ b/blog/categories/technology/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Technology | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/user-stories/atom.xml b/blog/categories/user-stories/atom.xml index b8fa6811cc..01dd5216c7 100644 --- a/blog/categories/user-stories/atom.xml +++ b/blog/categories/user-stories/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: User-Stories | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/video/atom.xml b/blog/categories/video/atom.xml index 0a6c650533..da287c2145 100644 --- a/blog/categories/video/atom.xml +++ b/blog/categories/video/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Video | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/blog/categories/website/atom.xml b/blog/categories/website/atom.xml index 5d29d89b17..5c51b5a6ed 100644 --- a/blog/categories/website/atom.xml +++ b/blog/categories/website/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Website | Home Assistant]]> - 2016-06-05T12:50:07+00:00 + 2016-06-05T14:11:26+00:00 https://home-assistant.io/ diff --git a/getting-started/android/index.html b/getting-started/android/index.html index c497456d3b..46781463bc 100644 --- a/getting-started/android/index.html +++ b/getting-started/android/index.html @@ -126,15 +126,16 @@
  • Raspberry Pi All-In-One Installer
  • Docker
  • Synology NAS
    • -
  • VirtualEnv Linux
    • +
  • Virtualenv Linux
  • Updating
  • Troubleshooting
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
      -
    • Configuration.yaml
      • +
    • YAML
      • +
    • Basic information
    • Setting up devices
    • Customizing devices and services
    • Presence Detection
      • diff --git a/getting-started/configuration/index.html b/getting-started/configuration/index.html index 2f694b5bdc..f5b544b26f 100644 --- a/getting-started/configuration/index.html +++ b/getting-started/configuration/index.html @@ -105,115 +105,7 @@ You will have to restart Home Assistant each time you make changes in configuration.yaml in order for these to take effect.

      -

      YAML

      - -

      Home Assistant uses the YAML syntax for configuration. YAML might take a while to get used to but is really powerful in allowing you to express complex configurations.

      - -

      For each component that you want to use in Home Assistant, you add code in your configuraton.yaml file to specify its settings.
      -The following example entry specifies that you want to use the notify component with the pushbullet platform.

      - -
      - 
      notify:
-  platform: pushbullet
-  api_key: "o.1234abcd"
-  name: pushbullet
-
      -
      -
      - -
        -
      • A component provides the core logic for some functionality (like notify provides sending notifications).
        • -
      • A platform makes the connection to a specific software or hardware platform (like pushbullet works with the service from pushbullet.com).
        • -
      - -

      The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a - while mappings have the format key: value. If you specify duplicate keys, the last value for a key is used.

      - -

      Note that indentation is an important part of specifying relationships using YAML. Things that are indented are nested “inside” things that are one level higher. So in the above example, platform: pushbullet is a property of (nested inside) the notify component.
      -Getting the right indentation can be tricky if you’re not using an editor with a fixed width font. Tabs are not allowed to be used for indentation. Convention is to use 2 spaces for each level of indentation.

      - -

      Lines that start with # are comments and are ignored by the system.

      - -

      The next example shows an input_select component that uses a block collection for the options values.
      -The other properties (like name) are specified using mappings. Note that the second line just has threat: with no value on the same line. Here threat is the name of the input_select and the values for it are everything nested below it.

      - -
      - 
      input_select:
-  threat:
-    name: Threat level
-# A collection is used for options
-    options:
-     - 0
-     - 1
-     - 2
-     - 3
-    initial: 0
-
      -
      -
      - -

      The following example shows nesting a collection of mappings in a mapping. In Home Assistant, this would create two sensors that each use the MQTT platform but have different values for their state_topic (one of the properties used for MQTT sensors).

      - -
      - 
      sensor:
-  - platform: mqtt
-    state_topic: sensor/topic
-  - platform: mqtt
-    state_topic: sensor2/topic
-
      -
      -
      - -

      Setting up the basic info

      - -

      By default Home Assistant will try to detect your location and will automatically select a temperature unit and time zone based on your location. You can overwrite this by adding the following information to your configuration.yaml:

      - -
      - 
      homeassistant:
-  # Omitted values in this section will be auto detected using freegeoip.io
-
-  # Location required to calculate the time the sun rises and sets
-  latitude: 32.87336
-  longitude: 117.22743
-
-  # C for Celsius, F for Fahrenheit
-  temperature_unit: C
-
-  # Pick yours from here:
-  # http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-  time_zone: America/Los_Angeles
-
-  # Name of the location where Home Assistant is running
-  name: Home
-
      -
      -
      - -

      Password protecting the web interface

      - -

      The first thing you will want to add is a password for the web interface. Use your favourite text editor to open configuration.yaml and edit the http section:

      - -
      - 
      http:
-  api_password: YOUR_PASSWORD
-
      -
      -
      - -

      See the HTTP component documentation for more options like HTTPS encryption.

      - -

      Setting up your phone or tablet

      - -

      Home Assistant runs as a self-hosted web application and contains support to be added to your home screen. If you’re on Android you can follow the visual guide. For other devices, open Home Assistant on your mobile browser and tap the add to home screen option.

      - -

      Remote access

      - -

      To make Home Assistant accessible while away from home, you will have to setup port forwarding from your router to port 8123 on the computer that is hosting Home Assistant. Instructions on how to do this can be found by searching <Router model> port forwarding instructions.

      - -

      Some Internet service providers will only offer dynamic IPs. This can cause you to be unable to access Home Assistant while away. You can solve this by using a free Dynamic DNS service like DuckDNS.

      - -

      You should definitely consider to encrypt your traffic if you are accessing your Home Assistant installation from abroad. For details please check the Set up encryption using Let’s Encrypt blog post.

      - -

      Next step: Setting up devices »

      +

      Next step: Get familiar with YAML »

      @@ -238,15 +130,16 @@ The other properties (like name) are specified using mappings. Note that the sec
    • Raspberry Pi All-In-One Installer
    • Docker
    • Synology NAS
      • -
    • VirtualEnv Linux
      • +
    • Virtualenv Linux
    • Updating
    • Troubleshooting
  • - Configuration + Configuration
      -
    • Configuration.yaml
      • +
    • YAML
      • +
    • Basic information
    • Setting up devices
    • Customizing devices and services
    • Presence Detection
      • diff --git a/getting-started/customizing-devices/index.html b/getting-started/customizing-devices/index.html index e6f1564e72..f097dc3be7 100644 --- a/getting-started/customizing-devices/index.html +++ b/getting-started/customizing-devices/index.html @@ -89,13 +89,11 @@
      -

      By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front
      -page by altering some of these parameters. This can be done by adding the following configuration inside the homeassistant: section.

      +

      By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by adding the following configuration inside the homeassistant: section.

      -

      Devices that you don’t want to have visible can be hidden with hidden.
      -entity_pictureentries, badges, device_tracker pictures, etc. can either be external URLs (e.g. http://example.com/example.jpg) or
      -of the form /local/filename.jpg, where /local represents the directory www in the HASS configuration directory.
      -You may have to create the www directory yourself as it is not made automatically.

      +

      Devices that you don’t want to have visible can be hidden with hidden.

      + +

      entity_pictureentries, badges, device_tracker pictures, etc. can either be external URLs (e.g. http://example.com/example.jpg) or of the form /local/filename.jpg, where /local represents the directory www in the HASS configuration directory. You may have to create the www directory yourself as it is not made automatically.

      You can also use icon and refer to any icon from MaterialDesignIcons.com.

      @@ -150,15 +148,16 @@ You may have to create the www directory yourself as it is not made
    • Raspberry Pi All-In-One Installer
    • Docker
    • Synology NAS
      • -
    • VirtualEnv Linux
      • +
    • Virtualenv Linux
    • Updating
    • Troubleshooting
  • - Configuration + Configuration
  • - Configuration + Configuration -

    What’s next

    +

    What’s next?

    To see what Home Assistant can do, launch demo mode: hass --demo-mode or visit the demo page.

    @@ -156,15 +156,16 @@ $ hass --open-ui
  • Raspberry Pi All-In-One Installer
  • Docker
  • Synology NAS
    • -
  • VirtualEnv Linux
    • +
  • Virtualenv Linux
  • Updating
  • Troubleshooting
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
      -
    • Configuration.yaml
      • +
    • YAML
      • +
    • Basic information
    • Setting up devices
    • Customizing devices and services
    • Presence Detection
      • diff --git a/getting-started/installation-virtualenv/index.html b/getting-started/installation-virtualenv/index.html index 6d3472cbe8..554da91716 100644 --- a/getting-started/installation-virtualenv/index.html +++ b/getting-started/installation-virtualenv/index.html @@ -93,7 +93,7 @@

      Virtualenvs are pretty easy to setup. This example will walk through one method of setting one up (there are certainly others). We’ll be using Debian in this example (as many Home Assistant users are running Raspbian on a Raspberry Pi), but all of the Python related steps should be the same on just about any platform.

      -

      Step 0: Install some dependencies

      +

      Step 0: Install some dependencies

      $ sudo apt-get update
@@ -104,7 +104,7 @@ $ sudo pip install --upgrade virtualenv
      -

      Step 1: Create a Home Assistant user

      +

      Step 1: Create a Home Assistant user

      This step is optional, but it’s a good idea to give services like Home Assistant their own user. It gives you more granular control over permissions, and reduces the exposure to the rest of your system in the event there is a security related bug in Home Assistant. This is a reasonably Linux oriented step, and will look different on other operating systems (or even other Linux distributions).

      @@ -124,7 +124,7 @@ $ sudo pip install --upgrade virtualenv
      -

      Step 2: Create a directory for Home Assistant

      +

      Step 2: Create a directory for Home Assistant

      This can be anywhere you want. AS example we put it in /srv. You also need to change the ownership of the directory to the user you created above (if you created one).

      @@ -134,7 +134,8 @@ $ sudo chown hass /srv/hass -

      ## Step 3: Become the new user

      + +

      Step 3: Become the new user

      This is obviously only necessary if you created a hass user, but if you did, be sure to switch to that user whenever you install things in your virtualenv, otherwise you’ll end up with mucked up permissions.

      @@ -146,7 +147,7 @@ $ sudo chown hass /srv/hass

      The su command means ‘switch’ user. We use the ‘-s’ flag because the hass user is a system user and doesn’t have a default shell by default (to prevent attackers from being able to log in as that user).

      -

      Step 4: Set up the virtualenv

      +

      Step 4: Set up the virtualenv

      All this step does is stick a Python environment in the directory we’re using. That’s it. It’s just a directory. There’s nothing ‘special’ about it, and it is entirely self-contained.

      @@ -168,7 +169,7 @@ $ sudo chown hass /srv/hass

      After that, your prompt should include (hass).

      -

      Step 6: Install Home Assistant

      +

      Step 6: Install Home Assistant

      Once your virtualenv has been activated, you don’t need to sudo any of your pip commands. pip will be installing things in the virtualenv, which the hass user has permission to modify.

      @@ -180,7 +181,7 @@ $ sudo chown hass /srv/hass

      And that’s it… you now have Home Assistant installed, and you can be sure that every bit of it is contained in /srv/hass.

      -

      Finally… Run Home Assistant

      +

      Finally… Run Home Assistant

      There are two ways to launch Home Assistant. If you are in the virtualenv, you can just run hass and it will work as normal. If the virtualenv is not activated, you just use the hass executable in the bin directory mentioned earlier. There is one caveat… Because Home Assistant stores it’s configuration in the user’s home directory, we need to be the user hass user or specify the configuration with -c.

      @@ -192,15 +193,15 @@ $ sudo chown hass /srv/hass

      The -H flag is important. It sets the $HOME environment variable to /home/hass so hass can find its configuration.

      -

      Upgrading Home Assistant

      +

      Upgrading Home Assistant

      Upgrading Home Assistant is simple, just repeat steps 3, 5 and 6.

      -

      Starting Home Assistant on boot

      +

      Starting Home Assistant on boot

      The autostart instructions will work just fine, just be sure to replace /usr/bin/hass with /srv/hass/bin/hass and specify the hass user where appropriate.

      -

      Installing python-openzwave

      +

      Installing python-openzwave

      If you want to use Z-Wave devices, you will need to install python-openzwave in your virtualenv. This requires a small tweak to the instructions on home-assistant.io

      @@ -257,15 +258,16 @@ $ sudo chown hass /srv/hass
    • Raspberry Pi All-In-One Installer
    • Docker
    • Synology NAS
      • -
    • VirtualEnv Linux
      • +
    • Virtualenv Linux
    • Updating
    • Troubleshooting
  • - Configuration + Configuration
  • - Configuration + Configuration
  • - Configuration + Configuration
      -
    • Configuration.yaml
      • +
    • YAML
      • +
    • Basic information
    • Setting up devices
    • Customizing devices and services
    • Presence Detection
      • diff --git a/getting-started/scripts-service-calls/index.html b/getting-started/scripts-service-calls/index.html index 17c731d6a0..b6200ae50b 100644 --- a/getting-started/scripts-service-calls/index.html +++ b/getting-started/scripts-service-calls/index.html @@ -182,15 +182,16 @@ Use the + + + + + + + + YAML - Home Assistant + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +
      +
      + +
      + + + Home Assistant + +
      + +
      + +
      + +
      +
      +
      + + + +
      +
      + +
      + + +
      + + + + +
      +

      + YAML +

      +
      +
      + + +

      Home Assistant uses the YAML syntax for configuration. YAML might take a while to get used to but is really powerful in allowing you to express complex configurations.

      + +

      For each component that you want to use in Home Assistant, you add code in your configuraton.yaml file to specify its settings.
      +The following example entry specifies that you want to use the notify component with the pushbullet platform.

      + +
      + 
      notify:
+  platform: pushbullet
+  api_key: "o.1234abcd"
+  name: pushbullet
+
      +
      +
      + +
        +
      • A component provides the core logic for some functionality (like notify provides sending notifications).
        • +
      • A platform makes the connection to a specific software or hardware platform (like pushbullet works with the service from pushbullet.com).
        • +
      + +

      The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a - while mappings have the format key: value. If you specify duplicate keys, the last value for a key is used.

      + +

      Note that indentation is an important part of specifying relationships using YAML. Things that are indented are nested “inside” things that are one level higher. So in the above example, platform: pushbullet is a property of (nested inside) the notify component.
      +Getting the right indentation can be tricky if you’re not using an editor with a fixed width font. Tabs are not allowed to be used for indentation. Convention is to use 2 spaces for each level of indentation.

      + +

      Lines that start with # are comments and are ignored by the system.

      + +

      The next example shows an input_select component that uses a block collection for the options values.
      +The other properties (like name) are specified using mappings. Note that the second line just has threat: with no value on the same line. Here threat is the name of the input_select and the values for it are everything nested below it.

      + +
      + 
      input_select:
+  threat:
+    name: Threat level
+# A collection is used for options
+    options:
+     - 0
+     - 1
+     - 2
+     - 3
+    initial: 0
+
      +
      +
      + +

      The following example shows nesting a collection of mappings in a mapping. In Home Assistant, this would create two sensors that each use the MQTT platform but have different values for their state_topic (one of the properties used for MQTT sensors).

      + +
      + 
      sensor:
+  - platform: mqtt
+    state_topic: sensor/topic
+  - platform: mqtt
+    state_topic: sensor2/topic
+
      +
      +
      + +

      Next step: Setting up the basics »

      + + +
      + + +
      + + + + +
      +
      + + + + + + \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 8f4246797b..7fe796519c 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -307,6 +307,9 @@ https://home-assistant.io/getting-started/autostart/ + + https://home-assistant.io/getting-started/basic/ + https://home-assistant.io/getting-started/browsers/ @@ -445,6 +448,9 @@ https://home-assistant.io/developers/website/ + + https://home-assistant.io/getting-started/yaml/ + https://home-assistant.io/blog/categories/website/ @@ -1704,26 +1710,26 @@ https://home-assistant.io/demo/frontend.html - 2016-06-05T12:49:23+00:00 + 2016-06-05T14:10:44+00:00 https://home-assistant.io/demo/index.html - 2016-06-05T12:49:23+00:00 + 2016-06-05T14:10:44+00:00 https://home-assistant.io/googlef4f3693c209fe788.html - 2016-06-05T12:49:23+00:00 + 2016-06-05T14:10:44+00:00 https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html - 2016-06-05T12:49:23+00:00 + 2016-06-05T14:10:44+00:00 https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html - 2016-06-05T12:49:23+00:00 + 2016-06-05T14:10:44+00:00 https://home-assistant.io/static/mdi-demo.html - 2016-06-05T12:49:23+00:00 + 2016-06-05T14:10:44+00:00