jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 09:46:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Fabian Affolter 2018-09-03 09:28:33 +02:00
commit 9359105354
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F
140 changed files with 443 additions and 280 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/_components/asterisk_mbox.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: asterisk.png
ha_category: Other
ha_category: Mailbox
ha_iot_class: "Local Push"
ha_release: 0.51
---
@ -19,6 +19,8 @@ To enable the component, a configuration is required in both Home Assistant as w
First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox/) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server)
## {% linkable_title Configuration %}
Once that is complete, add the following entry `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.arest.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: arest.png
ha_category: Binary Sensor
ha_category: DIY
ha_iot_class: "Local Polling"
ha_release: 0.9
---
@ -16,6 +16,8 @@ ha_release: 0.9
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
## {% linkable_title Configuration %}
To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.bbb_gpio.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: beaglebone-black.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: 0.37
ha_iot_class: "Local Push"
---
The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
## {% linkable_title Configuration %}
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.bmw_connected_drive.markdown
View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: bmw.png
ha_category: Binary Sensor
ha_category: Car
ha_release: 0.66
---
The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant.
The `bmw_connected_drive` binary sensor platform allows you to import data on your BMW into Home Assistant.
The binary sensors will be automatically configured if `bmw_connected_drive` component is configured.

2
source/_components/binary_sensor.digital_ocean.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets.
### {% linkable_title Configuration %}
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.eight_sleep.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: eight_sleep.png
ha_category: Binary Sensor
ha_category: Health
ha_release: "0.44"
ha_iot_class: "Cloud Polling"
---
@ -16,4 +16,4 @@ ha_iot_class: "Cloud Polling"
The `eight_sleep` binary sensor platform lets you observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/eight_sleep/) configuration on how to setup.
Devices will be configured automatically. Please refer to the [`eight_sleep` component](/components/eight_sleep/) configuration on how to setup.

6
source/_components/binary_sensor.ffmpeg_motion.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ffmpeg.png
ha_category: Binary Sensor
ha_category: Image Processing
ha_release: 0.27
redirect_from: /components/binary_sensor.ffmpeg/
---
@ -20,10 +20,12 @@ The `ffmpeg` platform allows you to use any video feed with [FFmpeg](http://www.
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.
</p>
### {% linkable_title Motion %}
## {% linkable_title Motion %}
FFmpeg doesn't have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option 'changes', the percent value of change between frames. If you want a really small value for 'changes', you can also add a denoise filter.
## {% linkable_title Configuration %}
To add FFmpeg with motion detection to your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.ffmpeg_noise.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ffmpeg.png
ha_category: Binary Sensor
ha_category: Image Processing
ha_release: 0.27
---
@ -19,7 +19,7 @@ The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](ht
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.
</p>
### {% linkable_title Noise %}
## {% linkable_title Configuration %}
To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file:

4
source/_components/binary_sensor.hydrawise.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: hydrawise_logo.png
ha_category: Binary Sensor
ha_category: Irrigation
ha_release: 0.71
ha_iot_class: Cloud Polling
---
Before setting up the [Hunter Hydrawise](https://hydrawise.com) binary sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component.
## {% linkable_title Configuration %}
Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/binary_sensor.linode.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
The `linode` binary sensor platform allows you to monitor your Linode nodes.
## {% linkable_title Configuration %}
Add the following to your `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.mercedesme.markdown
View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: mercedesme.png
ha_category: Binary Sensor
ha_category: Car
ha_iot_class: "Cloud polling"
ha_release: 0.63
---
The `Mercedes me` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors like windows, doors, lock, tire warnings from within Home Assistant.
The `mercedesme` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors like windows, doors, lock, tire warnings from within Home Assistant.
They will be automatically discovered if the Mercedes me component is loaded.

11
source/_components/binary_sensor.mychevy.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "MyChevy Binary Sensors"
title: "MyChevy Binary Sensor"
description: "Instructions on how to integrate Chevy Bolt binary sensors car into Home Assistant."
date: 2017-08-28 17:00
sidebar: true
@ -8,9 +8,14 @@ comments: false
sharing: true
footer: true
logo: chevy.png
ha_category: Binary Sensor
ha_category: Car
ha_release: 0.62
ha_iot_class: "Cloud Polling"
---
For configuration instructions, see [main component config](/components/mychevy/).
The `mychevy` binary sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant.
The binary sensor platform will be automatically configured if the `mychevy` component is configured.
For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation.

2
source/_components/binary_sensor.mysensors.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: 0.14
ha_iot_class: "Local Push"
---

12
source/_components/binary_sensor.openuv.markdown
View File

