+You must have the [Geofency component](/components/geofency/) configured to use this device tracker. +
Geofency will automatically generate the device tracker name used for geofences, and you will find it in `known_devices.yaml` after the first request. For beacons, the device name will be `beacon_-Some installations have [a small bug](https://github.com/openwrt/luci/issues/576). The timeout for luci RPC calls is not set and this makes the call fail. +Some installations have [a small bug](https://github.com/openwrt/luci/issues/576). The timeout for luci RPC calls is not set and this makes the call fail. +If you want to locally fix your OpenWRT installation, you can apply the change manually to `/usr/lib/lua/luci/controller/rpc.lua`, or simply set a fixed timeout. The default is 3600.
diff --git a/source/_components/device_tracker.mikrotik.markdown b/source/_components/device_tracker.mikrotik.markdown index 5476d7902bc..8e839945c87 100644 --- a/source/_components/device_tracker.mikrotik.markdown +++ b/source/_components/device_tracker.mikrotik.markdown @@ -30,7 +30,7 @@ Go to **IP** -> **Services** -> **API** and enable it. Make sure that port 8728 or the port you choose is accessible from your network. -To use an Mikrotik router in your installation, add the following to your `configuration.yaml` file: +To use a Mikrotik router in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -57,8 +57,30 @@ password: port: description: Mikrotik API port. required: false - default: 8728 + default: 8728 (or 8729 if ssl is true) type: integer +ssl: + description: Use api_ssl service instead of api. + required: false + default: false + type: boolean +method: + description: Override autodetection of device scanning method. Can be `wireless` to use local wireless registration, `capsman` for capsman wireless registration, or `ip` for DHCP leases. + required: false + type: string {% endconfiguration %} +To use api_ssl service further configuration is required at RouterOS side. You have to upload or generate a certificate for api\-ssl service. Here is an example for a self signed certificate: + +```bash +/certificate add common-name="Self signed demo certificate for API" days-valid=3650 name="Self signed demo certificate for API" key-usage=digital-signature,key-encipherment,tls-server,key-cert-sign,crl-sign +/certificate sign "Self signed demo certificate for API" +/ip service set api-ssl certificate="Self signed demo certificate for API" +/ip service enable api-ssl +``` +If everything is working you can disable the pure api service: + +```bash +/ip service disable api +``` See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/device_tracker.owntracks_http.markdown b/source/_components/device_tracker.owntracks_http.markdown deleted file mode 100644 index 64df68dd04e..00000000000 --- a/source/_components/device_tracker.owntracks_http.markdown +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: page -title: "OwnTracks (via HTTP)" -description: "Instructions on how to use Owntracks via HTTP to track devices in Home Assistant." -date: 2017-09-28 07:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: owntracks.png -ha_category: Presence Detection -featured: true -ha_release: 0.55 ---- - -OwnTracks is a free and open source application that allows you to track your location in Home Assistant. This is a platform that supports OwnTracks via their HTTP publishing method. - -To integrate Owntracks tracking via HTTP in Home Assistant, add the following section to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -device_tracker: - - platform: owntracks_http -``` - -For configuration options and usage instructions, read the documentation for the [OwnTracks platform](/components/device_tracker.owntracks/). - -## {% linkable_title Configuring OwnTracks to submit data via HTTP %} - -Open OwnTracks and go to Connection preferences: - - - Mode: Select **Private HTTP** - - Host: [Home Assistant URL]:[port]/api/owntracks/[your name]/[device name] - - Identification: Turn **Authentication** on, username `homeassistant` and password is your API password that you use to login to Home Assistant. - -Host example: If I host my Home Assistant at `https://example.duckdns.org`, my name is Paulus and my phone is a Pixel I would set the host to be `https://example.duckdns.org/api/owntracks/paulus/pixel`. This will result in an entity with an ID of `device_tracker.paulus_pixel`. You can pick any name for the user and the device. - -Since the battery data is available as an attribute of the device tracker entity, it can be tracked with a [`template` sensor](/components/sensor.template/). - -{% raw %} -```yaml -# Example configuration.yaml entry -sensor: - - platform: template - sensors: - pixel_battery: - friendly_name: Pixel of Paulus - unit_of_measurement: "%" - value_template: '{{ states.device_tracker.paulus_pixel.attributes.battery|int }}' - device_class: battery -``` -{% endraw %} diff --git a/source/_components/device_tracker.traccar.markdown b/source/_components/device_tracker.traccar.markdown new file mode 100644 index 00000000000..688d02d036e --- /dev/null +++ b/source/_components/device_tracker.traccar.markdown @@ -0,0 +1,63 @@ +--- +layout: page +title: "Traccar GPS tracker" +description: "Instructions how to use Traccar GPS tracker to track devices in Home Assistant." +date: 2018-11-04 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: traccar.png +ha_release: 0.83 +ha_category: Presence Detection +ha_iot_class: "Local Polling" +--- + +`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. + +## {% linkable_title Configuration %} + +To integrate Traccar GPS tracker in Home Assistant, add the following section to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +device_tracker: + - platform: traccar + host: IP_ADDRESS + username: USERNAME + password: PASSWORD +``` + +{% configuration %} +host: + description: The DNS name or IP Address of the server running Traccar. + required: true + type: string +username: + description: The username for the Traccar server. + required: true + type: string +password: + description: The password for your given account on the Traccar server. + required: true + type: string +host: + description: The DNS name or IP Address of the server running Traccar. + required: true + type: string +port: + description: The port of your Traccar server. + required: false + default: 8082 + type: integer +ssl: + description: Use HTTPS to connect to Traccar server. *NOTE* A host *cannot* be an IP address when this option is enabled. + required: false + default: false + type: boolean +verify_ssl: + description: Verify the certification of the system. + required: false + type: boolean + default: true +{% endconfiguration %} \ No newline at end of file diff --git a/source/_components/doorbird.markdown b/source/_components/doorbird.markdown index a25ea83fa3a..db6cbd8444b 100644 --- a/source/_components/doorbird.markdown +++ b/source/_components/doorbird.markdown @@ -48,7 +48,7 @@ devices: required: true type: string username: - description: The username of a non-administrator user account on the device. + description: The username of a non-administrator user account on the device. This user needs the "API-Operator" permission enabled on doorbird. required: true type: string password: diff --git a/source/_components/ffmpeg.markdown b/source/_components/ffmpeg.markdown index d567fb2de07..c7d2bf7028b 100644 --- a/source/_components/ffmpeg.markdown +++ b/source/_components/ffmpeg.markdown @@ -35,11 +35,6 @@ ffmpeg_bin: required: false default: ffmpeg type: string -run_test: - description: Check if `input` is usable by ffmpeg. - required: false - default: True - type: boolean {% endconfiguration %} ### {% linkable_title Raspbian Debian Jessie Lite Installations %} diff --git a/source/_components/fibaro.markdown b/source/_components/fibaro.markdown new file mode 100644 index 00000000000..d7a69c04e73 --- /dev/null +++ b/source/_components/fibaro.markdown @@ -0,0 +1,56 @@ +--- +layout: page +title: "Fibaro" +description: "Instructions on how to setup Fibaro Z-Wave hubs (HCL and HC2) and configure devices within Home Assistant." +date: 2018-11-14 20:04 +sidebar: true +comments: false +sharing: true +footer: true +logo: fibaro.png +ha_category: Hub +ha_release: 0.83 +ha_iot_class: "Local Push" +--- + +The [Fibaro](http://fibaro.com) hub is a controller mainly connecting to Z-Wave devices. + +Switches, Lights (including Dimmers), Locks, Sensors, Binary sensors and Covers are supported - and will be automatically added when HA connects to your Fibaro controller. + +## {% linkable_title Configuration %} + +To use Fibaro devices in your installation, add the following to your configuration.yaml file using the IP and port number of your Fibaro controller: + +```yaml +fibaro: + url: http://192.168.1.161/api/ + username: your_username + password: your_password +``` + +{% configuration %} +url: + description: The URL for your Fibaro HomeCenter device. + required: true + type: url +username: + description: The username for your Fibaro account. + required: true + type: string +password: + description: The password for your Fibaro account. + required: true + type: string +plugins: + description: Whether to import plugin-generated devices from Fibaro HomeCenter, such as Netatmo and Sonos devices, etc. Default is false. + required: false + type: bool +{% endconfiguration %} + ++ It is recommended to assign a static IP address to your Fibaro Controller. This ensures that it won't change IP addresses, so you won't have to change the 'url' if the controller reboots and comes up with a different IP address. See your router's manual for details on how to set this up. If you need the MAC address of your Fibaro, check the label on the bottom. +
+ +### {% linkable_title Using Z-Wave devices in automation %} + +If you want to use a Z-Wave device from the Fibaro controller in Home Assistant automation, you'll need the entity id. In the Home Assistant UI you'll find all entities listed under the
icon of the Developer Tools section. Look for entities that contain 'Fibaro Device Id' in their attributes, and you'll find the entity id on the left.
diff --git a/source/_components/geofency.md b/source/_components/geofency.md
new file mode 100644
index 00000000000..bff78c98327
--- /dev/null
+++ b/source/_components/geofency.md
@@ -0,0 +1,44 @@
+---
+layout: page
+title: "Geofency"
+description: "Instructions for how to use Geofency to track devices in Home Assistant."
+date: 2017-08-22 19:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: geofency.png
+ha_category: Presence Detection
+ha_release: 0.83
+ha_iot_class: "Cloud Push"
+---
+
+This component sets up integration with [Geofency](http://www.geofency.com/). Geofency is a [paid app](https://itunes.apple.com/app/id615538630) for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location.
+
+Enabling this component will automatically enable the [Geofency Device Tracker](/components/device_tracker.geofency/).
+
+To integrate Geofency in Home Assistant, add the following section to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+geofency:
+```
+
+{% configuration %}
+mobile_beacons:
+ description: List of beacon names that are to be treated as *mobile*. The name must match the name you configure in Geofency. By default, beacons will be treated as *stationary*.
+ required: false
+ type: list
+{% endconfiguration %}
+
+A full sample configuration for the `geofency` component is shown below:
+
+```yaml
+# Example configuration.yaml entry
+geofency:
+ mobile_beacons:
+ - car
+ - keys
+```
+
+To configure Geofency, you must configure (via the Webhook feature) to send a POST request to your Home Assistant server at `http://+To avoid any errors, after you have successfully paired your Home Assistant Bridge, remove the `safe_mode` option from your config and restart Home Assistant. +
+ ## {% linkable_title Supported Components %} The following components are currently supported: @@ -263,7 +285,7 @@ The following components are currently supported: | Component | Type Name | Description | | --------- | --------- | ----------- | | alarm_control_panel | SecuritySystem | All security systems. | -| automation / input_boolean / remote / script | Switch | All represented as switches. | +| automation / input_boolean / remote / scene / script | Switch | All represented as switches. | | binary_sensor | Sensor | Support for `co2`, `door`, `garage_door`, `gas`, `moisture`, `motion`, `occupancy`, `opening`, `smoke` and `window` device classes. Defaults to the `occupancy` device class for everything else. | | climate | Thermostat | All climate devices. | | cover | GarageDoorOpener | All covers that support `open` and `close` and have `garage` as their `device_class`. | @@ -339,7 +361,7 @@ Configure the network mode as `networkbridge`. Otherwise the Home Assistant Brid #### {% linkable_title Pairing hangs - zeroconf error %} -Paining eventually fails, you might see and an error message `NonUniqueNameException`. To resolve this, you need to replace a specific file. See the following git issues for more details: [home-assistant#14567](https://github.com/home-assistant/home-assistant/issues/14567) and [home-assistant#17181](https://github.com/home-assistant/home-assistant/issues/17181) +Pairing eventually fails, you might see and an error message `NonUniqueNameException`. Add the `safe_mode` option to your config, see [safe_mode](#safe-mode). #### {% linkable_title Pairing hangs - only works with debug config %} diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index 47e9b336bc5..062034d6751 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -137,11 +137,6 @@ component_config_glob: required: false {% endconfiguration %} -## {% linkable_title Helper scripts %} - -- [Helper script `influxdb_import`](/docs/tools/influxdb_import/) -- [Helper script `db_migrator`](/docs/tools/db_migrator/) (only used for [Home Assistant 0.36](/blog/2017/01/14/iss-usps-images-packages/#influxdb-export)) - ## {% linkable_title Examples %} ### {% linkable_title Full configuration %} diff --git a/source/_components/light.avion.markdown b/source/_components/light.avion.markdown index 7290fcedb01..6abf6e2fd61 100644 --- a/source/_components/light.avion.markdown +++ b/source/_components/light.avion.markdown @@ -37,6 +37,8 @@ light: - platform: avion ``` +There are two ways to configure this component: username & password, or list of devices. You must choose one. + {% configuration %} username: description: The username used in the Avion app. If username and password are both provided, all associated switches will automatically be added to your configuration. @@ -59,6 +61,10 @@ devices: description: The API Key. required: true type: string + id: + description: The ID of the dimmer switch. Only needed for independent control of multiple devices. + required: true + type: string {% endconfiguration %} ## {% linkable_title Full example %} @@ -73,7 +79,21 @@ light: 00:21:4D:00:00:01: name: Light 1 api_key: YOUR_API_KEY - 00:21:3D:20:00:a1: - name: Light 2 - api_key: YOUR_API_KEY +``` + +For independent control of multiple devices, you must specify each device's ID (integer starting with 1). Each switch's ID can be guessed or detected from the Avi-On API. + +```yaml +# Manual device configuration.yaml entry +light: + - platform: avion + devices: + 00:21:4D:00:00:01: + name: Light 1 + api_key: YOUR_API_KEY + id: 1 + 00:21:4D:00:00:02: + name: Light 1 + api_key: YOUR_API_KEY + id: 2 ``` diff --git a/source/_components/light.fibaro.markdown b/source/_components/light.fibaro.markdown new file mode 100644 index 00000000000..0932c0f1edc --- /dev/null +++ b/source/_components/light.fibaro.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "Fibaro Lights" +description: "Instructions on how to integrate Fibaro lights into Home Assistant." +date: 2018-11-14 23:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: fibaro.png +ha_category: Light +ha_iot_class: "Local Push" +ha_release: 0.83 +--- + +The `fibaro` platform allows you to get data from your [Fibaro](http://fibaro.com/) lights connected to your Fibaro HCL or HC2 from within Home Assistant. + +They will be automatically discovered if the `fibaro` component is loaded. diff --git a/source/_components/light.niko_home_control.markdown b/source/_components/light.niko_home_control.markdown new file mode 100644 index 00000000000..6a513b90ac0 --- /dev/null +++ b/source/_components/light.niko_home_control.markdown @@ -0,0 +1,33 @@ +--- +layout: page +title: "Niko Home Control Light" +description: "Instructions on how to integrate Niko Home Control lights into Home Assistant." +date: 2018-04-08 08:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Light +ha_iot_class: "Local Polling" +ha_release: 0.82 +--- + +The `niko_home_control` platform allows you to integrate your [Niko Home Control](https://www.niko.eu/enus/products/niko-home-control) into Home Assistant. + +## {% linkable_title Configuration %} + +To enable this lights, add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +light: + - platform: niko_home_control + host: IP_ADDRESS +``` + +{% configuration %} +host: + description: The IP address of the Niko Home light. + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/light.switch.markdown b/source/_components/light.switch.markdown new file mode 100644 index 00000000000..4e1eeb2135e --- /dev/null +++ b/source/_components/light.switch.markdown @@ -0,0 +1,46 @@ +--- +layout: page +title: "Light Switch" +description: "Instructions on how to set up a light switch within Home Assistant." +date: 2018-11-18 19:59 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Light +ha_release: 0.83 +ha_iot_class: "Local Push" +logo: home-assistant.png +ha_qa_scale: internal +--- + +The light switch platform lets you control an existing switch, allowing you +to use a switch like a light in Home Assistant. + +In Home Assistant's world, a wall plug is a switch. This platform allows you +to expose this switch as a light source, allowing you to add, e.g., the wall +plug controlling your Christmas Tree, to be part of a light group. + +To enable this platform in your installation, add the following to your +`configuration.yaml` file: + +```yaml +light: + - platform: switch + name: Christmas Tree Lights + entity_id: switch.christmas_tree_lights +``` + +{% configuration %} + name: + description: The name of the light switch. + required: false + type: string + default: Light Switch + entity_id: + description: "The `entity_id` of a switch entity to control as a light source." + required: true + type: string +{% endconfiguration %} + +A light switch only supports turning on/off a light. diff --git a/source/_components/light.xiaomi_miio.markdown b/source/_components/light.xiaomi_miio.markdown index 5b9a335f03f..523d6039dd1 100644 --- a/source/_components/light.xiaomi_miio.markdown +++ b/source/_components/light.xiaomi_miio.markdown @@ -13,11 +13,13 @@ ha_iot_class: "Local Polling" ha_release: 0.53 --- -The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philips LED Ball Lamp, Xiaomi Philips Zhirui LED Bulb E14 Candle Lamp, Xiaomi Philips LED Ceiling Lamp, Xiaomi Philips Eyecare Lamp 2 and Philips Zhirui Desk Lamp. +The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philips LED Ball Lamp, Xiaomi Philips Zhirui LED Bulb E14 Candle Lamp, Xiaomi Philips Zhirui Downlight, Xiaomi Philips LED Ceiling Lamp, Xiaomi Philips Eyecare Lamp 2 and Philips Zhirui Desk Lamp. ## Features -### Philips LED Ball Lamp and Philips Zhirui LED Candle Lamp +### Philips LED Ball Lamp, Philips Zhirui LED Candle Lamp and Philips Zhirui Downlight + +Supported models: `philips.light.bulb`, `philips.light.candle`, `philips.light.candle2`, `philips.light.downlight` * Power (on, off) * Brightness @@ -31,6 +33,8 @@ The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philip ### Philips LED Ceiling Lamp +Supported models: `philips.light.ceiling`, `philips.light.zyceiling` + * Power (on, off) * Brightness * Color temperature (175...370 mireds) @@ -46,6 +50,8 @@ The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philip ### Philips Eyecare Smart Lamp 2 +Supported models: `philips.light.sread1` + * Eyecare light (on, off) * Ambient light (on, off) * Brightness (of each light) @@ -55,7 +61,7 @@ The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philip * Eye fatigue reminder / notification (on, off) * Eyecare mode (on, off) * Attributes - - model (Warning: set this value to philips.light.sread1) + - model - scene - delayed_turn_off - night_light_mode @@ -64,6 +70,8 @@ The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philip ### Philips Zhirui Desk Lamp +Supported models: `philips.light.mono1` + * Power (on, off) * Brightness * Scene (1, 2, 3, 4) @@ -102,7 +110,7 @@ name: type: string default: Xiaomi Philips Light model: - description: The model of your miio light. Valid values are `philips.light.bulb`, `philips.light.candle`, `philips.light.candle2`, `philips.light.sread1`, `philips.light.ceiling`, `philips.light.zyceiling` and `philips.light.mono1`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. + description: The model of your light. Valid values are `philips.light.sread1`, `philips.light.ceiling`, `philips.light.zyceiling`, `philips.light.bulb`, `philips.light.candle`, `philips.light.candle2`, `philips.light.mono1` and `philips.light.downlight`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. required: false type: string {% endconfiguration %} diff --git a/source/_components/luftdaten.markdown b/source/_components/luftdaten.markdown new file mode 100644 index 00000000000..276c10c501e --- /dev/null +++ b/source/_components/luftdaten.markdown @@ -0,0 +1,108 @@ +--- +layout: page +title: "Luftdaten" +description: "Instructions on how to setup Luftdaten sensors in Home Assistant." +date: 2018-11-05 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: luftdaten.png +ha_category: Health +ha_release: 0.82 +ha_iot_class: "Cloud Polling" +ha_qa_scale: gold +--- + +The `luftdaten` component will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station. + +## {% linkable_title Setup %} + +- To get the ID of a particle sensor you need to select it on the [Feinstaub map](http://deutschland.maps.luftdaten.info/) and find it in the sidebar (Column "Sensor ID"). +- To get the ID of a temperature/humidity sensor you need to find it on the map hosted on [Madavi](https://www.madavi.de/sensor/feinstaub-map-dht/). + + +## {% linkable_title COnfiguration via the frontend %} + +Menu: **Configuration** -> **Integrations** + +Configure the integration: + +* Enter the **Sensor ID** +* Choose if you want to show the sensor's location on the map. + +## {% linkable_title Manual Configuration %} + +To enable this sensor, add the following lines to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +luftdaten: +``` + +{% configuration %} +sensor_id: + description: The ID of the sensor. + required: true + type: string +name: + description: Name of the sensor to use in the frontend. + required: false + default: Luftdaten Sensor + type: string +show_on_map: + description: Option to show the position of the sensor on the map. + required: optional + default: false + type: boolean +scan_interval: + description: the frequency (in seconds) between data updates. + required: false + type: integer + default: 1800 +sensors: + description: The sensor-related configuration options. + required: false + type: map + keys: + monitored_conditions: + description: A list of conditions you want to monitor. + required: true + type: list + keys: + P1: + description: Show the particle sensors (particles 10 microns and below). + P2: + description: Show the particle sensors (particles 2.5 microns and below). + temperature: + description: Display the temperature from the sensor. + humidity: + description: Display the humidity from the sensor. + pressure: + description: Display the pressure from the sensor. +{% endconfiguration %} + ++If you set `show_on_map` to `true` then the location attributes are named `latitude` and `longitude`. The default name of the location attributes is `lat` and `long` to avoid showing them on the map. +
+ +Not all sensors provide all conditions. Also, it's possible that the sensor values are not available all the time. To check what a sensor is publishing use `curl`: + +```bash +$ curl https://api.luftdaten.info/v1/sensor/[sensorid]/ +``` + +## {% linkable_title Full example %} + +This example would use the sensor with the ID 155, show it on the `map` and would monitor `temperature` and `humidity`. + +```yaml +# Example configuration.yaml entry +luftdaten: + sensor_id: 155 + show_on_map: true + sensors: + monitored_conditions: + - temperature + - humidity +``` diff --git a/source/_components/lupusec.markdown b/source/_components/lupusec.markdown new file mode 100644 index 00000000000..d26b74319ea --- /dev/null +++ b/source/_components/lupusec.markdown @@ -0,0 +1,51 @@ +--- +layout: page +title: "Lupus Electronics Home Security" +description: "Instructions on integrating Lupusec home security with Home Assistant." +date: 2018-10-03 16:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: lupusec.jpg +ha_category: Hub +ha_release: 0.83 +ha_iot_class: "Local Polling" +--- + +The `Lupusec` component allows the user to integrate their Lupusec alarm control panel and ultimately all connected sensors and other devices. For more information about the LUPUS-Electronics security system please visit their [website](https://www.lupus-electronics.de). + +The following devices are supported by the underlying `lupupy` python library and integrated into hass. + +- [Alarm Control Panel](/components/alarm_control_panel.lupusec/): Displays the alarm status and controls arming, disarming and home modus. +- [Binary Sensor](/components/binary_sensor.lupusec/): Displays the status of binary sensors. Currently only Door and window sensors are supported. +- [Switch](/components/switch.lupusec/): Turn off and on your Lupus power switches. + +To use Lupusec devices in your installation, add the following `lupusec` section to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +lupusec: + username: YOUR_USERNAME + password: YOUR_PASSWORD + ip_address: 192.168.178.35 +``` + +{% configuration %} +username: + description: The login username of your Lupusec alarm panel. + required: true + type: string +password: + description: The login password of your Lupusec alarm panel. + required: true + type: string +ip_address: + description: The IP-address of your Lupusec alarm panel. + required: true + type: string +name: + description: Name for your Lupusec panel. + required: false + type: string +{% endconfiguration %} \ No newline at end of file diff --git a/source/_components/media_player.directv.markdown b/source/_components/media_player.directv.markdown index d27b10e1101..e7b82e80650 100644 --- a/source/_components/media_player.directv.markdown +++ b/source/_components/media_player.directv.markdown @@ -87,3 +87,17 @@ media_player: ``` It is important to notice that the host and port variables for slave/Genie receivers are the same as the master receiver. + +## {% linkable_title Services %} + +### {% linkable_title Media control services %} + +Available services: turn_on, turn_off, media_play, media_pause, media_stop, media_next_track, media_previous_track, play_media + +#### {% linkable_title Service `media_player.play_media` %} + +| Service data attribute | Optional | Description | +| -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity_id` | yes | Target a specific media player. Defaults to all. | +| `media_content_id` | no | The channel number to change to. | +| `media_content_type` | no | A media type. Has to be `channel`. diff --git a/source/_components/media_player.firetv.markdown b/source/_components/media_player.firetv.markdown index b2abdca1113..4ca7e150c8c 100644 --- a/source/_components/media_player.firetv.markdown +++ b/source/_components/media_player.firetv.markdown @@ -14,9 +14,7 @@ ha_iot_class: "Local Polling" --- -The `firetv` platform allows you to control a [Amazon Fire TV/stick](https://www.amazon.com/b/?node=8521791011). - -The python-firetv Python 2.x module with its helper script that exposes an HTTP server to fetch state and perform actions is used. +The `firetv` platform allows you to control an [Amazon Fire TV/stick](https://www.amazon.com/b/?node=8521791011). Steps to configure your Amazon Fire TV stick with Home Assistant: @@ -27,59 +25,85 @@ Steps to configure your Amazon Fire TV stick with Home Assistant: - Find Amazon Fire TV device IP: - From the main (Launcher) screen, select Settings. - Select System > About > Network. -- The following commands must be run in a Python 2.x environment. They will allow the component to function in an Ubuntu 16.04/Hassbian environment. - - `apt-get install swig libssl-dev python-dev libusb-1.0-0 python-yaml` - - `pip install flask` - - `pip install https://pypi.python.org/packages/source/M/M2Crypto/M2Crypto-0.24.0.tar.gz` - - `pip install firetv[firetv-server]` -- `firetv-server -d-Note that python-firetv has support for multiple Amazon Fire TV devices. If you have more than one configured, be sure to specify the device ID in `device`. Run `firetv-server -h` and/or view the source for complete capabilities. + In the dialog appearing on your Fire TV, you must check the box that says "always allow connections from this device." ADB authentication in Home Assistant will only work using a trusted key.
+Once you've successfully connected to your Fire TV via the command `adb connect
+Be aware that images are uploaded onto the Jabber server of your provider. They reside there un-encrypted and could be accessed by the server admins. Usually images are deleted after a few days.
+
+Home-Assistant supports TLS encryption to ensure transport encryption. TLS is enforced by default. You can disable it with the [`tls`](#tls) flag -- which is not recommended.
+
Owntracks v2.0.0 removes support for iBeacons on Android.
@@ -117,7 +127,7 @@ When you exit an iBeacon region HA will switch back to using GPS to determine yo
Sometimes Owntracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` Owntracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the Owntracks region with Zones. So if you call your Owntracks region `-home` then HA will recognize it as `home`, but you will have a more stable iBeacon connection.
-### {% linkable_title Using Owntracks iBeacons to track devices %}
+## {% linkable_title Using Owntracks iBeacons to track devices %}
iBeacons don't need to be stationary. You could put one on your key ring, or in your car.
@@ -127,13 +137,29 @@ To use mobile iBeacons with HA, you just set up a region that doesn't match your
This allows you to write zone automations for devices that can't track themselves (for example *alert me if I leave the house and my keys are still at home*). Another example would be *open the gates if my car arrives home*.
-### {% linkable_title Using mobile and fixed iBeacons together %}
+## {% linkable_title Using mobile and fixed iBeacons together %}
You can use iBeacons of both types together, so if you have a Zone `drive` with an iBeacon region called `-drive` and you arrive home with a mobile iBeacon called `-car`, then `device_tracker.beacon_car` will be set to a state of `drive`.
-### {% linkable_title Importing Owntracks waypoints as zones %}
+## {% linkable_title Importing Owntracks waypoints as zones %}
By default, any Owntracks user connected to Home Assistant can export their waypoint definitions (from the *Export - Export to Endpoint* menu item) which will then be translated to zone definitions in Home Assistant. The zones will be named `
+The Point is just active occasionally so the sensors are only updated every hour or so.
+The events sent from the Point is sent as a webhook back to Home Assistant with `event_type` as `point_webhook_received`, please consider the documentation for the [IFTT](https://www.home-assistant.io/components/ifttt/) component on how to write automations for webhooks.
+
-If you set `show_on_map` to `True` then the location attributes are named `latitude` and `longitude`. The default name of the location attributes is `lat` and `long` to avoid showing them on the map. -
- -Not all sensors provide all conditions. Also, it's possible that the sensor values are not available all the time. To check what a sensor is publishing use `curl`: - -```bash -$ curl https://api.luftdaten.info/v1/sensor/[sensorid]/ -``` +You must have the [`luftdaten` component](/components/luftdaten/) configured to use this platform. After configuring that component, sensors will automatically appear. diff --git a/source/_components/sensor.melissa.markdown b/source/_components/sensor.melissa.markdown deleted file mode 100644 index 0b4360560d5..00000000000 --- a/source/_components/sensor.melissa.markdown +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: page -title: "Melissa Sensor" -description: "Instructions on how to integrate Melissa sensors into Home Assistant." -date: 2017-08-30 12:21 -sidebar: true -comments: false -sharing: true -footer: true -logo: mclimate.png -ha_category: Environment -ha_iot_class: "Cloud Polling" -ha_release: 0.63 ---- - -The `melissa` platform allows you to get data from your [Melissa](http://seemelissa.com/) sensors from within Home Assistant. - -The sensor platform will be automatically configured if Melissa component is configured. - -For more configuration information see the [Melissa component](/components/melissa/) documentation. diff --git a/source/_components/sensor.point.markdown b/source/_components/sensor.point.markdown new file mode 100644 index 00000000000..ad491d427c6 --- /dev/null +++ b/source/_components/sensor.point.markdown @@ -0,0 +1,29 @@ +--- +layout: page +title: "Minut Point Sensor" +description: "Access your Minut Point Sensors." +date: 2018-11-19 +sidebar: true +comments: false +sharing: true +footer: true +logo: minut.svg +ha_category: Sensor +ha_release: "0.83" +ha_iot_class: "Cloud Polling" +ha_qa_scale: silver +--- + +Each Point exposes the following sensors: + +- **temperature**: Temperature in °C. +- **humidity**: Percentage of humidity in the air. +- **pressure**: Pressure in hPa. +- **sound_level**: Sound level in dBa. + + +For installation instructions, see [the Point component](/components/point/). + ++The Point is just active occasionally so the sensors are only updated every hour or so. +
diff --git a/source/_components/sensor.pollen.markdown b/source/_components/sensor.pollen.markdown index 8c613882242..c3f781da50a 100644 --- a/source/_components/sensor.pollen.markdown +++ b/source/_components/sensor.pollen.markdown @@ -13,10 +13,11 @@ ha_release: 0.63 ha_iot_class: "Cloud Polling" --- -The `pollen` sensor platform collects and displays allergy and disease -information (based on a U.S. ZIP code) from [Pollen.com](https://www.pollen.com/). Data measured includes: +The `pollen` sensor platform collects and displays allergy, asthma, and disease +information (based on a U.S. ZIP code) from +[Pollen.com](https://www.pollen.com/). Data measured includes: -* Indicies for allergies and cold/flu measurements +* Indicies for allergies, asthma and cold/flu indices * Trends * Current outlook * more! @@ -37,6 +38,11 @@ sensor: - allergy_index_today - allergy_index_tomorrow - allergy_index_yesterday + - asthma_average_forecasted + - asthma_average_historical + - asthma_index_today + - asthma_index_tomorrow + - asthma_index_yesterday - disease_average_forecasted ``` @@ -69,6 +75,15 @@ historical allergy index over the past 30 days tomorrow * Allergy Index: Yesterday (`allergy_index_yesterday`): the allergy index for yesterday +* Asthma Index: Forecasted Average (`asthma_average_forecasted`): the average +forecasted asthma index over the next 5 days +* Asthma Index: Historical Average (`asthma_average_historical`): the average +historical asthma index over the past 30 days +* Asthma Index: Today (`asthma_index_today`): the asthma index for today +* Asthma Index: Tomorrow (`asthma_index_tomorrow`): the asthma index for +tomorrow +* Asthma Index: Yesterday (`asthma_index_yesterday`): the asthma index for +yesterday * Cold & Flu: Forecasted Average (`disease_average_forecasted`): the average forecasted cold/flu index over the next 5 days @@ -84,3 +99,17 @@ Range | Rating 4.9 - 7.2 | Medium 7.3 - 9.6 | Medium/High 9.7 - 12.0 | High + +## {% linkable_title Understanding Asthma Allergens %} + +Several asthma-related sensors carry information regarding the top three +"asthma allergens" (i.e., irritants that may exacerbate asthma symptoms). +Example values include: + +Pollutant | Symbol | More Info +--------- | ------ | --------- +Particulate (<= 2.5 μm) | PM2.5 | [EPA: Particulate Matter (PM) Pollution ](https://www.epa.gov/pm-pollution) +Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution ](https://www.epa.gov/pm-pollution) +Ozone | O | [EPA: Ozone Pollution](https://www.epa.gov/ozone-pollution) +Sulpher Dioxide | SO2 | [EPA: Sulfur Dioxide (SO2) Pollution](https://www.epa.gov/so2-pollution) +Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution) diff --git a/source/_components/sensor.ruter.markdown b/source/_components/sensor.ruter.markdown new file mode 100644 index 00000000000..dc25d3189b0 --- /dev/null +++ b/source/_components/sensor.ruter.markdown @@ -0,0 +1,54 @@ +--- +layout: page +title: "Ruter Public Transport" +description: "Instructions on how to integrate departure times from Ruter within Home Assistant." +date: 2018-11-05 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: ruter.png +ha_category: Transport +ha_iot_class: "Cloud Polling" +ha_release: 0.83 +--- + +The `ruter` sensor will provide you departure information for the larger Oslo area in Norway from the [Ruter][ruter] public transportation service. + +This platform is using the [Ruter reisapi API][ruter-api] to gather the information. + +To find the `stop_id` you need to visit the [Ruter][ruter] site and search for your stop. +In the URL after you have searched, there will be an ID right after the `Stoppested/` in a format like this `(2190400)`, the numbers there is what you need to put in the `stop_id:` configuration option. + +Add the data to your `configuration.yaml` file as shown in the example: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: ruter + stop_id: STOPID +``` + +{% configuration %} +stop_id: + description: The stop id for the stop you want to monitor. + required: true + type: string +destination: + description: A destination name to show only departures that has this as the final stop. + required: false + type: string +offset: + description: An offset for the next departure, 0 will give the first one. + required: false + type: integer + default: 0 +name: + description: Name of the sensor. + required: false + type: string + default: Ruter +{% endconfiguration %} + +[ruter]: https://ruter.no/reiseplanlegger/Stoppested +[ruter-api]: http://reisapi.ruter.no/Help diff --git a/source/_components/sensor.seventeentrack.markdown b/source/_components/sensor.seventeentrack.markdown new file mode 100644 index 00000000000..9da8cb7899f --- /dev/null +++ b/source/_components/sensor.seventeentrack.markdown @@ -0,0 +1,52 @@ +--- +layout: page +title: "17track.net" +description: "Instructions on how to use 17track.net data within Home Assistant" +date: 2018-10-31 10:42 +sidebar: true +comments: false +sharing: true +footer: true +logo: 17track.png +ha_category: Postal Service +ha_release: 0.83 +ha_iot_class: "Cloud Polling" +--- + +The 17track.net sensor platform allows users to get package data tied to their +17track.net account. The platform creates both summary sensors, which show the +number of packages in a current state (e.g., "In Transit"), as well as +individual sensors for each package within the account. + +## {% linkable_title Configuration %} + +To enable the platform, add the following lines to your `configuration.yaml` +file: + +```yaml +sensor: + - platform: seventeentrack + username:- This sensor doesn't work at the moment due to changed by the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) to access the data. -
- The `swiss_hydrological_data` sensor will show you details (temperature, level, and discharge) of rivers and lakes in Switzerland. ## {% linkable_title Setup %} -The [station overview](http://www.hydrodaten.admin.ch/en/danger-levels-table.html) contains a list of all available measuring points and will help to determine the ID of station which is needed for the configuration. +The [station overview](https://www.hydrodaten.admin.ch/en/stations-and-data.html) contains a list of all available measuring points and will help to determine the ID of station which is needed for the configuration. ## {% linkable_title Configuration %} @@ -32,6 +28,10 @@ To enable this sensor, add the following lines to your `configuration.yaml` file sensor: - platform: swiss_hydrological_data station: STATION_ID + monitored_conditions: + - temperature + - level + - discharge ``` {% configuration %} @@ -39,29 +39,27 @@ station: description: The ID of the measurement point. required: true type: string -name: - description: Name to use in the frontend. +monitored_conditions: + description: The list of measurements you want to use. Available is `temperature`, `level` or `discharge`. required: false - type: string - default: + type: list + default: temperature {% endconfiguration %} -The hydrological measurings are coming from the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) and are updated almost in real-time. +Sensors are exposing additional values through their attributes for all available conditions: -## {% linkable_title Example %} - -This sensor contains additional information which an easily accessed by a [template sensor](/components/sensor.template/). - -{% raw %} -```yaml -# Example configuration.yaml entry -sensor: - platform: template - sensors: - discharge: - value_template: '{{ states.sensor.aare.attributes.Discharge }}' - friendly_name: 'Discharge' -``` -{% endraw %} +- `delta-24h`: The delta measurement for the last 24 hours. +- `max-1h`: The maximum measurement for the last hour. +- `max-24h`: The maximum measurement for the last 24 hours. +- `mean-1h`: The mean measurement for the last hour. +- `mean-24h`: The mean measurement for the last 24 hours. +- `min-1h`: The minimum measurement for the last hour. +- `min-24h`: The minimum measurement for the last 24 hours. +- `previous-24h`: The previous measurement for the last 24 hours. +- `station_update`: There is a time span between the sensor update in Home Assistant and the updates from the stations. Include those information if you are building automations based on the discharge of a water body. ++ The sensors don't show the latest measurement, but those from the last hour due to the source of data. Some stations also don't provide data for certain measurements. +
+The hydrological measurements are coming from the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) and are updated every 10 minutes. diff --git a/source/_components/sensor.tautulli.markdown b/source/_components/sensor.tautulli.markdown new file mode 100644 index 00000000000..03a0dd98288 --- /dev/null +++ b/source/_components/sensor.tautulli.markdown @@ -0,0 +1,73 @@ +--- +layout: page +title: "Tautulli activity sensor" +description: "Instructions on how to set up Tautulli sensors in Home Assistant." +date: 2018-10-27 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: tautulli.png +ha_category: Sensor +ha_release: 0.82 +ha_iot_class: "Local Polling" +--- + +The `Tautulli` sensor platform will monitor activity on a given [Tautulli Server][tautulli]. It will create a sensor that shows the number of currently active streams as the state. If you click the sensor for more details it will show you more statistics, the following stats are available by default: + +- LAN bandwidth +- Number of direct plays +- Number of direct streams +- Stream count +- Top Movie +- Top TV Show +- Top User +- Total bandwidth +- Transcode count +- WAN bandwidth + +More user statistics can be added with the `monitored_variables` configuration option, this will add one attribute per user in addition to the users current `activity`. + +To find your `api_key` open the Tautulli web interface and navigate to `Settings` and then to `Web interface`, the `api_key` will be at the bottom of that page. + +If you want to enable this sensor, add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: tautulli + api_key: 24b6eac0a858748664878d146bf63623b4 + host: 192.168.1.14 +``` + +{% configuration %} +api_key: + description: The API key for your Tautulli server. + required: true + type: string +host: + description: The DNS name or IP Address of the server running Tautulli. + required: true + type: string +port: + description: The port of your Tautulli server. + required: false + default: 8181 + type: integer +ssl: + description: Use HTTPS to connect to Tautulli server. *NOTE* A host *cannot* be an IP address when this option is enabled. + required: false + default: false + type: boolean +monitored_users: + description: A list of Tautulli users you want to monitor, if not set this will monitor **all** users. + required: false + type: list +monitored_variables: + description: A list of attributes to expose for each Tautulli user you monitor, every key in the `session` [section here][tautulliapi] can be used. + required: false + type: list +{% endconfiguration %} + +[tautulli]: https://tautulli.com +[tautulliapi]: https://github.com/Tautulli/Tautulli/blob/master/API.md#get_activity diff --git a/source/_components/sensor.transport_nsw.markdown b/source/_components/sensor.transport_nsw.markdown index 9ddf794d069..8296ffdedea 100644 --- a/source/_components/sensor.transport_nsw.markdown +++ b/source/_components/sensor.transport_nsw.markdown @@ -14,15 +14,19 @@ ha_release: 0.81 --- -The `transport_nsw` sensor will give you the time until the next departure from a Transport NSW stop (bus, train or ferry). +The `transport_nsw` sensor will give you the time until the next departure from a Transport NSW stop for bus, train, light rail or ferry. -Get your free API key from [Transport NSW](https://opendata.transport.nsw.gov.au/). +## {% linkable_title Setup %} -In order to find the stop id, just go to Google maps and click on the bus/train/ferry stop. It will give you there the stop ID. +Prerequisite is a free API key from [Transport NSW](https://opendata.transport.nsw.gov.au/). -You can define a bus line, but if you don’t do it, the sensor will pick up the next stop event from any line servicing this stop. +In order to find your stop id, go to Google maps and click on any bus/train/ferry stop. The pop up window shows the stop ID underneath the station name. For train stations the easist way to get a stop id for a platform is through [Transport NSW Info](https://transportnsw.info/). -Then add the data to your `configuration.yaml` file as shown in the example: +As a default the sensor picks up the next mode of transport leaving from a stop id. + +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -34,15 +38,19 @@ sensor: {% configuration %} api_key: - description: Your API key for Open Data Transport NSW + description: Your API key for Open Data Transport NSW. required: true type: string stop_id: - description: The ID of the stop to get the information for + description: The ID of the stop to get the information for. required: true type: string route: - description: Only show a single bus route at the stop. This is the same as the bus number, e.g., `83` + description: Filter on bus route at the stop. This is the same as the bus number, e.g., `83`. + required: false + type: string +destination: + description: Useful for ferry or train stops to filter the destination of the sensor, e.g. `Circular Quay`. required: false type: string name: @@ -51,4 +59,46 @@ name: type: string {% endconfiguration %} -The public information is coming from [Transport NSW](https://opendata.transport.nsw.gov.au/). +The public information is provided from [Transport NSW](https://opendata.transport.nsw.gov.au/). + +## {% linkable_title Examples %} + +More example configurations for bus or ferry. + +```yaml +# Example bus route configuration.yaml entry +sensor: + - platform: transport_nsw + name: 'Bus' + stop_id: '209516' + route: '199' + api_key: 'YOUR API KEY' +``` + +```yaml +# Example ferry configuration.yaml entry +sensor: + - platform: transport_nsw + name: 'Ferry' + stop_id: '10102008' + destination: 'Circular Quay' + api_key: 'YOUR API KEY' +``` + +The sensor returns n/a if no stop event is found within the next 24h. A `template` sensor can help building a more meaninful string. + +{% raw %} +```yaml +# Sample template sensor +- platform: template + sensors: + busmonitor: + friendly_name: "Bus Mon 199" + value_template: >- + {% if is_state_attr('sensor.bus', 'due', 'n/a') %} + No schedule found + {% else %} + {{ states.sensor.bus.attributes.route }} in {{ states.sensor.bus.attributes.due }}m ({{ states.sensor.bus.attributes.delay }}) + {% endif %} +``` +{% endraw %} diff --git a/source/_components/sensor.version.markdown b/source/_components/sensor.version.markdown index 21aee9a6d4d..10ce29b4ac3 100644 --- a/source/_components/sensor.version.markdown +++ b/source/_components/sensor.version.markdown @@ -31,7 +31,7 @@ name: description: Name to use in the frontend. required: false type: string - default: Current Version + default: "`Current Version` in case of `source: local`, `Latest Version` otherwise" beta: description: Flag to indicate that it will check for beta versions, only supported for the sources `pypi`, `hassio` and `docker`. required: false diff --git a/source/_components/switch.fibaro.markdown b/source/_components/switch.fibaro.markdown new file mode 100644 index 00000000000..ef93f7853ac --- /dev/null +++ b/source/_components/switch.fibaro.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "Fibaro switches" +description: "Instructions on how to integrate Fibaro switches into Home Assistant." +date: 2018-11-14 23:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: fibaro.png +ha_category: Light +ha_iot_class: "Local Push" +ha_release: 0.83 +--- + +The `fibaro` platform allows you to get data from your [Fibaro](http://fibaro.com/) switches connected to your Fibaro HCL or HC2 from within Home Assistant. + +They will be automatically discovered if the `fibaro` component is loaded. diff --git a/source/_components/switch.lupusec.markdown b/source/_components/switch.lupusec.markdown new file mode 100644 index 00000000000..f526e35da2a --- /dev/null +++ b/source/_components/switch.lupusec.markdown @@ -0,0 +1,20 @@ +--- +layout: page +title: "Lupusec Switch" +description: "Instructions on how to integrate Lupusec switches into Home Assistant." +date: 2018-10-03 16:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: lupusec.jpg +ha_category: Switch +ha_release: 0.83 +ha_iot_class: "Local Polling" +--- + +The `LUPUS-Electronics` security control panel platform allows you to control your [Lupusec](https://www.lupus-electronics.de) devices. + +This component will automatically add `Power Switches` configured in your Lupusec control panel. + +For the switches to work you have to setup your [Lupusec component](/components/lupusec/). diff --git a/source/_components/tplink_lte.markdown b/source/_components/tplink_lte.markdown new file mode 100644 index 00000000000..1adabfe82d9 --- /dev/null +++ b/source/_components/tplink_lte.markdown @@ -0,0 +1,59 @@ +--- +layout: page +title: "TP-Link LTE" +description: "Instructions on how to integrate your TP-Link LTE routers within Home Assistant." +date: 2018-10-03 21:30 +sidebar: true +comments: false +sharing: true +footer: true +logo: tp-link.png +ha_release: 0.83 +ha_category: Network +ha_iot_class: "Local Polling" +--- + +The TP-Link LTE integration for Home Assistant allows you to observe and control TP-Link LTE routers, currently only tested with TL-MR6400 (firmware 1.4.0). + +The integration provides a notification service that will send an SMS. + +## {% linkable_title Configuration %} + +To enable the component, add the following lines to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +tplink_lte: + - host: IP_ADDRESS + password: SECRET + notify: + - name: sms1 + target: "+15105550123" + - name: sms2 + target: "+55520525252" +``` + +{% configuration %} +host: + description: The IP address of the router web interface. + required: true + type: string +password: + description: The password used for the router web interface. + required: true + type: string +notify: + description: A list of notification services connected to this specific host. + required: false + type: list + keys: + target: + description: The phone number of a default recipient or a list with multiple recipients. + required: true + type: string, list + name: + description: The name of the notification service. + required: false + default: notify + type: string +{% endconfiguration %} diff --git a/source/_components/w800rf32.markdown b/source/_components/w800rf32.markdown new file mode 100644 index 00000000000..47602c33abc --- /dev/null +++ b/source/_components/w800rf32.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "W800rf32" +description: "Instructions on how to integrate a W800rf32(a) into Home Assistant." +date: 2018-10-16 10:15 +sidebar: true +comments: false +sharing: true +footer: true +logo: w800rf32.png +ha_category: Hub +ha_release: 0.83 +ha_iot_class: "Local Push" +--- + +The `w800rf32` component supports W800RF32 devices by [WGL Designs](http://www.wgldesigns.com/w800.html) which +communicate in the frequency range of 310MHz or if you are outside Canada or the U.S., 433.92 MHz. + +The W800 family of RF receivers are designed to receive X10 RF signals generated from X10 products: Palm Pad +remotes, key chain remotes, Hawkeye motion detectors, and many, many other X10 RF devices. + +To enable W800rf32 in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +w800rf32: + device: PATH_TO_DEVICE +``` + +{% configuration %} +device: + description: "The path to USB/serial device, example: /dev/ttyUSB0." + required: true + type: string +{% endconfiguration %} + + + diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index 5f5cbd77fd8..926b2110b85 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -99,7 +99,7 @@ gateways: type: map keys: mac: - description: The MAC address of your gateway. *Optional if only using one gateway.* + description: The MAC address of your gateway. Needs to be formatted without ":". *Optional if only using one gateway.* required: false type: string key: @@ -208,7 +208,7 @@ This example plays the sound of a dog barking when the button is held down and s - alias: Let a dog bark on long press trigger: platform: event - event_type: click + event_type: xiaomi_aqara.click event_data: entity_id: binary_sensor.switch_158d000xxxxxc2 click_type: long_click_press @@ -222,7 +222,7 @@ This example plays the sound of a dog barking when the button is held down and s - alias: Stop barking immediately on single click trigger: platform: event - event_type: click + event_type: xiaomi_aqara.click event_data: entity_id: binary_sensor.switch_158d000xxxxxc2 click_type: single @@ -240,7 +240,7 @@ This example toggles the living room lamp on a double click of the button. - alias: Double Click to toggle living room lamp trigger: platform: event - event_type: click + event_type: xiaomi_aqara.click event_data: entity_id: binary_sensor.switch_158d000xxxxxc2 click_type: double diff --git a/source/_docs/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown index 7fb5bd48885..f0cce9e3f01 100644 --- a/source/_docs/mqtt/discovery.markdown +++ b/source/_docs/mqtt/discovery.markdown @@ -188,6 +188,7 @@ The following firmware for ESP8266, ESP32 and Sonoff unit has built-in support f - [esphomeyaml](https://esphomelib.com/esphomeyaml/index.html) - [ESPurna](https://github.com/xoseperez/espurna) - [Arilux AL-LC0X LED controllers](https://github.com/mertenats/Arilux_AL-LC0X) +- [room-assistant](https://github.com/mKeRix/room-assistant) (starting with 1.1.0) ### {% linkable_title Examples %} diff --git a/source/_docs/tools/db_migrator.markdown b/source/_docs/tools/db_migrator.markdown deleted file mode 100644 index 68127935ae3..00000000000 --- a/source/_docs/tools/db_migrator.markdown +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: page -title: "db_migrator" -description: "Script to migrate data in an InfluxDB database" -release_date: 2017-02-23 11:00:00 -sidebar: true -comments: false -sharing: true -footer: true ---- - --This script was only use for 0.36 release cycle! -
- -Starting with 0.36 the [InfluxDB](omponents/influxdb/) component has a new schema to store values in the InfluxDB databases. - -- There will no longer be any tags/fields named `time`. -- All numeric fields (int/float/bool) will be stored as float inside InfluxDB database. -- All string fields corresponding to state attributes will be renamed as `FIELDNAME_str`, where `FIELDNAME` is the state attribute, to avoid type conflicts. -- All string fields corresponding to a state will be renamed as `state` (former value). -- Fields named `value` will always be stored as float. -- Fields named `state` will always be stored as string. - -## {% linkable_title Migration script %} - -If you need to migrate your database, you may require to run the `influxdb_migrator` script. Run the script after upgrade to 0.36 but before the first regular start of `hass` version 0.36. - -These are the steps the script will perform: - -1. Create a new database (called `DBNAME__old`) to store old data. -2. Copy data from `DBNAME` database to `DBNAME__old` database. -3. Empty `DBNAME` database (using `drop` then `create`). `DBNAME` database is now considered as the new database. -4. For each measurement of `DBNAME__old` database: - 1. Read all points from the current measurement (in groups of 1000 points by default) and convert them. - 2. Send group of points to `DBNAME` database. -5. Delete the `DBNAME__old` database if needed. - -Example to run the script: - -```bash -$ hass --script influxdb_migrator \ - -H IP_INFLUXDB_HOST -u INFLUXDB_USERNAME -p INFLUXDB_PASSWORD \ - -d INFLUXDB_DB_NAME -``` -Script arguments: - -``` -required arguments: - -d dbname, --dbname dbname InfluxDB database name - -optional arguments: - -h, --help show this help message and exit - -H host, --host host InfluxDB host address - -P port, --port port InfluxDB host port - -u username, --username username - InfluxDB username - -p password, --password password - InfluxDB password - -s step, --step step How many points to migrate at the same time - -o override_measurement, --override-measurement override_measurement - Store all your points in the same measurement - -D, --delete Delete old database -``` - -- If you run the script with only the `-h` option, you will get a help printout with a short explanation of the different options. -- The host option defaults to `'127.0.0.1'`. -- The port option defaults to `8086`. -- You should be able to omit username and password if InfluxDB authentication is disabled, which it is by default. -- The step option defaults to `1000`. - diff --git a/source/_docs/tools/influxdb_import.markdown b/source/_docs/tools/influxdb_import.markdown deleted file mode 100644 index 8ff3d85e7b8..00000000000 --- a/source/_docs/tools/influxdb_import.markdown +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: page -title: "influxdb_import" -description: "Script to import data into an InfluxDB database" -release_date: 2017-02-23 11:00:00 -sidebar: true -comments: false -sharing: true -footer: true ---- - -If you want to import all the recorded data from your recorder database you can use the data import script. It will read all your state_change events from the database and add them as data-points to the InfluxDB. You can specify the source database either by pointing the `--config` option to the config directory which includes the default SQLite database or by giving a sqlalchemy connection URI with `--uri`. - -The writing to InfluxDB is done in batches that can be changed with `--step`. - -You can control, which data is imported by using the command line options `--exclude_entities` and `--exclude_domains`. Both get a comma separated list of either entity-ids or domain names that are excluded from the import. - -To test what gets imported you can use the `--simulate` option, which disables the actual write to the InfluxDB instance. This only writes the statistics how much points would be imported from which entity. - -Example to run the script: - -```bash -$ hass --script influxdb_import --config CONFIG_DIR \ - -H IP_INFLUXDB_HOST -u INFLUXDB_USERNAME -p INFLUXDB_PASSWORD \ - --dbname INFLUXDB_DB_NAME --exclude_domains automation,configurator -``` -Script arguments: - -``` -required arguments: - -d dbname, --dbname dbname - InfluxDB database name - -optional arguments: - -h, --help show this help message and exit - -c path_to_config_dir, --config path_to_config_dir - Directory that contains the Home Assistant - configuration - --uri URI Connect to URI and import (if other than default - sqlite) eg: mysql://localhost/homeassistant - - -H host, --host host InfluxDB host address - -P port, --port port InfluxDB host port - -u username, --username username - InfluxDB username - -p password, --password password - InfluxDB password - -s step, --step step How many points to import at the same time - -t tags, --tags tags Comma separated list of tags (key:value) for all - points - -D default_measurement, --default-measurement default_measurement - Store all your points in the same measurement - -o override_measurement, --override-measurement override_measurement - Store all your points in the same measurement - -e exclude_entities, --exclude_entities exclude_entities - Comma separated list of excluded entities - -E exclude_domains, --exclude_domains exclude_domains - Comma separated list of excluded domains - -S, --simulate Do not write points but simulate preprocessing - and print statistics -``` - - diff --git a/source/_docs/tools/influxdb_migrator.markdown b/source/_docs/tools/influxdb_migrator.markdown deleted file mode 100644 index df8e83e4058..00000000000 --- a/source/_docs/tools/influxdb_migrator.markdown +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: page -title: "influxdb_migrator" -description: "Script to convert an old-structure Influx database to a new one." -release_date: 2017-02-23 11:00:00 -sidebar: true -comments: false -sharing: true -footer: true ---- - -Script to convert an old-structure Influx database to a new one. - -Example to run the script: - -```bash -$ hass --script influxdb_migrator -H IP_INFLUXDB_HOST \ - -u INFLUXDB_USERNAME -p INFLUXDB_PASSWORD \ - --dbname INFLUXDB_DB_NAME -``` -Script arguments: - -``` -optional arguments: - -h, --help show this help message and exit - -d dbname, --dbname dbname - InfluxDB database name - -H host, --host host InfluxDB host address - -P port, --port port InfluxDB host port - -u username, --username username - InfluxDB username - -p password, --password password - InfluxDB password - -s step, --step step How many points to migrate at the same time - -o override_measurement, --override-measurement override_measurement - Store all your points in the same measurement - -D, --delete Delete old database -``` - diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index 84f70a61751..c6a7a752eb0 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -96,10 +96,7 @@
+
+Screenshot of the Shopping List card.
+
+
+It's release day! Today we're happy to release Home Assistant 0.83. If you might have noticed, this is using our new release schedule which evolves around releases on Wednesdays instead of Fridays (this one is one day late). It's the same 2-week release schedule as before, except that it has moved 5 days later.
+
+So what's new? A LOT. First, a contributor milestone. This release the backend has 99 contributors. That means that in the last 2,5 weeks since the last release, 99 people have written code that is now part of Home Assistant. The frontend has another 15 contributors. It's amazing to see how as a community we can rally around building the best piece of home automation software out there and get it done.
+
+I want to give a shout out to [@MartinHjelmare] who is doing an amazing job going through PRs and helping out where possible. Good job! ✨
+
+Alright, time for some highlights. First is that thanks to [@pbalogh77], Fibaro Home Center hubs are now supported. If you had already invested in a Z-Wave network with Fibaro, you can now seamlessly integrate that into Home Assistant and combine it with all the other intgrations out there.
+
+The second cool thing is that Google Assistant now supports locks. Locking is enabled by default, but if you want to support unlocking, you will need to go to the Home Assistant Cloud settings to enable unlocking, or, if you're using the manual config, add `allow_unlock: true` to your config.
+
+
+ 
+ See what entities are exposed to Google and enable unlocking of locks.
+