-
{% comment %}
## Pages without categories
-
{% for component in components %}
{% unless component.ha_category %}
- All
- Featured
+
-
-
+
- {% for component in components %}
- {% if component.ha_category %}
-
-
+
- {% if component.logo %}
- 
- {% endif %}
-
-
- {% endif %}
- {{ component.title }}
- {{ component.ha_category }}
-
- {% endif %}
- {% endfor %}
+ Other
+
+ {% for component in components %}
+ {% if component.ha_category %}
+
+
+ {% if component.logo %}
+
+ {% endif %}
+
+
+ {% endif %}
+ {{ component.title }}
+ {{ component.ha_category }}
+
+ {% endif %}
+ {% endfor %}
+ {{ component.title }}
diff --git a/source/developers/development_validation.markdown b/source/developers/development_validation.markdown index 9728474880..cd36cb5731 100644 --- a/source/developers/development_validation.markdown +++ b/source/developers/development_validation.markdown @@ -21,20 +21,40 @@ Beside the [voluptuous](https://pypi.python.org/pypi/voluptuous) default types a To validate plaforms using [MQTT](/components/mqtt/) there are `valid_subscribe_topic` and `valid_publish_topic` present. +Some things to keep in mind: + +- Use the constants which are definded in `const.py`. +- Import `PLATFORM_SCHEMA` from parent component and extend it. +- Preferred order is `required` first, then `optional`. + ### {% linkable_title Snippets %} This section contains a couple of snippets for the validation we use. ### {% linkable_title Default name %} +It's common to set a default for a sensor if the user is not providing a name to use. + ```python DEFAULT_NAME = 'Sensor name' -PLATFORM_SCHEMA = vol.Schema({ +PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ ... vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, ``` +### {% linkable_title Limit the values %} + +In certain cases you want to limit the user's input to a couple of options. + +```python +DEFAULT_METHOD = 'GET' + +PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ + ... + vol.Optional(CONF_METHOD, default=DEFAULT_METHOD): vol.In(['POST', 'GET']), +``` + ### {% linkable_title Port %} As all port numbers are coming out of the range 1 till 65535 a range check should be performed. @@ -42,8 +62,8 @@ As all port numbers are coming out of the range 1 till 65535 a range check shoul ```python DEFAULT_PORT = 993 -PLATFORM_SCHEMA = vol.Schema({ - [...] +PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ + ... vol.Optional(CONF_PORT, default=DEFAULT_PORT): vol.All(vol.Coerce(int), vol.Range(min=1, max=65535)), ``` @@ -58,8 +78,8 @@ SENSOR_TYPES = { 'average_download_rate': ('Average Speed', 'MB/s'), } -PLATFORM_SCHEMA = vol.Schema({ - .... +PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ + ... vol.Optional(CONF_MONITORED_VARIABLES, default=[]): [vol.In(SENSOR_TYPES)], ``` diff --git a/source/getting-started/configuration.markdown b/source/getting-started/configuration.markdown index 38b5dbe18d..f9ed323498 100644 --- a/source/getting-started/configuration.markdown +++ b/source/getting-started/configuration.markdown @@ -9,20 +9,28 @@ sharing: true footer: true --- -Home Assistant will create a configuration folder when it is run for the first time. The location of the folder differs between operating systems: on OS X and Linux it's `~/.homeassistant` and on Windows it's `%APPDATA%/.homeassistant`. If you want to use a different folder for configuration, run `hass --config path/to/config`. - -Inside your configuration folder is the file `configuration.yaml`. This is the main file that contains which components will be loaded and what their configuration is. This file contains YAML code, which is explained briefly below. [An example configuration file is located here](https://github.com/home-assistant/home-assistant/blob/master/config/configuration.yaml.example). - When launched for the first time, Home Assistant will write a default configuration file enabling the web interface and device discovery. It can take up to a minute for your devices to be discovered and show up in the user interface. -If you run into trouble while configuring Home Assistant, have a look at [the configuration troubleshooting page](/getting-started/troubleshooting-configuration/). +The location of the folder differs between operating systems: -- Install colorlog (`$ pip install colorlog`) to make the console output easier to read, hence also easier to catch errors and warnings. -
+| OS | Path | +| -- | ---- | +| OS X | `~/.homeassistant` | +| Linux | `~/.homeassistant` | +| Windows | `%APPDATA%/.homeassistant` | + +If you want to use a different folder for configuration, use the config command line parameter: `hass --config path/to/config`. + +Inside your configuration folder is the file `configuration.yaml`. This is the main file that contains which components will be loaded and what their configuration is. Throughout the documentation you will find snippets that you can add to your configuration file to enable that functionality. + +If you run into trouble while configuring Home Assistant, have a look at [the configuration troubleshooting page](/getting-started/troubleshooting-configuration/) and at the [configuration.yaml examples](/cookbook/#example-configurationyaml).- You will have to restart Home Assistant each time you make changes in `configuration.yaml` in order for these to take effect. + You will have to restart Home Assistant for changes to `configuration.yaml` take effect. +
+ ++ Install colorlog (`$ pip3 install colorlog`) to make the console output easier to read, hence also easier to catch errors and warnings.
### [Next step: Get familiar with YAML »](/getting-started/yaml/) diff --git a/source/getting-started/scripts-conditions.markdown b/source/getting-started/scripts-conditions.markdown index 11beeabadb..430727ba97 100644 --- a/source/getting-started/scripts-conditions.markdown +++ b/source/getting-started/scripts-conditions.markdown @@ -96,7 +96,9 @@ for: #### {% linkable_title Sun condition %} -The sun condition can test if the sun has already set or risen when a trigger occurs. The `before` and `after` keys can only be set to `sunset` or `sunrise`. They have a corresponding optional offset value (`before_offset`, `after_offset`) that can be added, similar to the [sun trigger](#sun-trigger). +The sun condition can test if the sun has already set or risen when a trigger occurs. The `before` and `after` keys can only be set to `sunset` or `sunrise`. They have a corresponding optional offset value (`before_offset`, `after_offset`) that can be added, similar to the [sun trigger][sun_trigger]. + +[sun_trigger]: /getting-started/automation-trigger/#sun-trigger ```yaml condition: sun diff --git a/source/getting-started/z-wave.markdown b/source/getting-started/z-wave.markdown index a0ea9ad7d7..9f111c0578 100644 --- a/source/getting-started/z-wave.markdown +++ b/source/getting-started/z-wave.markdown @@ -170,7 +170,7 @@ The *object_id* and *scene_id* of all triggered events can be seen in the consol #### {% linkable_title Services %} -The Z-Wave component exposes four services to help maintain the network. +The Z-Wave component exposes seven services to help maintain the network. | Service | Description | | ------- | ----------- | diff --git a/source/index.html b/source/index.html index 46d633741e..ffa5962b1e 100644 --- a/source/index.html +++ b/source/index.html @@ -15,8 +15,8 @@ hide_github_edit: true
-