diff --git a/_config.yml b/_config.yml index f28dd9bef83..da977b8bca4 100644 --- a/_config.yml +++ b/_config.yml @@ -141,14 +141,14 @@ social: # Home Assistant release details current_major_version: 0 -current_minor_version: 78 -current_patch_version: 3 -date_released: 2018-09-22 +current_minor_version: 80 +current_patch_version: 0 +date_released: 2018-09-24 # 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-0783---september-22" +patch_version_notes: "" # Minor release (Example #release-0431---april-25): # Date we moved to Discourse for comments diff --git a/source/_components/camera.logi_circle.markdown b/source/_components/camera.logi_circle.markdown new file mode 100644 index 00000000000..1b525400700 --- /dev/null +++ b/source/_components/camera.logi_circle.markdown @@ -0,0 +1,69 @@ +--- +layout: page +title: "Logi Circle Camera" +description: "Instructions on how to integrate your Logi Circle cameras within Home Assistant." +date: 2018-09-08 11:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: logi_circle.png +ha_category: Camera +ha_release: 0.79 +ha_iot_class: "Cloud Polling" +--- + +The `logi_circle` camera platform allows you to watch the still frames of your [Logi Circle](https://circle.logi.com/) camera's live stream in Home Assistant. + +
+You must have the [Logi Circle component](/components/logi_circle/) configured to use this camera platform. +
+ +Logi Circle cameras support the `camera.turn_on` and `camera.turn_off` services. This will set the streaming mode property of your camera accordingly, controlling whether the live stream is available and activity recordings are captured. + +## {% linkable_title Configuration %} + +Once you have enabled the [Logi Circle component](/components/logi_circle), add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +camera: + - platform: logi_circle +``` + +Configuration variables: + +- **scan_interval**: (*Optional*): How frequently to query for new camera stills. Defaults to 60 seconds. + +### {% linkable_title Service `camera.logi_circle_livestream_record` %} + +Initiates a recording of the camera's live stream. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | Name(s) of entities to initiate a recording for, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. | +| `filename ` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}.mp4`{% endraw %}. | +| `duration` | no | Duration of recording, in seconds. + +The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file. + +### {% linkable_title Service `camera.logi_circle_livestream_snapshot` %} + +Take a snapshot from a camera's live stream. This differs from the generic [snapshot](/components/camera/#service-snapshot) service in that it sources the snapshot from the camera's live stream. For battery powered devices, this will wake your camera from sleep to perform this action. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | Name(s) of entities to create a live stream snapshot from, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. | +| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}.jpg`{% endraw %}. | + +The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file. + +### {% linkable_title Service `camera.logi_circle_set_config` %} + +Sets an configuration property for your camera. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | Name(s) of entities to set the operation mode for, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. | +| `mode` | no | Configuration property to set. Allowed values: `BATTERY_SAVING`, `LED`, `PRIVACY_MODE` | +| `value` | no | Mode value. Allowed values: `true`, `false` | \ No newline at end of file diff --git a/source/_components/camera.mqtt.markdown b/source/_components/camera.mqtt.markdown index f0e903a37a9..411a37d19de 100644 --- a/source/_components/camera.mqtt.markdown +++ b/source/_components/camera.mqtt.markdown @@ -30,4 +30,5 @@ Configuration variables: - **topic** (*Required*): MQTT topic to subscribe to. - **name** (*Optional*): Name of the camera + - **unique_id** (*Optional*): An ID that uniquely identifies this camera. If two cameras have the same unique ID, Home Assistant will raise an exception. diff --git a/source/_components/cover.deconz.markdown b/source/_components/cover.deconz.markdown new file mode 100644 index 00000000000..1b721a581c1 --- /dev/null +++ b/source/_components/cover.deconz.markdown @@ -0,0 +1,26 @@ +--- +layout: page +title: "deCONZ Covers" +description: "Instructions on how to integrate Zigbee covers from deCONZ into Home Assistant." +date: 2018-09-20 23:32 +sidebar: true +comments: false +sharing: true +footer: true +logo: deconz.jpeg +ha_category: Cover +ha_release: "0.79" +ha_iot_class: "Local Push" +--- + +See the [deCONZ main component](/components/deconz/) for configuration instructions. + +Covers are devices like ventilation dampers. + +Note that devices in the cover platform identify as lights, so there is a manually curated list that defines which "lights" are covers. + +The `entity_id` name will be `cover.device_name`, where `device_name` is defined in deCONZ. + +#### {% linkable_title Verified supported covers %} + +- Keen vents diff --git a/source/_components/cover.markdown b/source/_components/cover.markdown index a530768096f..f276c9b398a 100644 --- a/source/_components/cover.markdown +++ b/source/_components/cover.markdown @@ -15,7 +15,7 @@ The display style of each entity can be modified in the [customize section](/get | Attribute | Default | Description | | --------- | ------- | ----------- | -| `device_class` | | `none` Generic cover device-Bbox is a generic name for different hardware routers. The platform has only been tested on a Sagem F@st 5330b because it's the only model the developer owns. -
+Bbox is a generic name for different hardware routers. The platform has been tested with the following devices: + +- Sagem F@st 5330b + +## {% linkable_title Configuration %} To use an Bbox router in your installation, add the following to your `configuration.yaml` file: @@ -28,8 +30,17 @@ device_tracker: - platform: bbox ``` +{% configuration %} +host: + description: IP address of your Bbox device. + required: false + type: string + default: 192.168.1.254 +{% endconfiguration %} + +-For now and due to third party limitation, the Bbox must be on the same local network as the Home Assistant installation. And with the default IP configuration (IP of the router must be 192.168.1.254). +For now and due to third party limitation, the Bbox must be on the same local network as the Home Assistant installation.
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.bluetooth_le_tracker.markdown b/source/_components/device_tracker.bluetooth_le_tracker.markdown index ce1dab50002..83c21c615b7 100644 --- a/source/_components/device_tracker.bluetooth_le_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_le_tracker.markdown @@ -13,10 +13,6 @@ ha_iot_class: "Local Poll" ha_release: 0.27 --- --We have received numerous reports that this integration will have a big impact on the performance of the server. -
- This tracker discovers new devices on boot and in regular intervals and tracks Bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other. Devices discovered are stored with 'BLE_' as the prefix for device mac addresses in `known_devices.yaml`. @@ -24,7 +20,7 @@ Devices discovered are stored with 'BLE_' as the prefix for device mac addresses This platform requires pybluez to be installed. On Debian based installs, run ```bash -$ sudo apt install bluetooth libbluetooth-dev pkg-config libboost-python-dev libboost-thread-dev libglib2.0-dev python-dev +$ sudo apt install bluetooth ``` Before you get started with this platform, please note that: @@ -42,9 +38,7 @@ device_tracker: Configuration variables: -- **device_id** (*Optional*): The device ID for the Bluetooth device to be used for tracking. Defaults to `hci0`. - **track_new_devices** (*Optional*): If new discovered devices are tracked by default. Defaults to `True`. -- **scan_duration** (*Optional*): How long should the scanner be looking for BLE devices. Defaults to `10` seconds. - **interval_seconds** (*Optional*): Seconds between each scan for new devices. Defaults to `12` seconds. As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times. @@ -59,12 +53,6 @@ $ sudo apt-get install libcap2-bin $ sudo setcap 'cap_net_raw,cap_net_admin+eip' `readlink -f \`which python3\`` ``` -If you have installed Home Assistant with [AIO](/getting-started/installation-raspberry-pi-all-in-one/), you need to do the following command, this will grant access to Home Assistant to run the required command. - -```bash -$ sudo setcap cap_net_raw,cap_net_admin+eip /srv/homeassistant/homeassistant_venv/bin/python3 -``` - A restart of Home Assistant is required. For additional configuration variables check the [Device tracker page](/components/device_tracker/). diff --git a/source/_components/device_tracker.huawei_lte.markdown b/source/_components/device_tracker.huawei_lte.markdown new file mode 100644 index 00000000000..7beb8c788cc --- /dev/null +++ b/source/_components/device_tracker.huawei_lte.markdown @@ -0,0 +1,32 @@ +--- +layout: page +title: "Huawei LTE Router Device Tracker" +description: "Instructions on how to use Huawei LTE routers to track devices within Home Assistant." +date: 2018-09-08 20:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: huawei.svg +ha_category: Presence Detection +ha_release: 0.79 +--- + + +This platform offers presence detection by looking at connected devices to a [Huawei LTE router](https://consumer.huawei.com/en/smart-home/). + +This requires you to have set up the [Huawei LTE component](/components/huawei_lte/). + +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your +`configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +device_tracker: + - platform: huawei_lte +``` + +See the [device tracker component page](/components/device_tracker/) +for instructions how to configure the people to be tracked. diff --git a/source/_components/edp_redy.markdown b/source/_components/edp_redy.markdown new file mode 100644 index 00000000000..ed1bbdef7fe --- /dev/null +++ b/source/_components/edp_redy.markdown @@ -0,0 +1,45 @@ +--- +layout: page +title: "EDP re:dy" +description: "Instructions on how to integrate the EDP re:dy platform into Home Assistant." +date: 2018-09-04 16:30 +sidebar: true +comments: false +sharing: true +footer: true +logo: edp_redy.png +ha_category: Hub +ha_release: "0.79" +ha_iot_class: "Cloud Polling" +--- + +[EDP re:dy](https://www.edp.pt/particulares/servicos/redy/) is a Home Automation platform from Portuguese energy provider EDP, that allows control of appliances and other devices, as well as monitoring power consumption. This component allows integrating EDP re:dy into Home Assistant. + +## {% linkable_title Configuration %} + +You will need your re:dy login information (username and password) to use this component. + +To set it up, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +edp_redy: + username: YOUR_USERNAME + password: YOUR_PASSWORD +``` + +{% configuration %} +username: + description: The username for accessing your re:dy account. + required: true + type: string +password: + description: The password for accessing your re:dy account. + required: true + type: string +{% endconfiguration %} + +After configuring the component, it will automatically add to Home Assistant: + +* A switch per toggleable device (switch, plug, etc). +* A sensor per each device that reports power consumption (SmartMeter, plug, meter) diff --git a/source/_components/geo_location.geo_json_events.markdown b/source/_components/geo_location.geo_json_events.markdown new file mode 100644 index 00000000000..3be0ccc2fb2 --- /dev/null +++ b/source/_components/geo_location.geo_json_events.markdown @@ -0,0 +1,57 @@ +--- +layout: page +title: "GeoJSON Events" +description: "Instructions on how to integrate GeoJSON feeds into Home Assistant." +date: 2018-09-19 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: geo_location.png +ha_category: Geo Location +ha_iot_class: "Cloud Polling" +ha_release: "0.79" +--- + +The `geo_json_events` platform lets you integrate GeoJSON feeds. It retrieves events from a feed and shows information of those events filtered by distance to Home Assistant's location. +All entries in the GeoJSON feed must define a `geometry` which typically is a point or polygon with geo coordinates. In addition, this platform will look for a `title` key in the entry's `properties` and use that as the entity's name. + +Entities are generated, updated and removed automatically with each update from the GeoJSON feed. Each entity defines latitude and longitude and will be shown on the map automatically. The distance in kilometers is available as the state of each entity. + +The data is updated every 5 minutes. + +## {% linkable_title Configuration %} + +To integrate a GeoJSON feed, add the following lines to your `configuration.yaml`. This is an example configuration showing [earthquake data provided by the U.S. Geological Survey](https://earthquake.usgs.gov/earthquakes/feed/v1.0/geojson.php). + +```yaml +# Example configuration.yaml entry +geo_location: + - platform: geo_json_events + url: https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_day.geojson +``` + +{% configuration %} +url: + description: Full URL of the GeoJSON feed. + required: true + type: string +radius: + description: The distance in kilometers around the Home Assistant's coordinates in which events are considered. + required: false + type: string + default: 20km +{% endconfiguration %} + +## {% linkable_title Advanced Configuration Example %} + +When integrating several GeoJSON feeds, it may be useful to distinguish the entities of different feeds. The easiest way to do that is by defining an [`entity_namespace`](/docs/configuration/platform_options/#entity-namespace/) for each platform which will prefix each entity ID with the defined value. + +```yaml +# Example configuration.yaml entry +geo_location: + - platform: geo_json_events + url: https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_day.geojson + radius: 250 + entity_namespace: 'usgs_earthquakes' +``` diff --git a/source/_components/geo_location.markdown b/source/_components/geo_location.markdown index 2990c019514..c77243971a8 100644 --- a/source/_components/geo_location.markdown +++ b/source/_components/geo_location.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Other +logo: geo_location.png ha_release: "0.78" --- diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index 74bb8a7c48a..b1ea53ff54d 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -272,6 +272,7 @@ The following components are currently supported: | sensor | TemperatureSensor | All sensors that have `Celsius` or `Fahrenheit` as their `unit_of_measurement` or `temperature` as their `device_class`. | | sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. | | sensor | AirQualitySensor | All sensors that have `pm25` as part of their `entity_id` or `pm25` as their `device_class` | +| sensor | CarbonMonoxideSensor | All sensors that have `co` as their `device_class` | | sensor | CarbonDioxideSensor | All sensors that have `co2` as part of their `entity_id` or `co2` as their `device_class` | | sensor | LightSensor | All sensors that have `lm` or `lx` as their `unit_of_measurement` or `illuminance` as their `device_class` | | switch | Switch | Represented as a switch by default but can be changed by using `type` within `entity_config`. | diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index 2a4c981e2e0..42ee4b27e2a 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -65,9 +65,11 @@ authtoken: - homematicip_cloud.binary_sensor - Window and door contact (*HmIP-SWDO*) - - Smoke sensor and alarm (*HmIP-SWSD*) + - Rotary Handle Sensor (*HmIP-SRH*) + - Smoke sensor and alarm (*HmIP-SWSD*) - Motion detectors (*HmIP-SMI*) - Motion detectors and push button (*HmIP-SMI55*) + - Water detector (*HmIP-SWD*) - homematicip_cloud.climate - Radiator thermostat (*HmIP-eTRV,-2*) @@ -82,6 +84,7 @@ authtoken: - Wall-mounted thermostat (*HmIP-WTH*) - Temperature and humidity sensor (*HmIP-STH*) - Temperature and humidity Sensor with display (*HmIP-STHD*) + - Outdoor temperature and humidity sensor (*HmIP-STHO*) - Illuminance sensor (*HmIP-SMI, 55*) - homematicip_cloud.switch diff --git a/source/_components/huawei_lte.markdown b/source/_components/huawei_lte.markdown new file mode 100644 index 00000000000..7d6afd4afa6 --- /dev/null +++ b/source/_components/huawei_lte.markdown @@ -0,0 +1,49 @@ +--- +layout: page +title: "Huawei LTE Routers" +description: "Instructions on how to integrate Huawei LTE routers with Home Assistant." +date: 2018-09-08 20:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: huawei.svg +ha_category: Network +ha_release: 0.79 +--- + +The Huawei LTE router integration for Home Assistant allows you to observe +and control [Huawei LTE routers](https://consumer.huawei.com/en/smart-home/). + +The integration provides: + +* a sensor with device, signal, and traffic information +* a device tracker for connected devices + +## {% linkable_title Configuration %} + +To enable the component, add the following lines to your +`configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +huawei_lte: + - url: http://192.168.100.1/ + username: YOUR_USERNAME + password: YOUR_PASSWORD +``` + +{% configuration %} +url: + description: URL of the router web interface. + required: true + type: url +username: + description: The username used for the router web interface. + required: true + type: string +password: + description: The password used for the router web interface. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/konnected.markdown b/source/_components/konnected.markdown index 67ac706e43b..1467787a493 100644 --- a/source/_components/konnected.markdown +++ b/source/_components/konnected.markdown @@ -83,6 +83,11 @@ devices: description: The name of the device used in the front end. required: false default: automatically generated + inverse: + type: boolean + description: Inverts the open/closed meaning of a binary sensor circuit. Commonly needed for normally open wired smoke alarm circuits. + required: false + default: false switches: description: A list of actuators (on/off switches) connected to the device. See [Konnected Switch](/components/switch.konnected/) for configuration variables. required: false @@ -133,6 +138,7 @@ konnected: - zone: 2 type: smoke name: 'Bedroom Smoke Detector' + inverse: true - zone: 3 type: motion name: 'Test Motion' @@ -182,6 +188,9 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use ### {% linkable_title Revision History %} +#### 0.79 +* Added `inverse` configuration option for binary sensors. + #### 0.77 * Added support for momentary and beep/blink switches. [[#15973](https://github.com/home-assistant/home-assistant/pull/15973)] * Decouple entity initialization from discovery, enabling devices to recover faster after a Home Assistant reboot. [[#16146](https://github.com/home-assistant/home-assistant/pull/16146)] diff --git a/source/_components/light.mqtt_json.markdown b/source/_components/light.mqtt_json.markdown index 6e70c8be891..cd4f65737e5 100644 --- a/source/_components/light.mqtt_json.markdown +++ b/source/_components/light.mqtt_json.markdown @@ -56,6 +56,10 @@ name: required: false type: string default: MQTT JSON Light +unique_id: + description: An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception. + required: false + type: string command_topic: description: The MQTT topic to publish commands to change the light’s state. required: true @@ -262,4 +266,4 @@ Home Assistant expects the hue values to be in the range 0 to 360 and the satura - [esphomelib](https://github.com/OttoWinter/esphomelib) is a library for ESP8266 and ESP32 boards that has many of Home Assistant's MQTT features (like [discovery](/docs/mqtt/discovery/)) pre-implemented and provides high-level abstractions for components such as lights or sensors. -- [AiLight](https://github.com/stelgenhof/AiLight) is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the [MQTT JSON light](/components/light.mqtt_json/) platform and supports ON/OFF, RGBW colours, brightness, colour temperature, flashing and transitions. Also it includes [MQTT Auto Discovery](/docs/mqtt/discovery/)) and the MQTT Last Will and Testament is enabled as well. \ No newline at end of file +- [AiLight](https://github.com/stelgenhof/AiLight) is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the [MQTT JSON light](/components/light.mqtt_json/) platform and supports ON/OFF, RGBW colours, brightness, colour temperature, flashing and transitions. Also it includes [MQTT Auto Discovery](/docs/mqtt/discovery/)) and the MQTT Last Will and Testament is enabled as well. diff --git a/source/_components/light.yeelight.markdown b/source/_components/light.yeelight.markdown index 83b1fda3353..d5d5adb4e80 100644 --- a/source/_components/light.yeelight.markdown +++ b/source/_components/light.yeelight.markdown @@ -28,7 +28,7 @@ light: name: Living Room transition: 1000 use_music_mode: True #(defaults to False) - save_on_change: False #(defaults to True) + save_on_change: True #(defaults to False) 192.168.1.13: name: Front Door ``` @@ -39,7 +39,7 @@ Configuration variables: - **name** (*Optional*): A friendly name for the device. - **transition** (*Optional*, default 350): Smooth transitions over time (in ms). - **use_music_mode** (*Optional*, default False): Enable music mode. -- **save_on_change** (*Optional*, default True): Saves the bulb state when changed from Home Assistant. +- **save_on_change** (*Optional*, default False): Saves the bulb state in its nonvolatile memory when changed from Home Assistant. #### {% linkable_title Music mode %} Per default the bulb limits the amount of requests per minute to 60, a limitation which can be bypassed by enabling the music mode. In music mode the bulb is commanded to connect back to a socket provided by the component and it tries to keep the connection open, which may not be wanted in all use-cases. diff --git a/source/_components/logi_circle.markdown b/source/_components/logi_circle.markdown new file mode 100644 index 00000000000..5b891755da2 --- /dev/null +++ b/source/_components/logi_circle.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "Logi Circle" +description: "Instructions on how to integrate your Logi Circle cameras within Home Assistant." +date: 2018-09-08 11:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: logi_circle.png +ha_category: Camera +ha_release: 0.79 +ha_iot_class: "Cloud Polling" +--- + +The `logi_circle` implementation allows you to integrate your [Logi Circle](https://circle.logi.com/) cameras in Home Assistant. + +## {% linkable_title Configuration %} + +To integrate cameras linked with your [Logi Circle](https://circle.logi.com/) account, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +logi_circle: + username: YOUR_USERNAME + password: YOUR_PASSWORD +``` + +{% configuration %} +username: + description: The username for accessing your Logi Circle account. + required: true + type: string +password: + description: The password for accessing your Logi Circle account. + required: true + type: string +{% endconfiguration %} + +Finish its configuration by visiting the [Logi Circle camera](/components/camera.logi_circle/) or [Logi Circle sensor](/components/sensor.logi_circle/) documentation. diff --git a/source/_components/mailbox.asterisk_cdr.markdown b/source/_components/mailbox.asterisk_cdr.markdown new file mode 100644 index 00000000000..61597bdfeff --- /dev/null +++ b/source/_components/mailbox.asterisk_cdr.markdown @@ -0,0 +1,15 @@ +--- +layout: page +title: "Asterisk Call Data Recorder" +description: "Instructions on how to integrate an Asterisk CDR within Home Assistant." +date: 2018-09-12 06:30 +sidebar: true +comments: false +sharing: true +footer: true +logo: asterisk.png +ha_category: Mailbox +ha_release: 0.79 +--- + +The Asterisk Call Data Recorder provides access to Asterisk call logs on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail component](/components/asterisk_mbox/) configuration if the `asterisk_mbox_server` is configured to provide CDR data. More information on configuring the server can be found in the [Asterisk PBX configuration guide](/docs/asterisk_mbox/). diff --git a/source/_components/notify.nfandroidtv.markdown b/source/_components/notify.nfandroidtv.markdown index e1bf8659ba8..6ec1639edb2 100644 --- a/source/_components/notify.nfandroidtv.markdown +++ b/source/_components/notify.nfandroidtv.markdown @@ -10,15 +10,14 @@ footer: true logo: nfandroidtv.png ha_category: Notifications ha_release: 0.32 -ha_iot_class: "Local Polling" --- -Notification platform for [Notifications for Android TV](https://play.google.com/store/apps/details?id=de.cyberdream.androidtv.notifications.google) and [Notifications for FireTV](https://play.google.com/store/apps/details?id=de.cyberdream.firenotifications.google). +Notification platform for [Notifications for Android TV](https://play.google.com/store/apps/details?id=de.cyberdream.androidtv.notifications.google) and [Notifications for FireTV](https://play.google.com/store/apps/details?id=de.cyberdream.firenotifications.google). You can use this plarform to send notifications to your Android TV device. An overlay with the message content will appear for a configurable amount of seconds and then disapper again. Sending images (e.g. security cam) is supported too. The notifications are in the global scope of your Android TV device. They will be displayed regardless of which application is running. -When setting this up be aware, that there are two apps: one for your smartphone to send notifications (not required for this platform) and one for your Android TV device to receive the notifications. The app available in the store of your target device is the one that is needed to display notifications sent from Home Assistant. The In-App purchases only apply to the client for Android smartphones, so there isn't any limit when pushing notifications from Home Assistant. +When setting this up be aware, that there are two apps: one for your smartphone to send notifications (not required for this platform) and one for your Android TV device to receive the notifications. The app available in the store of your Android TV device is the one that is needed to display notifications sent from Home Assistant. The In-App purchases only apply to the client for Android smartphones, so there isn't any limit when pushing notifications from Home Assistant. To enable the notification platform, add the following to your `configuration.yaml` file: @@ -35,6 +34,7 @@ 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`. - **host** (*Required*): IP address of the Android TV / FireTV device. - **duration** (*Optional*): The duration in seconds for which the notification will be displayed. Default is 5 seconds. +- **fontsize** (*Optional*): Has to be one of: small, medium (default), large, max - **position** (*Optional*): Has to be one of: bottom-right (default), bottom-left, top-right, top-left, center - **color** (*Optional*): Has to be one of: grey (default), black, indigo, green, red, cyan, teal, amber, pink - **transparency** (*Optional*): Has to be one of: 0%, 25% (default), 50%, 75%, 100% @@ -48,6 +48,7 @@ This is a fully customized JSON you can use to test how the final notification w "message": "Messagetext", "title": "My Notification", "data":{ + "fontsize": "large", "position":"center", "duration":2, "transparency":"0%", @@ -56,3 +57,48 @@ This is a fully customized JSON you can use to test how the final notification w } } ``` + +### {% linkable_title Service data for sending images %} + +The following attributes can be placed inside `data` to send images. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `file` | yes | Groups the attributes for file upload. If present, either `url` or `path` have to be provided. +| `path ` | yes | Local path of an image file. Is placed inside `file`. +| `url` | yes | URL of an image file. Is placed inside `file`. +| `username` | yes | Username if the url requires authentication. Is placed inside `file`. +| `password` | yes | Password if the url requires authentication. Is placed inside `file`. +| `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing, HTTP-BASIC-Authentication is used. Is placed inside `file`. + +Example for posting file from URL: + +```json +{ + "message":"Messagetext", + "title":"My Notification", + "data":{ + "file":{ + "url":"http://[url to image file]", + "username":"optional user, if necessary", + "password":"optional password, if necessary", + "auth":"digest" + } + } +} +``` + +Example for posting file from local path: + +```json +{ + "message":"Messagetext", + "title":"My Notification", + "data":{ + "file":{ + "path":"/path/to/file.ext" + } + } +} +``` +Please note that `path` is validated against the `whitelist_external_dirs` in the `configuration.yaml`. diff --git a/source/_components/sensor.edp_redy.markdown b/source/_components/sensor.edp_redy.markdown new file mode 100644 index 00000000000..4071a509467 --- /dev/null +++ b/source/_components/sensor.edp_redy.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "EDP re:dy Sensor" +description: "Instructions on how to integrate the EDP re:dy sensors into Home Assistant." +date: 2018-09-04 16:30 +sidebar: true +comments: false +sharing: true +footer: true +logo: edp_redy.png +ha_category: Sensor +ha_release: "0.79" +ha_iot_class: "Cloud Polling" +--- + +See the [EDP re:dy main component](/components/edp_redy/) for configuration instructions. + +This sensor platform will provide a sensor per each EDP re:dy device that reports power consumption (SmartMeter, plug, meter). \ No newline at end of file diff --git a/source/_components/sensor.huawei_lte.markdown b/source/_components/sensor.huawei_lte.markdown new file mode 100644 index 00000000000..682d3bc0518 --- /dev/null +++ b/source/_components/sensor.huawei_lte.markdown @@ -0,0 +1,51 @@ +--- +layout: page +title: "Huawei LTE Router Sensor" +description: "Instructions on how to integrate Huawei LTE router sensors into Home Assistant." +date: 2018-09-08 20:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: huawei.svg +ha_category: Network +ha_iot_class: "Local Polling" +ha_release: 0.79 +--- + +The `huawei_lte` sensor platform allows you to monitor Huawei LTE routers. + +This requires you to have set up the [Huawei LTE component](/components/huawei_lte/). + +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your +`configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: huawei_lte + monitored_conditions: + - device_information.SoftwareVersion + - device_signal.rssi + - traffic_statistics.CurrentDownloadRate + - traffic_statistics.TotalConnectTime +``` + +Configuration variables: + +**monitored_conditions** array (*Optional*): Defines the data to monitor as sensors. Defaults to a few generally available data items expected to be available on most boxes. The names here are dot separated paths to information returned by the router. The data set varies by router model; to see what your router provides, set logging level to debug and watch homeassistant.components.huawei_lte debug entries. The following list contains a few example paths just to illustrate the syntax; these may not be available on all routers or their semantics may differ, and there are quite likely many more that are not listed here. + + - **device_information.SoftwareVersion**: Software version. + - **device_information.WanIPAddress**: WAN interface IP address. + - **device_information.WanIPv6Address**: WAN interface IP address. + - **device_signal.rsrq**: The signal RSRQ value. + - **device_signal.rsrp**: The signal RSRP value. + - **device_signal.rssi**: The signal RSSI value. + - **device_signal.sinr**: The signal SINR value. + - **traffic_statistics.CurrentDownloadRate**: Current download rate, bytes/sec. + - **traffic_statistics.CurrentUploadRate**: Current upload rate, bytes/sec. + - **traffic_statistics.TotalUpload**: Total bytes uploaded since last reset. + - **traffic_statistics.TotalDownload**: Total bytes downloaded since last reset. + - **traffic_statistics.TotalConnectTime**: Total time connected since last reset. diff --git a/source/_components/sensor.ios.markdown b/source/_components/sensor.ios.markdown index e69de29bb2d..a1fce7f74f8 100644 --- a/source/_components/sensor.ios.markdown +++ b/source/_components/sensor.ios.markdown @@ -0,0 +1,17 @@ +--- +layout: page +title: "iOS" +description: "Instructions on how to use the iOS sensors with Home Assistant." +date: 2018-04-06 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: apple.png +ha_category: Sensor +featured: false +ha_release: 0.31 +ha_iot_class: push +--- + +The `ios` component is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details. diff --git a/source/_components/sensor.jewish_calendar.markdown b/source/_components/sensor.jewish_calendar.markdown new file mode 100644 index 00000000000..42a4c53ad8b --- /dev/null +++ b/source/_components/sensor.jewish_calendar.markdown @@ -0,0 +1,103 @@ +--- +layout: page +title: "Jewish Calendar" +description: "Instructions on how to integrate the Jewish Calendar sensor within Home Assistant." +date: 2018-09-09 00:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Calendar +ha_iot_class: "Local Poll" +ha_release: "0.79" +--- + +The Jewish Calendar (`jewish_calendar`) sensor platform displays a variety of information related to the Jewish Calendar as a variety of sensors. + +## {% linkable_title Configuration %} + +To enable this sensor in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: jewish_calendar +``` + +{% configuration %} +language: + required: false + default: hebrew + description: Whether to represent the sensors in Hebrew (א' תשרי תשע"ט) or English characters (1 Tishri 5779). + type: string +latitude: + required: false + description: Latitude for time calculations of the sensor. + default: Home Assistant location + type: int +longitude: + required: false + description: Longitude for time calculations of the sensor. + default: Home Assistant location + type: int +disapora: + required: false + description: Consider the location as diaspora or not for calculation of the weekly portion and holidays. + default: False + type: string +sensors: + required: false + default: date + description: List of available sensors. + keys: + date: + description: Show the hebrew date for today. + weekly_portion: + description: Show the weekly portion (parshat hashavu'a) - _At the moment only shows up on Saturday's_. + holiday_name: + description: If it is a holiday, show the name of the holiday. + holyness: + description: On a scale of 1 to 9 show the level of holyness _(see below)_. + first_light: + description: First light of dawn (Alot Hashachar - עלות השחר). + gra_end_shma: + description: Last time for reading of the Shma according to the GR"A. + mga_end_shma: + description: Last time for reading of the Shma according to the MG"A. + plag_mincha: + description: Time of the Plag Hamincha. + first_stars: + description: Time at which the first stars are visible (Tset Hakochavim - צאת הכוכבים). +{% endconfiguration %} + +### {% linkable_title Holyness levels %} + +1. Mido'rayta - by Torah ordination (Rosh Hashana, Yom Kippur, Pesach, Shavuot, Sukkot) +2. Erev Yom Kippur +3. Hol Hamo'ed +4. Hanukka and Purim +5. Fast days +6. Yom Yerushalayim and Yom Haatsmaut +7. Lag ba'omer and Tu bishvat +8. Memorial days: yom hazikaron and yom hashoah +9. Days mentioned by the Israeli parliament: Rabin memorial day, Ze'ev Zhabotinsky day, etc. + +## {% linkable_title Full configuration sample %} + +```yaml +# Example configuration.yaml entry +sensor: + - platform: jewish_calendar + language: english + disapora: True + sensors: + - date + - weekly_portion + - holiday_name + - holyness + - first_light + - gra_end_shma + - mga_end_shma + - plag_mincha + - first_stars +``` diff --git a/source/_components/sensor.linky.markdown b/source/_components/sensor.linky.markdown new file mode 100644 index 00000000000..a6f60920053 --- /dev/null +++ b/source/_components/sensor.linky.markdown @@ -0,0 +1,41 @@ +--- +layout: page +title: "Linky Sensor" +description: "Instructions on how to integrate Linky daily data within Home Assistant." +date: 2018-09-06 08:35 +sidebar: true +comments: false +sharing: true +footer: true +logo: enedis.png +ha_release: 0.79 +ha_category: Energy +ha_iot_class: "Cloud Polling" +--- + + +The `linky` sensor platform is showing the last day consumption of your home from the [Linky electric meter](https://www.enedis.fr/english). + +## {% linkable_title Configuration %} + +To add the Linky sensor to your installation, add your Enedis account credentials to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: linky + username: YOUR_LINKY_USERNAME + password: YOUR_LINKY_PASSWORD +``` + +{% configuration %} +username: + description: The Enedis account username. + required: true + type: string +password: + description: The Enedis account password. + required: true + type: string +{% endconfiguration %} + diff --git a/source/_components/sensor.logi_circle.markdown b/source/_components/sensor.logi_circle.markdown new file mode 100644 index 00000000000..aa42c0218c8 --- /dev/null +++ b/source/_components/sensor.logi_circle.markdown @@ -0,0 +1,43 @@ +--- +layout: page +title: "Logi Circle Sensor" +description: "Instructions on how to integrate your Logi Circle cameras within Home Assistant." +date: 2018-09-08 11:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: logi_circle.png +ha_category: Camera +ha_release: 0.79 +ha_iot_class: "Cloud Polling" +--- + +The `logi_circle` sensor platform lets you monitor sensors connected to your [Logi Circle](https://circle.logi.com) cameras in Home Assistant. + ++You must have the [Logi Circle component](/components/logi_circle/) configured to use this sensor platform. +
+ +## {% linkable_title Configuration %} + +Once you have enabled the [Logi Circle component](/components/logi_circle), add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: logi_circle +``` + +Configuration variables: + +- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions supported by your camera will be enabled. + - **battery_level**: Return the battery level percentage from the camera. + - **last_activity_time**: Return the timestamp from the last time the Logi Circle camera detected any activity. + - **privacy_mode**: Return the privacy mode status from the camera. + - **signal_strength_category**: Return the WiFi signal level from the camera. + - **signal_strength_percentage**: Return the WiFi signal percentage from the camera. + - **speaker_volume**: Return the relative speaker volume from the camera (0-100%). + - **streaming_mode**: Return the streaming mode status from the camera. + +Currently it supports all 1st and 2nd generation cameras. Cameras without an internal battery will not expose a `battery_level` sensor. \ No newline at end of file diff --git a/source/_components/sensor.netdata.markdown b/source/_components/sensor.netdata.markdown index 6cf4c3e1d86..0a1a4df622d 100644 --- a/source/_components/sensor.netdata.markdown +++ b/source/_components/sensor.netdata.markdown @@ -51,9 +51,11 @@ To add this platform to your installation, add the following to your `configurat sensor: - platform: netdata resources: - system.load: + load: + data_group: system.load element: load15 - system.cpu: + cpu: + data_group: system.cpu element: system ``` @@ -78,19 +80,19 @@ resources: required: true type: map keys: - data_group: - description: "Name of the data group to monitor, e.g., `system.cpu`." + name: + description: Name to use for the sensor in the frontend. required: true + type: string keys: + data_group: + description: "Name of the data group to monitor, e.g., `system.cpu`." + required: true + type: string element: description: The element of the group to monitor. required: true type: string - name: - description: Name to use for the sensor in the frontend. - required: false - type: string - default: element name icon: description: Icon to use for the sensor. required: false diff --git a/source/_components/sensor.starlingbank.markdown b/source/_components/sensor.starlingbank.markdown new file mode 100644 index 00000000000..e997e0da2a3 --- /dev/null +++ b/source/_components/sensor.starlingbank.markdown @@ -0,0 +1,80 @@ +--- +layout: page +title: "Starling Bank" +description: "How to integrate your Starling Bank account within Home Assistant." +date: 2018-09-07 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: starlingbank.png +ha_category: Finance +featured: false +ha_release: "0.79" +ha_iot_class: "Cloud Polling" +--- + +The Starling Bank sensor platform allows you to monitor your account balance data as sensors in Home Assistant. + +* Turn off the lights when money's tight? +* Play a song when you reach a savings goal? +* Sound an alarm if you go into your overdraft? + +You can find more information about Starling Bank at [their website](https://www.starlingbank.com/). Information on their API can be found on their [developers site](https://developer.starlingbank.com/). + +## {% linkable_title Access Token %} + +Once you have your own Starling bank account you will need to sign up for a Staring developer account [here](https://developer.starlingbank.com/signup). You won't need to do any development but you will need to get a "Personal Access Token" that will allow the integration to access your account balance. + ++ You control what access is granted using this token. This integration only needs very basic access (see below). +
+ +Once you've signed up: +1. Head to the [Personal Access Section](https://developer.starlingbank.com/personal/token) of your developer account. +2. Click "Create Token". +3. Give your token a name e.g. "Home Assistant". +4. Tick the permissions "account:read" and "balance:read". The others you can leave un-ticked. +5. Click "Create" and make a note of the newly created token, you will need this for your Home Assistant configuration. + +## {% linkable_title Configuration %} + +To add Starling account balance sensors to your installation, add the following to your `configuration.yaml` file: +```yaml +# Example configuration.yaml entry +sensor: + - platform: starlingbank + accounts: + - access_token: YOUR_PERSONAL_ACCESS_TOKEN +``` + +{% configuration %} +accounts: + description: A list of Starling accounts. Allows you to monitor multiple Starling accounts. + required: true + type: list +name: + description: A friendly name for your account. + required: false + type: string + default: Starling +sandbox: + description: For test purposes. Set to true if you are using an access token for a sandbox Starling account. + required: false + default: false + type: boolean +access_token: + description: Your personal access token. + required: true + type: string +balance_types: + description: Choose to monitor your cleared or effective balance (or both). + required: false + type: list + default: Both balance types will be monitored. + keys: + cleared_balance: + description: Excludes outstanding transactions. + effective_balance: + description: Includes outstanding transactions. +{% endconfiguration %} diff --git a/source/_components/sensor.tibber.markdown b/source/_components/sensor.tibber.markdown index 3e71d8fc2a5..7e022d81368 100644 --- a/source/_components/sensor.tibber.markdown +++ b/source/_components/sensor.tibber.markdown @@ -14,6 +14,7 @@ ha_iot_class: "Cloud Polling" --- The `tibber` sensor provides the current electricity price if you are a [Tibber](https://tibber.com/) customer. +If you have a Tibber Pulse it will also show the electricity consumption in real time. To add Tibber to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.velbus.markdown b/source/_components/sensor.velbus.markdown index 7ec537b6e57..56233e50c8a 100644 --- a/source/_components/sensor.velbus.markdown +++ b/source/_components/sensor.velbus.markdown @@ -13,6 +13,6 @@ ha_iot_class: "Local Push" ha_release: 0.78 --- -The `velbus` sensor allows you to control [Velbus](http://www.velbus.eu) connected temperature sensors. +The `velbus` sensor allows you to control [Velbus](http://www.velbus.eu) connected sensors. For hub configuration, see [the Velbus component](/components/velbus/). diff --git a/source/_components/switch.edp_redy.markdown b/source/_components/switch.edp_redy.markdown new file mode 100644 index 00000000000..9f8e7984164 --- /dev/null +++ b/source/_components/switch.edp_redy.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "EDP re:dy Switch" +description: "Instructions on how to integrate the EDP re:dy switches into Home Assistant." +date: 2018-09-04 16:30 +sidebar: true +comments: false +sharing: true +footer: true +logo: edp_redy.png +ha_category: Switch +ha_release: "0.79" +ha_iot_class: "Cloud Polling" +--- + +See the [EDP re:dy main component](/components/edp_redy/) for configuration instructions. + +This switch platform will provide a switch per toggleable EDP re:dy device (switch, plug, etc). diff --git a/source/_components/switch.switchmate.markdown b/source/_components/switch.switchmate.markdown index b6e53624eed..bfc26d496c9 100644 --- a/source/_components/switch.switchmate.markdown +++ b/source/_components/switch.switchmate.markdown @@ -32,5 +32,12 @@ name: description: The name used to display the switch in the frontend. required: false type: string +flip_on_off: + description: Option to flip the on/off state. + required: false + type: boolean + default: false {% endconfiguration %} + +The component is tested with SwitchMate Lighting Control Rocker and SwitchMate Lighting Control Toggle. diff --git a/source/_components/vacuum.neato.markdown b/source/_components/vacuum.neato.markdown index 544d60f62c3..bbdd37730b1 100644 --- a/source/_components/vacuum.neato.markdown +++ b/source/_components/vacuum.neato.markdown @@ -17,6 +17,10 @@ redirect_from: /components/sensor.neato/ The `neato` vacuum platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). The status will contain attributes on the robots last clean session. ++If you notice the robot stops responding to commands check the status attribute to see if the robot is offline. If you see "Robot Offline" check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant. +
+ To add `neato` vacuum to your installation, please follow instructions in [Neato component](/components/neato/). Currently supported services are: diff --git a/source/_components/velbus.markdown b/source/_components/velbus.markdown index 329258ee28a..c5cb790ee99 100644 --- a/source/_components/velbus.markdown +++ b/source/_components/velbus.markdown @@ -13,21 +13,27 @@ ha_iot_class: "Local Push" ha_release: "0.50" --- -The `velbus` component supports the Velbus USB and serial gateways. +The `velbus` component supports the Velbus USB, Velbus serial and a TCP/IP gateway. ## {% linkable_title Configuration %} The gateway needs to be configured by adding the following lines to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yaml entry for a USB or serial interface velbus: port: '/dev/ttyUSB00' ``` +```yaml +# Example configuration.yaml entry for a TCP/IP interface +velbus: + port: '127.0.0.1:3678' +``` + {% configuration %} port: - description: The port where your board is connected to your Home Assistant host. The port will be most likely named `ttyUSB*`. + description: The port where your board is connected to your Home Assistant host. required: true type: string {% endconfiguration %} diff --git a/source/_components/weather.darksky.markdown b/source/_components/weather.darksky.markdown index 6a3b1ad138f..96ef461a9ed 100644 --- a/source/_components/weather.darksky.markdown +++ b/source/_components/weather.darksky.markdown @@ -58,11 +58,15 @@ name: required: false type: string default: Open Sky +mode: + description: "The forecast type. Can be `hourly` or `daily`." + required: false + type: string + default: hourly {% endconfiguration %}-This platform is an alternative to the [`darksky`](/components/sensor.darksky/) -sensor. +This platform is an alternative to the [`darksky`](/components/sensor.darksky/) sensor.
Details about the API are available in the [Dark Sky documentation](https://darksky.net/dev/docs). diff --git a/source/_components/weather.met.markdown b/source/_components/weather.met.markdown new file mode 100644 index 00000000000..1c31f4a0357 --- /dev/null +++ b/source/_components/weather.met.markdown @@ -0,0 +1,44 @@ +--- +layout: page +title: "Met.no" +description: "Instructions on how to integrate Met.no within Home Assistant." +date: 2018-09-17 09:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: metno.png +ha_category: Weather +ha_release: 0.79 +ha_iot_class: "Cloud Polling" +--- + +The `met` platform uses the [Met.no](https://met.no/) web service as a source for meteorological data for your location. The weather forecast is delivered by the Norwegian Meteorological Institute and the NRK. + +## {% linkable_title Configuration %} + +To add Met to your installation, add the following to your `configuration.yaml` file: + +```yaml +weather: + - platform: met +``` + + +{% configuration %} +latitude: + description: Manually specify latitude. By default the value will be taken from the Home Assistant configuration. + required: false + type: number + default: Provided by Home Assistant configuration +longitude: + description: Manually specify longitude. By default the value will be taken from the Home Assistant configuration. + required: false + type: number + default: Provided by Home Assistant configuration +altitude: + description: Manually specify altitude. By default the value will be taken from the Home Assistant configuration. + required: false + type: number + default: Provided by Home Assistant configuration +{% endconfiguration %} diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index cf62b8d380e..0d97c91d465 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -141,6 +141,7 @@ The Wink hub, by default, can only be accessed via the cloud. This means it requ - GoControl siren and strobe - Dome siren/chime/strobe +- Quirky Nimbus (Legacy device) These can no longer be officialy added to your Wink account ### {% linkable_title Service `set_siren_auto_shutoff` %} @@ -286,3 +287,55 @@ script: data: enabled: False ``` + +### {% linkable_title Service `set_nimbus_dial_state` %} + +You can use the service wink/set_nimbus_dial_state to update an individual dial's value/position and it's labels + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | no | String or list of strings that point at `entity_id`s of chime/chime. +| `value` | no | A number, should be between the dials min and max value (See set_nimbus_dial_configuration below) +| `labels` | yes | A list of strings the first being the value set on the dial's face and the second being the value on the dial face when the Nimbus is pressed + +Example: + +```yaml +script: + set_dial_1_value: + sequence: + - service: wink.set_nimbus_dial_state + data: + entity_id: wink.nimbus_dial_1 + value: 150 + labels: + - "Dial 1" + - "150" +``` + +### {% linkable_title Service `set_nimbus_dial_configuration` %} + +You can use the service wink/set_nimbus_dial_configuration to update an individual dial's configuration. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | no | String or list of strings that point at `entity_id`s of chime/chime. +| `rotation` | yes | One of "cw" or "ccw" the direction the dial hand should rotate. +| `ticks` | yes | A positive number, the number of times the hand should move. +| `scale` | yes | One of "linear" or "log" How the dial should move in response to higher values. +| `min_value` | yes | A number, the minimum value that the dial can have. +| `max_value` | yes | A number, the maximum value that the dial can have. +| `min_position` | yes | A number generally [0-360], the minimum position for the dial's hand. +| `max_value` | yes | A number generally [0-360], the maximum position for the dial's hand. + +Example: + +```yaml +script: + set_dial_1_value: + sequence: + - service: wink.set_nimbus_dial_state + data: + entity_id: wink.nimbus_dial_1 + rotation: 'ccw' +``` diff --git a/source/_docs/asterisk_mbox.markdown b/source/_docs/asterisk_mbox.markdown index 438ed0fd422..45bc4071a80 100644 --- a/source/_docs/asterisk_mbox.markdown +++ b/source/_docs/asterisk_mbox.markdown @@ -56,6 +56,8 @@ Before beginning make sure that you have the following: mbox_path = PATH_TO_VOICEMAIL_FILES cache_file = PATH_TO_CACHE_FILE google_key = GOOGLE_API_KEY + cdr = mysql+pymysql://+Notify MFA module would not verify the one-time password deliveried success, so that if user cannot received the message due any reason, he/she may not be login again. Edit or remove `[your_config_dir]/.storage/auth_module.notify` can disable nofiy MFA module to resolve the issue. +
+ +Example of configuration + +```yaml +homeassistant: + auth_mfa_modules: + - type: notify +``` + +Optional configuration variables: + +- **exclude** (*Optional*): The list of notify services you do not want to include in. +- **include** (*Optional*): The list of notify services you want to include in. +- **message** (*Optional*): The message template + +```yaml +# Example configure with message template +homeassistant: + auth_mfa_modules: + - type: totp + name: Authenticator app + - type: notify + message: 'I almost forget, to get into my clubhouse, you need to say {}' +``` diff --git a/source/_docs/configuration/packages.markdown b/source/_docs/configuration/packages.markdown index b8caf5394cb..9bcd0e2822c 100644 --- a/source/_docs/configuration/packages.markdown +++ b/source/_docs/configuration/packages.markdown @@ -63,9 +63,8 @@ light: There are some rules for packages that will be merged: -1. Component names may only use the basic form (e.g., `switch`, but not `switch 1` or `switch aa`). -2. Platform based components (`light`, `switch`, etc) can always be merged. -3. Components where entities are identified by a key that will represent the entity_id (`{key: config}`) need to have unique 'keys' between packages and the main configuration file. +1. Platform based components (`light`, `switch`, etc) can always be merged. +2. Components where entities are identified by a key that will represent the entity_id (`{key: config}`) need to have unique 'keys' between packages and the main configuration file. For example if we have the following in the main config. You are not allowed to re-use "my_input" again for `input_boolean` in a package: @@ -73,7 +72,7 @@ There are some rules for packages that will be merged: input_boolean: my_input: ``` -4. Any component that is not a platform [2], or dictionaries with Entity ID keys [3] can only be merged if its keys, except those for lists, are solely defined once. +3. Any component that is not a platform [2], or dictionaries with Entity ID keys [3] can only be merged if its keys, except those for lists, are solely defined once.
Components inside packages can only specify platform entries using configuration style 1, where all the platforms are grouped under the component name.
diff --git a/source/_docs/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown
index 7c14077f91e..af0f99c2c1e 100644
--- a/source/_docs/mqtt/discovery.markdown
+++ b/source/_docs/mqtt/discovery.markdown
@@ -25,7 +25,6 @@ Supported by MQTT discovery:
- [Sensors](/components/sensor.mqtt/)
- [Switches](/components/switch.mqtt/)
-
To enable MQTT discovery, add the following to your `configuration.yaml` file:
```yaml
@@ -52,6 +51,8 @@ The discovery topic need to follow a specific format:
The payload will be checked like an entry in your `configuration.yaml` file if a new device is added. This means that missing variables will be filled with the platform's default values. All configuration variables which are *required* must be present in the initial payload send to `/config`.
+An empty payload will cause a previously discovered device to be deleted.
+
The `
Battery powered devices need to be awake before you can use the Z-Wave control panel to update their settings. How to wake your device is device specific, and some devices will stay awake for only a couple of seconds. Please refer to the manual of your device for more details.
+In case you missed it two weeks ago, check [our plans for the future](/blog/2018/09/17/thinking-big/).
+
+
+
+
+
+It's time for another great release and we're introducing a brand new feature: device registry. This allows integrations to tell Home Assistant not only about entities, but also which devices the entities represent. It also allows integrations to tell Home Assistant how a device is connected to Home Assistant. For example, a Hue light bulb is connected to Home Assistant via the Hue hub.
+
+
+Screenshot showing several configured integrations in the configuration panel.
+
+Screenshot showing the devices of the iOS integration.
+
+Screenshot showing how to configure MQTT via UI
+