You must have the [Nest component](/components/nest/) configured to use this camera. The `nest` camera will automatically be setup when you do.
+ +Nest Camera supports `camera.turn_on` and `camera.turn_off` service since 0.75 release. diff --git a/source/_components/camera.xiaofang.markdown b/source/_components/camera.xiaofang.markdown index 2285e405a41..cfe319bec8c 100644 --- a/source/_components/camera.xiaofang.markdown +++ b/source/_components/camera.xiaofang.markdown @@ -1,86 +1,86 @@ ---- -layout: page -title: "Xiaomi Cameras" -description: "Instructions on how to integrate a video feed (via FFmpeg) as a camera within Home Assistant." -date: 2018-06-20 13:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: xiaomi.png -ha_category: Camera -ha_release: 0.72 -ha_iot_class: "Local Polling" ---- - -The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant. - -To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem. - -## {% linkable_title Preparing the Device %} - -### {% linkable_title Installing Alternative Firmware %} - -In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found for each models. - -* [Yi 720p](https://github.com/fritz-smh/yi-hack) -* [Yi Home 17CN / 27US / 47US / 1080p Home / Dome / 1080p Dome](https://github.com/shadow-1/yi-hack-v3) -* [Xiaofang 1080p Camera](https://github.com/samtap/fang-hacks) - -Once installed, please ensure that you have enabled FTP. - --Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. -
- --Hassbian users: don't forget to install ffmpeg support on your platform, otherwise, you'll not see video. -
- --The live stream writing by the camera is not an supported format when the hass reads through FTP for Yi 720p and Xiaofang Cameras, so this component retrives the video which was saved 1 minute earlier. -
- --If you enabled RTSP server, you can connect to your camera via other Home Assistant camera platforms. However, this RTSP server disables the ability to use the supremely-useful Mi Home app. In order to maintain both Home Assistant compatibility _and_ the native app, this platform retrieves videos via FTP. -
- -## {% linkable_title Configuring the Platform %} - -To enable the platform, add the following lines to your`configuration.yaml` file: - -```yaml -camera: - - platform: xiaomi - name: Camera - host: '192.168.1.100' - model: 'yi' - password: my_password_123 -``` - -Configuration variables: - -- **name** (*Required*): A human-friendly name for the camera. -- **host** (*Required*): The IP address or hostname of the camera. -- **model** (*Required*): The model of Xiaomi Camera, currently supporting yi and xiaofang. -- **password** (*Required*): The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords. -- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`. -- **username** (*Optional*): The user that can access the FTP server. Defaults to `root`. -- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options). - -## {% linkable_title Image quality %} - -Any option supported by [`ffmpeg` camera](/components/camera.ffmpeg/) can be utilized via the `ffmpeg_arguments` configuration parameter. - -One particularly useful adjustment deals with video size. Since Yi videos are fairly large (especially on the 1080p cameras), the following configuration will bring them down to a manageable size: - -```yaml -camera: - - platform: xiaomi - name: My Camera - host: '192.168.1.100' - model: 'xiaofang' - password: my_password_123 - path: /home/camera/feed - ffmpeg_arguments: '-vf scale=800:450' -``` +--- +layout: page +title: "Xiaomi Cameras" +description: "Instructions on how to integrate a video feed (via FFmpeg) as a camera within Home Assistant." +date: 2018-06-20 13:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: xiaomi.png +ha_category: Camera +ha_release: 0.72 +ha_iot_class: "Local Polling" +--- + +The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant. + +To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem. + +## {% linkable_title Preparing the Device %} + +### {% linkable_title Installing Alternative Firmware %} + +In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found for each models. + +* [Yi 720p](https://github.com/fritz-smh/yi-hack) +* [Yi Home 17CN / 27US / 47US / 1080p Home / Dome / 1080p Dome](https://github.com/shadow-1/yi-hack-v3) +* [Xiaofang 1080p Camera](https://github.com/samtap/fang-hacks) + +Once installed, please ensure that you have enabled FTP. + ++Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. +
+ ++Hassbian users: don't forget to install ffmpeg support on your platform, otherwise, you'll not see video. +
+ ++The live stream writing by the camera is not an supported format when the hass reads through FTP for Yi 720p and Xiaofang Cameras, so this component retrives the video which was saved 1 minute earlier. +
+ ++If you enabled RTSP server, you can connect to your camera via other Home Assistant camera platforms. However, this RTSP server disables the ability to use the supremely-useful Mi Home app. In order to maintain both Home Assistant compatibility _and_ the native app, this platform retrieves videos via FTP. +
+ +## {% linkable_title Configuring the Platform %} + +To enable the platform, add the following lines to your`configuration.yaml` file: + +```yaml +camera: + - platform: xiaomi + name: Camera + host: '192.168.1.100' + model: 'yi' + password: my_password_123 +``` + +Configuration variables: + +- **name** (*Required*): A human-friendly name for the camera. +- **host** (*Required*): The IP address or hostname of the camera. +- **model** (*Required*): The model of Xiaomi Camera, currently supporting yi and xiaofang. +- **password** (*Required*): The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords. +- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`. +- **username** (*Optional*): The user that can access the FTP server. Defaults to `root`. +- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options). + +## {% linkable_title Image quality %} + +Any option supported by [`ffmpeg` camera](/components/camera.ffmpeg/) can be utilized via the `ffmpeg_arguments` configuration parameter. + +One particularly useful adjustment deals with video size. Since Yi videos are fairly large (especially on the 1080p cameras), the following configuration will bring them down to a manageable size: + +```yaml +camera: + - platform: xiaomi + name: My Camera + host: '192.168.1.100' + model: 'xiaofang' + password: my_password_123 + path: /home/camera/feed + ffmpeg_arguments: '-vf scale=800:450' +``` diff --git a/source/_components/camera.xiaomi.markdown b/source/_components/camera.xiaomi.markdown index 6e1c279da40..96649e18e48 100644 --- a/source/_components/camera.xiaomi.markdown +++ b/source/_components/camera.xiaomi.markdown @@ -1,88 +1,88 @@ ---- -layout: page -title: "Xiaomi Cameras" -description: "Instructions on how to integrate a video feed (via FFmpeg) as a camera within Home Assistant." -date: 2018-06-20 13:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: xiaomi.png -ha_category: Camera -ha_release: 0.72 -ha_iot_class: "Local Polling" ---- - -The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant. - -To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem. - -## {% linkable_title Preparing the Device %} - -In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found for each models. - -* [Yi 720p](https://github.com/fritz-smh/yi-hack) -* [Yi Home 17CN / 27US / 47US / 1080p Home / Dome / 1080p Dome](https://github.com/shadow-1/yi-hack-v3) -* [Xiaofang 1080p Camera](https://github.com/samtap/fang-hacks) - -Once installed, please ensure that you have enabled FTP. - --Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. -
- --Hassbian users: Don't forget to install `ffmpeg` support on your platform, otherwise, you'll not see video. -
- --The live stream writing by the camera is not an supported format when the hass reads through FTP for Yi 720p and Xiaofang Cameras, so this platform retrives the video which was saved 1 minute earlier. -
- --If you enabled RTSP server, you can connect to your camera via other Home Assistant camera platforms. However, this RTSP server disables the ability to use the supremely-useful Mi Home app. In order to maintain both Home Assistant compatibility _and_ the native app, this platform retrieves videos via FTP. -
- -## {% linkable_title Configuring the Platform %} - -To enable the platform, add the following lines to your`configuration.yaml` file: - -```yaml -camera: - - platform: xiaomi - name: Camera - host: '192.168.1.100' - model: 'yi' - password: my_password_123 -``` - -Configuration variables: - -- **name** (*Required*): A human-friendly name for the camera. -- **host** (*Required*): The IP address or hostname of the camera. -- **model** (*Required*): The model of Xiaomi Camera, currently supporting yi and xiaofang. -- **password** (*Required*): The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords. -- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`. -- **username** (*Optional*): The user that can access the FTP server. Defaults to `root`. -- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options). - --The default for `path:` will not work with all cameras. It may be needed that you add that key with the exact path for your device. -
- -## {% linkable_title Image quality %} - -Any option supported by [`ffmpeg` camera](/components/camera.ffmpeg/) can be utilized via the `ffmpeg_arguments` configuration parameter. - -One particularly useful adjustment deals with video size. Since Yi videos are fairly large (especially on the 1080p cameras), the following configuration will bring them down to a manageable size: - -```yaml -camera: - - platform: xiaomi - name: My Camera - host: '192.168.1.100' - model: 'xiaofang' - password: my_password_123 - path: /home/camera/feed - ffmpeg_arguments: '-vf scale=800:450' -``` +--- +layout: page +title: "Xiaomi Cameras" +description: "Instructions on how to integrate a video feed (via FFmpeg) as a camera within Home Assistant." +date: 2018-06-20 13:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: xiaomi.png +ha_category: Camera +ha_release: 0.72 +ha_iot_class: "Local Polling" +--- + +The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant. + +To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem. + +## {% linkable_title Preparing the Device %} + +In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found for each models. + +* [Yi 720p](https://github.com/fritz-smh/yi-hack) +* [Yi Home 17CN / 27US / 47US / 1080p Home / Dome / 1080p Dome](https://github.com/shadow-1/yi-hack-v3) +* [Xiaofang 1080p Camera](https://github.com/samtap/fang-hacks) + +Once installed, please ensure that you have enabled FTP. + ++Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. +
+ ++Hassbian users: Don't forget to install `ffmpeg` support on your platform, otherwise, you'll not see video. +
+ ++The live stream writing by the camera is not an supported format when the hass reads through FTP for Yi 720p and Xiaofang Cameras, so this platform retrives the video which was saved 1 minute earlier. +
+ ++If you enabled RTSP server, you can connect to your camera via other Home Assistant camera platforms. However, this RTSP server disables the ability to use the supremely-useful Mi Home app. In order to maintain both Home Assistant compatibility _and_ the native app, this platform retrieves videos via FTP. +
+ +## {% linkable_title Configuring the Platform %} + +To enable the platform, add the following lines to your`configuration.yaml` file: + +```yaml +camera: + - platform: xiaomi + name: Camera + host: '192.168.1.100' + model: 'yi' + password: my_password_123 +``` + +Configuration variables: + +- **name** (*Required*): A human-friendly name for the camera. +- **host** (*Required*): The IP address or hostname of the camera. +- **model** (*Required*): The model of Xiaomi Camera, currently supporting yi and xiaofang. +- **password** (*Required*): The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords. +- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`. +- **username** (*Optional*): The user that can access the FTP server. Defaults to `root`. +- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options). + ++The default for `path:` will not work with all cameras. It may be needed that you add that key with the exact path for your device. +
+ +## {% linkable_title Image quality %} + +Any option supported by [`ffmpeg` camera](/components/camera.ffmpeg/) can be utilized via the `ffmpeg_arguments` configuration parameter. + +One particularly useful adjustment deals with video size. Since Yi videos are fairly large (especially on the 1080p cameras), the following configuration will bring them down to a manageable size: + +```yaml +camera: + - platform: xiaomi + name: My Camera + host: '192.168.1.100' + model: 'xiaofang' + password: my_password_123 + path: /home/camera/feed + ffmpeg_arguments: '-vf scale=800:450' +``` diff --git a/source/_components/climate.spider.markdown b/source/_components/climate.spider.markdown new file mode 100644 index 00000000000..a25d49d7f94 --- /dev/null +++ b/source/_components/climate.spider.markdown @@ -0,0 +1,28 @@ +--- +layout: page +title: "Spider Thermostat" +description: "Instructions on how to integrate Spider thermostats within Home Assistant." +date: 2018-07-17 22:01 +sidebar: true +comments: false +sharing: true +footer: true +logo: spider.png +ha_category: Climate +ha_iot_class: "Cloud Polling" +ha_release: 0.75 +--- + +The `spider` climate platform allows you to control your temperature settings as well as if you want to cool or heat. + ++Full configuration details can be found on the main [Spider component](/components/spider/) page. +
+ ++Although this component lets you change the operation mode to heating or cooling, it doesn't necessarily mean your boiler can. Spider is not aware of your current situation. +
+ ++This component is not affiliated with Itho Daalderop Spider and retrieves data from the endpoints of the mobile application. Use at your own risk. +
\ No newline at end of file diff --git a/source/_components/climate.tuya.markdown b/source/_components/climate.tuya.markdown new file mode 100644 index 00000000000..4d89a4783b1 --- /dev/null +++ b/source/_components/climate.tuya.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: "Tuya Climate" +description: "Instructions on how to setup the Tuya climate devices within Home Assistant." +date: 2018-07-16 09:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: tuya.png +ha_category: Climate +ha_release: 0.75 +ha_iot_class: "Cloud Polling" +--- + +The `tuya` climate platform allows you to control your [Tuya Smart](https://www.tuya.com) climate devices. + +The platform supports the air conditioner and heater. + ++Full configuration details can be found on the main [Tuya component](/components/tuya/) page. +
diff --git a/source/_components/cover.aladdin_connect.markdown b/source/_components/cover.aladdin_connect.markdown new file mode 100644 index 00000000000..ca3576dce58 --- /dev/null +++ b/source/_components/cover.aladdin_connect.markdown @@ -0,0 +1,41 @@ +--- +layout: page +title: "Genie Aladdin Connect Cover" +description: "Instructions how to integrate Genie Aladdin Connect garage door covers into Home Assistant." +date: 2018-07-26 22:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: aladdin_connect.png +ha_category: Cover +ha_release: 0.75 +ha_iot_class: "Cloud Polling" +--- + +The `aladdin_connect` cover platform lets you control Genie Aladdin Connect garage doors through Home Assistant. + ++Only doors that are owned by your Aladdin Connect account will be available. Doors that your account has been granted shared access to are not yet supported. +
+ +To use your Aladdin Connect cover in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yml entry +cover: + - platform: aladdin_connect + username: user@email.com + password: password +``` + +{% configuration %} +username: + description: Your Aladdin Connect account username. + required: true + type: string +password: + description: Your Aladdin Connect account password. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/cover.brunt.markdown b/source/_components/cover.brunt.markdown new file mode 100644 index 00000000000..536eb1c1802 --- /dev/null +++ b/source/_components/cover.brunt.markdown @@ -0,0 +1,47 @@ +--- +layout: page +title: Brunt Cover +description: "Instructions on how to set up Brunt Blind Engine within Home Assistant." +date: 2018-06-24 14:36 +sidebar: true +comments: false +sharing: true +footer: true +logo: brunt.png +ha_category: Cover +ha_release: 0.75 +ha_iot_class: "Cloud Polling" +--- + +The `brunt` platform allows one to control Blind Engines by [Brunt](https://www.brunt.co). To use this sensor, you need a Brunt App Account. All Brunt Blind devices registered to your account are automatically added to your Home Assistant with the names given them through the Brunt app. + +## {% linkable_title Configuration %} + +To enable this integration, add the following lines to your `configuration.yaml`: + +```yaml +cover: + - platform: brunt + username: BRUNT_USERNAME + password: BRUNT_PASSWORD +``` + +{% configuration %} +name: + description: Cover name + required: false + default: "brunt blind engine" + type: string +username: + description: Account username of your Brunt app + required: true + type: string +password: + description: Account password of your Brunt app + required: true + type: string +{% endconfiguration %} + ++This component is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk. +
diff --git a/source/_components/cover.tuya.markdown b/source/_components/cover.tuya.markdown new file mode 100644 index 00000000000..82040f93ecc --- /dev/null +++ b/source/_components/cover.tuya.markdown @@ -0,0 +1,23 @@ +--- +layout: page +title: "Tuya Cover" +description: "Instructions on how to setup the Tuya cover within Home Assistant." +date: 2018-07-20 09:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: tuya.png +ha_category: Cover +ha_iot_class: "Cloud Polling" +ha_release: 0.75 +--- + + +The `tuya` cover platform allows you to control your [Tuya Smart](https://www.tuya.com) curtains. + +The platform supports curtains. + ++Full configuration details can be found on the main [Tuya component](/components/tuya/) page. +
\ No newline at end of file diff --git a/source/_components/fan.tuya.markdown b/source/_components/fan.tuya.markdown new file mode 100644 index 00000000000..273a6f00729 --- /dev/null +++ b/source/_components/fan.tuya.markdown @@ -0,0 +1,23 @@ +--- +layout: page +title: "Tuya Fan" +description: "Instructions on how to setup the Tuya fan within Home Assistant." +date: 2018-07-17 09:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: tuya.png +ha_category: Fan +ha_iot_class: "Cloud Polling" +ha_release: 0.75 +--- + + +The `tuya` fan platform allows you to control your [Tuya Smart](https://www.tuya.com) fan. + +The platform supports most kinds of Tuya fans. + ++Full configuration details can be found on the main [Tuya component](/components/tuya/) page. +
\ No newline at end of file diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index b2cea8deeda..74bb8a7c48a 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -64,6 +64,11 @@ homekit: required: false type: int default: 51827 + name: + description: Need to be individual for each instance of Home Assistant using the component on the same local network. Between `3` and `25` characters. Alphanumeric and spaces allowed. + required: false + type: string + default: '`Home Assistant Bridge`' ip_address: description: The local network IP address. Only necessary if the default from Home Assistant does not work. required: false diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index f22cd2b623d..52f7b93530c 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -162,3 +162,57 @@ light: - platform: insteon_plm address: 1a2b3c ``` + +### {% linkable_title Events and Mini-Remotes %} + +Mini-Remote devices do not appear as Home Assistant entities. They generate +events. The following events are available: + +- **insteon_plm.button_on** + - **address**: (required) The Insteon device address in lower case without + dots (e.g. 1a2b3c) + - **button**: (Optional) The button id in lower case. For an 4 button remote + the values are a to d. For an 8 button remote the values are a to g. For + a one button remote this field is not used. +- **insteon_plm.button_of** + - **address**: (required) The Insteon device address in lower case without + dots (e.g. 1a2b3c) + - **button**: (Optional) The button id in lower case. For an 4 button remote + the values are a to d. For an 8 button remote the values are a to g. For + a one button remote this field is not used. + +This allows the mini-remotes to be configured as + +Here is an example of how to use these events for automations: + +``` +automation: + # 4 or 8 button remote with button c pressed + trigger: + platform: event + event_type: insteon_plm.button_on + event_data: + address: 1a2b3c + button: c + condition: + - condition: state + entity_id: light.some_light + state: 'off' + action: + service: light.turn_on + entity_id: light.some_light + + # single button remote + trigger: + platform: event + event_type: insteon_plm.button_on + event_data: + address: 1a2b3c + condition: + - condition: state + entity_id: light.some_light + state: 'off' + action: + service: light.turn_on + entity_id: light.some_light +``` diff --git a/source/_components/light.futurenow.markdown b/source/_components/light.futurenow.markdown new file mode 100644 index 00000000000..fac13214fca --- /dev/null +++ b/source/_components/light.futurenow.markdown @@ -0,0 +1,97 @@ +--- +layout: page +title: "P5 FutureNow Lights" +description: "Instructions on how to set up P5 FutureNow relay/dimmer units as lights within Home Assistant." +date: 2018-07-24 15:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: p5.png +ha_category: Light +ha_release: 0.75 +--- + +The `futurenow` light platform allows you to use [P5](http://www.p5.hu) FutureNow relay/dimmer units as lights. Currently supported units: +* [FutureNow FNIP-6x2AD](http://www.p5.hu/index.php/products/ethernet-modules/265-fnip-6x2ad) dimmer unit (outputs only) +* [FutureNow FNIP-8x10A](http://www.p5.hu/index.php/products/ethernet-modules/263-fnip-8x10a) relay unit (outputs only) + +### {% linkable_title Configuration Sample %} + +To use your FutureNow units, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +light: + - platform: futurenow + driver: FNIP6x10ad + host: 192.168.1.101 + port: 7078 + devices: + 5: + name: Dimmer Channel 5 + dimmable: true +``` + +{% configuration %} +driver: + description: "Type of the device. Currently `FNIP6x10ad` or `FNIP8x10a`." + required: true + type: string +host: + description: "The IP address or hostname of your unit, e.g., `192.168.1.101`." + required: true + type: string +port: + description: "The TCP port, as set in the unit's settings. Default is `7078`." + required: true + type: string +devices: + description: "List of output channels to set up as lights." + required: true + type: map + keys: + channel_number: + description: "Output's (light) properties." + required: true + type: map + keys: + name: + description: "The name of the light." + required: true + type: string + dimmable: + description: "Set to `true` to enable dimming (FNIP6x10ad only)." + required: false + type: boolean + default: false +{% endconfiguration %} + +### {% linkable_title Extended Configuration Sample %} + +The following example `configuration.yaml` has two different FutureNow units with multiple channels: + +```yaml +# Example configuration.yaml entry +light: + - platform: futurenow + driver: FNIP6x10ad + host: 192.168.1.101 + port: 7078 + devices: + 5: + name: Dimmer Channel 5 + 6: + name: Dimmer Channel 6 + dimmable: true + + - platform: futurenow + driver: FNIP8x10a + host: 192.168.1.102 + port: 7078 + devices: + 1: + name: Relay Channel 1 + 2: + name: Relay Channel 2 +``` diff --git a/source/_components/light.markdown b/source/_components/light.markdown index 5eb3083f2de..b4e6102c8f6 100644 --- a/source/_components/light.markdown +++ b/source/_components/light.markdown @@ -15,6 +15,12 @@ This component allows you to track and control various light bulbs. Read the pla The light component supports multiple entries inconfiguration.yaml by appending a sequential number to the section: light 2:, light 3: etc.
+### {% linkable_title Default turn-on values %}
+
+To set the default color and brightness values when the light is turned on, create a custom `light_profiles.csv` (as described below in the `profile` attribute of `light.turn_on`).
+
+The `.default` suffix should be added to the entity identifier of each light to define a default value, e.g. for `light.ceiling_2` the `id` field is `light.ceiling_2.default`. To define a default for all lights, the identifier `group.all_lights.default` can be used. Individual settings always supercede the `all_lights` default setting.
+
### {% linkable_title Service `light.turn_on` %}
Turns one light on or multiple lights on using [groups]({{site_root}}/components/group/).
diff --git a/source/_components/light.sisyphus.markdown b/source/_components/light.sisyphus.markdown
new file mode 100644
index 00000000000..4c9e0146a99
--- /dev/null
+++ b/source/_components/light.sisyphus.markdown
@@ -0,0 +1,20 @@
+---
+layout: page
+title: "Sisyphus Light"
+description: "Instructions on how to integrate the light in your Sisyphus Kinetic Art Table into Home Assistant."
+date: 2018-05-06 22:26
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: sisyphus.png
+ha_category: Light
+ha_iot_class: "Local Push"
+ha_release: 0.75
+---
+
+The [Sisyphus](https://sisyphus-industries.com/) integration for Home Assistant allows you to observe and control your Sisyphus Kinetic Art Table.
+
+Lights will be automatically added for each of your Sisyphus tables if the Sisyphus component is configured.
+
+For more configuration information see the [Sisyphus component](/components/sisyphus/) documentation.
diff --git a/source/_components/media_player.sisyphus.markdown b/source/_components/media_player.sisyphus.markdown
new file mode 100644
index 00000000000..ef0637ea32a
--- /dev/null
+++ b/source/_components/media_player.sisyphus.markdown
@@ -0,0 +1,20 @@
+---
+layout: page
+title: "Sisyphus Media Player"
+description: "Instructions on how to integrate media playing on your Sisyphus Kinetic Art Table into Home Assistant."
+date: 2018-05-06 22:26
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: sisyphus.png
+ha_category: Media Player
+ha_iot_class: "Local Push"
+ha_release: 0.75
+---
+
+The [Sisyphus](https://sisyphus-industries.com/) integration for Home Assistant allows you to observe and control your Sisyphus Kinetic Art Table.
+
+Media players will be automatically added for each of your Sisyphus tables if the Sisyphus component is configured.
+
+For more configuration information see the [Sisyphus component](/components/sisyphus/) documentation.
diff --git a/source/_components/scene.tuya.markdown b/source/_components/scene.tuya.markdown
new file mode 100644
index 00000000000..70babb97885
--- /dev/null
+++ b/source/_components/scene.tuya.markdown
@@ -0,0 +1,24 @@
+---
+layout: page
+title: "Tuya Scene"
+description: "Instructions on how to setup the Tuya scene within Home Assistant."
+date: 2018-07-20 09:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: tuya.png
+ha_category: Scene
+ha_release: 0.75
+---
+
+
+The `tuya` scene platform allows you to activate your [Tuya Smart](https://www.tuya.com) scenes.
+
+The platform supports scenes.
+
+The device state in frontend panel will not change immediately after you activate a scene.
+
++Full configuration details can be found on the main [Tuya component](/components/tuya/) page. +
\ No newline at end of file diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index 5cc0b4d9eaa..238c46f7f61 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -32,6 +32,8 @@ Configuration variables: - **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any. - **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. - **scan_interval** (*Optional*): Defines number of seconds for polling interval (defaults to 60 seconds). +- **command_timeout** (*Optional*): Defines number of seconds for command timeout (defaults to 15 seconds). +- **json_attributes** (*Optional*): Defines a list of keys to extract values from a JSON dictionary result and then set as sensor attributes. ## {% linkable_title Examples %} @@ -161,3 +163,22 @@ sensor: unit_of_measurement: "Direction" ``` {% endraw %} + + +### {% linkable_title Usage of JSON attributes in command output %} + +The example shows how you can retrieve multiple values with one sensor (where the additional are attributes) by using `value_json` and `json_attributes`. + +{% raw %} +```yaml +# Example configuration.yaml entry +sensor: + - platform: command_line + name: JSON time + json_attributes: + - date + - milliseconds_since_epoch + command: 'python3 /home/pi/.homeassistant/scripts/datetime.py' + value_template: '{{ value_json.time }}' +``` +{% endraw %} diff --git a/source/_components/sensor.magicseaweed.markdown b/source/_components/sensor.magicseaweed.markdown new file mode 100644 index 00000000000..1396a5245d0 --- /dev/null +++ b/source/_components/sensor.magicseaweed.markdown @@ -0,0 +1,95 @@ +--- +layout: page +title: "Magicseaweed Sensor" +description: "How to integrate Magicseaweed within Home Assistant." +date: 2018-06-24 21:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: magicseaweed.png +ha_category: Sensor +featured: false +ha_release: "0.75" +ha_iot_class: "Cloud Polling" +--- + +The 'magicseaweed' platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice. + +You need an API key which is free but requires [registration](https://magicseaweed.com/developer/sign-up). Magicseaweed is limiting users of the API to 2 spots for the free plan. + +To add Magicseaweed forecasts to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: magicseaweed + api_key: YOUR_API_KEY + spot_id: 1092 + monitored_conditions: + - max_breaking_swell +``` + +{% configuration %} +api_key: + description: The API key to access the service. + required: true + type: string +name: + description: Spot nickname for the sensors. + required: false + default: MSW. + type: string +hour: + description: List of hours you would like to receive data for. + required: false + default: Defaults to current forecast. + type: list + keys: + 3AM: + description: Display forecast for 3AM. + 6AM: + description: Display forecast for 6AM. + 9AM: + description: Display forecast for 9AM. + 12PM: + description: Display forecast for 12PM. + 3PM: + description: Display forecast for 3PM. + 6PM: + description: Display forecast for 6PM. + 9PM: + description: Display forecast for 9PM. + 12AM: + description: Display forecast for 12AM. +spot_id: + description: ID of the surf spot. Details for getting spot id available at [Magicseaweed](https://magicseaweed.com/developer/forecast-api) + required: true + type: string +monitored_conditions: + description: Type of data to display. + required: true + type: list + keys: + swell_forecast: + description: List of forecast summaries as attributes with current summary as state. + min_breaking_swell: + description: The minimum wave height as the state with a detailed list of forecast attributes. + max_breaking_swell: + description: The maximum wave height as the state with a detailed list of forecast attributes. +units: + description: Specify the unit system. + required: false + default: Default to `uk` or `us` based on the temperature preference in Home Assistant. + type: string + keys: + uk: + description: Use UK units. + eu: + description: Use EU units. + us: + description: Use US units. +{% endconfiguration %} + + +Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api). diff --git a/source/_components/sensor.mvglive.markdown b/source/_components/sensor.mvglive.markdown index 7d613d85987..75306f563ff 100644 --- a/source/_components/sensor.mvglive.markdown +++ b/source/_components/sensor.mvglive.markdown @@ -13,7 +13,6 @@ ha_release: 0.42 ha_iot_class: "Cloud Polling" --- - The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes. ## {% linkable_title Configuration %} @@ -36,7 +35,9 @@ Configuration variables: - **lines** (*Optional*): One or more line numbers, e.g., 'U2' or ['U2','U8','N41'] - **products** (*Optional*): One or more modes of transport, defaults to all 4 modes ['U-Bahn', 'Tram', 'Bus', 'S-Bahn']. - **timeoffset** (*Optional*): Do not display departures leaving sooner than this number of minutes (defaults to 0). Useful if you are a couple of minutes away from the stop. + - **number** (*Optional*): Store a list of departures in the attribute "departures", defaults to 1. If you set this parameter to 3, the next three departures will be stored. - **name** (*Optional*): You can customize the name of the sensor, which defaults to the station name. + ## {% linkable_title Examples %} ### {% linkable_title Full configuration %} @@ -55,8 +56,12 @@ sensor: timeoffset: 2 - station: Sendlinger Tor lines: ['U2','U8'] + number: 5 - station: Scheidplatz products: ['U-Bahn'] directions: '1' ``` -The first sensor will return S-Bahn departures to Munich Airport or Markt Schwaben that are at least 2 minutes away. The second sensor returns U2 and U8 departures from Sendlinger Tor while the third sensor returns all south-bound U-Bahn trains from Scheidplatz. + +The first sensor will return S-Bahn departures to Munich Airport or Markt Schwaben that are at least 2 minutes away. +The second sensor returns U2 and U8 departures from Sendlinger Tor and stores a total of 5 departures in attributes. To retrieve the time until the second departure, you would use states.sensor.ENTITY_NAME.attributes.departures[1].time. +The third sensor returns all south-bound U-Bahn trains from Scheidplatz. diff --git a/source/_components/sisyphus.markdown b/source/_components/sisyphus.markdown new file mode 100644 index 00000000000..dfec9823599 --- /dev/null +++ b/source/_components/sisyphus.markdown @@ -0,0 +1,52 @@ +--- +layout: page +title: "Sisyphus" +description: "Instructions on how to integrate your Sisyphus Kinetic Art Table within Home Assistant." +date: 2018-05-06 22:26 +sidebar: true +comments: false +sharing: true +footer: true +logo: sisyphus.png +ha_category: Hub +featured: false +ha_release: 0.75 +ha_iot_class: "Local Push" +--- + +The [Sisyphus](https://sisyphus-industries.com/) integration for Home Assistant allows you to observe and control your Sisyphus Kinetic Art Table. + +Each table appears in Home Assistant as a Light and a Media Player. + +The light can be used to sleep/wake the table or adjust the brightness of the table light. + +The media player can be used to sleep/wake the table, play/pause, move between tracks, or toggle shuffle on and off. The "volume" control adjusts the table's speed. + +There are two ways to configure this component. For the automatic discovery of your table(s), simply add the following to your `configuration.yaml`: + +```yaml +# This will auto-detect all Sisyphus tables on your local network. +sisyphus: +``` + +Auto-detection can be a little slow, so if your table has a fixed IP address or hostname, you may add a list of tables in your `configuration.yaml`. For example: + +```yaml +# This will skip auto-detection and add only the listed tables +sisyphus: + - name: 'TABLE_NAME' + host: 'TABLE_IP_OR_HOSTNAME' + - name: 'ANOTHER_TABLE_NAME' + host: 'ANOTHER_TABLE_IP_OR_HOSTNAME' +``` + +{% configuration %} +name: + description: The name by which the table should appear in Home Assistant + required: true + type: string +host: + description: The hostname or IP address of the table + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/spider.markdown b/source/_components/spider.markdown new file mode 100644 index 00000000000..1e71b2bc281 --- /dev/null +++ b/source/_components/spider.markdown @@ -0,0 +1,45 @@ +--- +layout: page +title: "Spider" +description: "Instructions on how to setup the Spider hub within Home Assistant." +date: 2018-07-17 22:01 +sidebar: true +comments: false +sharing: true +footer: true +logo: spider.png +ha_category: Hub +ha_iot_class: "Cloud Polling" +ha_release: 0.75 +--- + +The `spider` component is the main component to integrate all [Itho Daalderop Spider](https://www.ithodaalderop.nl/spider-thermostaat) related platforms. You will need your Spider account information (username, password) to discover and control devices which are related to your account. + +## {% linkable_title Configuration %} + +To add your Spider devices into your Home Assistant installation, add the following to your `configuration.yaml` file: + +```yaml +spider: + username: YOUR_USERNAME + password: YOUR_PASSWORD +``` + +{% configuration %} +username: + description: Account username of mijn.ithodaalderop.nl + required: true + type: string +password: + description: Account password of mijn.ithodaalderop.nl + required: true + type: string +scan_interval: + description: How frequently to query for new data. Defaults to 120 seconds. + required: false + type: int +{% endconfiguration %} + ++This component is not affiliated with Itho Daalderop Spider and retrieves data from the endpoints of the mobile application. Use at your own risk. +
diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown index 295ae106db1..ff824f97137 100644 --- a/source/_components/switch.mqtt.markdown +++ b/source/_components/switch.mqtt.markdown @@ -46,6 +46,16 @@ state_topic: description: The MQTT topic subscribed to receive state updates. required: false type: string +state_on: + description: The payload that represents the on state. + required: false + type: string + default: ON +state_off: + description: The payload that represents the off state. + required: false + type: string + default: OFF command_topic: description: The MQTT topic to publish commands to change the switch state. required: false @@ -117,6 +127,8 @@ switch: availability_topic: "home/bedroom/switch1/available" payload_on: "ON" payload_off: "OFF" + state_on: "ON" + state_off: "OFF" optimistic: false qos: 0 retain: true diff --git a/source/_components/switch.spider.markdown b/source/_components/switch.spider.markdown new file mode 100644 index 00000000000..a38456e927b --- /dev/null +++ b/source/_components/switch.spider.markdown @@ -0,0 +1,24 @@ +--- +layout: page +title: "Spider Power Plug" +description: "Instructions on how to integrate Spider power plugs within Home Assistant." +date: 2018-07-26 22:01 +sidebar: true +comments: false +sharing: true +footer: true +logo: spider.png +ha_category: Switch +ha_iot_class: "Cloud Polling" +ha_release: 0.75 +--- + +The `spider` power plug platform allows you to control your power plugs. It also shows you your current and daily energy usage by the power plug. + ++Full configuration details can be found on the main [Spider component](/components/spider/) page. +
+ ++This component is not affiliated with Itho Daalderop Spider and retrieves data from the endpoints of the mobile application. Use at your own risk. +
diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown index 906c40f536e..0f1728cc013 100644 --- a/source/_docs/configuration/secrets.markdown +++ b/source/_docs/configuration/secrets.markdown @@ -10,7 +10,7 @@ footer: true redirect_from: /topics/secrets/ --- -The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secrets` you can remove any private information from you configuration files. This separation can also help you to keep easier track of your passwords and API keys. As they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple yaml files if you [split up your configuration](/docs/configuration/splitting_configuration/). +The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from you configuration files. This separation can also help you to keep easier track of your passwords and API keys. As they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple yaml files if you [split up your configuration](/docs/configuration/splitting_configuration/). ### {% linkable_title Using secrets.yaml %} diff --git a/source/_lovelace/conditional.markdown b/source/_lovelace/conditional.markdown new file mode 100644 index 00000000000..4bf17345887 --- /dev/null +++ b/source/_lovelace/conditional.markdown @@ -0,0 +1,62 @@ +--- +layout: page +title: Conditional Card +sidebar_label: Conditional +description: Displays another card based on entity states. +date: 2018-07-26 10:28 +00:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +Displays another card based on entity states. + +{% configuration %} +type: + required: true + description: conditional + type: string +conditions: + required: true + description: List of entity IDs and matching states. + type: list + keys: + entity: + required: true + description: HA entity ID. + type: string + state: + required: false + description: Entity state is equal to this value.* + type: string + state_not: + required: false + description: Entity state is unequal to this value.* + type: string +card: + required: true + description: Card to display if all conditions match. + type: object +{% endconfiguration %} + +*one is required (`state` or `state_not`) + +### {% linkable_title Examples %} + +```yaml +- type: conditional + conditions: + - entity: light.bed_light + state: "on" + - entity: switch.decorative_lights + state_not: "off" + card: + type: entities + entities: + - device_tracker.demo_paulus + - cover.kitchen_window + - group.kitchen + - lock.kitchen_door + - light.bed_light +``` diff --git a/source/_lovelace/entities.markdown b/source/_lovelace/entities.markdown index 01c0241fb61..6cc85912674 100644 --- a/source/_lovelace/entities.markdown +++ b/source/_lovelace/entities.markdown @@ -49,14 +49,86 @@ name: required: false description: Overwrites friendly name. type: string +icon: + required: false + description: Overwrites icon or entity picture. + type: string secondary_info: required: false description: "Show additional info. Values: `entity-id`, `last-changed`." type: string {% endconfiguration %} +## {% linkable_title Secial Row Elements %} + +### {% linkable_title Call Service %} + +{% configuration %} +type: + required: true + description: call-service + type: string +name: + required: true + description: Main Label. + type: string +icon: + required: true + description: "Icon to display (e.g. `mdi:home`)" + type: string +action_name: + required: true + description: Button label. + type: string +service: + required: true + description: "Service like `media_player.media_play_pause`" + type: string +service_data: + required: true + description: The service data to use. + type: object +{% endconfiguration %} + +### {% linkable_title Weblink %} + +{% configuration %} +type: + required: true + description: weblink + type: string +name: + required: true + description: Link label. + type: string +icon: + required: true + description: "Icon to display (e.g. `mdi:home`)" + type: string +url: + required: true + description: "Website URL." + type: string +{% endconfiguration %} + +### {% linkable_title Divider %} + +{% configuration %} +type: + required: true + description: divider + type: string +style: + required: false + description: Style the element using CSS. + type: object + default: "height: 1px, background-color: var(--secondary-text-color)" +{% endconfiguration %} + ## {% linkable_title Example %} +Entity rows: + ```yaml - type: entities title: Entities card sample @@ -69,3 +141,24 @@ secondary_info: - group.all_lights - group.all_locks ``` + +Special rows: + +```yaml +- type: entities + title: Entities card sample + show_header_toggle: true + entities: + - type: call-service + icon: mdi:power + name: Bed light + action_name: Toggle light + service: light.toggle + service_data: + entity_id: light.bed_light + - type: divider + - type: weblink + name: Home Assistant + url: https://www.home-assistant.io/ + icon: mdi:home-assistant +``` diff --git a/source/_lovelace/glance.markdown b/source/_lovelace/glance.markdown index f1aceb91e53..ab3c553bd08 100644 --- a/source/_lovelace/glance.markdown +++ b/source/_lovelace/glance.markdown @@ -60,11 +60,24 @@ name: required: false description: Overwrites friendly name. type: string +icon: + required: false + description: Overwrites icon or entity picture. + type: string tap_action: required: false - description: "Set to `toggle` or `turn-on` for direct actions." + description: "Set to `toggle` or `call-service` for direct actions." type: string default: more-info +service: + required: false + description: "For `call-service`, e.g. `media_player.media_play_pause`" + type: string +service_data: + required: false + description: The service data to use. + type: object + default: "entity_id: entity_id" {% endconfiguration %} ## {% linkable_title Examples %} diff --git a/source/_lovelace/picture-elements.markdown b/source/_lovelace/picture-elements.markdown index c81fdac9770..e9da937b142 100644 --- a/source/_lovelace/picture-elements.markdown +++ b/source/_lovelace/picture-elements.markdown @@ -104,6 +104,14 @@ entity: required: true description: Entity id type: string +prefix: + required: false + description: Text before entity state. + type: string +suffix: + required: false + description: Text after entity state. + type: string tap_action: required: false description: more-info, toggle, navigate, call-service diff --git a/source/_lovelace/picture-entity.markdown b/source/_lovelace/picture-entity.markdown index 4bc579f0e35..39ad6002f19 100644 --- a/source/_lovelace/picture-entity.markdown +++ b/source/_lovelace/picture-entity.markdown @@ -42,9 +42,14 @@ name: required: false description: Overwrite entity name. type: string -show_info: +show_name: required: false - description: Shows the footer box. + description: Shows name in footer. + type: boolean + default: true +show_state: + required: false + description: Shows state in footer. type: boolean default: true tap_action: diff --git a/source/_lovelace/picture-glance.markdown b/source/_lovelace/picture-glance.markdown index 20b43724ac7..62a6c258c82 100644 --- a/source/_lovelace/picture-glance.markdown +++ b/source/_lovelace/picture-glance.markdown @@ -24,7 +24,7 @@ type: type: string entities: required: true - description: List of entities. + description: List of entities or entity objects. type: list title: required: false @@ -57,6 +57,21 @@ entity: type: string {% endconfiguration %} +## {% linkable_title Options For Entities %} + +If you define entities as objects instead of strings, you can add more customization and configuration: + +{% configuration %} +entity: + required: true + description: Home Assistant entity ID. + type: string +icon: + required: false + description: Overwrites default icon. + type: string +{% endconfiguration %} + ## {% linkable_title Examples %} ```yaml diff --git a/source/_posts/2018-08-03-release-75.markdown b/source/_posts/2018-08-03-release-75.markdown new file mode 100644 index 00000000000..5ee1b8012d9 --- /dev/null +++ b/source/_posts/2018-08-03-release-75.markdown @@ -0,0 +1,397 @@ +--- +layout: post +title: "0.75: Spider, Tuya, Brunt, Magicseaweed API" +description: "You're now able to change entity IDs on the fly." +date: 2018-07-31 00:01:00 +date_formatted: "August 3, 2018" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Release-Notes +og_image: /images/blog/2018-08-0.75/components.png +--- + +
+
+And just like that, it's August. Time is flying by. People all over the world have been busy to create this release for you. This release again a ton of cool new stuff.
+
+First, let's talk entity IDs. Entity IDs are how we identify entities in automations and scripts. They start with the domain and end with an object id, for example: `light.kitchen`. Or, if you're unlucky `light.node_2_2_abc`. With this release, it will now be possible to manage entity IDs of entities via the UI! Just as with changing the name, it requires that the integration is able to supply a unique ID for each entity.
+
+
+
+Screenshot of the new user interface to change entity IDs.
+