diff --git a/_config.yml b/_config.yml index 41f8bb5eacb..905f48a3a53 100644 --- a/_config.yml +++ b/_config.yml @@ -141,14 +141,14 @@ social: # Home Assistant release details current_major_version: 0 -current_minor_version: 75 -current_patch_version: 3 -date_released: 2018-08-09 +current_minor_version: 76 +current_patch_version: 0 +date_released: 2018-08-17 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. # Major release: -patch_version_notes: "#release-0753---august-9" +patch_version_notes: "#" # Minor release (Example #release-0431---april-25): # Date we moved to Discourse for comments diff --git a/source/_components/amcrest.markdown b/source/_components/amcrest.markdown index 9c0aad4929e..220ab96d17f 100644 --- a/source/_components/amcrest.markdown +++ b/source/_components/amcrest.markdown @@ -46,7 +46,7 @@ Configuration variables: - **host** (*Required*): The IP address or hostname of your camera. If using a hostname, make sure the DNS works as expected. - **username** (*Required*): The username for accessing your camera. - **password** (*Required*): The password for accessing your camera. -- **name** (*Optional*): This parameter allows you to override the name of your camera. The default is "Amcrest Camera". +- **name** (*Optional*): This parameter allows you to override the name of your camera. The default is "Amcrest Camera". In the case of multi-camera setups, this is highly recommended as camera id number will be randomly changed at each reboot if a name is not allocated. - **port** (*Optional*): The port that the camera is running on. The default is 80. - **resolution** (*Optional*): This parameter allows you to specify the camera resolution. For a high resolution (1080/720p), specify the option `high`. For VGA resolution (640x480p), specify the option `low`. If omitted, it defaults to *high*. - **stream_source** (*Optional*): The data source for the live stream. `mjpeg` will use the camera's native MJPEG stream, whereas `snapshot` will use the camera's snapshot API to create a stream from still images. You can also set the `rtsp` option to generate the streaming via RTSP protocol. If omitted, it defaults to *snapshot*. diff --git a/source/_components/binary_sensor.openuv.markdown b/source/_components/binary_sensor.openuv.markdown new file mode 100644 index 00000000000..21cd0cb2bc0 --- /dev/null +++ b/source/_components/binary_sensor.openuv.markdown @@ -0,0 +1,23 @@ +--- +layout: page +title: "OpenUV Binary Sensor" +description: "Instructions on how to integrate OpenUV binary sensors within Home Assistant." +date: 2018-07-31 22:01 +sidebar: true +comments: false +sharing: true +footer: true +logo: openuv.jpg +ha_category: Binary Sensor +ha_release: 0.76 +ha_iot_class: "Cloud Polling" +--- + +The `openuv` binary sensor platform allows you to view binary sensor data from +[OpenUV](http://openuv.io). + +
+You must have the [OpenUV component](/components/openuv/) configured to use +this platform. After configuring that component, binary sensors will +automatically appear. +
diff --git a/source/_components/binary_sensor.velbus.markdown b/source/_components/binary_sensor.velbus.markdown index dc476b53f12..bdbba5f7075 100644 --- a/source/_components/binary_sensor.velbus.markdown +++ b/source/_components/binary_sensor.velbus.markdown @@ -13,49 +13,6 @@ ha_iot_class: "Local Push" ha_release: "0.50" --- -The `velbus` binary_sensor allows you to control [Velbus](http://www.velbus.eu) connected wall switches. - -## {% linkable_title Configuration %} - -To use your Velbus wall switches in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -binary_sensor: - - platform: velbus - devices: - - name: Wall Switch 1 - module: 0xda - channel: 4 - - name: Wall Switch 2 - module: 0xbc - channel: 1 - is_pushbutton: true -``` - -{% configuration %} -devices: - description: The list contains the binary sensors to configure. - required: true - type: map - keys: - name: - description: Name to use in the frontend. - required: true - type: string - module: - description: The hexadecimal module address. - required: true - type: string - channel: - description: The channel number in the module. - required: true - type: string - is_pushbutton: - description: Set to indicate if a wall switch is a push button or not. - required: false - type: boolean - default: false -{% endconfiguration %} +The `velbus` binary_sensor allows you to control [Velbus](http://www.velbus.eu) connected input devices. For hub configuration, see [the Velbus component](/components/velbus/). diff --git a/source/_components/device_tracker.bt_home_hub_5.markdown b/source/_components/device_tracker.bt_home_hub_5.markdown index 106ba06083d..ce8890a0ed7 100644 --- a/source/_components/device_tracker.bt_home_hub_5.markdown +++ b/source/_components/device_tracker.bt_home_hub_5.markdown @@ -25,6 +25,6 @@ device_tracker: Configuration variables: -- **host** (*Required*): The IP address of your router, e.g., 192.168.1.254. +- **host** (*Optional*): The IP address of your router, Default: 192.168.1.254. 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.google_maps.markdown b/source/_components/device_tracker.google_maps.markdown index 206c2cc9bec..6289ba26332 100644 --- a/source/_components/device_tracker.google_maps.markdown +++ b/source/_components/device_tracker.google_maps.markdown @@ -13,7 +13,7 @@ ha_category: Presence Detection ha_iot_class: "Cloud Polling" --- -The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing). +The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing). ## {% linkable_title Configuration %} @@ -45,4 +45,8 @@ password: description: The password for your given username. required: true type: string +max_gps_accuracy: + description: Sometimes Google Maps can report GPS locations with a very low accuracy (few kilometers). That can trigger false zoning. Using this parameter, you can filter these false GPS reports. The number has to be in meters. For example, if you put 200 only GPS reports with an accuracy under 200 will be taken into account - Defaults to 100km if not specified. + required: false + type: float {% endconfiguration %} diff --git a/source/_components/device_tracker.keenetic_ndms2.markdown b/source/_components/device_tracker.keenetic_ndms2.markdown index aec5ac8a522..d2d9fc506be 100644 --- a/source/_components/device_tracker.keenetic_ndms2.markdown +++ b/source/_components/device_tracker.keenetic_ndms2.markdown @@ -29,7 +29,8 @@ device_tracker: Configuration variables: - **host** (*Required*): The IP address of your router, e.g., 192.168.1.1. -- **username** (*Required*): The username to login into the router (user should have read access to web interface of the router). +- **port** (*Optional*): The Telnet port of your router. Default is 23. +- **username** (*Required*): The username to login into the router (user should have read access to telnet interface of the router). - **password** (*Required*): The password for the specified username. - **interface** (*Optional*): Ihe internal name of the interface to get devices connected to. Default is 'Home'. For expert users only. diff --git a/source/_components/device_tracker.ritassist.markdown b/source/_components/device_tracker.ritassist.markdown new file mode 100644 index 00000000000..e8f170f2026 --- /dev/null +++ b/source/_components/device_tracker.ritassist.markdown @@ -0,0 +1,82 @@ +--- +layout: page +title: "RitAssist" +description: "Instructions on how to use a RitAssist as a device tracker." +date: 2018-06-15 22:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: ritassist.png +ha_category: Presence Detection +ha_iot_class: Cloud Polling +ha_release: 0.76 +--- + +This platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. + +## API key +To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key). + +## Configuration +To use this device tracker in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +device_tracker: + - platform: ritassist + client_id: YOUR_CLIENT_ID + client_secret: YOUR_CLIENT_SECRET + username: YOUR_RITASSIST_USERNAME + password: YOUR_RITASSIST_PASSWORD + include: + - LICENSE_PLATE +``` + +{% configuration %} +client_id: + description: The client ID used to connect to the RitAssist API. + required: true + type: string +client_secret: + description: The client secret used to connect to the RitAssist API. + required: true + type: string +username: + description: Your RitAssist username. + required: true + type: string +password: + description: Your RitAssist password. + required: true + type: string +include: + description: A list of license plates to include, if this is not specified, all vehicles will be added. + required: false + type: strings +{% endconfiguration %} + +See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. + +## Available Attributes + +| Attribute | Description | +|---|---| +| latitude | The latitude of your vehicle | +| longitude | The longitude of your vehicle | +| altitude | Altitude of your vehicle | +| id | Identifier used to identify your vehicle | +| make | The make of the vehicle | +| model | Model of your vehicle | +| license_plate | License plate number | +| active | If the engine is currently active or not | +| odo | The odometer in kilometers | +| speed | The current speed of your vehicle, in KM/h | +| last_seen | The date and time when your vehicle last communicated with the API | +| fuel_level | Fuel level of the vehicle [1] | +| malfunction_light | Are any malfunction lights burning [1] | +| coolant_temperature | Temperature of the coolant [1] | +| power_voltage | Power voltage measured by the hardware [1] | +| distance_from_home | How far is your vehicle located from your Home Assistant Home location | + +[1] Only available on certain cars and hardware revisions. diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index e148bfdac29..f923c0ddb3f 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -21,6 +21,7 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi * [Bose Soundtouch speakers](/components/media_player.soundtouch/) * [Denon network receivers](/components/media_player.denonavr/) * [DirecTV receivers](/components/media_player.directv/) + * [DLNA DMR enabled devices](/components/media_player.dlna_dmr/) * [Frontier Silicon internet radios](/components/media_player.frontier_silicon/) * [Google Cast](/components/media_player.cast/) * [HomeKit](/components/homekit_controller/) @@ -79,6 +80,7 @@ Valid values for ignore are: * `bose_soundtouch`: Bose Soundtouch speakers * `denonavr`: Denon network receivers * `directv`: DirecTV receivers + * `dlna`: DLNA DMR enabled devices * `frontier_silicon`: Frontier Silicon internet radios * `google_cast`: Google Cast * `harmony`: Logitech Harmony Hub diff --git a/source/_components/fan.dyson.markdown b/source/_components/fan.dyson.markdown index d1ae60c6381..c3480135efb 100644 --- a/source/_components/fan.dyson.markdown +++ b/source/_components/fan.dyson.markdown @@ -22,3 +22,12 @@ You have first to setup the [Dyson component](/components/dyson/) - Pure Cool link (desk and tower) - Pure Hot+cool link (but heating is not yet supported) + +### {% linkable_title Attributes %} + +The are several attributes that can be useful for automations and templates. + +| Attribute | Description | +| --------- | ----------- | +| `is_night_mode` | A boolean that indicates if the night mode of the fan device is on. +| `is_auto_mode` | A boolean that indicates if the auto mode of the fan device is on. diff --git a/source/_components/fan.velbus.markdown b/source/_components/fan.velbus.markdown deleted file mode 100644 index e1686e65642..00000000000 --- a/source/_components/fan.velbus.markdown +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: page -title: "Velbus Fans" -description: "Access and control your Velbus fans." -date: 2017-06-17 16.58 -sidebar: true -comments: false -sharing: true -footer: true -logo: velbus.png -ha_category: Fan -ha_iot_class: "Local Push" -ha_release: "0.50" ---- - -The `velbus` fan allows you to control [Velbus](http://www.velbus.eu) connected fans. - -## {% linkable_title Configuration %} - -To use your Velbus fans in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -fan: - - platform: velbus - devices: - - name: Fan 1 - module: 0xda - channel_low: 4 - channel_medium: 3 - channel_high: 2 -``` - -{% configuration %} -devices: - description: The list contains the fans to configure. - required: true - type: map - keys: - name: - description: Name to use in the frontend. - required: true - type: string - module: - description: The hexadecimal module address. - required: true - type: string - channel_low: - description: The channel number in the module for low-speed. - required: true - type: string - channel_medium: - description: The channel number in the module for medium-speed. - required: true - type: string - channel_high: - description: The channel number in the module for high-speed. - required: true - type: string -{% endconfiguration %} - -For hub configuration, see [the Velbus component](/components/velbus/). diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index 70f90d77af9..2a4c981e2e0 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -14,31 +14,75 @@ ha_release: 0.66 featured: false --- -The [HomematicIP](http://www.homematic-ip.com) component platform is used as an interface to the cloud server. -For for communication [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used. +The [HomematicIP](http://www.homematic-ip.com) component platform is used as an interface to the cloud server. Since there is no official documentation about this API, everything was done via reverse engineering. The [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used for communicating. Use at your own risk. -To set up the component: +## {% linkable_title Setup the component via the frontend %} -- generate the authentication token: -```yaml -generate_auth_token.py -``` +Menu: *Configuration* -> *Integrations* + +Fill the form: +* Your **access point ID** (SGTIN) +* Optional a **name** to identify your access point, this will be used to prefix your device names. + +The authentification token will be generated and stored internally. + +## {% linkable_title Setup the component using the configuration files %} + +Generate the authentication token: + +`generate_auth_token.py` + +Add the information to your `configuration.yaml` file: -- add the information to your `configuration.yaml` file: ```yaml homematicip_cloud: - accesspoint: IDENTIFIER authtoken: AUTHTOKEN - name: Location2 accesspoint: IDENTIFIER2 - authtoken: AUTHTOKEN2 + authtoken: AUTHTOKEN2 ``` -Configuration variables (global): +{% configuration %} +name: + required: false + description: Name to identify your access point, this will be used to prefix your device names. + type: string +accesspoint: + required: true + description: This is the access point ID (SGTIN). + type: string +authtoken: + required: true + description: "Authentication token generated with `generate_auth_token.py`." + type: string +{% endconfiguration %} -- **name** (*Optional*): Name to identify your access point, this will be - used to prefix your device names. -- **accesspoint** (*Required*): This is the access point id (SGTIN) -- **authtoken** (*Required*): Authentification token generated with -`generate_auth_token.py`. +## {% linkable_title Implemented and tested devices %} +- homematicip_cloud.alarm_control_panel + - Security zones (*HmIP-SecurityZone*) + +- homematicip_cloud.binary_sensor + - Window and door contact (*HmIP-SWDO*) + - Smoke sensor and alarm (*HmIP-SWSD*) + - Motion detectors (*HmIP-SMI*) + - Motion detectors and push button (*HmIP-SMI55*) + +- homematicip_cloud.climate + - Radiator thermostat (*HmIP-eTRV,-2*) + - Climate group (*HmIP-HeatingGroup*) + +- homematicip_cloud.light + - Switch actuator and meter for brand switches (*HmIP-BSM*) + - Dimming actuator for brand switches (*HmIP-BDT*) + +- homematicip_cloud.sensor + - Accesspoint duty-cycle (*HmIP-HAP*) + - Wall-mounted thermostat (*HmIP-WTH*) + - Temperature and humidity sensor (*HmIP-STH*) + - Temperature and humidity Sensor with display (*HmIP-STHD*) + - Illuminance sensor (*HmIP-SMI, 55*) + +- homematicip_cloud.switch + - Pluggable Switch and Meter (*HmIP-PSM*) diff --git a/source/_components/http.markdown b/source/_components/http.markdown index 1a7416b0b3f..f108795b7ac 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -87,6 +87,11 @@ login_attempts_threshold: required: false type: integer default: -1 +ssl_profile: + description: The [Mozilla SSL profile](https://wiki.mozilla.org/Security/Server_Side_TLS) to use. Only lower if you are experiencing integrations causing SSL handshake errors. + required: false + type: string + default: modern {% endconfiguration %} The sample below shows a configuration entry with possible values: diff --git a/source/_components/image_processing.facebox.markdown b/source/_components/image_processing.facebox.markdown index ebb9892aad8..5723f5abaa8 100644 --- a/source/_components/image_processing.facebox.markdown +++ b/source/_components/image_processing.facebox.markdown @@ -24,6 +24,7 @@ MB_KEY="INSERT-YOUR-KEY-HERE" sudo docker run --name=facebox --restart=always -p 8080:8080 -e "MB_KEY=$MB_KEY" machinebox/facebox ``` +You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"` but bare in mind that the component does not encrypt these credentials and this approach does not guarantee security on an unsecured network. If you only require face detection (number of faces) you can disable face recognition by adding `-e "MB_FACEBOX_DISABLE_RECOGNITION=true"` to the `docker run` command. @@ -51,6 +52,14 @@ port: description: The port which Facebox is exposed on. required: true type: string +username: + description: The Facebox username if you have set one. + required: false + type: string +password: + description: The Facebox password if you have set one. + required: false + type: string source: description: The list of image sources. required: true @@ -109,24 +118,53 @@ A valid service data example: ``` {% endraw %} -An `image_processing.teach_classifier` event is fired for each service call, providing feedback on whether teaching has been successful or unsuccessful. In the unsuccessful case, the `message` field of the `event_data` will contain information on the cause of failure, and a warning is also published in the logs. An automation can be used to receive alerts on teaching, for example, the following automation will send a notification with the teaching image and a message describing the status of the teaching: +You can use an automation to receive a notification when you train a face: + +{% raw %} +```yaml +- id: '1533703568569' + alias: Face taught + trigger: + - event_data: + service: facebox_teach_face + event_type: call_service + platform: event + condition: [] + action: + - service: notify.pushbullet + data_template: + message: '{{ trigger.event.data.service_data.name }} taught + with file {{ trigger.event.data.service_data.file_path }}' + title: Face taught notification +``` +{% endraw %} + +Any errors on teaching will be reported in the logs. If you enable [system_log](https://www.home-assistant.io/components/system_log/) events: ```yaml -- id: '11200961111' - alias: Send facebox teaching result +system_log: + fire_event: true +``` + +you can create an automation to receive notifications on Facebox errors: + +{% raw %} +```yaml +- id: '1533703568577' + alias: Facebox error trigger: platform: event - event_type: image_processing.teach_classifier - event_data: - classifier: facebox + event_type: system_log_event + condition: + condition: template + value_template: '{{ "facebox" in trigger.event.data.message }}' action: - service: notify.platform + - service: notify.pushbullet data_template: - title: Facebox teaching - message: Name {{ trigger.event.data.name }} teaching was successful? {{ trigger.event.data.success }} - data: - file: ' {{trigger.event.data.file_path}} ' + message: '{{ trigger.event.data.message }}' + title: Facebox error ``` +{% endraw %} ## {% linkable_title Optimising resources %} diff --git a/source/_components/light.velbus.markdown b/source/_components/light.velbus.markdown deleted file mode 100644 index ddafbaa7eb5..00000000000 --- a/source/_components/light.velbus.markdown +++ /dev/null @@ -1,55 +0,0 @@ ---- -layout: page -title: "Velbus lights" -description: "Access and control your Velbus lights." -date: 2017-06-17 16.58 -sidebar: true -comments: false -sharing: true -footer: true -logo: velbus.png -ha_category: Light -ha_iot_class: "Local Push" -ha_release: "0.50" ---- - -The `velbus` light allows you to control [Velbus](http://www.velbus.eu) lights. - -## {% linkable_title Configuration %} - -To use your Velbus lights in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -light: - - platform: velbus - devices: - - name: Light 1 - module: 0xda - channel: 4 - - name: Light 2 - module: 0xbc - channel: 1 -``` - -{% configuration %} -devices: - description: The list contains the lights to configure. - required: true - type: map - keys: - name: - description: Name to use in the frontend. - required: true - type: string - module: - description: The hexadecimal module address. - required: true - type: string - channel: - description: The channel number in the module. - required: true - type: string -{% endconfiguration %} - -For hub configuration, see [the Velbus component](/components/velbus/). diff --git a/source/_components/media_player.dlna_dmr.markdown b/source/_components/media_player.dlna_dmr.markdown new file mode 100644 index 00000000000..1713a1c212c --- /dev/null +++ b/source/_components/media_player.dlna_dmr.markdown @@ -0,0 +1,50 @@ +--- +layout: page +title: "DLNA DMR" +description: "Instructions on how to integrate a DLNA DMR device into Home Assistant." +date: 2018-06-01 14:27 +sidebar: true +comments: false +sharing: true +footer: true +logo: dlna.png +ha_category: Media Player +featured: false +ha_release: 0.76 +ha_iot_class: "Local Push" +--- + +The `dlna_dmr` platform allows you to control a [DLNA Digital Media Renderer](https://www.dlna.org/), such as DLNA enabled TVs or radios. + +Please note that some devices, such as Samsung TVs, are rather picky about the source used to play from. The TTS service might not work in combination with these devices. If the play_media service does not work, please try playing from a DLNA/DMS (such as [MiniDLNA](https://sourceforge.net/projects/minidlna/)). + +## {% linkable_title Configuration %} + +To add a DLNA DMR device to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +media_player: + - platform: dlna_dmr + url: http://192.168.0.10:9197/dmr +``` + +{% configuration %} +url: + description: The URL to the device description, e.g., `http://192.168.0.10:9197/dmr`. + required: true + type: string +listen_ip: + description: IP to listen on for events from the device. Only set this when the IP is not detected properly. + required: false + type: string +listen_port: + description: Port to listen on for events from the device. + required: false + default: 8301 + type: int +name: + description: The name you would like to give to the device, e.g., `TV living room`. + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/media_player.pjlink.markdown b/source/_components/media_player.pjlink.markdown new file mode 100644 index 00000000000..785f7cf2d1d --- /dev/null +++ b/source/_components/media_player.pjlink.markdown @@ -0,0 +1,53 @@ +--- +layout: page +title: "PJLink" +description: "Instructions on how to integrate PJLink enabled projectors into Home Assistant." +date: 2018-06-21 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: pjlink.png +ha_category: Media Player +ha_release: 0.76 +ha_iot_class: "Local Polling" +--- + +The `pjlink` platform allows you to control from Home Assistant, projectors with support for the [PJLink protocol](http://pjlink.jbmia.or.jp/english/index.html). + +## {% linkable_title Configuration %} + +To add a PJLink projector to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +media_player: + - platform: pjlink + host: 192.168.1.2 +``` + +{% configuration %} +host: + description: IP address or hostname of the device. Example:`192.168.1.2`. + required: true + type: string +port: + description: port on which the PJLink service runs on the device. + required: false + type: int + default: 4352 +name: + description: Name of the device. + required: false + type: string + default: name of the device as returned by PJLink. +encoding: + description: Character encoding to use to communicate with the device. + required: false + type: string + default: utf-8 +password: + description: Password to authenticate with the projector. + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/notify.telstra.markdown b/source/_components/notify.telstra.markdown deleted file mode 100644 index 4297cfc69f1..00000000000 --- a/source/_components/notify.telstra.markdown +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: page -title: "Telstra" -description: "Instructions on how to add Telstra API notifications to Home Assistant." -date: 2016-10-19 10:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: telstra.png -ha_category: Notifications -ha_release: 0.31 ---- - - -The `telstra` notification platform allows you to deliver Home Assistant notifications to Australian phone numbers over the [Telstra SMS API](https://dev.telstra.com/content/sms-api-0). - -To enable the Telstra notifications in your installation, you must first create an account and API app over at [dev.telstra.com](https://dev.telstra.com/). The free tier allows for a maximum of 1000 free messages. - -After your API app is approved, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -notify: - name: NOTIFIER_NAME - platform: telstra - consumer_key: TELSTRA_API_CONSUMER_KEY_HERE - consumer_secret: TELSTRA_API_CONSUMER_SECRET_HERE - phone_number: SMS_RECIPIENT_PHONE_NUMBER_HERE -``` - -Configuration variables: - -- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. -- **consumer_key** (*Required*): The consumer key of your Telstra API app. -- **consumer_secret** (*Required*): The consumer secret of your Telstra API app. -- **phone_number** (*Required*): The phone number of where the notifications will be sent. - -To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown new file mode 100644 index 00000000000..e157ee396dc --- /dev/null +++ b/source/_components/openuv.markdown @@ -0,0 +1,126 @@ +--- +layout: page +title: "OpenUV" +description: "Instructions on how to integrate OpenUV within Home Assistant." +date: 2018-07-31 22:01 +sidebar: true +comments: false +sharing: true +footer: true +logo: openuv.jpg +ha_category: Hub +ha_release: 0.76 +ha_iot_class: "Cloud Polling" +--- + +The `openuv` component displays UV and Ozone data from +[openuv.io](http://openuv.io). + +## {% linkable_title Generating an API Key %} + +To generate an API key, [simply log in to the OpenUV website](https://www.openuv.io/auth/google). + ++The "Limited" plan (which is what new users are given by default) is limited to +500 API requests per day. In order to leave a buffer, the `openuv` component +queries the API every 30 minutes by default. This value can be modifed (via the +`scan_interval` key), but please note that over-running the API will require +you to upgrade to a paid plan (and may disable your access in the meantime). +
+ +## {% linkable_title Base Configuration %} + +To retrieve data from OpenUV, add the following to your `configuration.yaml` +file: + +```yaml +openuv: + api_key: YOUR_OPENUV_API_KEY +``` + +To configure additional functionality, add configuration options beneath +a `binary_sensor` and/or `sensor` key within the `openuv` section of +`configuration.yaml` as below: + +```yaml +openuv: + api_key: YOUR_OPENUV_API_KEY + binary_sensors: + # binary sensor configuration options... + sensors: + # sensor configuration options... +``` + +{% configuration %} +api_key: + description: your OpenUV API key + required: true + type: string +scan_interval: + description: the frequency (in seconds) between data updates + required: false + type: int + default: 1800 +binary_sensors: + description: binary sensor-related configuration options + required: false + type: map + keys: + monitored_conditions: + description: the conditions to create sensors from + required: false + type: list + default: all (`uv_protection_window`) +sensors: + description: sensor-related configuration options + required: false + type: map + keys: + monitored_conditions: + description: the conditions to create sensors from + required: false + type: list + default: all ( `current_ozone_index`, `current_uv_index`, `max_uv_index`, `safe_exposure_time_type_1`, `safe_exposure_time_type_2`, `safe_exposure_time_type_3`, `safe_exposure_time_type_4`, `safe_exposure_time_type_5`, `safe_exposure_time_type_6` ) +{% endconfiguration %} + +## {% linkable_title Binary Sensor Types %} + +### {% linkable_title `uv_protection_window` %} + +This sensor displays `true` if UV protection (sunscreen, etc.) is recommended +at the current date and time; displays `false` otherwise. + +## {% linkable_title Sensor Types %} + +### {% linkable_title `current_ozone_level` %} + +This sensor displays the current ozone level in du (Dobson Units). + +### {% linkable_title `current_uv_index` %} + +This sensor displays the current UV index. + +### {% linkable_title `max_uv_index` %} + +This sensor displays the maximum UV index that will be encountered that day (at +solar noon). + +### {% linkable_title `safe_exposure_time_type_X` %} + +These sensors display the approximate number of minutes a particular skin type +can be exposed to the sun before burning/tanning starts. Each sensor depicts +a skin type based on the +[Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale): + +* Skin Type I +* Skin Type II +* Skin Type III +* Skin Type IV +* Skin Type V +* Skin Type VI + ++The above guidelines constitude estimates and are intended to help informed +decision making. They should not replace analysis, advice, or diagnosis from a +trained medical professional. +
diff --git a/source/_components/sensor.enphase_envoy.markdown b/source/_components/sensor.enphase_envoy.markdown new file mode 100644 index 00000000000..fb04d906ed4 --- /dev/null +++ b/source/_components/sensor.enphase_envoy.markdown @@ -0,0 +1,55 @@ +--- +layout: page +title: "Enphase Envoy" +description: "Instructions on how to setup Enphase Envoy with Home Assistant." +date: 2018-06-30 12:30 +sidebar: true +comments: false +sharing: true +footer: true +logo: enphase-logo.svg +ha_category: Energy +ha_release: 0.76 +ha_iot_class: "Local Polling" +--- + +A sensor platform for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy) solar energy monitor. + +### {% linkable_title Configuration %} + +To enable this sensor, add the following lines to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: enphase_envoy + ip_address: ENVOY_LOCAL_IP_ADDRESS +``` + +{% configuration %} +ip_address: + description: The local IP Address of your Envoy + required: true + type: string +monitored_conditions: + description: The list of conditions to monitor + required: false + type: list + keys: + production: + description: The power in W being produced by the solar panels + daily_production: + description: The energy in Wh produced that day + 7_days_production: + description: The energy in Wh produced the last 7 days + lifetime_production: + description: The energy in Wh produced in the lifetime of the Envoy + consumption: + description: The power in W being consumed in the whole house + daily_consumption: + description: The energy in Wh consumed that day + 7_days_consumption: + description: The energy in Wh consumed the last 7 days + lifetime_consumption: + description: The energy in Wh consumed in the lifetime of the Envoy +{% endconfiguration %} diff --git a/source/_components/sensor.opensky.markdown b/source/_components/sensor.opensky.markdown index 552de4c420a..cf16befa77e 100644 --- a/source/_components/sensor.opensky.markdown +++ b/source/_components/sensor.opensky.markdown @@ -31,6 +31,7 @@ Configuration options for the OpenSky Network sensor: - **radius** (*Required*): Radius of region to monitor, in kilometers - **latitude** (*Optional*): Region latitude (defaults to home zone latitude) - **longitude** (*Optional*): Region longitude (defaults to home zone longitude) +- **altitude** (*Optional*): The maximum altitude(in meters) for planes to be detected in, 0 sets it to unlimited (defaults to 0) - **name** (*Optional*): Sensor name (defaults to `opensky`) ## Events @@ -42,6 +43,7 @@ Both events have two attributes: - **sensor**: Name of `opensky` sensor that fired the event - **callsign**: Callsign of the flight +- **altitude**: Altitude of the flight in meters To receive notifications of the entering flights, add the following lines to your `configuration.yaml`. diff --git a/source/_components/sensor.openuv.markdown b/source/_components/sensor.openuv.markdown new file mode 100644 index 00000000000..f777be94262 --- /dev/null +++ b/source/_components/sensor.openuv.markdown @@ -0,0 +1,23 @@ +--- +layout: page +title: "OpenUV Sensor" +description: "Instructions on how to integrate OpenUV sensors within Home Assistant." +date: 2018-07-31 22:01 +sidebar: true +comments: false +sharing: true +footer: true +logo: openuv.jpg +ha_category: Sensor +ha_release: 0.76 +ha_iot_class: "Cloud Polling" +--- + +The `openuv` sensor platform allows you to view sensor data from +[OpenUV](http://openuv.io). + ++You must have the [OpenUV component](/components/openuv/) configured to use +this platform. After configuring that component, sensors will automatically +appear. +
diff --git a/source/_components/sensor.rmvtransport.markdown b/source/_components/sensor.rmvtransport.markdown new file mode 100644 index 00000000000..e6584282bda --- /dev/null +++ b/source/_components/sensor.rmvtransport.markdown @@ -0,0 +1,101 @@ +--- +layout: page +title: "RMV" +description: "Instructions on how to integrate Rhein-Main public transport departure times into Home Assistant." +date: 2018-08-02 22:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: RMV.png +ha_category: Transport +ha_release: 0.76 +ha_iot_class: "Cloud Polling" +--- + +The `rvmtransport` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes. + +## {% linkable_title Configuration %} + +To enable this sensor, add the following lines to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: rmvtransport + next_departure: + - station: STATION_OR_STOP_ID +``` + +{% configuration %} +name: + description: Name to use in the frontend. + required: false + default: The default is the station name. + type: string +stationId: + description: ID of the stop or station, e.g. 3000010. Visit [the RMV OpenData web site](https://opendata.rmv.de) to find a list of valid IDs. + required: true + type: string +destinations: + description: "One or multiple final stop names, e.g., 'Frankfurt (Main) Hauptbahnhof' or ['Frankfurt (Main) Hauptbahnhof','Frankfurt (Main) Stadion']. This can be used to only consider a particular direction of travel." + required: false + type: [string] +lines: + description: "One or more line numbers, e.g., `'S8'` or `['S8', 'RB33', '41']`" + required: false + default: The default is the station name. + type: [string, int] +products: + description: "One or more modes of transport `['U-Bahn', 'Tram', 'Bus', 'S-Bahn', 'RB', 'RE', 'EC', 'IC', 'ICE']`." + required: false + default: Defaults to all. + type: [string] +time_offset: + description: Do not display departures leaving sooner than this number of minutes. Useful if you are a couple of minutes away from the stop. + required: false + default: The defaults is 0. + type: int +max_journeys: + description: Specify the maximal number of journeys. + required: false + default: The default is 5. + type: string +{% endconfiguration %} + +## {% linkable_title Examples %} + +### {% linkable_title Full configuration %} + +The example below shows a full configuration with three sensors that showcase the various configuration options. + +```yaml +# Example configuration.yaml entry +sensor: + - platform: rmvtransport + next_departure: + - station: 3000010 + time_offset: 5 + destinations: + - 'Frankfurt (Main) Flughafen Regionalbahnhof' + - 'Frankfurt (Main) Stadion' + products: + - 'RB' + - 'RE' + - 'Bus' + - 'S' + - station: 3006907 + products: 'Bus' + destinations: ['Wiesbaden Dernsches GelΓ€nde', 'Mainz Hauptbahnhof'] + name: Destination + - station: 3006904 + lines: 'S8' + max_journeys: 5 + products: 'S' +``` + +The first sensor will return S-Bahn, bus, RB and RE trains departures from Frankfurt Hauptbahnhof to Frankfurt Airport or Stadium that are at least 5 minutes away. + +The second sensor returns bus departures from Wiesbaden Hauptbahnhof going to Dernsches GelΓ€nde and Mainz Hauptbahnhof. To retrieve the time of the second departure, you would use states.sensor.ENTITY_NAME.attributes.departures[1].time. + +The third sensor returns all S-Bahn trains from Mainz Hauptbahnhof for line S8. diff --git a/source/_components/sensor.waze_travel_time.markdown b/source/_components/sensor.waze_travel_time.markdown index 484785a1a07..b7398d5217c 100644 --- a/source/_components/sensor.waze_travel_time.markdown +++ b/source/_components/sensor.waze_travel_time.markdown @@ -56,4 +56,8 @@ excl_filter: description: A substring that has to be NOT present in the description of the selected route (a simple case-insensitive matching). required: false type: string +realtime: + description: If this is set to false, Waze returns the time estimate, not including current conditions, but rather the average travel time for the current time of day. The parameter defaults to true, meaning Waze will return real-time travel time. + required: false + type: boolean {% endconfiguration %} diff --git a/source/_components/switch.amcrest.markdown b/source/_components/switch.amcrest.markdown index d9ed4564b22..d494df7b02b 100644 --- a/source/_components/switch.amcrest.markdown +++ b/source/_components/switch.amcrest.markdown @@ -16,3 +16,7 @@ ha_iot_class: "Local Polling" The `amcrest` switch platform lets you control settings of [Amcrest IP Camera](https://home-assistant.io/components/camera.amcrest/) through Home Assistant. Switches will be configured automatically. Please refer to the [component](/components/amcrest/) configuration on how to setup. + ++In previous versions, switch devices in setups with multiple cameras, would not have specific entity ID causing them to change randomly after each Home Assistant restart. The current version adds the name of the camera at the end of the switch entity ID, making it more specific and consistent and causes the name option to be required in a multi-camera system. This behavior matches the sensor behavior of the Amcrest component. Because of this, older automations may require updates to the entity ID. +
diff --git a/source/_components/switch.deconz.markdown b/source/_components/switch.deconz.markdown new file mode 100644 index 00000000000..1b7a1b3e3f8 --- /dev/null +++ b/source/_components/switch.deconz.markdown @@ -0,0 +1,27 @@ +--- +layout: page +title: "deCONZ Switches" +description: "Instructions on how to integrate Zigbee switches from deCONZ into Home Assistant." +date: 2018-07-31 23:32 +sidebar: true +comments: false +sharing: true +footer: true +logo: deconz.jpeg +ha_category: Switch +ha_release: "0.76" +ha_iot_class: "Local Push" +--- + +See the [deCONZ main component](/components/deconz/) for configuration instructions. + +Switches are devices like power plugs and sirens. + +Note that devices in the switch platform identify as lights, so there is a manually curated list that defines which "lights" are switches. + +The `Entity Id` names will be `switch.device_name`, where `device_name` is defined in deCONZ. + +#### {% linkable_title Verified supported switches %} + +- Innr SP120 +- Osram Outdoor plug diff --git a/source/_components/switch.velbus.markdown b/source/_components/switch.velbus.markdown index 6cd0303fde6..10062bddfc1 100644 --- a/source/_components/switch.velbus.markdown +++ b/source/_components/switch.velbus.markdown @@ -15,49 +15,4 @@ ha_release: "0.50" The `velbus` switch allows you to control [Velbus](http://www.velbus.eu) connected switches. -## {% linkable_title Configuration %} - -To use your Velbus switches in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry - -light: - - platform: velbus - devices: - - name: Switch 1 - type: single - module: 0xda - channel: 4 - - name: Switch 2 - type: double - module: 0xbc - open_channel: 1 - close_channel: 2 -``` - -{% configuration %} -devices: - description: The list contains the switches to configure. - required: true - type: map - keys: - name: - description: Name to use in the frontend. - required: true - type: string - module: - description: The hexadecimal module address. - required: true - type: string - channel: - description: The channel number in the module. - required: true - type: string - type: - description: "Either `single` or `double`. If single, only `channel` attribute is required. If `double`, both `open_channel:` and `close_channel:` keys are required." - required: true - type: string -{% endconfiguration %} - For hub configuration, see [the Velbus component](/components/velbus/). diff --git a/source/_components/vacuum.markdown b/source/_components/vacuum.markdown index bcbf2b1ccaa..3df2abbca45 100644 --- a/source/_components/vacuum.markdown +++ b/source/_components/vacuum.markdown @@ -23,7 +23,7 @@ vacuum: ### {% linkable_title Component services %} -Available services: `turn_on`, `turn_off`, `start_pause`, `stop`, `return_to_home`, `locate`, `clean_spot`, `set_fanspeed` and `send_command`. +Available services: `turn_on`, `turn_off`, `start_pause`, `start`, `pause`, `stop`, `return_to_home`, `locate`, `clean_spot`, `set_fanspeed` and `send_command`. Before calling one of these services, make sure your vacuum platform supports it. @@ -51,6 +51,22 @@ Start, pause or resume a cleaning task. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on specific vacuum. Else targets all. | +#### {% linkable_title Service `vacuum.start` %} + +Start or resume a cleaning task. + +| Service data attribute | Optional | Description | +|---------------------------|----------|-------------------------------------------------------| +| `entity_id` | yes | Only act on specific vacuum. Else targets all. | + +#### {% linkable_title Service `vacuum.pause` %} + +Pause a cleaning task. + +| Service data attribute | Optional | Description | +|---------------------------|----------|-------------------------------------------------------| +| `entity_id` | yes | Only act on specific vacuum. Else targets all. | + #### {% linkable_title Service `vacuum.stop` %} Stop the current activity of the vacuum. diff --git a/source/_docs/z-wave/control-panel.markdown b/source/_docs/z-wave/control-panel.markdown index 81ae4b9918b..d3169a41c9f 100644 --- a/source/_docs/z-wave/control-panel.markdown +++ b/source/_docs/z-wave/control-panel.markdown @@ -41,8 +41,6 @@ Since 0.63 and the new experimental [entity registry](/docs/configuration/entity * **Replace Failed Node** will replace a failed device with another. If the node is not in the controller's Failed Node List, or the node responds, this command will fail. * **Print Node** prints all state of Z-Wave node to the console log -* **Rename Node** sets the name of the `zwave` entity - this won't happen immediately, and requires you to restart Home Assistant (not reboot) to set the new name. Other entities of a device are renamed using the [entity registry](/docs/configuration/entity-registry/). - * **Heal Node** starts healing of the node.(Update neighbor list and update return routes) * **Test Node** sends no_op test messages to the node. This could in theory bring back a dead node. @@ -116,7 +114,7 @@ This will display the Z-Wave related information about the node: ### {% linkable_title Node Values %} -Allows you to rename the entities of the node. For example, maybe for the sensor `front_door`, you want to rename the value `seismic_intensity` to `shake`. The `entity_id` for that sensor will then change from `sensor.front_door_seismic_intensity` to `sensor.front_door_shake`. +Contains a list of available values of the selected node, and it's instances. ### {% linkable_title Node group associations %} @@ -142,6 +140,12 @@ You can set the *wakeup* interval (in seconds) of the device, this is shown for Underneath that you can select any supported configuration parameter to see the current setting. You can then change this and select **Set Config Parameter** to updated it. Battery powered devices will be updated the next time they wake. +### {% linkable_title Node protection %} + +If your node has the protection commandclass, you can change the protection level of the node. +Check your device manual on how to use this setting, as it is different between manufacturers. +Set the new selection by pressing the **Set Protection** button. + ## {% linkable_title Node user codes %} If your node has user codes, you can set and delete them. The format is raw hex Ascii code. Below the input you will see your actual code. For normal nodes this is as follows: diff --git a/source/_posts/2018-08-17-release-76.markdown b/source/_posts/2018-08-17-release-76.markdown new file mode 100644 index 00000000000..ed224b333f1 --- /dev/null +++ b/source/_posts/2018-08-17-release-76.markdown @@ -0,0 +1,368 @@ +--- +layout: post +title: "0.76: Auth almost done, FleetGo, PJLink, RMV public transport" +description: "The boys and girls in our virtual HQ have been working hard on creating yet another great release." +date: 2018-08-17 00:01:00 +date_formatted: "August 17, 2018" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Release-Notes +og_image: /images/blog/2018-08-0.76/components.png +--- + ++This release has a migration, initial startup can take ~20 minutes (depends on size DB) +
+ +This release includes a database migration to allow us to store context in the database. This will make it possible in the future to introduce attribution. For example, we'll be able to say which user opened the garage door or which automation triggered the party mode at 3am. + +Split configuration is currently possible directly in Lovelace, but it is expected to be removed in the near future due to fact that Home Assistant @@ -54,10 +58,11 @@ mobile browser. (@Toast) [@dale3h]: https://github.com/dale3h [@thomasloven]: https://github.com/thomasloven - +[@skalavala]: https://github.com/skalavala [config-generator]: https://github.com/thomasloven/homeassistant-lovelace-gen [header-stacks]: https://gist.github.com/dale3h/37b34aebb0c336ffd5fb877c2651097a [horizontal-stack]: /lovelace/horizontal-stack/ [migration-script]: https://github.com/dale3h/python-lovelace [picture-elements]: /lovelace/picture-elements/ [vertical-stack]: /lovelace/vertical-stack/ +[lovelace-jinja]: https://sharethelove.io/tools/jinja-magic-scripts