This add-on will not enable you to install packages or do anything as root. This is not allowed with Hass.io.
+ +To use this add-on, you must have a private/public key to log in. To generate them, follow the [instructions for Windows][win] and [these for other platforms][other]. ```json { @@ -26,21 +30,4 @@ Configuration variables: [win]: https://www.digitalocean.com/community/tutorials/how-to-create-ssh-keys-with-putty-to-connect-to-a-vps [other]: https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/ --This add-on is not compatible when you installed Hass.io via the generic Linux installer. - -If you're coming from Rasbian or similar, use `root` rather than `pi` when connecting via ssh or else you will get this error. - -```bash -Permission denied (publickey,keyboard-interactive) -``` -
- --If you install this addon you can use `sshfs` as well to access files from a remote system where you have git and your favourite editing tools installed. - -```bash -$ mkdir ~/ha_config -$ sshfs -o allow_other,defer_permissions root@h[your_hassio_ip]:/config ~/ha_config -``` -
+This add-on is not compatible when you installed Hass.io via the generic Linux installer.
diff --git a/source/_docs/automation/troubleshooting.markdown b/source/_docs/automation/troubleshooting.markdown index 5207175e258..86cf9c9e479 100644 --- a/source/_docs/automation/troubleshooting.markdown +++ b/source/_docs/automation/troubleshooting.markdown @@ -12,7 +12,7 @@ redirect_from: /getting-started/automation-troubleshooting/ You can verify that your automation rules are being initialized correctly by watching both the realtime logs (`homeassistant.log` in the configuration directory) and also the [Logbook](/components/logbook/). The realtime logs will show the rules being initialized (once for each trigger), example: -```plain +```text INFO [homeassistant.components.automation] Initialized rule Rainy Day INFO [homeassistant.components.automation] Initialized rule Rainy Day INFO [homeassistant.components.automation] Initialized rule Rainy Day diff --git a/source/_includes/asides/developers_navigation.html b/source/_includes/asides/developers_navigation.html index 7a595c2da4d..d60e6ce1674 100644 --- a/source/_includes/asides/developers_navigation.html +++ b/source/_includes/asides/developers_navigation.html @@ -34,7 +34,7 @@- {% active_link /developers/code_review_platform/ Checklist creating a platform %}
- {% active_link /developers/platform_example_sensor/ Example sensor platform %} @@ -72,13 +72,29 @@
- {% active_link /developers/frontend_creating_custom_ui/ Add Custom UI %}
-
+
- {% active_link /developers/hassio/debugging/ Debugging Hass.io %} +
-
+
- {% active_link /developers/hassio/addon_tutorial/ Tutorial: Making your first add-on %} +
- {% active_link /developers/hassio/addon_config/ Configuration %} +
- {% active_link /developers/hassio/addon_testing/ Local Testing %} +
- {% active_link /developers/hassio/addon_publishing/ Publishing %} +
- {% active_link /developers/hassio/addon_repository/ Repositories %} +
-
-
- {% active_link https://dev-docs.home-assistant.io/en/dev/ Home Assistant API %} +
- {% active_link https://dev-docs.home-assistant.io/en/dev/ Python API %}
- {% active_link /developers/websocket_api/ Websocket API %} -
- {% active_link /developers/rest_api/ RESTful API %} -
- {% active_link /developers/python_api/ Python API %} +
- {% active_link /developers/rest_api/ REST API %} +
- {% active_link /developers/python_api/ Python REST API %}
- {% active_link /developers/server_sent_events/ Server-sent events %}
-
{% for addon in addons %}
-
- {{ addon.title }} +
-
+ {{ addon.title }}
+ {{ addon.description }} +
{% endfor %}
+ Check the Hass.io forums for add-on repositories managed by the community. +
diff --git a/source/developers/api.markdown b/source/developers/api.markdown index feb599063b9..b46b1fdc4d4 100644 --- a/source/developers/api.markdown +++ b/source/developers/api.markdown @@ -11,8 +11,8 @@ footer: true Home Assistant provides various APIs. For detail please refer to [Home Assistant API](https://dev-docs.home-assistant.io/en/dev/) documentation. + * [Python API](https://dev-docs.home-assistant.io/) * [Websocket API](/developers/websocket_api/) - * [RESTful API](/developers/rest_api/) - * [Python API](/developers/python_api/) + * [REST API](/developers/rest_api/) + * [Python REST API](/developers/python_api/) * [Server-sent events](/developers/server_sent_events/) - diff --git a/source/developers/architecture_components.markdown b/source/developers/architecture_components.markdown index 9bf4bff3e37..eff2ff1f2e6 100644 --- a/source/developers/architecture_components.markdown +++ b/source/developers/architecture_components.markdown @@ -32,22 +32,22 @@ These components provide small pieces of home automation logic or involve servic For example, the [`device_sun_light_trigger` component](/components/device_sun_light_trigger/) tracks the state of devices and the sun to make sure that the lights are turned on when it gets dark and people are home. The component uses logic like this: -```plain - In the event that device 'Paulus Nexus 5' changes to the 'Home' state: - If the sun has set and the lights are not on: - Turn on the lights +```text +In the event that device 'Paulus Nexus 5' changes to the 'Home' state: + If the sun has set and the lights are not on: + Turn on the lights ``` -```plain - In the event that the combined state of all tracked devices changes to 'Not Home': - If the lights are on: - Turn off the lights +```text +In the event that the combined state of all tracked devices changes to 'Not Home': + If the lights are on: + Turn off the lights ``` -```plain - In the event of the sun setting: - If the lights are off and the combined state of all tracked device equals 'Home': - Turn on the lights +```text +In the event of the sun setting: + If the lights are off and the combined state of all tracked device equals 'Home': + Turn on the lights ``` Look [here](https://github.com/home-assistant/home-assistant/blob/master/config/custom_components/example.py) for a comprehensive example of a home automation component. diff --git a/source/hassio/addon_config.markdown b/source/developers/hassio/addon_config.markdown similarity index 99% rename from source/hassio/addon_config.markdown rename to source/developers/hassio/addon_config.markdown index 8760ae6d918..d6ed5d0527f 100644 --- a/source/hassio/addon_config.markdown +++ b/source/developers/hassio/addon_config.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +redirect_from: /hassio/addon_config/ --- Each add-on is stored in a folder. The file structure looks like this: diff --git a/source/hassio/addon_development.markdown b/source/developers/hassio/addon_development.markdown similarity index 63% rename from source/hassio/addon_development.markdown rename to source/developers/hassio/addon_development.markdown index dc0c3eda648..e08e6c95720 100644 --- a/source/hassio/addon_development.markdown +++ b/source/developers/hassio/addon_development.markdown @@ -7,8 +7,17 @@ sidebar: true comments: false sharing: true footer: true +redirect_from: /hassio/addon_development/ --- Add-ons for Hass.io allows the user to extend the functionality around Home Assistant. This can be running an application that Home Assistant can integrate with (like an MQTT broker) or to share the configuration via Samba for easy editing from other computers. Add-ons can be configured via the Hass.io panel in Home Assistant. Under the hood, add-ons are Docker images published in [Docker Hub](https://hub.docker.com/). Developers can create [GitHub](https://github.com) repositories that contain multiple references to add-ons for easy sharing with the community. + + diff --git a/source/hassio/addon_publishing.markdown b/source/developers/hassio/addon_publishing.markdown similarity index 98% rename from source/hassio/addon_publishing.markdown rename to source/developers/hassio/addon_publishing.markdown index 011fed11f79..012eb425a32 100644 --- a/source/hassio/addon_publishing.markdown +++ b/source/developers/hassio/addon_publishing.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +redirect_from: /hassio/addon_publishing/ --- There are two different ways of publishing add-ons. One is to publish pre-build containers to Docker Hub and the other option is to have users build the containers locally on their Hass.io instance. diff --git a/source/hassio/addon_repository.markdown b/source/developers/hassio/addon_repository.markdown similarity index 96% rename from source/hassio/addon_repository.markdown rename to source/developers/hassio/addon_repository.markdown index 662fa8ef08a..04152968bc4 100644 --- a/source/hassio/addon_repository.markdown +++ b/source/developers/hassio/addon_repository.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +redirect_from: /hassio/addon_repository/ --- Add-ons repository can contain one or more add-ons. Each add-on is stored in it's own unique folder. For it to be indentified as a repository, a repository contains a configuration file. diff --git a/source/hassio/addon_testing.markdown b/source/developers/hassio/addon_testing.markdown similarity index 97% rename from source/hassio/addon_testing.markdown rename to source/developers/hassio/addon_testing.markdown index e7162741d8b..a78a672546a 100644 --- a/source/hassio/addon_testing.markdown +++ b/source/developers/hassio/addon_testing.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +redirect_from: /hassio/addon_testing/ --- The fastest way to develop add-ons is by adding them to your local add-on repository. To access your local add-on repository, install either the [Samba add-on] or [SSH add-on]. diff --git a/source/hassio/addon_tutorial.markdown b/source/developers/hassio/addon_tutorial.markdown similarity index 98% rename from source/hassio/addon_tutorial.markdown rename to source/developers/hassio/addon_tutorial.markdown index 32855ad745c..8121ec86e7f 100644 --- a/source/hassio/addon_tutorial.markdown +++ b/source/developers/hassio/addon_tutorial.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +redirect_from: /hassio/addon_tutorial/ --- So you've got Home Assistant going and you've been enjoying the built-in add-ons but you're missing this one application. Time to make your own add-on! In Hass.io 0.24 we introduced the option to have local add-ons be build on your device. This is great for developing new add-ons locally. @@ -203,4 +204,4 @@ Refresh the add-on store and re-install your add-on. You will now see the option - [Learn more about the available schema options.](/hassio/addon_config/#options--schema) - [See how options.json can be used inside `run.sh`](https://github.com/home-assistant/hassio-addons/blob/master/mosquitto/run.sh#L4-L6) -### [Next step: Add-on config reference »](/hassio/addon_config/) +### [Next step: Add-on config reference »](/developers/hassio/addon_config/) diff --git a/source/hassio/architecture.markdown b/source/developers/hassio/architecture.markdown similarity index 97% rename from source/hassio/architecture.markdown rename to source/developers/hassio/architecture.markdown index 5dbb1c4354e..173e3657ae3 100644 --- a/source/hassio/architecture.markdown +++ b/source/developers/hassio/architecture.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +redirect_from: /hassio/architecture/ ---diff --git a/source/hassio/debugging.markdown b/source/developers/hassio/debugging.markdown similarity index 87% rename from source/hassio/debugging.markdown rename to source/developers/hassio/debugging.markdown index ae8eef22d6b..6b47eb12440 100644 --- a/source/hassio/debugging.markdown +++ b/source/developers/hassio/debugging.markdown @@ -7,8 +7,15 @@ sidebar: true comments: false sharing: true footer: true +redirect_from: /hassio/debugging/ --- +
+This section is not for users. Use the [SSH add-on] to SSH into Hass.io. This is for developers of Hass.io. Do not ask for support if you are using these options. +
+ +[SSH add-on]: /addons/ssh/ + The following debug tips and tricks are for people who are running the Hass.io image and are working on the base image. If you use the generic Linux installer script, you should be able to access your host and logs as per your host. ## {% linkable_title SSH access to the host %} diff --git a/source/hassio/index.markdown b/source/hassio/index.markdown index 5265840726d..ebe99c5a784 100644 --- a/source/hassio/index.markdown +++ b/source/hassio/index.markdown @@ -9,4 +9,33 @@ sharing: true footer: true --- -Hass.io turns your Raspberry Pi (or other device) into the ultimate Home Automation hub. It takes away all the hassle of installing Home Assistant and related applications and keeping them up to date. Updates to the operating system, Home Assistant, and any add-ons can be done via the Home Assistant UI with a single click. +Hass.io turns your Raspberry Pi (or other device) into the ultimate home automation hub powered by Home Assistant. With Hass.io you can focus on integrating your devices and writing automations. + +[Go to the installation instructions »][install] + +The advantages of using Hass.io: + + - Free and open source + - Optimized for the Raspberry Pi + - 100% local home automation + - Easy installation and updates (powered by [ResinOS] and [Docker]) + - Management user interface integrated into Home Assistant + - Easily create and restore full backups of your whole configuration. + - One click install of many popular add-ons including voice assistant via [Snips.ai], encryption via [Let's Encrypt] and dynamic DNS via [Duck DNS].[Browse available add-ons »][all] + - Active community that is helpful and sharing add-ons including AppDaemon, Homebridge and InfluxDB.
[Browse the forums »][forums]
[Join the Hass.io chat »][chat]
[Browse community add-on repositories »][comm-add-ons] + +
+
+Hass.io dashboard
+
If you copy over your existing Home Assistant configuration, make sure to enable the Hass.io panel by adding either `discovery:` or `hassio:` to your configuration.
-### {% linkable_title Alternative: install on generic Linux server %} +## {% linkable_title Alternative: install on generic Linux server %} For advanced users, it is also possible to try Hass.io on your Linux server or inside a VM. To do so, [follow these instructions][linux]. +When you use this installation method, some add-ons will not be available and the documentation might not work for your installation.
+ [Etcher]: https://etcher.io/ [resinos-network]: https://docs.resin.io/deployment/network/2.0.0/ [pi1]: https://github.com/home-assistant/hassio-build/releases/download/0.8/resinos-hassio-0.8-raspberrypi.img.bz2 @@ -37,3 +40,5 @@ For advanced users, it is also possible to try Hass.io on your Linux server or i [nuc]: https://github.com/home-assistant/hassio-build/releases/download/0.8/resinos-hassio-0.8-intel-nuc.img.bz2 [linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio [local]: http://hassio.local:8123 +[samba]: /addons/samba/ +[ssh]: /addons/ssh/ diff --git a/source/hassio/installing_third_party_addons.markdown b/source/hassio/installing_third_party_addons.markdown index 8db74287763..a6385b52786 100644 --- a/source/hassio/installing_third_party_addons.markdown +++ b/source/hassio/installing_third_party_addons.markdown @@ -9,7 +9,11 @@ sharing: true footer: true --- -Hass.io allows anyone to create add-on repositories to easily share their add-ons for Hass.io. To try this locally, you can use our example add-on repository at `https://github.com/home-assistant/hassio-addons-example`. +Hass.io allows anyone to create add-on repositories to easily share their add-ons for Hass.io. To try this locally, you can use our example add-on repository at + +```text +https://github.com/home-assistant/hassio-addons-example +```Home Assistant cannot guarantee the quality or security of third party add-ons. Use at your own risk. @@ -27,4 +31,4 @@ Add the urls of repositories (one per line) and then press "Save". A new card fo ### {% linkable_title Help: Repository is not showing up %} -If you have added a repository but it's not showing up, it means that the repository contains invalid configuration. Go to the Hass.io panel -> Supervisor card -> View logs and scroll to the bottom. It should tell you what went wrong. Report this information to the repository author. +If you have added a repository but it's not showing up, it means that the repository contains invalid configuration. Go to the Hass.io panel -> Three dot menu -> Advanced Settings -> Supervisor card -> View logs and scroll to the bottom. It should tell you what went wrong. Report this information to the repository author. diff --git a/source/hassio/run_local.markdown b/source/hassio/run_local.markdown index c12c602ea35..a93e9b211ad 100644 --- a/source/hassio/run_local.markdown +++ b/source/hassio/run_local.markdown @@ -9,15 +9,19 @@ sharing: true footer: true --- -On a normal Home Assistant installation you have access to the base machine and can install or add scripts that you can call with a `command_line` sensor/switch. Since Hass.IO uses Docker, you can not use this old way to perform local stuff. On its face, it looks quite restrictive, but it makes the whole system stable. +Hass.io is a managed environment. This means that you're unable to install applications that you can embed into Home Assistant using the `command_line` sensor/switch. -However, if you need to run a script to read data for a sensor or send commands to other devices on Hass.IO, you can do that with a add-on or on inside the Home Assistant container with a custom component. Here is one way to accomplish that using an add-on. For custom component, look at the [devoloper site][custom-component] and also read the [add-ons tutorial][addons-tutorial]. Now you can get started with your custom component in the right way. +There are two options if you need to run a script to read data from a sensor or send commands to other devices on Hass.IO. -First you need install a MQTT broker. You can use our [MQTT broker add-on][mqtt-addon]. Make sure you use logins and disable anonymous access if you want to secure the system. We provide no Hass.IO way to exchange data, that will be not realy good for security and is also to slow to exchange data between containers or stop and go stuff. That is the reason why we use a mqtt broker for it. +First option is to write a custom component for Home Assistant. Using Python you can communicate with your device. For custom component, look at the [devoloper site][custom-component]. + +The second 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]. + +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]. ### {% linkable_title Sensors %} -Short story of that caption: We loop in our script to fetch data and push it to MQTT and wait until next process is ready. Here is a basic example and structure for that process. +We loop in our script to fetch data and push it to MQTT and wait until next process is ready. Here is a basic example and structure for that process. Our Dockerfile need to install: @@ -26,6 +30,7 @@ RUN apk --no-cache add jq mosquitto-clients ``` Now we can process it with `run.sh`: + ```bash #!/bin/bash set -e @@ -52,11 +57,11 @@ do sleep "$WAIT_TIME" done - ``` ### {% linkable_title Commands %} -Short story of that caption: We wait for incoming data from 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. + +We wait for incoming data from 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: @@ -88,10 +93,9 @@ do fi done < <(mosquitto_sub -h "$MQTT_SERVER" -p "$MQTT_PORT" -u "$USER" -P "$PASSWORD" -t "$TOPIC" -q 1) - ``` [MQTT-addon]: /addons/mosquitto/ [custom-component]: /developers/component_loading/ -[addons-tutorial]: /hassio/addon_tutorial/ +[addons-tutorial]: /developers/hassio/addon_tutorial/ diff --git a/source/hassio/zwave.markdown b/source/hassio/zwave.markdown new file mode 100644 index 00000000000..d6ef71f79a1 --- /dev/null +++ b/source/hassio/zwave.markdown @@ -0,0 +1,17 @@ +--- +layout: page +title: "Z-Wave" +description: "Instructions on how-to use Z-Wave with Hass.io." +date: 2017-04-30 13:28 +sidebar: true +comments: false +sharing: true +footer: true +--- + +To enable Z-Wave, plug your Z-Wave USB stick into your Raspberry Pi 3 and add the following to your `configuration.yaml`: + +```yaml +zwave: + usb_path: /dev/ttyACM0 +``` diff --git a/source/images/hassio/screenshots/addon_repository_editor.png b/source/images/hassio/screenshots/addon_repository_editor.png deleted file mode 100644 index e0e2b212886..00000000000 Binary files a/source/images/hassio/screenshots/addon_repository_editor.png and /dev/null differ diff --git a/source/images/hassio/screenshots/dashboard.png b/source/images/hassio/screenshots/dashboard.png new file mode 100644 index 00000000000..997fad3d223 Binary files /dev/null and b/source/images/hassio/screenshots/dashboard.png differ diff --git a/source/images/hassio/screenshots/main_panel_store_icon.png b/source/images/hassio/screenshots/main_panel_store_icon.png index a6b04be1134..27e650fdf9d 100644 Binary files a/source/images/hassio/screenshots/main_panel_store_icon.png and b/source/images/hassio/screenshots/main_panel_store_icon.png differ diff --git a/source/images/hassio/screenshots/repositories_editor.png b/source/images/hassio/screenshots/repositories_editor.png index a02427d1659..9c3df30568c 100644 Binary files a/source/images/hassio/screenshots/repositories_editor.png and b/source/images/hassio/screenshots/repositories_editor.png differ