-+You should not use this if you are also using the [DuckDNS add-on]. The DuckDNS add-on has integrated Let's Encrypt support. +
+ Setup and manage a [Let's Encrypt](https://letsencrypt.org/) certificate. This will create a certificate on the first run and will auto-renew if the certificate is within 30 days of expiration.-This add-on need port 80/443 to verify the certificate request, please stop all add-ons that also use these ports, or you may not be able to start this add-on. +This add-on uses ports 80/443 to verify the certificate request. You will need to stop all other add-ons that also use these ports. If you don't need a port (like with https you don't need port 80) you can remove this from network config.
```json @@ -36,6 +40,11 @@ Use the following configuration in Home Assistant to use the generated certifica ```yaml http: + base_url: https://my-domain.tld:8123 ssl_certificate: /ssl/fullchain.pem ssl_key: /ssl/privkey.pem ``` + +If you use a other port as `8123` or a SSL proxy, change the port number. + +[DuckDNS add-on]: /addons/duckdns/ diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index ad2fef0f620..f944dc7989c 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -46,5 +46,5 @@ To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own) add the follow ```yaml # Example configuration.yaml entry mqtt: - broker: 172.17.0.1 + broker: core-mosquitto ``` diff --git a/source/_addons/rpc_shutdown.markdown b/source/_addons/rpc_shutdown.markdown index ba1fe46ebee..10aba2dcf5f 100644 --- a/source/_addons/rpc_shutdown.markdown +++ b/source/_addons/rpc_shutdown.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -Allow to shutdown a computer with a service call from Home-Assistant. +Allow to shutdown a Windows computer with a service call from Home Assistant. ```json { diff --git a/source/_components/alarm_control_panel.manual.markdown b/source/_components/alarm_control_panel.manual.markdown index ffb15498103..d4f6227fa4b 100644 --- a/source/_components/alarm_control_panel.manual.markdown +++ b/source/_components/alarm_control_panel.manual.markdown @@ -28,7 +28,7 @@ Configuration variables: - **pending_time** (*Optional*): The time in seconds of the pending time before arming the alarm. Default is 60 seconds. - **trigger_time** (*Optional*): The time in seconds of the trigger time in which the alarm is firing. Default is 120 seconds. - **disarm_after_trigger** (*Optional*): If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state. -- **armed_home|armed_away|armed_night|triggered** (*Optional*): State specific settings +- **armed_home/armed_away/armed_night/triggered** (*Optional*): State specific settings - **pending_time**: State specific pending time override. In the config example below, armed_home state will have no pending time and triggered state will have pending time of 20 second whereas armed_away state will have a default pending time of 30 seconds. diff --git a/source/_components/alarmdecoder.markdown b/source/_components/alarmdecoder.markdown index b3b54f2959f..82beb4b5e62 100644 --- a/source/_components/alarmdecoder.markdown +++ b/source/_components/alarmdecoder.markdown @@ -50,6 +50,6 @@ Configuration variables: - **host** (*Optional*): The IP address of the AlarmDecoder device on your home network, if using socket type. Default: `localhost` - **port** (*Optional*): The port of the AlarmDecoder device on your home network, if using socket type. Default: `10000` - **path** (*Optional*): The path of the AlarmDecoder device, if using socket type. Default: `/dev/ttyUSB0` -- **baud** (*Optional*): The baud rate of the AlarmDecoder device, if using serial type. Default: `115200` +- **baudrate** (*Optional*): The baud rate of the AlarmDecoder device, if using serial type. Default: `115200` - **panel_display** (*Optional*): Create a sensor called sensor.alarm_display to match the Alarm Keypad display. Default: `off` - **zones** (*Optional*): AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. 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.* diff --git a/source/_components/alexa.markdown b/source/_components/alexa.markdown index d97bf68ae1b..179fb4076c1 100644 --- a/source/_components/alexa.markdown +++ b/source/_components/alexa.markdown @@ -101,7 +101,7 @@ This means that we can now ask Alexa things like: When activated, the Alexa component will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component. -To enable Alex add the following entry to your `configuration.yaml` file: +To enable Alexa add the following entry to your `configuration.yaml` file: ```yaml alexa: diff --git a/source/_components/apiai.markdown b/source/_components/apiai.markdown index 664540b6a1c..4e6d73d024f 100644 --- a/source/_components/apiai.markdown +++ b/source/_components/apiai.markdown @@ -21,7 +21,7 @@ api.ai could be integrated with many popular messaging, virtual assistant and Io Using Api.ai will be easy to create conversations like: - > User: Which is the temperature at home? + > User: What is the temperature at home? > > Bot: The temperature is 34 degrees diff --git a/source/_components/binary_sensor.bayesian.markdown b/source/_components/binary_sensor.bayesian.markdown index 53505593b6b..b5d20c509ff 100644 --- a/source/_components/binary_sensor.bayesian.markdown +++ b/source/_components/binary_sensor.bayesian.markdown @@ -40,8 +40,8 @@ Configuration variables: - **entity_id** (*Required*): Name of the entity to monitor. - **prob_given_true** (*Required*): The probability of the observation occurring, given the event is `true`. - **prob_given_false** (*Optional*): The probability of the observation occurring, given the event is `false` can be set as well. If `prob_given_false` is not set, it will default to `1 - prob_given_true`. - - **platform** (*Required*): The only supported observation platforms are `state` and `numeric_state`, which are modeled after their corresponding triggers for automations. - - **to_state** (*Required*): The target start. + - **platform** (*Required*): The only supported observation platforms are `state` and `numeric_state`, which are modeled after their corresponding triggers for automations, requiring `before` and/or `after` instead of `to_state`. + - **to_state** (*Required*): The target state. - **probability_threshold** (*Optional*): The probability at which the sensor should trigger to `on`. - **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Bayesian Binary`. @@ -74,3 +74,16 @@ binary_sensor: platform: 'state' to_state: 'below_horizon' ``` +```yaml +# Example configuration.yaml entry +binary_sensor: + name: 'Heat On' + platform: 'bayesian' + prior: 0.2 + probability_threshold: 0.9 + observations: + - entity_id: 'sensor.outside_air_temperature_fahrenheit' + prob_given_true: 0.95 + platform: 'numeric_state' + below: 50 +``` diff --git a/source/_components/binary_sensor.http.markdown b/source/_components/binary_sensor.http.markdown index 8e96f517918..aaddf8a7256 100644 --- a/source/_components/binary_sensor.http.markdown +++ b/source/_components/binary_sensor.http.markdown @@ -12,6 +12,10 @@ ha_category: Binary Sensor ha_release: pre 0.7 --- +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. + +The sensor will then exist as long as Home Assistant is running. After a restart of Home Assistant the sensor will be gone until it is triggered again. + The URL for a binary sensor looks like the example below: ```bash diff --git a/source/_components/binary_sensor.mystrom.markdown b/source/_components/binary_sensor.mystrom.markdown index 9deeb443452..6d093a2f259 100644 --- a/source/_components/binary_sensor.mystrom.markdown +++ b/source/_components/binary_sensor.mystrom.markdown @@ -38,7 +38,7 @@ binary_sensor: ### {% linkable_title Setup of the myStrom Buttons %} -You need to configure every button to make it work with Home Assistant. First connect the Wifi Buttons to your wireless network. Keep in mind that they only support WPS (Wi-FI Protected Setup). Once a button is connected you have three minutes to set the actions for the push patterns. The fastest way is to use `curl`. Check the [documentation](https://mystrom.ch/wp-content/uploads/REST_API_WBP.txt) of the WiFi Button for further details about the implementation (`http://` is replaced by `get://` or `post://`). `action` is the name of the corresponding push pattern (see above). +You need to configure every button to make it work with Home Assistant. First connect the Wifi Buttons to your wireless network. Once a button is connected you have three minutes to set the actions for the push patterns. The fastest way is to use `curl`. Check the [documentation](https://mystrom.ch/wp-content/uploads/REST_API_WBP.txt) of the WiFi Button for further details about the implementation (`http://` is replaced by `get://` or `post://`). `action` is the name of the corresponding push pattern (see above). The endpoint that is receiving the data is `[IP address Home Assistant]:8123/api/mystrom`. diff --git a/source/_components/climate.mysensors.markdown b/source/_components/climate.mysensors.markdown index c629b0083fc..a61fae33f90 100644 --- a/source/_components/climate.mysensors.markdown +++ b/source/_components/climate.mysensors.markdown @@ -98,6 +98,8 @@ MyMessage msgHVACSetPointC(CHILD_ID_HVAC, V_HVAC_SETPOINT_COOL); MyMessage msgHVACSpeed(CHILD_ID_HVAC, V_HVAC_SPEED); MyMessage msgHVACFlowState(CHILD_ID_HVAC, V_HVAC_FLOW_STATE); +bool initialValueSent = false; + void presentation() { sendSketchInfo("Heatpump", "2.1"); present(CHILD_ID_HVAC, S_HVAC, "Thermostat"); @@ -108,6 +110,13 @@ void setup() { void loop() { // put your main code here, to run repeatedly: + if (!initialValueSent) { + send(msgHVACSetPointC.set(20)); + send(msgHVACSpeed.set("Auto")); + send(msgHVACFlowState.set("Off")); + + initialValueSent = true; + } } void receive(const MyMessage &message) { diff --git a/source/_components/config.markdown b/source/_components/config.markdown index 7490d3e4064..514840e7f73 100644 --- a/source/_components/config.markdown +++ b/source/_components/config.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Config" -description: "Instructions how to setup the configuration panel Home Assistant." +description: "Instructions how to setup the configuration panel for Home Assistant." date: 2017-02-24 20:00 sidebar: true comments: false @@ -21,16 +21,7 @@ To enable the configuration panel, add the following to your `configuration.yaml config: ``` -### {% linkable_title Group & Views %} - -The **Groups & Views** sections allows you to re-arrange your [groups](/components/group/). Also, you can edit the group's setting and switch between "view" and "group". - -
-
-
+### {% linkable_title Customization %}
+This section enables you to customize entities within Home Assistant. Use this to set friendly names, change icons, hide entities, and modify other attributes.
+
+### {% linkable_title Automation %}
+
+This section enables you to create and modify automations from within Home Assistant, without needing to write out the yaml code.
+
+### {% linkable_title Script %}
+
+Similar to the automation editor, this section enables you to create and modify scripts from within Home Assistant, without needing to write out the yaml code.
+
+### {% linkable_title Z-Wave %}
+
+This section enables you to control your Z-Wave network and devices from within Home Assistant. You can add and remove devices, as well as change device specific configuration variables.
diff --git a/source/_components/device_tracker.gpslogger.markdown b/source/_components/device_tracker.gpslogger.markdown
index d0f92db962b..6b6a439cdee 100644
--- a/source/_components/device_tracker.gpslogger.markdown
+++ b/source/_components/device_tracker.gpslogger.markdown
@@ -11,7 +11,7 @@ ha_category: Presence Detection
ha_release: 0.34
---
-This platform allows you to detect presence using [GPSLogger](http://code.mendhak.com/gpslogger/). GPSLogger is an open source app for [Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger) that allows users to set up a `GET` request to update GPS coordinates. This can be configured with Home Assistant to update your location.
+The `gpslogger` device tracker platform allows you to detect presence using [GPSLogger](http://code.mendhak.com/gpslogger/). GPSLogger is an open source app for [Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger) that allows users to set up a `GET` request to update GPS coordinates. This can be configured with Home Assistant to update your location.
To integrate GPSLogger in Home Assistant, add the following section to your `configuration.yaml` file:
@@ -23,34 +23,52 @@ device_tracker:
## {% linkable_title Setup on your smartphone %}
-- [GPSLogger for Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger)
+Install [GPSLogger for Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger) on your device.
-To configure GPSLogger, you must set up the app to send a `GET` request to your Home Assistant server at
-```yaml
-http://
+ 
+ GPSLogger Settings
+
+ 
+ Logging Details
+
+ 
+ Log to custom URL details
+
+ 
+ Performance
+
+At this time `emulated_hue` doesn't appear to be working for new Google Home users. +
+ The `emulated_hue` component provides a virtual Philips Hue bridge, written entirely in software, that allows services that work with the Hue API to interact with Home Assistant entities. The driving use case behind this functionality is to allow Home Assistant to work with an Amazon Echo or Google Home with no set up cost outside of configuration changes. The virtual bridge has the ability to turn entities on or off, or change the brightness of dimmable lights. The volume level of media players can be controlled as brightness. diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index 03f775e47fa..43c95c45ada 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -235,7 +235,7 @@ Toggle mute: {"mute": ""} ``` -value is ignores. +value is ignored. ## {% linkable_title Useful References %} diff --git a/source/_components/input_datetime.markdown b/source/_components/input_datetime.markdown index f9351f09848..0ae8cae833c 100644 --- a/source/_components/input_datetime.markdown +++ b/source/_components/input_datetime.markdown @@ -12,6 +12,10 @@ ha_category: Automation ha_release: 0.55 --- ++This component is a work in progress. The frontend is not yet implemented. +
+ The `input_datetime` component allows the user to define date and time values that can be controlled via the frontend and can be used within automations and templates. To add three datetime inputs to your installation, one with both date and time, and one with date or time each, add the following lines to your `configuration.yaml`: diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index 3a5202960ba..e043b924696 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -9,10 +9,14 @@ sharing: true footer: true logo: home-assistant.png ha_category: Automation -ha_release: 0.16 +ha_release: 0.55 redirect_from: /components/input_slider/ --- ++Before version 0.55 this component was known as `input_slider` and did not have the `mode` configuration option. +
+ 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. To enable this input number in your installation, add the following lines to your `configuration.yaml`: diff --git a/source/_components/light.xiaomi_aqara.markdown b/source/_components/light.xiaomi_aqara.markdown index 561cf132c29..25e01ba22c7 100644 --- a/source/_components/light.xiaomi_aqara.markdown +++ b/source/_components/light.xiaomi_aqara.markdown @@ -14,7 +14,7 @@ ha_iot_class: "Local Push" --- -The `xiaomi aqara` light platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) lights. +The `xiaomi aqara` light platform allows you to control the internal light of the xiaomi gateway. The component will be loaded automatically and provides a device called `light.gateway_light_28ffffffffff`. The requirement is that you have setup [Xiaomi aqara](/components/xiaomi_aqara/). diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index e04e44511b0..70168cf440b 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -68,8 +68,16 @@ data: homeassistant.components.media_player.yamaha: debug ``` -The log information are stored in the [configuration directory](/docs/configuration/) as `home-assistant.log` and you can read it with the command-line tool `cat` or follow it dynamically with `tail -f`. If you are a Hassbian user you can use the example below: +The log information are stored in the [configuration directory](/docs/configuration/) as `home-assistant.log` and you can read it with the command-line tool `cat` or follow it dynamically with `tail -f`. + +If you are a Hassbian user you can use the example below: ```bash $ tail -f /home/homeassistant/.homeassistant/home-assistant.log ``` + +If you are a Hass.io user you can use the example below, whenlogged in through the ssh addon: + +```bash +$ tail -f /config/home-assistant.log +``` diff --git a/source/_components/media_player.denonavr.markdown b/source/_components/media_player.denonavr.markdown index b95cf5899b3..a64c85c44b3 100644 --- a/source/_components/media_player.denonavr.markdown +++ b/source/_components/media_player.denonavr.markdown @@ -24,6 +24,7 @@ Supported devices: - Denon AVR-1912 - Denon AVR-2312CI - Denon AVR-3311CI +- Denon AVR-4810 - Marantz M-CR603 - Marantz M-RC610 - Marantz SR5008 diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index 90fe9a22423..daa7b072c55 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -14,7 +14,7 @@ Interacts with media players on your network. Please check the sidebar for a ful ## {% linkable_title Services %} ### {% linkable_title Media control services %} -Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `media_play_pause`, `play_media`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist` +Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist` | Service data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------ | diff --git a/source/_components/media_player.vizio.markdown b/source/_components/media_player.vizio.markdown index 989d37113d7..ae68385e13a 100644 --- a/source/_components/media_player.vizio.markdown +++ b/source/_components/media_player.vizio.markdown @@ -20,10 +20,15 @@ The `vizio` component will allow you to control [SmartCast](https://www.vizio.co Before adding your TV to Home Assistant you'll need to pair it manually. To do so follow these steps: -Install the command-line tool using pip (or you can choose to download it manually): +Install the command-line tool using `pip` (or you can choose to download it manually): ```bash $ pip3 install git+https://github.com/vkorn/pyvizio.git@master +``` + +or + +```bash $ pip3 install -I . ``` diff --git a/source/_components/notify.facebook.markdown b/source/_components/notify.facebook.markdown index 1d76436a13e..209fe6c827d 100644 --- a/source/_components/notify.facebook.markdown +++ b/source/_components/notify.facebook.markdown @@ -46,8 +46,8 @@ automation: data: message: 'Good Evening' target: - - +919413017584 - - +919784516314 + - '+919413017584' + - '+919784516314' ``` You can also send messages to users that do not have stored their phone number with Facebook, but this requires a bit more work. The Messenger platform uses page specific user IDs instead of a global user ID. You will need to enable a webhook for the "messages" event in Facebook's developer console. Once a user writes a message to a page, that webhook will then receive the user's page specifc ID as part of the webhook's payload. Below is a simple PHP script that reacts to the message "get my id" and sends a reply containing the user's ID: diff --git a/source/_components/notify.telegram.markdown b/source/_components/notify.telegram.markdown index 6bd390bdb75..7df967d6289 100644 --- a/source/_components/notify.telegram.markdown +++ b/source/_components/notify.telegram.markdown @@ -28,8 +28,30 @@ The quickest way to retrieve your `chat_id` is visiting [https://api.telegram.or The result set will include your chat ID as `id` in the `from` section: ```json -{"ok":true,"result":[{"update_id":254199982, -"message":{"message_id":27,"from":{"id":123456789,"first_name":"YOUR_FIRST_NAME YOUR_NICK_NAME","last_name":"YOUR_LAST_NAME","username":"YOUR_NICK_NAME"},"chat":{"id":123456789,"first_name":"YOUR_FIRST_NAME YOUR_NICK_NAME","last_name":"YOUR_LAST_NAME","username":"YOUR_NICK_NAME","type":"private"},"date":1678292650,"text":"test"}}]} +{ + "ok": true, + "result": [{ + "update_id": 254199982, + "message": { + "message_id": 27, + "from": { + "id": 123456789, + "first_name": "YOUR_FIRST_NAME YOUR_NICK_NAME", + "last_name": "YOUR_LAST_NAME", + "username": "YOUR_NICK_NAME" + }, + "chat": { + "id": 123456789, + "first_name": "YOUR_FIRST_NAME YOUR_NICK_NAME", + "last_name": "YOUR_LAST_NAME", + "username": "YOUR_NICK_NAME", + "type": "private" + }, + "date": 1678292650, + "text": "test" + } + }] +} ``` Another way to get your chat ID directly is described below. Start your Python interpreter from the command-line: diff --git a/source/_components/panel_custom.markdown b/source/_components/panel_custom.markdown index 1ed44576e58..49775f28557 100644 --- a/source/_components/panel_custom.markdown +++ b/source/_components/panel_custom.markdown @@ -18,7 +18,7 @@ The `panel_custom` support allows you to add additional panels to your Home Assi To enable customized panels in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yaml entry for https://github.com/home-assistant/example-custom-config/blob/master/panels/hello_world.html panel_custom: - name: todomvc sidebar_title: TodoMVC @@ -26,7 +26,7 @@ panel_custom: url_path: my-todomvc webcomponent_path: /home/hass/hello.html config: - hello: world + who: world ``` Configuration variables: diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 4eeeb72ee8b..b96abb90a48 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -27,7 +27,7 @@ recorder: Configuration variables: -- **purge_interval** (*Optional*): (days) Enable scheduled purge of older events and states. The purge task runs every x days, starting from when Home Assistant is started. If you restart your instance more frequently, than the purge will never take place. You can use [service](#service) call `recorder.purge` when needed. +- **purge_interval** (*Optional*): (days) Enable scheduled purge of older events and states. The purge task runs every x days, starting from when Home Assistant is started. If you restart your instance more frequently, than the purge will never take place. You can use [service](#service-purge) call `recorder.purge` when needed. - **purge_keep_days** (*Required with `purge_interval`*): Specify number of history days to keep in recorder database after purge. - **exclude** (*Optional*): Configure which components should be excluded from recordings. - **entities** (*Optional*): The list of entity ids to be excluded from recordings. diff --git a/source/_components/sensor.gitter.markdown b/source/_components/sensor.gitter.markdown index 2ed03c0e856..55b8d29fe40 100644 --- a/source/_components/sensor.gitter.markdown +++ b/source/_components/sensor.gitter.markdown @@ -15,6 +15,8 @@ ha_release: 0.47 This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages. +Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token". + To use a Gitter sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.http.markdown b/source/_components/sensor.http.markdown index 5f912103905..c119330eb41 100644 --- a/source/_components/sensor.http.markdown +++ b/source/_components/sensor.http.markdown @@ -13,6 +13,11 @@ ha_release: pre 0.7 ha_iot_class: "Local Push" --- + +The HTTP 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. + +The sensor will then exist as long as Home Assistant is running. After a restart of Home Assistant the sensor will be gone until it is triggered again. + The URL for a sensor looks like the example below: ```bash diff --git a/source/_components/sensor.onewire.markdown b/source/_components/sensor.onewire.markdown index 4ec2ca7565e..19396863493 100644 --- a/source/_components/sensor.onewire.markdown +++ b/source/_components/sensor.onewire.markdown @@ -22,25 +22,38 @@ Supported devices: - [DS1822](https://datasheets.maximintegrated.com/en/ds/DS1822.pdf) - [DS1825](https://datasheets.maximintegrated.com/en/ds/DS1825.pdf) - [DS28EA00](https://datasheets.maximintegrated.com/en/ds/DS28EA00.pdf) temperature sensors -- [DS2406/TAI-8570] (https://datasheets.maximintegrated.com/en/ds/DS2406.pdf) Temperature and pressure sensor made by AAG -- [DS2438/B1-R1-A] (https://datasheets.maximintegrated.com/en/ds/DS2438.pdf) Temperature, pressure and humidity sensor by AAG +- [DS2406/TAI-8570](https://datasheets.maximintegrated.com/en/ds/DS2406.pdf) Temperature and pressure sensor made by AAG +- [DS2438/B1-R1-A](https://datasheets.maximintegrated.com/en/ds/DS2438.pdf) Temperature, pressure and humidity sensor by AAG -The 1-Wire bus can be connected directly to the IO pins of Raspberry Pi or using dedicated interface adapter (e.g [DS9490R](https://datasheets.maximintegrated.com/en/ds/DS9490-DS9490R.pdf)). When an interface adapter is used, sensors can be accessed on Linux hosts via [owfs 1-Wire file system](http://owfs.org/). When using an interface adapter and the owfs, the 'mount_dir' option must be configured to correspond a directory, where owfs device tree has been mounted. If you are using Raspberry Pi and IO pin connected bus setup, don't use the 'mount_dir' option. +The 1-Wire bus can be connected directly to the IO pins of Raspberry Pi or using dedicated interface adapter (e.g [DS9490R](https://datasheets.maximintegrated.com/en/ds/DS9490-DS9490R.pdf)). + +#### Raspberry Pi setup +In order ot setup 1-Wire support on Raspberry Pi, you'll need to edit `/boot/config.txt` following [this documentation](https://www.waveshare.com/wiki/Raspberry_Pi_Tutorial_Series:_1-Wire_DS18B20_Sensor#Enable_1-Wire). Don't use the `mount_dir` option. + +#### Interface adapter setup +When an interface adapter is used, sensors can be accessed on Linux hosts via [owfs 1-Wire file system](http://owfs.org/). When using an interface adapter and the owfs, the `mount_dir` option must be configured to correspond a directory, where owfs device tree has been mounted.
This component has been modified to work with devices with multiple sensors which will cause a discontinuity in recorded values. Existing devices will receive a new ID and therefore show up as new devices.
If you wish to maintain continuity it can be resolved in the database by renaming the old devices to the new names.
-Connect to your database using the instructions from https://home-assistant.io/docs/backend/database/
-Check the names of sensors:
+Connect to your database using the instructions from [home-assistant.io/docs/backend/database/](https://home-assistant.io/docs/backend/database/). Check the names of sensors:
+
+```sql
SELECT entity_id, COUNT(*) as count FROM states GROUP BY entity_id ORDER BY count DESC LIMIT 10;
+```
Alter the names of sensors using the following examples:
+
+```sql
UPDATE states SET entity_id='sensor.
+Rendering templates with time is dangerous as updates only trigger templates in sensors based on entity state changes. +
+ ## {% linkable_title Home Assistant template extensions %} In templates, besides the normal [state object methods and properties](/topics/state_object/), there are also some extra things available: diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index f16cdb7ab85..f1b88fe876e 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -87,3 +87,13 @@ Contents of `sensors.yaml`:Whenever you report an issue, be aware that we are volunteers who do not have access to every single device in the world nor unlimited time to fix every problem out there.
+ +### {% linkable_title Entity names %} + +The only characters valid in entity names are: + +* Lowercase letters +* Numbers +* Underscores + +If you create an entity with other characters then Home Assistant may not generate an error for that entity. However you will find that attempts to use that entity will generate errors (or possibly fail silently). diff --git a/source/_docs/configuration/yaml.markdown b/source/_docs/configuration/yaml.markdown index bba05d53e76..9398ec30bdb 100644 --- a/source/_docs/configuration/yaml.markdown +++ b/source/_docs/configuration/yaml.markdown @@ -83,3 +83,13 @@ If an environment variable is not set, you can fallback to a default value. http: api_password: !env_var PASSWORD default_password ``` + +### {% linkable_title Including Separate Files %} + +To improve readability, you can source out certain domains from your main configuration file with the `!include`-syntax. + +```yaml +lights: !include lights.yaml +``` + +More information about this feature can also be found at [splitting configuration](/docs/configuration/splitting_configuration/). diff --git a/source/_docs/ecosystem/apache.markdown b/source/_docs/ecosystem/apache.markdown index d8ec1aac020..ae0c1925114 100644 --- a/source/_docs/ecosystem/apache.markdown +++ b/source/_docs/ecosystem/apache.markdown @@ -32,13 +32,19 @@ To be able to access to your Home Assistant instance by using https://home.examp ```text+If you are using Hass.io, do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) to automatically maintain a subdomain including HTTPS certificates via Let's Encrypt. +
+Before exposing your Home Assistant instance to the outside world it is ESSENTIAL that you have set a password following the advice on the [http](https://home-assistant.io/docs/configuration/basic/) page.
diff --git a/source/_docs/ecosystem/tor.markdown b/source/_docs/ecosystem/tor.markdown index c5fd98dc0eb..6d87b5f08b4 100644 --- a/source/_docs/ecosystem/tor.markdown +++ b/source/_docs/ecosystem/tor.markdown @@ -88,7 +88,7 @@ Add the authentication cookie to your `torrc` client configuration on your lapto HidServAuth abcdef1234567890.onion ABCDEF1122334455667789 ``` -For Tor Browser on Windows, Mac or Linux, you can find the torrc file here: `There is an issue with the Mosquitto package included in Ubuntu 14.04 LTS. Specify `protocol: 3.1` in your MQTT configuration to work around this issue. diff --git a/source/_docs/z-wave.markdown b/source/_docs/z-wave.markdown index 2e756036358..b1b41896112 100644 --- a/source/_docs/z-wave.markdown +++ b/source/_docs/z-wave.markdown @@ -18,13 +18,16 @@ Before configuring the Z-Wave setup, please take a moment and read [this article ### {% linkable_title Installation %} -As of version 0.45, Home Assistant automatically installs python-openzwave from PyPI as needed. - There is one dependency you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems): ```bash $ sudo apt-get install libudev-dev ``` +When installing on macOS you may have to also run the command below ahead of time, replace "x.x" with the version of Python you have installed. + +```bash +sudo /Applications/Python\ x.x/Install\ Certificates.command +``` ### {% linkable_title Configuration %} @@ -41,7 +44,7 @@ Configuration variables: - **config_path** (*Optional*): The path to the Python OpenZWave configuration files. Defaults to the 'config' that is installed by python-openzwave - **autoheal** (*Optional*): Allows disabling auto Z-Wave heal at midnight. Defaults to True. - **polling_interval** (*Optional*): The time period in milliseconds between polls of a nodes value. Be careful about using polling values below 30000 (30 seconds) as polling can flood the zwave network and cause problems. -- **device_config** (*Optional*): This attribute contains node-specific override values. (For releases prior to 0.39 this variable is called **customize**) See [Customizing devices and services](https://home-assistant.io/getting-started/customizing-devices/) for format: +- **device_config** (*Optional*): This attribute contains node-specific override values: - **polling_intensity** (*Optional*): Enables polling of a value and sets the frequency of polling (0=none, 1=every time through the list, 2=every other time, etc). If not specified then your device will not be polled. - **ignored** (*Optional*): Ignore this entity completely. It won't be shown in the Web Interface and no events are generated for it. - **refresh_value** (*Optional*): Enable refreshing of the node value. Only the light component uses this. Defaults to False. diff --git a/source/_includes/asides/developers_navigation.html b/source/_includes/asides/developers_navigation.html index 632f09c5afd..613ff5834b4 100644 --- a/source/_includes/asides/developers_navigation.html +++ b/source/_includes/asides/developers_navigation.html @@ -121,7 +121,9 @@ Governance
+ `now()` will be rendered as current time in your time zone. ++ +Hmmm, ...OK, that's a start. How to get the year? {% raw %}`{{ now() }}`{% endraw %} gives you `2017-10-14 20:27:23.700401+02:00` which is far more than we are looking for. As an user you don't want to dive into the code but there would you find the solution. You will get a [Python `datetime` object](https://docs.python.org/3.6/library/datetime.html#datetime.datetime) from {% raw %}`{{ now() }}`{% endraw %}. This means that you can access more than you think in a template: + +- For the time: `now().microsecond`, `now().second`, `now().minute` and `now().hour` +- For the date: `now().day`, `now().month` and `now().year` +- Misc: `now().weekday()` and `now().isoweekday()` + +For the year it would be: {% raw %}`{{ now().year }}`{% endraw %}. I guess that there are rare use cases for `now().resolution`, `now().min` and `now().max` too. + +[Hacktoberfest](/blog/2017/09/29/hacktoberfest/) is still running. Working on the documentation is pretty easy. If you know a nice [trick](/cookbook/), want to help improving the page of a platform or just fix typo then please do. Our [Website/Documentation section](/developers/documentation/) contains some requirements which are defined in the [Documentation Standards](/developers/documentation/standards/) and the "[Create a page](/developers/documentation/create_page/)" documentation for other useful details. + +Thanks to [Egor Tsinko](https://github.com/etsinko) for bringing this issue to our attention. + diff --git a/source/_posts/2017-10-18-hasspodcast-ep-10.markdown b/source/_posts/2017-10-18-hasspodcast-ep-10.markdown new file mode 100644 index 00000000000..295702ce37a --- /dev/null +++ b/source/_posts/2017-10-18-hasspodcast-ep-10.markdown @@ -0,0 +1,18 @@ +--- +layout: post +title: "Home Assistant Podcast #10" +description: "0.55 and bye bye Python 3.4" +date: 2017-10-18 00:01:00 +0000 +date_formatted: "October 18, 2017" +author: Phil Hawthorne +author_twitter: philhawthorne +comments: true +categories: Media +og_image: /images/hasspodcast.jpg +--- + +Show notes available on the [Home Assistant Podcast Website](https://hasspodcast.io/HA010/) + +[Listen online][episode] + +[episode]: https://hasspodcast.io/ha010/ diff --git a/source/_posts/2017-10-23-simple-analog-sensor.markdown b/source/_posts/2017-10-23-simple-analog-sensor.markdown new file mode 100644 index 00000000000..10ae33715af --- /dev/null +++ b/source/_posts/2017-10-23-simple-analog-sensor.markdown @@ -0,0 +1,93 @@ +--- +layout: post +title: "Serial analog sensor" +description: "Using a Digispark with Home Assistant." +date: 2017-10-23 08:00:00 +0200 +date_formatted: "October 23, 2017" +author: Fabian Affolter +comments: true +categories: How-To +og_image: /images/blog/2017-10-analog-sensor/analog-sensor.png +--- + + +This blog post is about building a super simple analog sensor for Home Assistant. The physical sensor will send the data over its virtual serial port as it will be connected over USB. The concept is similar to the [TEMPer USB](/components/sensor.temper/) devices. The attatched sensor type to the microcontroller can be any kind of sensor which gives you an analog signal from brightness over soil moisture to temperature. + +The microcontroller will only transfer the voltage of an analog input pin which will be between 0 and 1024. Home Assistant will use the new [`serial`](/components/sensor.serial/) sensor platform to read the data and perform actions to convert the raw reading into a real measurement. This means that you don't have to adjust the code of your microcontroller if you change the attached sensor type. + +
+ 
+ The assembled sensor
+
-Make sure when you are copying the public key to the root of the /boot partition of the SD card that you rename the file correctly with no `.pub` file extension. +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.
You should then be able to SSH into your Hass.io device. On mac/linux, use: diff --git a/source/developers/maintenance.markdown b/source/developers/maintenance.markdown index 7b1d9d59a4f..0a509231e84 100644 --- a/source/developers/maintenance.markdown +++ b/source/developers/maintenance.markdown @@ -36,7 +36,7 @@ If you update the requirements of a component/platform through the `REQUIREMENTS $ script/gen_requirements_all.py ``` -Start a test run of Home Assistant if that was successful include all files in a Pull Request. Add a short summary of the changes, a sample configuration entry, details about the tests, and other useful information to the description. +Start a test run of Home Assistant if that was successful include all files in a Pull Request. Add a short summary of the changes, a sample configuration entry, details about the tests you performed to ensure the update works, and other useful information to the description. diff --git a/source/hassio/index.markdown b/source/hassio/index.markdown index 89f078729d0..84cb5ac4027 100644 --- a/source/hassio/index.markdown +++ b/source/hassio/index.markdown @@ -34,7 +34,12 @@ Hass.io users can update Home Assistant via the 'Hass.io' page in the UI. Howeve
-Hass.io dashboard
+Hass.io dashboard with upgrade notification (under the hamburger menu -> Hass.io)
+
+
+Hass.io upgrade process from the SSH command line