@ -8,16 +8,12 @@ comments: false
sharing: true
footer: true
logo: openuv.jpg
ha_category: Binary Sensor
ha_category: Health
ha_release: 0.76
ha_iot_class: "Cloud Polling"
---
The `openuv` binary sensor platform allows you to view binary sensor data from
[OpenUV](http://openuv.io).
The `openuv` binary sensor platform allows you to view binary sensor data from [OpenUV](http://openuv.io).
You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, binary sensors will automatically appear.
<p class='note'>
You must have the [OpenUV component](/components/openuv/) configured to use
this platform. After configuring that component, binary sensors will
automatically appear.
</p>

4
source/_components/binary_sensor.pilight.markdown
View File

@ -8,14 +8,14 @@ comments: false
sharing: true
footer: true
logo: pilight.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: 0.44
ha_iot_class: "Local Polling"
---
The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector).
## {% linkable_title Configuration %}
To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file:

2
source/_components/binary_sensor.rachio.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: rachio.png
ha_category: Hub
ha_category: Sensor
ha_iot_class: "Cloud Push"
ha_release: 0.73
---

4
source/_components/binary_sensor.raincloud.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raincloud.jpg
ha_category: Binary Sensor
ha_category: Irrigation
ha_release: "0.55"
ha_iot_class: "Cloud Polling"
---
To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud).
## {% linkable_title Configuration %}
Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file:
```yaml

2
source/_components/binary_sensor.rainmachine.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: rainmachine.png
ha_category: Binary Sensor
ha_category: Irrigation
ha_iot_class: "Cloud Polling"
ha_release: 0.71
---

4
source/_components/binary_sensor.raspihats.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raspihats.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: 0.44
ha_iot_class: "Local Push"
---
The `raspihats` binary sensor platform allows you to read sensor values ​​using the digital inputs of the [raspihats](http://www.raspihats.com/) boards.
## {% linkable_title Configuration %}
To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.rpi_gpio.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: pre 0.7
ha_iot_class: "Local Push"
---
The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
## {% linkable_title Configuration %}
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.rpi_pfio.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: 0.45
ha_iot_class: "Local Push"
---
The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) .
## {% linkable_title Configuration %}
To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/binary_sensor.sleepiq.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: sleepiq.png
ha_category: Binary Sensor
ha_category: Health
ha_release: 0.29
ha_iot_class: "Local Polling"
---

4
source/_components/binary_sensor.tesla.markdown
View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Binary Sensor
ha_category: Car
ha_iot_class: "Cloud polling"
ha_release: 0.53
---
The `Tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant.
The `tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant.
They will be automatically discovered if the Tesla component is loaded.

4
source/_components/bmw_connected_drive.markdown
View File

@ -8,11 +8,11 @@ comments: false
sharing: true
footer: true
logo: bmw.png
ha_category: Hub
ha_category: Car
ha_release: 0.64
---
This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work.
The `bmw_connected_drive` component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work.
For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github.

4
source/_components/camera.rpi_camera.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Camera
ha_category: DIY
ha_iot_class: "Local Polling"
ha_release: 0.17
---
@ -16,6 +16,8 @@ ha_release: 0.17
The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera.
## {% linkable_title Configuration %}
To enable this camera in your installation, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/camera.yi.markdown
View File

@ -31,7 +31,7 @@ In order to integrate the camera with Home Assistant, it is necessary to install
Once installed, please ensure that you have enabled FTP and Telnet on your device.
<p class='note warning'>
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.
Currently, version 0.1.4-beta2 of the custom firmware is the highest supported without having to make additional modifications. 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. To use higher firmware versions you must also follow [this workaround](https://github.com/shadow-1/yi-hack-v3/issues/129#issuecomment-361723075) to revert back to ftpd.
</p>
<p class='note warning'>

2
source/_components/climate.mysensors.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Climate
ha_category: DIY
ha_release: 0.29
ha_iot_class: "Local Push"
---

4
source/_components/climate.tesla.markdown
View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Climate
ha_category: Car
ha_iot_class: "Cloud push"
ha_release: 0.53
---
The `Tesla` climate platform allows you to control your [Tesla](https://www.tesla.com/) climate from within Home Assistant.
The `tesla` climate platform allows you to control your [Tesla](https://www.tesla.com/) climate from within Home Assistant.
The climate platform will be automatically configured if Tesla component is configured.

5
source/_components/coinbase.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "coinbase"
title: "Coinbase"
description: "Instructions for how to add Coinbase sensors to Home Assistant."
date: 2017-12-08 17:54
sidebar: true
@ -8,6 +8,7 @@ comments: false
sharing: true
footer: true
logo: coinbase.png
ha_category: Finance
ha_release: 0.61
ha_iot_class: "Cloud Polling"
---
@ -17,6 +18,8 @@ The `coinbase` component lets you access account balances and exchange rates fro
You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data.
## {% linkable_title Configuration %}
To set it up, add the following information to your `configuration.yaml` file:
```yaml

8
source/_components/counter.markdown
View File

@ -44,7 +44,7 @@ Increments the counter with 1 or the given value for the steps.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
#### {% linkable_title Service `counter.decrement` %}
@ -52,7 +52,7 @@ Decrements the counter with 1 or the given value for the steps.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
#### {% linkable_title Service `counter.reset` %}
@ -60,7 +60,7 @@ With this service the counter is reset to its initial value.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
### {% linkable_title Use the service %}
@ -69,7 +69,7 @@ Select <img src='/images/screenshots/developer-tool-services-icon.png' alt='serv
```json
{
"entity_id": "counter.count0"
"entity_id": "counter.my_custom_counter"
}
```

2
source/_components/cover.mysensors.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Cover
ha_category: DIY
ha_release: "0.30"
ha_iot_class: "Local Push"
---

7
source/_components/cover.opengarage.markdown
View File

@ -8,12 +8,14 @@ comments: false
sharing: true
footer: true
logo: opengarage.png
ha_category: Cover
ha_category: DIY
ha_release: 0.44
---
The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant.
## {% linkable_title Configuration %}
To enable OpenGarage Covers in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -87,7 +89,7 @@ sensor:
{% endif %}
{% else %}
n/a
{% endif %}'{% endraw %}
{% endif %}'
group:
garage:
@ -104,3 +106,4 @@ customize:
sensor.garage_car_present:
icon: mdi:car
```
{% endraw %}

4
source/_components/cover.rpi_gpio.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Cover
ha_category: DIY
ha_release: 0.23
ha_iot_class: "Local Push"
---
@ -22,6 +22,8 @@ It uses two pins on the Raspberry Pi.
Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup).
## {% linkable_title Configuration %}
To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file:
```yaml

