-Before version 0.55 this component was known as `input_slider` and did not have the `mode` configuration option. +Before version 0.55 this component was known as `input_slider` and did not have the `mode` configuration option. Also, service `select_value` is now `set_value`.
The `input_number` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. @@ -39,7 +39,6 @@ input_number: mode: box ``` - {% configuration %} input_number: description: Alias for the input. Multiple entries are allowed. diff --git a/source/_components/input_text.markdown b/source/_components/input_text.markdown index 2fa07711af3..d0afd0ff097 100644 --- a/source/_components/input_text.markdown +++ b/source/_components/input_text.markdown @@ -12,7 +12,7 @@ ha_category: Automation ha_release: 0.53 --- -The `input_text` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. +The `input_text` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). ```yaml # Example configuration.yaml entries @@ -27,6 +27,9 @@ input_text: text3: name: Text 3 pattern: '[a-fA-F0-9]*' + text4: + name: Text 4 + mode: password ``` {% configuration %} @@ -59,6 +62,11 @@ input_text: required: false type: String default: empty + mode: + description: Can specify `text` or `password`. Elements of type "password" provide a way for the user to securely enter a value. + required: false + type: String + default: text {% endconfiguration %} ### {% linkable_title Restore State %} diff --git a/source/_components/media_player.mediaroom.markdown b/source/_components/media_player.mediaroom.markdown index 047a79d80c5..a2eece639d9 100644 --- a/source/_components/media_player.mediaroom.markdown +++ b/source/_components/media_player.mediaroom.markdown @@ -47,10 +47,12 @@ Notice that all parameters are optional, and discovery should configure everythi The component has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082. -In most cases (single STB) you just need to setup the *name* and discovery will do the rest. In case you have more than one STB you are required to set the *host* in each one of the entries. +In most cases (single STB) you just need to setup the *platform* and discovery will do the rest. In case you have more than one STB you are required to set the *host* in each one of the entries. If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the component will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable. +## {% linkable_title Examples %} + ### {% linkable_title Example `press_button` script %} The `play_media` function can be used in scripts to change channels. @@ -65,4 +67,16 @@ press_button: entity_id: media_player.mediaroom_stb media_content_id: "{{ value }}" media_content_type: "channel" + +### {% linkable_title Example configuration with 2 STB %} + +```yaml +# Example configuration.yaml entry for 2 STB +media_player: + - platform: mediaroom + host: 192.168.1.64 + name: Living Room STB + - platform: mediaroom + host: 192.168.1.65 + name: Bedroom STB ``` diff --git a/source/_components/mercedesme.markdown b/source/_components/mercedesme.markdown index e84e87c6124..c85b54cd78e 100644 --- a/source/_components/mercedesme.markdown +++ b/source/_components/mercedesme.markdown @@ -48,4 +48,8 @@ scan_interval: required: true default: 30 type: int -{% endconfiguration %} \ No newline at end of file +{% endconfiguration %} + ++The requirement `lxml` has to be [installed](http://lxml.de/installation.html) manually `pip install lxml` on some devices. +
diff --git a/source/_components/sensor.sql.md b/source/_components/sensor.sql.md index a1a0c40fc14..28ec3797881 100644 --- a/source/_components/sensor.sql.md +++ b/source/_components/sensor.sql.md @@ -90,6 +90,12 @@ SELECT * FROM states WHERE entity_id='binary_sensor.xyz789' GROUP BY state ORDER ### {% linkable_title Database size in Postgres %} -```sql -SELECT pg_size_pretty(pg_database_size('Database Name')); +```yaml +- platform: sql + db_url: postgresql://user:password@host/dbname + queries: + - name: db_size + query: "SELECT (pg_database_size('dsmrreader')/1024/1024) as db_size;" + column: "db_size" + unit_of_measurement: MB ``` diff --git a/source/_components/sensor.steam_online.markdown b/source/_components/sensor.steam_online.markdown index 6cf46388770..e49bef70cb5 100644 --- a/source/_components/sensor.steam_online.markdown +++ b/source/_components/sensor.steam_online.markdown @@ -16,9 +16,9 @@ ha_release: 0.14 The Steam component will allow you to track the online status of public [Steam](https://steamcommunity.com) accounts. -You need an API key which is [free](https://steamcommunity.com/dev/apikey) to use the component +You need a [free API key](https://steamcommunity.com/dev/apikey) to use the component -To find an account's 64-bit SteamID you can check the URL of the profile page, if it ends with a long string on numbers then that's the 64-bit SteamID. However, if the profile has a custom URL you will have to copy the it and enter it into [STEAMID I/O](https://steamid.io/) to find the 64-bit SteamID. +To find an account's 64-bit SteamID on profiles without a custom URL you can check the URL of the profile page, the long string of numbers at the end is the 64-bit SteamID. If the profile has a custom URL you will have to copy the URL into [STEAMID I/O](https://steamid.io/) to find the 64-bit SteamID. To use Steam in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.systemmonitor.markdown b/source/_components/sensor.systemmonitor.markdown index 0cc01b8ade6..9ae17d80ba0 100644 --- a/source/_components/sensor.systemmonitor.markdown +++ b/source/_components/sensor.systemmonitor.markdown @@ -60,15 +60,6 @@ The table contains types and their argument to use in your `configuration.yaml` | last_boot | | | since_last_boot | | -**Note**: Some `type:` names used in the `configuration.yaml` file differ from the entity names. - -| Sensor type | Entity ID | -| :------------------ |:-------------------------| -| memory_free | sensor.ram_available | -| memory_use_percent | sensor.ram_used | -| processor_use | sensor.cpu_used | -| disk_use | sensor.disk_used | - ## {% linkable_title Linux specific %} To retrieve all available network interfaces on a Linux System, execute the `ifconfig` command. diff --git a/source/_components/switch.rpi_gpio.markdown b/source/_components/switch.rpi_gpio.markdown index ad4079a433d..9f50d12987f 100644 --- a/source/_components/switch.rpi_gpio.markdown +++ b/source/_components/switch.rpi_gpio.markdown @@ -32,10 +32,13 @@ Configuration variables: - **ports** array (*Required*): Array of used ports. - **port: name** (*Required*): Port numbers and corresponding names (GPIO #). - **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH). -- **shared_gpio** (*Optional*): If true, forces a GPIO.setup() before each write. Default is false. For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi. ++Note that a pin managed by HASS is expected to be exclusive to HASS. +
+ A common question is what does Port refer to, this number is the actual GPIO # not the pin #. For example, if you have a relay connected to pin 11 its GPIO # is 17. @@ -47,14 +50,4 @@ switch: 17: Speaker Relay ``` -In case you have any other python scripts running that use RPi.GPIO no values will be written after the initial HASS-start. -Setting **shared_gpio** to true will reinit the pin before each write, working around this issue. -```yaml -# Example configuration.yaml entry -switch: - - platform: rpi_gpio - shared_gpio: true - ports: - 19: LED-Red -``` diff --git a/source/_docs/ecosystem/appdaemon.markdown b/source/_docs/ecosystem/appdaemon.markdown index 76edbc1dd54..f327433108d 100755 --- a/source/_docs/ecosystem/appdaemon.markdown +++ b/source/_docs/ecosystem/appdaemon.markdown @@ -76,7 +76,7 @@ class FlashyMotionLights(appapi.AppDaemon): This is starting to get a little more complex in Home Assistant automations, requiring an automation rule and two separate scripts. -Now let's extend this with a somewhat artificial example to show something that is simple in AppDaemon but very difficult if not impossible using automations. Let's warn someone inside the house that there has been motion outside by flashing a lamp on and off ten times. We are reacting to the motion as before by turning on the light and setting a timer to turn it off again, but in addition, we set a 1-second timer to run `flash_warning()`, which, when called, toggles the inside light and sets another timer to call itself a second later. To avoid re-triggering forever, it keeps a count of how many times it has been activated and bales out after ten iterations. +Now let's extend this with a somewhat artificial example to show something that is simple in AppDaemon but very difficult if not impossible using automations. Let's warn someone inside the house that there has been motion outside by flashing a lamp on and off ten times. We are reacting to the motion as before by turning on the light and setting a timer to turn it off again, but in addition, we set a 1-second timer to run `flash_warning()`, which, when called, toggles the inside light and sets another timer to call itself a second later. To avoid re-triggering forever, it keeps a count of how many times it has been activated and bails out after ten iterations. ```python import appdaemon.appapi as appapi diff --git a/source/_docs/ecosystem/hass-configurator.markdown b/source/_docs/ecosystem/hass-configurator.markdown index c9fac261ec8..1d07bf163d1 100644 --- a/source/_docs/ecosystem/hass-configurator.markdown +++ b/source/_docs/ecosystem/hass-configurator.markdown @@ -109,8 +109,8 @@ Since the configurator script on its own is no service, you will have to take so 1. Fork the process into the background with the command: `nohup sudo ./configurator.py &` -2. If your system is using systemd (that's usually what you'll find on a Raspberry Pi), there's a [template file](https://github.com/danielperna84/hass-configurator/blob/master/hass-poc-configurator.systemd) you can use and then apply the same process to integrate it as mentioned in the [Home Assistant documentation](https://home-assistant.io/docs/autostart/systemd/). If you use this method you have to set the `BASEPATH` variable according to your environment. -3. If you have [supervisor](http://supervisord.org/) running on your system, [hass-poc-configurator.supervisor](https://github.com/danielperna84/hass-configurator/blob/master/hass-poc-configurator.supervisor) would be an example configuration you could use to control the configurator. +2. If your system is using systemd (that's usually what you'll find on a Raspberry Pi), there's a [template file](https://github.com/danielperna84/hass-configurator/blob/master/hass-configurator.systemd) you can use and then apply the same process to integrate it as mentioned in the [Home Assistant documentation](https://home-assistant.io/docs/autostart/systemd/). If you use this method you have to set the `BASEPATH` variable according to your environment. +3. If you have [supervisor](http://supervisord.org/) running on your system, [hass-poc-configurator.supervisor](https://github.com/danielperna84/hass-configurator/blob/master/hass-configurator.supervisor) would be an example configuration you could use to control the configurator. 4. A tool called [tmux](https://tmux.github.io/), which should be pre-installed with [HASSbian](https://home-assistant.io/docs/hassbian/). 5. A tool called [screen](http://ss64.com/bash/screen.html) (alternative to tmux). If it's not already installed on your system, you can do `sudo apt-get install screen` or `sudo yum install screen` to get it. When it's installed, start a screen session by executing `screen`. Then navigate to your Home Assistant directory and start the configurator like described above. Put the screen session into the background by pressing `CTRL+A` and then `CTRL+D`. It is now safe to disconnect from your SSH session. To resume the screen session, log in to your machine and execute `screen -r`. diff --git a/source/_docs/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown index 0fa7a45c040..a0f3737cbce 100644 --- a/source/_docs/mqtt/discovery.markdown +++ b/source/_docs/mqtt/discovery.markdown @@ -58,6 +58,7 @@ The following firmware for ESP8266, ESP32 and Sonoff unit has built-in support f - [Sonoff-Tasmota](https://github.com/arendst/Sonoff-Tasmota) (starting with 5.11.1e) - [esphomelib](https://github.com/OttoWinter/esphomelib) - [ESPurna](https://github.com/xoseperez/espurna) +- [Arilux AL-LC0X LED controllers](https://github.com/mertenats/Arilux_AL-LC0X) ### {% linkable_title Examples %} diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown index 3314e0f4273..d2dc0638d80 100644 --- a/source/_docs/scripts/conditions.markdown +++ b/source/_docs/scripts/conditions.markdown @@ -30,7 +30,7 @@ condition: ### {% linkable_title OR condition %} -Test multiple conditions in 1 condition statement. Passes if any embedded conditions is valid. +Test multiple conditions in 1 condition statement. Passes if any embedded condition is valid. ```yaml condition: @@ -114,6 +114,16 @@ condition: after_offset: "-1:00:00" ``` +```yaml +condition: + condition: or # 'when dark' condition: either after sunset or before sunrise + conditions: + - condition: sun + after: sunset + - condition: sun + before: sunrise +``` + Here is a truth table to clarify the parameters with and without offset: | command | night | at sunrise | daytime | at sunset | diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index b110e34863e..7b40c12bb4a 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -36,7 +36,7 @@ $ sudo /Applications/Python\ x.x/Install\ Certificates.command ### {% linkable_title Raspberry Pi %} -On Raspberry Pi you will need to enable the serial interface in the `raspbi-config` tool before you can add Z-Wave to Home Assistant. +On Raspberry Pi you will need to enable the serial interface in the `raspi-config` tool before you can add Z-Wave to Home Assistant. ## {% linkable_title Configuration %} diff --git a/source/_faq/ha-vs-hassio.markdown b/source/_faq/ha-vs-hassio.markdown new file mode 100644 index 00000000000..a331e034aa2 --- /dev/null +++ b/source/_faq/ha-vs-hassio.markdown @@ -0,0 +1,16 @@ +--- +layout: page +title: "Home Assistant vs. Hass.io" +description: "Home Assistant vs. Hass.io" +date: 2018-02-12 09:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Installation +--- + +Home Assistant is a Python program, in simple words. It can be run various operating system and provide the ability to track, control and automate your devices. When people talking about Home Assistant they usually refer to a standalone [installation method](/docs/installation/). + +[Hass.io](/hassio/) is a combination of Home Assistant and tools which allows one to run it easily on a Raspberry Pi and other platforms without setting up an operating system first. Hass.io is an all-in one-solution and has a management user interface that can be used from the Home Assistant frontend. This interface is not present in a standalone setup of Home Assistant. + diff --git a/source/_posts/2018-02-10-release-63.markdown b/source/_posts/2018-02-10-release-63.markdown index e9fb47b45a8..b58560e3ad6 100644 --- a/source/_posts/2018-02-10-release-63.markdown +++ b/source/_posts/2018-02-10-release-63.markdown @@ -41,6 +41,24 @@ We're planning a lot of cool stuff around the entity registry. Stay tuned! - SQL sensor ([@dgomes] - [#12142]) ([sensor.sql docs]) (new-platform) - Add Mercedes me component ([@ReneNulschDE] - [#11743]) (new-platform) +## {% linkable_title Release 0.63.1 - February 12 %} + +- Fix Alexa Step Volume ([@lucasweb78] - [#12314]) ([alexa docs]) +- Remove unique ID from netatmo ([@balloob] - [#12317]) ([binary_sensor.netatmo docs]) ([camera.netatmo docs]) ([sensor.netatmo docs]) +- Allow overriding name via entity registry ([@balloob] - [#12292]) +- Respect entity namespace for entity registry ([@balloob] - [#12313]) +- Fix Report State for Alexa Brightness Controller ([@lucasweb78] - [#12318]) ([alexa docs]) +- Always return lockState == LOCKED when handling Alexa.LockController ([@lucasweb78] - [#12328]) ([alexa docs]) +- Fix platform dependencies ([@balloob] - [#12330]) + +## {% linkable_title Release 0.63.2 - February 14 %} + +- Fix MercedesMe - add check for unsupported features ([@ReneNulschDE] - [#12342]) ([mercedesme docs]) ([binary_sensor.mercedesme docs]) ([device_tracker.mercedesme docs]) ([sensor.mercedesme docs]) +- Fix WUnderground names ([@OttoWinter] - [#12346]) ([sensor.wunderground docs]) +- Updated beacontools ([@citruz] - [#12368]) ([sensor.eddystone_temperature docs]) +- Introduce zone_id to identify player+zone ([@sdague] - [#12382]) ([media_player.yamaha docs]) +- Downgrade limitlessled to 1.0.8 ([@amelchio] - [#12403]) ([light.limitlessled docs]) + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. @@ -78,17 +96,20 @@ Experiencing issues introduced by this release? Please report them in our [issue | Resource | Old Entity ID | New Entity ID | | :------------------ | :------------------ |:-------------------------| | disk_use | sensor.disk_used | sensor.disk_use | + | disk_use_percent | sensor.disk_used | sensor.disk_use_percent | | load_15m | sensor.average_load_15m | sensor.load_15m | | load_1m | sensor.average_load_1m | sensor.load_1m | | load_5m | sensor.average_load_5m | sensor.load_5m | | memory_free | sensor.ram_available | sensor.memory_free | | memory_use | sensor.ram_used | sensor.memory_use | + | memory_use_percent | sensor.ram_used | sensor.memory_use_percent | | network_in | sensor.received | sensor.network_in | | network_out | sensor.sent | sensor.network_out | | packets_in | sensor.packets_received | sensor.packets_in | | packets_out | sensor.packets_sent | sensor.packets_out | | processor_use | sensor.cpu_used | sensor.processor_use | | swap_use | sensor.swap_used | sensor.swap_use | + | swap_use_percent | sensor.swap_used | sensor.swap_use_percent | - Developers only: Following EntityComponent methods have been removed: `extract_from_service`, `async_update_group`, `async_reset`, `prepare_reload` ([@balloob] - [#12237]) (breaking change) @@ -602,3 +623,34 @@ Experiencing issues introduced by this release? Please report them in our [issue [zha docs]: https://home-assistant.io/components/zha/ [zha.const docs]: https://home-assistant.io/components/zha.const/ [zwave docs]: https://home-assistant.io/components/zwave/ +[#12292]: https://github.com/home-assistant/home-assistant/pull/12292 +[#12313]: https://github.com/home-assistant/home-assistant/pull/12313 +[#12314]: https://github.com/home-assistant/home-assistant/pull/12314 +[#12317]: https://github.com/home-assistant/home-assistant/pull/12317 +[#12318]: https://github.com/home-assistant/home-assistant/pull/12318 +[#12328]: https://github.com/home-assistant/home-assistant/pull/12328 +[#12330]: https://github.com/home-assistant/home-assistant/pull/12330 +[@balloob]: https://github.com/balloob +[@lucasweb78]: https://github.com/lucasweb78 +[alexa docs]: https://home-assistant.io/components/alexa/ +[binary_sensor.netatmo docs]: https://home-assistant.io/components/binary_sensor.netatmo/ +[camera.netatmo docs]: https://home-assistant.io/components/camera.netatmo/ +[sensor.netatmo docs]: https://home-assistant.io/components/sensor.netatmo/ +[#12342]: https://github.com/home-assistant/home-assistant/pull/12342 +[#12346]: https://github.com/home-assistant/home-assistant/pull/12346 +[#12368]: https://github.com/home-assistant/home-assistant/pull/12368 +[#12382]: https://github.com/home-assistant/home-assistant/pull/12382 +[#12403]: https://github.com/home-assistant/home-assistant/pull/12403 +[@OttoWinter]: https://github.com/OttoWinter +[@ReneNulschDE]: https://github.com/ReneNulschDE +[@amelchio]: https://github.com/amelchio +[@citruz]: https://github.com/citruz +[@sdague]: https://github.com/sdague +[binary_sensor.mercedesme docs]: https://home-assistant.io/components/binary_sensor.mercedesme/ +[device_tracker.mercedesme docs]: https://home-assistant.io/components/device_tracker.mercedesme/ +[light.limitlessled docs]: https://home-assistant.io/components/light.limitlessled/ +[media_player.yamaha docs]: https://home-assistant.io/components/media_player.yamaha/ +[mercedesme docs]: https://home-assistant.io/components/mercedesme/ +[sensor.eddystone_temperature docs]: https://home-assistant.io/components/sensor.eddystone_temperature/ +[sensor.mercedesme docs]: https://home-assistant.io/components/sensor.mercedesme/ +[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ diff --git a/source/developers/hassio/debugging.markdown b/source/developers/hassio/debugging.markdown index 01a92c98ea8..d9030069a87 100644 --- a/source/developers/hassio/debugging.markdown +++ b/source/developers/hassio/debugging.markdown @@ -28,7 +28,7 @@ Alternative instructions, for Mac, Windows and Linux can be found [here](https:/ Follow steps 1-4 under 'Generating a new SSH key' (The other sections are not applicable to Hass.io and can be ignored.) -Step 3 in the link above, shows the path to the private key file `id_rsa` for your chosen operating system. Your public key, `id_rsa.pub`, is saved in the same folder. Next, copy your public key file to the root of your SD card as `authorized_keys`. +Step 3 in the link above, shows the path to the private key file `id_rsa` for your chosen operating system. Your public key, `id_rsa.pub`, is saved in the same folder. Next, select all text from text box "Public key for pasting into OpenSSH authorized_keys file" and save it to the root of your SD card as `authorized_keys`.Make sure when you are copying the public key to the root of the /resin-boot partition of the SD card that you rename the file correctly to `authorized_keys` with no `.pub` file extension. diff --git a/source/faq/index.markdown b/source/faq/index.markdown index f3af719ffb5..9dc9352fcf6 100644 --- a/source/faq/index.markdown +++ b/source/faq/index.markdown @@ -11,7 +11,7 @@ regenerate: true hide_github_edit: true --- -This is a community curated list of frequently asked questions (FAQ) about the installation, setup, and usage of Home Assistant. +This is a community curated list of frequently asked questions (FAQ) about the installation, setup, and usage of Home Assistant. If you want to get details about a term, please check the [glossary](/docs/glossary/). {% assign faq = site.faq | sort: 'title' %} {% assign categories = faq | map: 'ha_category' | uniq | sort %} diff --git a/source/getting-started/index.markdown b/source/getting-started/index.markdown index 472503ae24c..d70ee636624 100644 --- a/source/getting-started/index.markdown +++ b/source/getting-started/index.markdown @@ -9,9 +9,9 @@ sharing: true footer: true --- -The goal of this getting started guide is to install Hass.io on a Raspberry Pi 3. Hass.io is our own all in one solution that turns your Raspberry Pi into the ultimate home automation hub. +The goal of this getting started guide is to install [Hass.io](/hassio/) on a Raspberry Pi 3. Hass.io is our own all in one solution that turns your Raspberry Pi into the ultimate home automation hub. -Follow this guide if you want to easily get started with Home Assistant, or if you have no or little Linux experience. For advanced users, check our [alternative installation methods](/docs/installation/). +Follow this guide if you want to easily get started with Home Assistant, or if you have no or little Linux experience. For advanced users or if you have no Raspberry Pi at hand, check our [alternative installation methods](/docs/installation/). ### {% linkable_title Hardware requirements %} @@ -31,7 +31,7 @@ We will need a few things to get started with installing Home Assistant. Links b [Etcher]: https://etcher.io/ [pi3]: https://github.com/home-assistant/hassio-build/releases/download/1.1/resinos-hassio-1.1-raspberrypi3.img.bz2 -### Installing Hass.io +### {% linkable_title Installing Hass.io %} 1. Put the SD card in your SD card reader. 1. Open Etcher, select the Hass.io image and flash it to the SD card. diff --git a/source/hassio/run_local.markdown b/source/hassio/run_local.markdown index 311098aa413..8085f77f1f3 100644 --- a/source/hassio/run_local.markdown +++ b/source/hassio/run_local.markdown @@ -9,15 +9,15 @@ sharing: true footer: true --- -Hass.io is a managed environment, which means that you can't install applications that can be embedded into Home Assistant using the `command_line` sensor/switch. +Hass.io is a managed environment, which means you can't install applications that can be embedded into Home Assistant using the `command_line` sensor/switch. -There are three options if you need to run a script to read data from a sensor or send commands to other devices on Hass.io. +There are three options if you need to run a script which reads data from a sensor or sends commands to other devices on Hass.io. -The first option is to write a custom component for Home Assistant. Using Python, you can communicate with your device. For more information about developing a custom component, take a look at the [developer documentation][custom-component]. +The first option is to write a custom component for Home Assistant. This implies that you can communicate with your device using Python. For more information about developing a custom component, take a look at [custom-component development][custom-component]. -The second option is to use STDIN inside add-on and use the service `hassio.addon_stdin` to send data. More about this options look into [developer documentation][communication] for internal add-on communication. There is also describe how do you can easy access to Home-Assistant Rest API. +The second option is to use STDIN inside an add-on and use the service `hassio.addon_stdin` to send data. For more information, have a look at [internal add-on communication][communication]. Here you will also find how you can easily access the Home Assistant Rest API. -The third option is to make a local add-on for Hass.io that sends the data to Home Assistant via MQTT. Before we dive into this, read up on [Hass.io add-on development][addons-tutorial] first. +The third option is to create a local add-on for Hass.io that sends the data to Home Assistant via MQTT. Before we dive into this, read up on [Hass.io add-on development][addons-tutorial] first. For security and speed, Hass.io does not provide a way for containers to communicate directly. So the first step is to set up a communication channel. We're going to use MQTT for this using the [MQTT broker add-on][mqtt-addon]. @@ -25,7 +25,7 @@ For security and speed, Hass.io does not provide a way for containers to communi We loop in our script to fetch data and push it to MQTT and wait until the next process is ready. Here is a basic example and structure for that process. -Our Dockerfile need to install: +In our Dockerfile we need to install: ``` RUN apk --no-cache add jq mosquitto-clients @@ -65,7 +65,7 @@ done We wait for incoming data from the MQTT broker. We can also use an `input_boolean` that triggers an automation to publish a custom command to MQTT topic that can process multiple things in one add-on. -Our Dockerfile need to install: +In our Dockerfile we need to install: ``` RUN apk --no-cache add jq mosquitto-clients