-It's recommended that you only open your firewall to the SSL/TLS port (8883) and only use the insecure port (1883) for local devices. Also, disable `anonymous:` and set `logins:`. -
+Remove the ports from the add-on page network card (set them as blank) to disable them. ### {% linkable_title Access Control Lists (ACLs) %} diff --git a/source/_addons/samba.markdown b/source/_addons/samba.markdown index fe967f6ab28..f28ac32f215 100644 --- a/source/_addons/samba.markdown +++ b/source/_addons/samba.markdown @@ -13,22 +13,12 @@ featured: true This add-on allows you to set up a [Samba](https://samba.org/) server to access Hass.io folders using Windows network shares.
-It is strongly recommended to set a username and password. By using guest mode, you expose your configuration and secrets to every user in local network.
-Also be careful when setting up port forwarding for remote access. If you don't restrict access by setting a username and password, your configuration could be exposed to the entire internet!
+Be careful when setting up port forwarding for remote access. If you don't restrict access by setting a username and strong password, your configuration could be exposed to the entire internet!
The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so make sure that is installed. +
Home Assistant comes with certain Intents builtin to handle common tasks. A complete list of Intents can be found in this wiki [Hass Snips Bundle](https://github.com/tschmidty69/hass-snips-bundle-intents/wiki). @@ -51,7 +53,6 @@ Now it's time to start Snips for the first time. You can configure the microphon Configuration variables: -- **mqtt_bridge**: Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your the Mosquitto add-on. - **assistant**: The name of your custom assistant in `/share`. If no assistant is found then a default assistant will be used. - **language**: Language. This is used to select the default custom assistant, Currently `en`, `de` and `fr` are supported. - **custom_tts**: Whether to use a TTS provider from Home Assistant for a variety of voices. diff --git a/source/_components/binary_sensor.http.markdown b/source/_components/binary_sensor.http.markdown index 779cafb95e2..36ee7eba9e0 100644 --- a/source/_components/binary_sensor.http.markdown +++ b/source/_components/binary_sensor.http.markdown @@ -10,6 +10,7 @@ footer: true logo: http.png ha_category: Binary Sensor ha_release: pre 0.7 +ha_qa_scale: internal --- The HTTP binary sensor is dynamically created with the first request that is made to its URL. You don't have to define it in the configuration first. diff --git a/source/_components/calendar.todoist.markdown b/source/_components/calendar.todoist.markdown index 36c6e844b78..d738b4b0914 100644 --- a/source/_components/calendar.todoist.markdown +++ b/source/_components/calendar.todoist.markdown @@ -94,7 +94,7 @@ As you can see, there are 4 custom projects here: You can mix-and-match these attributes to create all sorts of custom projects. You can even use [IFTTT](https://ifttt.com/todoist) to create a task with a certain label, then have Home Assistant do some kind of automation when a task with that label comes due. -Home Assistant does its best to determine what task in each project is "most" important, and it's that task which has its state reported. You can access the other tasks you have due soon via the `all_tasks` array (see below). +Home Assistant does its best to [determine what task in each project is "most" important](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/calendar/todoist.py#L432), and it's that task which has its state reported. You can access the other tasks you have due soon via the `all_tasks` array (see below). ### {% linkable_title Sensor attributes %} diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index 37d1e7584ab..e665590ff74 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -153,6 +153,7 @@ automation: #### {% linkable_title Appdaemon event helper %} Helper app that creates a sensor `sensor.deconz_event` with a state that represents the id from the last event and an attribute to show the event data. +Put this in `apps.yaml`: {% raw %} ```yaml deconz_helper: @@ -160,6 +161,7 @@ deconz_helper: class: DeconzHelper ``` +Put this in `deconz_helper.py`: ```python import appdaemon.plugins.hass.hassapi as hass import datetime @@ -179,6 +181,7 @@ class DeconzHelper(hass.Hass): ``` {% endraw %} +Note: the event will not be visible before one event gets sent. #### {% linkable_title Appdaemon remote template %} diff --git a/source/_components/device_tracker.owntracks.markdown b/source/_components/device_tracker.owntracks.markdown index 9a2e98158de..8180739e9bc 100644 --- a/source/_components/device_tracker.owntracks.markdown +++ b/source/_components/device_tracker.owntracks.markdown @@ -104,7 +104,7 @@ When you exit a zone, Home Assistant will start using location updates to track ### {% linkable_title Using Owntracks regions - forcing Owntracks to update using iBeacons %}-Owntracks v2.0.0 removes support for iBecons on Android. +Owntracks v2.0.0 removes support for iBeacons on Android.
When run in the usual *significant changes mode* (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons. diff --git a/source/_components/device_tracker.tomato.markdown b/source/_components/device_tracker.tomato.markdown index 0c080449b64..bb394f8c56b 100644 --- a/source/_components/device_tracker.tomato.markdown +++ b/source/_components/device_tracker.tomato.markdown @@ -16,11 +16,6 @@ The `tomato` platform requires an extra config variable called `http_id`. The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code. -Because of a limitation in Tomato's API, this platform will only track wireless -devices. If tracking wired devices like a Philips Hue Hub is necessary, it is -possible to use another platform like -[NMAP](/components/device_tracker.nmap_tracker/). - Because of a limitation in Tomato's API, this platform will only track wireless devices. If tracking wired devices like a Philips Hue Hub is necessary, it is possible to use another platform like [Nmap](/components/device_tracker.nmap_tracker/). diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index e7cd1f97c9b..413e1dcf478 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -125,7 +125,7 @@ project_id: required: true type: string api_key: - description: Your API key. + description: Your Homegraph API key (for the `google_assistant.request_sync` service) required: false type: string expose_by_default: diff --git a/source/_components/media_player.russound_rio.markdown b/source/_components/media_player.russound_rio.markdown index 7a63ab7c666..c431cbbec1d 100644 --- a/source/_components/media_player.russound_rio.markdown +++ b/source/_components/media_player.russound_rio.markdown @@ -27,8 +27,18 @@ media_player: name: Russound ``` -Configuration variables: - -- **host** (*Required*): The IP of the TCP gateway -- **port** (*Optional*): The port of the TCP gateway (default: 9621) -- **name** (*Required*): The name of the device +{% configuration %} +host: + description: The IP of the TCP gateway. + required: true + type: string +port: + description: The port of the TCP gateway. + required: false + default: 9621 + type: integer +name: + description: The name of the device. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/media_player.webostv.markdown b/source/_components/media_player.webostv.markdown index f321a4807f9..ba5646c91a3 100644 --- a/source/_components/media_player.webostv.markdown +++ b/source/_components/media_player.webostv.markdown @@ -145,7 +145,7 @@ remembering to split them per line into your `sources:` configuration. ### {% linkable_title Change channel through play_media service %} The `play_media` service can be used in a script to switch to the specified tv -channel. It selects the best matching cannel according to the `media_content_id` +channel. It selects the best matching channel according to the `media_content_id` parameter: 1. Channel number *(i.e. '1' or '6')* diff --git a/source/_components/notify.clickatell.markdown b/source/_components/notify.clickatell.markdown index 8ac5d9a614c..e7ed3b902db 100644 --- a/source/_components/notify.clickatell.markdown +++ b/source/_components/notify.clickatell.markdown @@ -12,10 +12,10 @@ ha_category: Notifications ha_release: 0.56 --- - The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant. -### Get your Clickatell API Credentials +## {% linkable_title Setup %} + Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) section and create a new SMS integration. There are three screens of information required to create an integration. Please ensure the following: 1. Give the new Integration an identification name. @@ -25,6 +25,8 @@ Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) se 5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide. 6. Once you have completed entering your details an API key is generated. Copy the API key. +## {% linkable_title Configuration %} + To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file: ```yaml @@ -36,11 +38,20 @@ notify: recipient: PHONE_NO ``` -Configuration variables: - -* **name** (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is `clickatell`. The notifier will bind to the service notify.NOTIFIER_NAME. -* **api_key** (Required): Your API key. -* **recipient** (Required): Your phone number. This is where you want to send your notification SMS messages. e.g., `61444333444`. - +{% configuration %} +name: + description: Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME. + required: false + default: clickatell + type: string +api_key: + description: Your Clicktell API key. + required: true + type: string +recipient: + description: Your phone number. This is where you want to send your notification SMS messages. e.g., `61444333444`. + required: true + type: string +{% endconfiguration %} To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.gntp.markdown b/source/_components/notify.gntp.markdown index da4f718eb29..f2a3ee782b3 100644 --- a/source/_components/notify.gntp.markdown +++ b/source/_components/notify.gntp.markdown @@ -12,7 +12,6 @@ ha_category: Notifications ha_release: 0.16 --- - [GNTP](http://www.growlforwindows.com/gfw/help/gntp.aspx) is a specification for sending and receiving notifications between computers. The most well known server implementations are [Growl](http://growl.info) for Mac and [Growl for Windows](http://www.growlforwindows.com/gfw/). To use GNTP notifications, add the following to your `configuration.yaml` file: @@ -26,13 +25,35 @@ notify: GNTP will attempt to connect to a local server running on port 23053 if no `hostname` is provided. -Configuration variables: - -- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. -- **app_name** (*Optional*): The application name that will be displayed on every notification and will be registered with the server. -- **app_icon** (*Optional*): The icon that will be displayed on every notification. You can provide an HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use an HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering. -- **hostname** (*Optional*): The hostname or IP address of the GNTP server to contact. -- **password** (*Optional*): The password to authenticate to the GNTP server with. -- **port** (*Optional*): The port that the GNTP server runs on. The specification states that servers should not allow users to use any port other than 23053 but `port` is provided here just in case. +{% configuration %} +name: + description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. + required: false + default: notify + type: string +app_name: + description: The application name that will be displayed on every notification and will be registered with the server. + required: false + default: HomeAssistant + type: string +app_icon: + description: "The icon that will be displayed on every notification. You can provide an HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use an HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering." + required: false + type: string +hostname: + description: The hostname or IP address of the GNTP server to contact. + required: false + default: localhost + type: string +password: + description: The password to authenticate to the GNTP server with. + required: false + type: string +port: + description: The port that the GNTP server runs on. The specification states that servers should not allow users to use any port other than 23053 but `port` is provided here just in case. + required: false + default: 23053 + type: integer +{% endconfiguration %} To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/nuimo_controller.markdown b/source/_components/nuimo_controller.markdown index e450fc515f0..cfbb5f66d89 100644 --- a/source/_components/nuimo_controller.markdown +++ b/source/_components/nuimo_controller.markdown @@ -19,14 +19,20 @@ To connect to a Nuimo device add the following section to your `configuration.ya ```yaml # Example configuration.yaml entry -nuimo_controller: +nuimo_controller: ``` -Configuration variables: - -- **mac** (*Optional*): Skip discovery and connect to this device address. -- **name** (*Optional*): To handle more than one device by names, add the name of the device. - +{% configuration %} +mac: + description: Skip discovery and connect to this device address. + required: false + type: string +name: + description: To handle more than one device by names, add the name of the device. + required: false + default: None + type: string +{% endconfiguration %} Example for testing rotation value and sending to the LED matrix: @@ -42,7 +48,7 @@ automation Nuimo_rotate_right: value_template: {% raw %}'{{ trigger.event.data.value > 100 }}'{% endraw %} action: service: nuimo_controller.led_matrix - data: + data: matrix: '........ 0000000. @@ -52,7 +58,7 @@ automation Nuimo_rotate_right: .00.000. .000000. .000000. - ........ ' + ........' interval: 0.5 ``` @@ -60,7 +66,7 @@ Troubleshooting: - use `hcitool lescan` to see the mac address of your device -- allow non-root user access to Bluetooth LE with `sudo setcap cap_net_raw+eip $(eval readlink -f $(which python))` +- allow non-root user access to Bluetooth LE with `sudo setcap cap_net_raw+eip $(eval readlink -f $(which python))` - install the newest version of [pygattlib](https://bitbucket.org/OscarAcena/pygattlib) from the repository, either because there is no binary package for your system or the pip version contains errors, with `pip install hg+https://bitbucket.org/OscarAcena/pygattlib --target $HOME/.homeassistant/deps`. (Dependencies of pygattlib: `sudo apt-get install pkg-config libboost-python-dev libboost-thread-dev libbluetooth-dev libglib2.0-dev python-dev`) diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index 4c8897e2522..debdfaec6cb 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -14,7 +14,7 @@ ha_iot_class: "Local Push" --- The `opentherm_gw` component is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant. -When enabled, this component will automatically add it's [`climate` entity](/components/climate.opentherm_gw) to Home Assistant. +When enabled, this component will automatically add its [`climate` entity](/components/climate.opentherm_gw) to Home Assistant. # {% linkable_title Configuration %} diff --git a/source/_components/satel_integra.markdown b/source/_components/satel_integra.markdown index 8e71d59e7f0..b330fd29938 100644 --- a/source/_components/satel_integra.markdown +++ b/source/_components/satel_integra.markdown @@ -22,9 +22,64 @@ There is currently support for the following device types within Home Assistant: The module communicates via Satel's open TCP protocol published on their website. It subscribes for new events coming from alarm system and reacts to them immediately. -**IMPORTANT:** The library currently doesn't support encrypted connection to your alarm, so you need **to turn off encryption for integration protocol**. In Polish: "koduj integracje" must be unchecked. You will find this setting in your DLOADX program. +## {% linkable_title Setup %} + +The library currently doesn't support encrypted connection to your alarm, so you need **to turn off encryption for integration protocol**. In Polish: "koduj integracje" must be unchecked. You will find this setting in your DloadX program. + +A list of all zone IDs can be taken from DloadX program. + +For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) documentation. Note: If no zones are specified, Home Assistant will not load any binary_sensor components." + +## {% linkable_title Configuration %} + +A `satel_integra` section must be present in the `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +satel_integra: + host: IP_ADDRESS +``` + +{% configuration %} +host: + description: The IP address of the Satel Integra ETHM module on your home network, if using socket type. + required: true + default: localhost + type: string +port: + description: The port on which the ETHM module listens for clients using integration protocol. + required: false + default: 7094 + type: integer +partition: + description: The partition to operate on. Integra can support multiple partitions, this platform only supports one. + required: false + default: 1 + type: integer +arm_home_mode: + description: The mode in which arm Satel Integra when 'arm home' is used. Possible options are `1`,`2` or `3`. For more information on what are the differences between them, please refer to Satel Integra manual. + required: false + default: 1 + type: integer +zones: + description: "This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the configuration. For each zone, a proper ID must be given as well as its name (does not need to match the one specified in Satel Integra alarm)." + required: false + type: [integer, list] + keys: + name: + description: Name of the zone. + required: true + type: string + type: + description: The zone type. + required: false + default: motion + type: string +{% endconfiguration %} + + +## {% linkable_title Full examples %} -A `satel_integra` section must be present in the `configuration.yaml` file and contain the following options as required: ```yaml # Example configuration.yaml entry @@ -33,7 +88,6 @@ satel_integra: port: 7094 partition: 1 arm_home_mode: 1 - zones: 01: name: 'Bedroom' @@ -47,19 +101,8 @@ satel_integra: 113: name: 'Entry door' type: 'opening' - ``` -Configuration variables: - -- **host** (*Required*): The IP address of the Satel Integra ETHM module on your home network, if using socket type. Default: `localhost` -- **port** (*Optional*): The port on which the ETHM module listens for clients using integration protocol. Default: `7094` -- **partition** (*Optional*): The partition to operate on. Integra can support multiple partitions, this platform only supports one. Default: `1` -- **arm_home_mode** (*Optional*): The mode in which arm Satel Integra when 'arm home' is used. Possible options are `1`,`2` or `3`, default being `1`. For more information on what are the differences between them, please refer to Satel Integra manual. -- **zones** (*Optional*): This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the config. For each zone, a proper ID must be given as well as its name (does not need to match the one specified in Satel Integra alarm). For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.* - -List of all zone IDs can be taken from DloadX program. - Having configured the zones, you can use them for automation, such as to react on the movement in your bedroom. For example: @@ -73,7 +116,5 @@ For example: service: input_boolean.turn_on data: entity_id: input_boolean.movement_detected - ``` -Enjoy! diff --git a/source/_components/sensor.bh1750.markdown b/source/_components/sensor.bh1750.markdown index b7bae73cf1e..1da1ae5eba3 100644 --- a/source/_components/sensor.bh1750.markdown +++ b/source/_components/sensor.bh1750.markdown @@ -13,7 +13,6 @@ ha_release: 0.48 ha_iot_class: "Local Push" --- - The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet. Tested devices: @@ -30,15 +29,43 @@ sensor: - platform: bh1750 ``` -Configuration variables: - -- **name** (*Optional*): The name of the sensor -- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x23 or 0x5C. -- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3. -- **operation_mode** (*Optional*): Working mode for the sensor. Defaults to `continuous_high_res_mode_1` for continuous measurement and 1 lx resolution. -- **measurement_delay_ms** (*Optional*): Delay time in ms for waiting the sensor to get the measure. Defaults to 120 ms. -- **multiplier** (*Optional*): Correction coefficient to multiply the measured light level. Value between 0.1 and 10. Default is 1. - +{% configuration %} +name: + description: Name of the sensor. + required: false + default: BH1750 Light Sensor + type: string +i2c_address: + description: I2c address of the sensor. It is 0x23 or 0x5C. + required: false + default: 0x23 + type: string +i2c_bus: + description: I2c bus where the sensor is. + required: false + default: 1, for Raspberry Pi 2 and 3. + type: integer +operation_mode: + description: Working mode for the sensor. + required: false + default: continuous_high_res_mode_1 + type: string +sensitivity: + description: The sensitivity of the sensor can be a value between 31 and 254. + required: false + default: 69 + type: integer +measurement_delay_ms: + description: Delay time in ms for waiting the sensor to get the measure. + required: false + default: 120 + type: integer +multiplier: + description: Correction coefficient to multiply the measured light level. Value between 0.1 and 10. + required: false + default: 1 + type: integer +{% endconfiguration %} ## {% linkable_title Full Examples %} @@ -53,6 +80,7 @@ sensor: name: Ambient light i2c_address: 0x5C operation_mode: one_time_high_res_mode_1 + sensitivity: 60 measurement_delay_ms: 200 scan_interval: 25 ``` diff --git a/source/_components/sensor.bitcoin.markdown b/source/_components/sensor.bitcoin.markdown index ba47bf8d9e1..4465554c50c 100644 --- a/source/_components/sensor.bitcoin.markdown +++ b/source/_components/sensor.bitcoin.markdown @@ -59,7 +59,7 @@ display_options: timestamp: description: Timestamp mined_blocks: - description: Minded Blocks + description: Mined Blocks blocks_size: description: Block size total_fees_btc: diff --git a/source/_components/sensor.bme280.markdown b/source/_components/sensor.bme280.markdown index 7887aff3dde..59612eb46d1 100644 --- a/source/_components/sensor.bme280.markdown +++ b/source/_components/sensor.bme280.markdown @@ -13,7 +13,6 @@ ha_release: 0.48 ha_iot_class: "Local Push" --- - The `bme280` sensor platform allows you to read temperature, humidity and pressure values of a [Bosch BME280 Environmental sensor](https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. Tested devices: @@ -30,19 +29,63 @@ sensor: - platform: bme280 ``` -Configuration variables: - -- **name** (*Optional*): The name of the sensor -- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x76 or 0x77. -- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3. -- **operation_mode** (*Optional*): Power mode for the sensor. Use 2 for forced mode or 3 for normal mode. Defaults to normal mode. -- **time_standby** (*Optional*): Standby time in ms for normal mode of operation as described in the sensor datasheet. Defaults to 5 ms. -- **oversampling_temperature** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1. -- **oversampling_pressure** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1. -- **oversampling_humidity** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1. -- **filter_mode** (*Optional*): IIR filter coeficient as described in the sensor datasheet. Default is 0, for filter off. -- **delta_temperature** (*Optional*): Absolute delta for temperature correction. -- **monitored_conditions** array (*Optional*): Conditions to monitor. Available conditions are *temperature*, *humidity* and *pressure*. By default all three are displayed. +{% configuration %} +name: + description: The name of the sensor. + required: false + default: BME280 Sensor + type: string +i2c_address: + description: I2c address of the sensor. It is 0x76 or 0x77. + required: false + default: 0x76 + type: string +i2c_bus: + description: I2c bus where the sensor is. + required: false + default: 1, for Raspberry Pi 2 and 3. + type: integer +operation_mode: + description: Power mode for the sensor. Use 2 for forced mode or 3 for normal mode. + required: false + default: 3 + type: integer +time_standby: + description: Standby time in ms for normal mode of operation as described in the sensor datasheet. + required: false + default: 5 + type: integer +oversampling_temperature: + description: Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. + required: false + default: 1 + type: integer +oversampling_pressure: + description: Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. + required: false + default: 1 + type: integer +oversampling_humidity: + description: Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. + required: false + default: 1 + type: integer +filter_mode: + description: IIR filter coeficient as described in the sensor datasheet. + required: false + default: 0 + type: integer +delta_temperature: + description: Absolute delta for temperature correction. + required: false + default: 0 + type: float +monitored_conditions: + description: Conditions to monitor. Available conditions are *temperature*, *humidity* and *pressure*. + required: false + default: All three conditions + type: list +{% endconfiguration %} ## {% linkable_title Full Examples %} diff --git a/source/_components/sensor.dweet.markdown b/source/_components/sensor.dweet.markdown index 1bc81d27e67..971c4e734bb 100644 --- a/source/_components/sensor.dweet.markdown +++ b/source/_components/sensor.dweet.markdown @@ -15,36 +15,55 @@ ha_iot_class: "Cloud Polling" The `dweet` sensor platform allows you to get details from your devices which are publishing their values to [Dweet.io](https://dweet.io/). -To use Dweet.io in your installation, add the following to your `configuration.yaml` file: +## {% linkable_title Configuration %} +To use Dweet.io sensors in your installation, add the following to your `configuration.yaml` file: + +{% raw %} ```yaml # Example configuration.yaml entry sensor: - platform: dweet device: THING_NAME - value_template: '{% raw %}{{ value_json.VARIABLE }}{% endraw %}' + value_template: '{{ value_json.VARIABLE }}' ``` +{% endraw %} -Configuration variables: - -- **device** (*Required*): Identification of the device (also known as `thing`). -- **value_template** (*Required*): The variable to extract a value from the content. -- **name** (*Optional*): Let you overwrite the name of the device in the frontend. -- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any. +{% configuration %} +device: + description: Identification of the device (also known as `thing`). + required: true + type: string +value_template: + description: The variable to extract a value from the content. + required: true + type: template +name: + description: Let you overwrite the name of the device in the frontend. + required: false + default: Dweet.io Sensor + type: string +unit_of_measurement: + description: Defines the unit of measurement of the sensor, if any. + required: false + type: string +{% endconfiguration %} ### {% linkable_title Full configuration sample %} A full configuration entry could look like the sample below. +{% raw %} ```yaml # Example configuration.yaml entry sensor: - platform: dweet name: Temperature device: THING_NAME - value_template: '{% raw %}{{ value_json.VARIABLE }}{% endraw %}' + value_template: '{{ value_json.VARIABLE }}' unit_of_measurement: "°C" ``` +{% endraw %} ### {% linkable_title Interacting with Dweet.io %} @@ -53,6 +72,7 @@ You can easily send dweets from the command-line to test your sensor with `curl` ```bash $ curl -H 'Content-Type: application/json' -d '{"temperature": 40, "humidity": 65}' https://dweet.io/dweet/for/ha-sensor ``` + will give you a response like the one below: ```json @@ -61,7 +81,7 @@ will give you a response like the one below: The [dweepy](https://github.com/paddycarey/dweepy) module gives you another option to work with [Dweet.io](https://dweet.io/). -Send a dweet. +Send a dweet. ```bash $ python3 @@ -76,4 +96,3 @@ Receive the latest dweet. >>> dweepy.get_latest_dweet_for('ha-sensor') [{'thing': 'ha-sensor'', 'created': '2015-12-10T09:43:31.133Z', 'content': {'humidity': 65, 'temperature': 40}}] ``` - diff --git a/source/_components/sensor.ebox.markdown b/source/_components/sensor.ebox.markdown index c71643c4c81..cbdad34af61 100644 --- a/source/_components/sensor.ebox.markdown +++ b/source/_components/sensor.ebox.markdown @@ -31,20 +31,47 @@ sensor: - before_offpeak_total ``` -Configuration variables: - -- **username** (*Required*): Your EBox username. -- **password** (*Required*): Your EBox password. -- **monitored_variables** array (*Required*): Variables to monitor. - - **before_offpeak_download**: Download before offpeak usage - - **before_offpeak_upload**: Upload before offpeak usage - - **before_offpeak_total**: Total before offpeak usage - - **offpeak_download**: Download offpeak usage - - **offpeak_upload**: Upload offpeak usage - - **offpeak_total**: Total offpeak usage - - **download**: Download usage - - **upload**: Upload usage - - **total**: Total usage - - **balance**: Account balance - - **limit**: Limit usage - - **usage**: Percent usage +{% configuration %} +username: + description: Your EBox username. + required: true + type: string +password: + description: Your EBox password. + required: true + type: string +name: + description: The name of the sensor. + required: false + default: EBox + type: string +monitored_variables: + description: Variables to monitor. + required: true + type: list + keys: + before_offpeak_download: + description: Download before offpeak usage + before_offpeak_upload: + description: Upload before offpeak usage + before_offpeak_total: + description: Total before offpeak usage + offpeak_download: + description: Download offpeak usage + offpeak_upload: + description: Upload offpeak usage + offpeak_total: + description: Total offpeak usage + download: + description: Download usage + upload: + description: Upload usage + total: + description: Total usage + balance: + description: Account balance + limit: + description: Limit usage + usage: + description: Percent usage +{% endconfiguration %} diff --git a/source/_components/sensor.efergy.markdown b/source/_components/sensor.efergy.markdown index 3ffd7d36d77..3291644614e 100644 --- a/source/_components/sensor.efergy.markdown +++ b/source/_components/sensor.efergy.markdown @@ -45,16 +45,43 @@ sensor: - type: current_values ``` -Configuration variables: - -- **app_token** (*Required*): The App Token for your account. -- **utc_offset** (*Required*): Some variables (currently only the daily_cost) require that the negative number of minutes your timezone is ahead/behind UTC time. -- **monitored_variables** array (*Required*): Variables to monitor. - - **type** (*Required*): Name of the variable. - - **instant_readings**: Instant energy consumption. - - **budget**: Monthly budget. - - **cost**: The cost for energy consumption (with the tariff that has been set in Efergy) over a given period. - - **amount**: The amount of energy consumed over a given period. - - **current_values**: This returns the current energy usage of each device on your account, as `efergy_\