8
source/_components/device_tracker.automatic.markdown
View File

@ -8,18 +8,22 @@ comments: false
sharing: true
footer: true
logo: automatic.png
ha_category: Presence Detection
ha_category: Car
ha_release: 0.28
ha_iot_class: "Cloud Push"
---
The `automatic` platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service.
The `automatic` device tracker platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service.
## {% linkable_title Setup %}
To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference. Next, specify the OAuth Redirect URL in the developer page. This should be configured to `<home-assistant-url>/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication.
Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml.
## {% linkable_title Configuration %}
Once your developer account is created, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/device_tracker.bmw_connected_drive.markdown
View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: bmw.png
ha_category: Presence Detection
ha_category: Car
ha_release: 0.64
---
The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant.
The `bmw_connected_drive` device tracker platform allows you to import data on your BMW into Home Assistant.
The device tracker platform will be automatically configured if the `bmw_connected_drive` component is configured.

4
source/_components/device_tracker.mercedesme.markdown
View File

@ -8,11 +8,11 @@ comments: false
sharing: true
footer: true
logo: mercedesme.png
ha_category: Presence Detection
ha_category: Car
ha_release: 0.63
---
The `Mercedes me` platform allows you to get data about the location of your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) car within Home Assistant.
The `mercedesme` platform allows you to get data about the location of your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) car within Home Assistant.
The device tracker platform will be automatically configured if Mercedes me component is configured.

3
source/_components/device_tracker.mysensors.markdown
View File

@ -8,8 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Presence Detection
featured: false
ha_category: DIY
ha_release: "0.38"
ha_iot_class: "Local Push"
---

12
source/_components/device_tracker.ritassist.markdown
View File

@ -8,17 +8,19 @@ comments: false
sharing: true
footer: true
logo: ritassist.png
ha_category: Presence Detection
ha_category: Car
ha_iot_class: Cloud Polling
ha_release: 0.76
---
This platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
The `ritassist` device tracker platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
## {% linkable_title Setup %}
## API key
To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key).
## Configuration
## {% linkable_title Configuration %}
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -58,7 +60,7 @@ include:
See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked.
## Available Attributes
## {% linkable_title Available attributes %}
| Attribute | Description |
|---|---|

4
source/_components/device_tracker.tesla.markdown
View File

@ -8,11 +8,11 @@ comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Presence Detection
ha_category: Car
ha_release: 0.53
---
The `Tesla` platform allows you to get data about the location of your [Tesla](https://www.tesla.com/) car within Home Assistant.
The `tesla` platform allows you to get data about the location of your [Tesla](https://www.tesla.com/) car within Home Assistant.
The device tracker platform will be automatically configured if Tesla component is configured.

2
source/_components/device_tracker.volvooncall.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: volvo.png
ha_category: Presence Detection
ha_category: Car
ha_release: "0.30"
---

6
source/_components/digital_ocean.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Hub
ha_category: System Monitor
ha_release: "0.30"
logo: digital_ocean.png
ha_iot_class: "Local Polling"
@ -16,8 +16,12 @@ ha_iot_class: "Local Polling"
The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
### {% linkable_title Setup %}
Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens).
### {% linkable_title Configuration %}
To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file:
```yaml

4
source/_components/eight_sleep.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: eight_sleep.png
ha_category: Hub
ha_category: Health
ha_release: "0.44"
ha_iot_class: "Cloud Polling"
---
@ -17,7 +17,7 @@ The `eight_sleep` component allows Home Assistant to fetch data from your [Eight
## {% linkable_title Configuration %}
It's setup utilizing 'Sensor' components to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' component to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed.
It's setup utilizing 'Sensor' platform to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' platform to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed.
You must have at least two sleep sessions recorded in the Eight Sleep app prior to setting up the Home Assistant component.

4
source/_components/ffmpeg.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ffmpeg.png
ha_category: Hub
ha_category: Image Processing
---
The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update.
@ -21,6 +21,8 @@ You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessi
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
</p>
## {% linkable_title Configuration %}
To set it up, add the following information to your `configuration.yaml` file:
```yaml

4
source/_components/hydrawise.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: hydrawise_logo.png
ha_category: Hub
ha_category: Irrigation
ha_release: 0.71
ha_iot_class: Cloud Polling
---
The `hydrawise` component allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant.
## {% linkable_title Configuration %}
To enable it, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/image_processing.opencv.markdown
View File

@ -17,6 +17,8 @@ ha_release: 0.47
Some pre-defined classifiers can be found [here](https://github.com/opencv/opencv/tree/master/data).
## {% linkable_title Configuration %}
To setup OpenCV with Home Assistant, add the following section to your `configuration.yaml` file:
```yaml

20
source/_components/light.blinksticklight.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: blinkstick.png
ha_category: Light
ha_category: DIY
ha_release: 0.7.5
ha_iot_class: "Local Polling"
---
@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
The `blinkstick` platform lets you control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant.
## {% linkable_title Configuration %}
To add blinkstick to your installation, add the following to your `configuration.yaml` file:
```yaml
@ -23,10 +25,18 @@ To add blinkstick to your installation, add the following to your `configuration
light:
- platform: blinksticklight
serial: BS000795-1.1
name: Living Room
```
Configuration variables:
{% configuration %}
serial:
description: The serial number of your stick.
required: true
default: 640
type: string
name:
description: Name of the stick.
required: false
type: string
default: Blinkstick
{% endconfiguration %}
- **serial** (*Required*): The serial number of your stick.
- **name** (*Required*): Name of the stick.

5
source/_components/light.blinkt.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Light
ha_category: DIY
ha_iot_class: "Local Push"
ha_release: 0.44
---
The `blinkt` light platform lets you control the [Blinkt!](https://shop.pimoroni.com/products/blinkt) board, featuring eight super-bright RGB LEDs.
## {% linkable_title Configuration %}
To enable `blinkt` in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -22,3 +24,4 @@ To enable `blinkt` in your installation, add the following to your `configuratio
light:
- platform: blinkt
```

2
source/_components/light.mysensors.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Light
ha_category: DIY
ha_release: 0.13
ha_iot_class: "Local Push"
---

4
source/_components/light.piglow.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Light
ha_category: DIY
ha_release: 0.37
ha_iot_class: "Local Polling"
---
@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
The `piglow` platform lets you control the [Piglow](https://shop.pimoroni.com/products/piglow) lights on your Raspberry Pi from within Home Assistant.
## {% linkable_title Configuration %}
To add piglow to your installation, add the following to your `configuration.yaml` file:
```yaml

6
source/_components/light.rpi_gpio_pwm.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "PWM LED"
title: "PWM LED Light"
description: "Instructions on how to setup PWM LEDs within Home Assistant."
date: 2017-04-04 13:00
sidebar: true
@ -8,7 +8,7 @@ layout: page
comments: false
sharing: true
footer: true
ha_category: Light
ha_category: DIY
ha_iot_class: "Local Push"
ha_release: 0.43
logo: raspberry-pi.png
@ -18,6 +18,8 @@ The `rpi_gpio_pwm` platform allows to control multiple lights using pulse-width
For controlling the GPIOs, the platform connects to the [pigpio-daemon](http://abyz.co.uk/rpi/pigpio/pigpiod.html), which must be running. On Raspbian Jessie 2016-05-10 or newer the `pigpio` library is already included. On other operating systems it needs to be installed first (see [installation instructions](https://github.com/soldag/python-pwmled#installation)).
## {% linkable_title Configuration %}
To enable this platform, add the following lines to your `configuration.yaml`:
```yaml

10
source/_components/light.sensehat.markdown
View File

@ -8,20 +8,20 @@ comments: false
sharing: true
footer: true
logo: sense-hat.png
ha_category: Light
ha_category: DIY
ha_iot_class: "Assumed State"
ha_release: 0.44
---
The `sensehat` light platform lets you control the [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) board's 8x8 RGB LED matrix on your Raspberry Pi from within Home Assistant.
To add `sensehat` to your installation, add the following to your `configuration.yaml` file:
## {% linkable_title Configuration %}
To add `sensehat` light to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
platform: sensehat
name: SenseHAT
- platform: sensehat
```
For setting up the Sense HAT sensors, please see the [Sense HAT sensor component](/components/sensor.sensehat/).

17
source/_components/linode.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Hub
ha_category: System Monitor
logo: linode.png
ha_release: 0.57
ha_iot_class: "Cloud Polling"
@ -15,12 +15,17 @@ ha_iot_class: "Cloud Polling"
The `linode` component allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant.
## {% linkable_title sETUP %}
Obtain your oAuth2 Access Token from Linode account.
* <http://cloud.linode.com>
* Log in
* Select API Tokens
* Create a Personal Access Token,
* Assigned scope (Please choose the least possible access required.)
* <http://cloud.linode.com>
* Log in
* Select API Tokens
* Create a Personal Access Token,
* Assigned scope (Please choose the least possible access required.)
## {% linkable_title Configuration %}
To integrate Linode with Home Assistant, add the following section to your `configuration.yaml` file:

4
source/_components/lock.bmw_connected_drive.markdown
View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: bmw.png
ha_category: Lock
ha_category: Car
ha_release: 0.66
---
The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant.
The `bmw_connected_drive` lock platform allows you to import data on your BMW into Home Assistant.
The lock will be automatically configured if `bmw_connected_drive` component is configured.

6
source/_components/lock.tesla.markdown
View File

@ -8,13 +8,13 @@ comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Lock
ha_category: Car
ha_iot_class: "Cloud Push"
ha_release: 0.53
---
The `Tesla` platform allows you to control your [Tesla](https://www.tesla.com/) door lock from within Home Assistant.
The `tesla` platform allows you to control your [Tesla](https://www.tesla.com/) door lock from within Home Assistant.
The lock platform will be automatically configured if Tesla component is configured.
The lock platform will be automatically configured if `tesla` component is configured.
For more configuration information see the [Tesla component](/components/tesla/) documentation.

2
source/_components/mercedesme.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mercedesme.png
ha_category: Hub
ha_category: Car
ha_release: 0.63
ha_iot_class: "Cloud Polling"
---

22
source/_components/mychevy.markdown
View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: chevy.png
ha_category: Hub
ha_category: Car
ha_release: 0.62
ha_iot_class: "Cloud Polling"
---
The `MyChevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using selenium to log in as your user, and screen scrape the data provided. GM does not make it easy to sign up for any official development program, so this provides a workaround to get access to your data.
The `mychevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using selenium to log in as your user and screen scrape the data provided. GM does not make it easy to sign up for any official development program, so this provides a workaround to get access to your data.
This component provides the following platforms:
@ -33,21 +33,21 @@ mychevy:
{% configuration %}
username:
description: The email address associated with your my.chevrolet account.
required: true
type: string
description: The email address associated with your my.chevrolet account.
required: true
type: string
password:
description: The password for your given my.chevrolet account.
required: true
type: string
description: The password for your given my.chevrolet account.
required: true
type: string
{% endconfiguration %}
#### {% linkable_title Installation %}
### {% linkable_title Installation %}
Because this uses selenium behind the scenes, installation is more complicated than merely pip install. See the [installation instructions](https://github.com/sdague/mychevy).
Because this uses selenium behind the scenes, installation is more complicated than merely `pip` install. See the [installation instructions](https://github.com/sdague/mychevy).
#### {% linkable_title Limitations %}
### {% linkable_title Limitations %}
The architecture of the GM automotive networking imposes some limitations on the functionality of the component.

17
source/_components/mycroft.markdown
View File

@ -14,18 +14,21 @@ ha_release: 0.53
[Mycroft](https://mycroft.ai) is an open source voice assistant that allows you to send notifications and more to Mycroft from Home Assistant.
## {% linkable_title Configuration %}
To use Mycroft in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
mycroft:
host: 0.0.0.0
```
`host` is your IP address of your mycroft instance. Once you have added your host to your `configuration.yaml` file, restart your Home Assistant server. This will load up the Mycroft component and make a service available to notify on Mycroft and more eventually.
{% configuration %}
host:
description: The IP address of your Mycroft instance.
required: true
type: string
{% endconfiguration %}
The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/).
To use this notification platform you simply need to input into the configuration that mycroft is your notification platform like seen above.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

2
source/_components/mysensors.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Hub
ha_category: DIY
featured: true
ha_iot_class: "Local Push"
---

11
source/_components/notify.mailgun.markdown
View File

@ -22,8 +22,7 @@ The Mailgun notification service allows you to send emails via Mailgun's REST AP
# Example configuration.yaml entry
mailgun:
domain: mg.example.com
api_key: token-XXXXXXXXX
sandbox: False
api_key: XXXXXXXXXXXXXX
notify:
- name: mailgun
@ -33,11 +32,11 @@ notify:
Configuration variables:
- **domain** (*Optional*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up.
- **sandbox** (*Optional*): Whether to use the sandboxed domain for outgoing mail. The `domain` item takes precedence over this. Defaults to `False`.
- **token** (*Required*): This is the API token that has been generated in your Mailgun account.
- **domain** (*Required*): This is the domain name to be used when sending out mail.
- **sandbox** (*Deprecated*): If a sandboxed domain is used, specify it in `domain`. Defaults to `False`.
- **api_key** (*Required*): This is the API Key that has been generated in your Mailgun account.
- **recipient** (*Required*): The email address of the recipient.
- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is outgoint mail domain, as defined by the `domain` and `sanbox` configuration entries.
- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is the outgoing mail domain, as defined by the `domain` configuration entry.
## {% linkable_title Example automation %}

7
source/_components/notify.mycroft.markdown
View File

@ -12,4 +12,9 @@ ha_category: Notifications
ha_release: "0.53"
---
Please see the main [Mycroft Component](/components/mycroft)
The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/).
Please check the [`mycroft` component](/components/mycroft/) for details.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

2
source/_components/notify.mysensors.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Notifications
ha_category: DIY
ha_release: 0.36
ha_iot_class: "Local Push"
---

2
source/_components/notify.rest.markdown
View File

@ -29,7 +29,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`.
- **resource** (*Required*): The resource or endpoint that will receive the value.
- **method** (*Optional*): The method of the request. Default is GET.
- **method** (*Optional*): The method of the request. Default is `GET`. Other valid options are `POST` or `POST_JSON`.
- **headers** (*Optional*): The headers for the request.
- **message_param_name** (*Optional*): Parameter name for the message. Defaults to `message`.
- **title_param_name** (*Optional*): Parameter name for the title. Defaults to none.

31
source/_components/openuv.markdown
View File

@ -8,23 +8,19 @@ comments: false
sharing: true
footer: true
logo: openuv.jpg
ha_category: Hub
ha_category: Health
ha_release: 0.76
ha_iot_class: "Cloud Polling"
---
The `openuv` component displays UV and Ozone data from
[openuv.io](http://openuv.io).
The `openuv` component displays UV and Ozone data from [openuv.io](http://openuv.io).
## {% linkable_title Generating an API Key %}
To generate an API key, [simply log in to the OpenUV website](https://www.openuv.io/auth/google).
<p class='note warning'>
The "Limited" plan (which is what new users are given by default) is limited to
500 API requests per day. In order to leave a buffer, the `openuv` component
queries the API every 30 minutes by default. This value can be modifed (via the
`scan_interval` key), but please note that over-running the API will require
The "Limited" plan (which is what new users are given by default) is limited to 500 API requests per day. In order to leave a buffer, the `openuv` component queries the API every 30 minutes by default. This value can be modifed (via the `scan_interval` key), but please note that over-running the API will require
you to upgrade to a paid plan (and may disable your access in the meantime).
</p>
@ -38,9 +34,7 @@ openuv:
api_key: YOUR_OPENUV_API_KEY
```
To configure additional functionality, add configuration options beneath
a `binary_sensor` and/or `sensor` key within the `openuv` section of
`configuration.yaml` as below:
To configure additional functionality, add configuration options beneath a `binary_sensor` and/or `sensor` key within the `openuv` section of `configuration.yaml` as below:
```yaml
openuv:
@ -87,8 +81,7 @@ sensors:
### {% linkable_title `uv_protection_window` %}
This sensor displays `true` if UV protection (sunscreen, etc.) is recommended
at the current date and time; displays `false` otherwise.
This sensor displays `true` if UV protection (sunscreen, etc.) is recommended at the current date and time; displays `false` otherwise.
## {% linkable_title Sensor Types %}
@ -102,19 +95,15 @@ This sensor displays the current UV index.
### {% linkable_title `current_uv_level` %}
This sensor displays the level of current UV index, which is calculated based
on [UV Index Levels & Colors](https://www.openuv.io/kb/uv-index-levels-colors).
This sensor displays the level of current UV index, which is calculated based on [UV Index Levels & Colors](https://www.openuv.io/kb/uv-index-levels-colors).
### {% linkable_title `max_uv_index` %}
This sensor displays the maximum UV index that will be encountered that day (at
solar noon).
This sensor displays the maximum UV index that will be encountered that day (at solar noon).
### {% linkable_title `safe_exposure_time_type_X` %}
These sensors display the approximate number of minutes a particular skin type
can be exposed to the sun before burning/tanning starts. Each sensor depicts
a skin type based on the
These sensors display the approximate number of minutes a particular skin type can be exposed to the sun before burning/tanning starts. Each sensor depicts a skin type based on the
[Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale):
* Skin Type I
@ -125,7 +114,5 @@ a skin type based on the
* Skin Type VI
<p class='note warning'>
The above guidelines constitude estimates and are intended to help informed
decision making. They should not replace analysis, advice, or diagnosis from a
trained medical professional.
The above guidelines constitude estimates and are intended to help informed decision making. They should not replace analysis, advice, or diagnosis from a trained medical professional.
</p>

2
source/_components/pilight.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: pilight.png
ha_category: Hub
ha_category: DIY
ha_release: 0.26
ha_iot_class: "Local Push"
---

4
source/_components/rainbird.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: rainbird.png
ha_category: Hub
ha_category: Irrigation
ha_release: 0.61
ha_iot_class: "Local Polling"
---
This `rainbird` component allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant.
## {% linkable_title Configuration %}
To enable it, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/raincloud.markdown
View File

@ -8,12 +8,14 @@ comments: false
sharing: true
footer: true
logo: raincloud.jpg
ha_category: Hub
ha_category: Irrigation
ha_release: 0.55
---
The `raincloud` component allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant.
## {% linkable_title Configuration %}
To enable it, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/rainmachine.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: rainmachine.png
ha_category: Hub
ha_category: Irrigation
ha_release: 0.69
ha_iot_class: "Cloud Polling"
---

4
source/_components/sensor.arest.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: arest.png
ha_category: Sensor
ha_category: DIY
ha_iot_class: "Local Polling"
ha_release: pre 0.7
---
@ -16,6 +16,8 @@ ha_release: pre 0.7
The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
## {% linkable_title Configuration %}
To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file:
```yaml

3
source/_components/sensor.bh1750.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Sensor
ha_category: DIY
ha_release: 0.48
ha_iot_class: "Local Push"
---
@ -20,6 +20,7 @@ Tested devices:
- [Raspberry Pi](https://www.raspberrypi.org/)
## {% linkable_title Configuration %}
To use your BH1750 sensor in your installation, add the following to your `configuration.yaml` file:

4
source/_components/sensor.bme280.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Sensor
ha_category: DIY
ha_release: 0.48
ha_iot_class: "Local Push"
---
@ -20,6 +20,8 @@ Tested devices:
- [Raspberry Pi](https://www.raspberrypi.org/)
## {% linkable_title Configuration %}
To use your BME280 sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/sensor.bme680.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Sensor
ha_category: DIY
ha_release: 0.62
ha_iot_class: "Local Push"
---

4
source/_components/sensor.bmw_connected_drive.markdown
View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: bmw.png
ha_category: Sensor
ha_category: Car
ha_release: 0.64
---
The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant.
The `bmw_connected_drive` sensor platform allows you to import data on your BMW into Home Assistant.
The sensors will be automatically configured if the `bmw_connected_drive` component is configured.

8
source/_components/sensor.citybikes.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "CityBikes API sensor"
title: "CityBikes Sensor"
description: "Instructions on how to integrate data from the CityBikes API into Home Assistant."
date: 2017-06-25 14:20
sidebar: true
@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: citybikes.png
ha_category: Sensor
ha_category: Transport
ha_release: 0.49
---
The `citybikes` sensor platform monitors bike availability at bike sharing stations in a chosen area. The data is provided by [CityBikes](https://citybik.es/#about), which supports bike sharing systems all around the world.
## {% linkable_title Configuration %}
To enable it, add the following lines to your `configuration.yaml`:
```yaml
@ -33,6 +35,8 @@ Configuration options:
- **radius** (*Optional*): The radius (in meters or feet, depending on the Home Assistant configuration) around the monitored location. Only stations closer than this distance will be monitored.
- **stations** array (*Optional*): A list of specific stations to monitor. The list should contain station `ID`s or `UID`s, which can be obtained from the CityBikes API.
## {% linkable_title Example %}
Additional configuration samples:
```yaml

2
source/_components/sensor.coinbase.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: coinbase.png
ha_category: Sensor
ha_category: Finance
ha_release: 0.61
---

2
source/_components/sensor.eight_sleep.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: eight_sleep.png
ha_category: Sensor
ha_category: Health
ha_release: "0.44"
ha_iot_class: "Cloud Polling"
---

2
source/_components/sensor.envirophat.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Sensor
ha_category: DIY
ha_iot_class: "Local Polling"
ha_release: 0.44
---

4
source/_components/sensor.fedex.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: fedex.png
ha_category: Sensor
ha_category: Postal Service
ha_release: 0.39
ha_iot_class: "Cloud Polling"
---
The `fedex` platform allows one to track deliveries by [FedEx](http://www.fedex.com/). To use this sensor, you need a [FedEx Delivery Manager](https://www.fedex.com/us/delivery/) account.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml

7
source/_components/sensor.fints.markdown
View File

@ -7,14 +7,16 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_release: 0.70
ha_category: Finance
ha_release: "0.70"
ha_iot_class: "Local Push"
logo: home-assistant.png
---
With the FinTS sensor, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline.
## {% linkable_title Configuration %}
For each account you have with the bank, a separate sensor is created. If you have several accounts with a bank, you can select which ones you want to have, and you can also give the accounts a name.
{% raw %}
@ -70,5 +72,4 @@ To find out the configuration for your bank, check their website or call their h
description: (optional) Use this field to give the account a meaningful name.
required: false
type: string
{% endconfiguration %}

4
source/_components/sensor.htu21d.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Sensor
ha_category: DIY
ha_release: 0.48
ha_iot_class: "Local Push"
---
@ -20,6 +20,8 @@ Tested devices:
- [Raspberry Pi](https://www.raspberrypi.org/)
## {% linkable_title Configuration %}
To use your HTU21D sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/sensor.hydrawise.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: hydrawise_logo.png
ha_category: Sensor
ha_category: Irrigation
ha_release: 0.71
ha_iot_class: Cloud Polling
---
Before setting up the [Hunter Hydrawise](https://hydrawise.com) sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component.
## {% linkable_title Configuration %}
Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/sensor.imap.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: smtp.png
ha_category: Sensor
ha_category: Mailbox
ha_release: 0.25
ha_iot_class: "Cloud Push"
---
@ -16,6 +16,8 @@ ha_iot_class: "Cloud Push"
The `imap` sensor platform is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml

4
source/_components/sensor.imap_email_content.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: smtp.png
ha_category: Sensor
ha_category: Mailbox
ha_iot_class: "Local Polling"
ha_release: 0.25
---
@ -16,6 +16,8 @@ ha_release: 0.25
The `imap_email_content` sensor platform will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml

4
source/_components/sensor.mercedesme.markdown
View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: mercedesme.png
ha_category: Sensor
ha_category: Car
ha_iot_class: "Cloud Push"
ha_release: 0.63
---
The `Mercedes me` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors from within Home Assistant.
The `mercedesme` sensor platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors from within Home Assistant.
The sensor platform will be automatically configured if Mercedes me component is configured.

4
source/_components/sensor.mhz19.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mhz19_logo.png
ha_category: Sensor
ha_category: DIY
ha_release: 0.27
ha_iot_class: "Local Polling"
---
@ -17,6 +17,8 @@ The MH-Z19 is a small non-dispersive infrared sensor that can measure CO2 level.
Check out the [Open Home Automation web site](https://www.open-homeautomation.com/2016/08/24/monitor-co2-levels-in-your-house/) for a quick guide how to connect the sensor to your PC or Raspberry Pi.
## {% linkable_title Configuration %}
To use this sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

8
source/_components/sensor.mopar.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mopar.png
ha_category: Sensor
ha_category: Car
featured: false
ha_release: 0.53
ha_iot_class: "Cloud Polling"
@ -19,8 +19,12 @@ The `mopar` sensor provides the following for owners of FCA vehicles with a uCon
- Sensor per vehicle with vehicle health report and other meta-data
- Service for remote commands: Lock/unlock, Engine on/off, Horn & lights
## {% linkable_title Setup %}
Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) registered by VIN. You must also have a current uConnect subscription.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`.
```yaml
@ -42,7 +46,7 @@ password:
required: true
type: string
pin:
description: v
description: The pin for your account.
required: true
type: string
{% endconfiguration %}

12
source/_components/sensor.mychevy.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "MyChevy Sensors"
title: "MyChevy Sensor"
description: "Instructions on how to integrate Chevy Bolt sensors car into Home Assistant."
date: 2017-08-28 17:00
sidebar: true
@ -8,9 +8,15 @@ comments: false
sharing: true
footer: true
logo: chevy.png
ha_category: Sensor
ha_category: Car
ha_release: 0.62
ha_iot_class: "Cloud Polling"
---
For configuration instructions, see [main component config](/components/mychevy/).
The `mychevy` sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant.
The sensor platform will be automatically configured if the `mychevy` component is configured.
For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation.

2
source/_components/sensor.mysensors.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Sensor
ha_category: DIY
featured: false
ha_iot_class: "Local Push"
---

2
source/_components/sensor.nsw_fuel_station.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Fuel
ha_category: Car
ha_release: 0.72
ha_iot_class: "Cloud Polling"
---

30
source/_components/sensor.opensky.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: opensky.png
ha_category: Sensor
ha_category: Transport
featured: false
ha_release: 0.43
ha_iot_class: "Cloud Polling"
@ -16,9 +16,9 @@ ha_iot_class: "Cloud Polling"
The `opensky` sensor allows one to track overhead flights in a given region. It uses crowd-sourced data from the [OpenSky Network](https://opensky-network.org/) public API. It will also fire Home Assistant events when flights enter and exit the defined region.
## Configuration
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`.
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
sensor:
@ -28,24 +28,24 @@ sensor:
Configuration options for the OpenSky Network sensor:
- **radius** (*Required*): Radius of region to monitor, in kilometers
- **latitude** (*Optional*): Region latitude (defaults to home zone latitude)
- **longitude** (*Optional*): Region longitude (defaults to home zone longitude)
- **altitude** (*Optional*): The maximum altitude(in meters) for planes to be detected in, 0 sets it to unlimited (defaults to 0)
- **name** (*Optional*): Sensor name (defaults to `opensky`)
- **radius** (*Required*): Radius of region to monitor, in kilometers.
- **latitude** (*Optional*): Region latitude. Defaults to home zone latitude.
- **longitude** (*Optional*): Region longitude. Defaults to home zone longitude.
- **altitude** (*Optional*): The maximum altitude (in meters) for planes to be detected in, 0 sets it to unlimited. Defaults to 0).
- **name** (*Optional*): Sensor name. Defaults to opensky.
## Events
## {% linkable_title Events %}
- **opensky_entry**: Fired when a flight enters the region
- **opensky_exit**: Fired when a flight exits the region
- **opensky_entry**: Fired when a flight enters the region.
- **opensky_exit**: Fired when a flight exits the region.
Both events have two attributes:
- **sensor**: Name of `opensky` sensor that fired the event
- **callsign**: Callsign of the flight
- **altitude**: Altitude of the flight in meters
- **sensor**: Name of `opensky` sensor that fired the event.
- **callsign**: Callsign of the flight.
- **altitude**: Altitude of the flight in meters.
To receive notifications of the entering flights, add the following lines to your `configuration.yaml`.
To receive notifications of the entering flights, add the following lines to your `configuration.yaml` file:
{% raw %}
```yaml

12
source/_components/sensor.openuv.markdown
View File

@ -8,16 +8,12 @@ comments: false
sharing: true
footer: true
logo: openuv.jpg
ha_category: Sensor
ha_category: Health
ha_release: 0.76
ha_iot_class: "Cloud Polling"
---
The `openuv` sensor platform allows you to view sensor data from
[OpenUV](http://openuv.io).
The `openuv` sensor platform allows you to view sensor data from [OpenUV](http://openuv.io).
You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, sensors will automatically appear.
<p class='note'>
You must have the [OpenUV component](/components/openuv/) configured to use
this platform. After configuring that component, sensors will automatically
appear.
</p>

2
source/_components/sensor.pilight.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: pilight.png
ha_category: Sensor
ha_category: DIY
ha_release: 0.31
ha_iot_class: depends
---

2
source/_components/sensor.postnl.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: postnl.png
ha_category: Sensor
ha_category: Postal Service
ha_release: 0.69
ha_iot_class: "Cloud Polling"
---

2
source/_components/sensor.radarr.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: radarr.png
ha_category: Sensor
ha_category: Downloading
ha_release: 0.47
---

4
source/_components/sensor.rainbird.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: rainbird.png
ha_category: Hub
ha_category: Irrigation
ha_release: 0.61
ha_iot_class: "Local Polling"
---
This `rainbird` sensor allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant.
## {% linkable_title Configuration %}
Once you have enabled the [Rain Bird component](/components/rainbird), add the following to your `configuration.yaml` file to enable the rain sensor:
```yaml

4
source/_components/sensor.raincloud.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raincloud.jpg
ha_category: Sensor
ha_category: Irrigation
ha_release: "0.55"
ha_iot_class: "Cloud Polling"
---
To get your [Melnor RainCloud](https://wifiaquatimer.com) sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud).
## {% linkable_title Configuration %}
Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file:
```yaml

2
source/_components/sensor.rainmachine.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: rainmachine.png
ha_category: Sensor
ha_category: Irrigation
ha_iot_class: "Cloud Polling"
ha_release: 0.71
---

2
source/_components/sensor.random.markdown
View File

@ -18,7 +18,7 @@ The `random` sensor platform is creating random sensor values (integers) out of
## {% linkable_title Configuration %}
To enable the random sensor, add the following lines to your `configuration.yaml`:
To enable the random sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

25
source/_components/sensor.sense.markdown
View File

@ -15,6 +15,9 @@ ha_release: 0.65
Integrate your [Sense](https://sense.com) meter information into Home Assistant.
## {% linkable_title Configuration %}
To enable this sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -31,9 +34,9 @@ sensor:
```
Two types of sensors can be monitored and will be created with the following names:
- **Active Usage/Production**: Current active power usage/production in Watts. Updated every 30 seconds.
- **Daily Usage/Production**: Daily power usage/production in kWh. Updated every 5 minutes.
- ...
Weekly, Monthly and Yearly variants are also available.
@ -52,23 +55,23 @@ monitored_conditions:
type: list
keys:
active_usage:
description: The current power usage in W
description: The current power usage in W.
active_production:
description: The current solar production in W
description: The current solar production in W.
daily_usage:
description: Total power used for current day in kWh
description: Total power used for current day in kWh.
daily_production:
description: Total power produced for current day in kWh
description: Total power produced for current day in kWh.
weekly_usage:
description: Total power used for current week in kWh
description: Total power used for current week in kWh.
weekly_production:
description: Total power produced for current week in kWh
description: Total power produced for current week in kWh.
monthly_usage:
description: Total power used for current month in kWh
description: Total power used for current month in kWh.
monthly_production:
description: Total power produced for current month in kWh
description: Total power produced for current month in kWh.
yearly_usage:
description: Total power used for current year in kWh
description: Total power used for current year in kWh.
yearly_production:
description: Total power produced for current year in kWh
description: Total power produced for current year in kWh.
{% endconfiguration %}

10
source/_components/sensor.sensehat.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: sense-hat.png
ha_category: Sensor
ha_category: DIY
ha_release: 0.35
ha_iot_class: "Local Push"
---
@ -16,6 +16,8 @@ ha_iot_class: "Local Push"
The `sensehat` sensor platform allows you to display information collected by a [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) add-on board for Raspberry Pi.
## {% linkable_title Configuration %}
To add this platform to your installation, add the following to your `configuration.yaml` file:
```yaml
@ -23,9 +25,9 @@ To add this platform to your installation, add the following to your `configurat
sensor:
- platform: sensehat
display_options:
- temperature
- humidity
- pressure
- temperature
- humidity
- pressure
```
Configuration variables:

2
source/_components/sensor.sleepiq.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: sleepiq.png
ha_category: Sensor
ha_category: Health
ha_release: 0.29
ha_iot_class: "Local Polling"
---

Some files were not shown because too many files have changed in this diff Show More