Merge branch 'current' into next
This commit is contained in:
Fabian Affolter
commit
518dbd7b89
92 changed files with 561 additions and 364 deletions
|
|
@ -12,7 +12,7 @@ ha_category: Alarm
|
|||
ha_release: 0.11
|
||||
---
|
||||
|
||||
The `alarmdotcom` platform is consuming the information provided by a [Alarm.com](https://www.alarm.com/).
|
||||
The `alarmdotcom` platform is consuming the information provided by [Alarm.com](https://www.alarm.com/).
|
||||
|
||||
To enable this, add the following lines to your `configuration.yaml`:
|
||||
|
||||
|
|
|
|||
|
|
@ -39,11 +39,11 @@ Configuration variables:
|
|||
- **report_server_codes** list (*Optional*): List of codes for the different states.
|
||||
|
||||
Note that this basic configuration will only enable you to read the armed/armed away/disarmed status of your alarm and will **not** update the status if the alarm is triggered. This is because of how Egardia built their system. The alarm triggers normally go through their servers.
|
||||
You can change this however, using the following procedure. This is an more advanced configuration.
|
||||
You can change this, however, using the following procedure. This is a more advanced configuration.
|
||||
|
||||
1. Login into your alarm system's control panel. You will need to access http://[ip of your control panel]. You know this already, since you need it in the basic configuration from above. Login to the control panel with your Egardia/Woonveilig username and password
|
||||
1. Log in into your alarm system's control panel. You will need to access http://[ip of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password.
|
||||
2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. Also, update the port number 85 or to anything you like. The provided software that you will set up in the next steps runs on port 85 by default. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'.
|
||||
3. On your Home Assistant machine run `$ sudo python3 egardiaserver.py`. This will receive status codes from your alarm control panel and display them. You will need the codes to include in your configuration.yaml. Make sure to change the status of your alarm to all states (disarm, arm, armhome) as well as trigger the alarm in all ways possible to get 100% coverage. **Before triggering the alarm it might be good to temporarily disable the siren (can be done in Panel Settings).**
|
||||
3. On your Home Assistant machine run `$ sudo python3 egardiaserver.py`. This will receive status codes from your alarm control panel and display them. You will need the codes to include in your configuration.yaml. Make sure to change the status of your alarm to all states (disarm, arm, armhome) as well as trigger the alarm in all ways possible to get 100% coverage. **Before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).**
|
||||
4. Once you have the codes, update your `configuration.yaml`:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
@ -61,10 +61,10 @@ alarm_control_panel:
|
|||
triggered: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
|
||||
standby: XXXXXXXXXXXXXXXX
|
||||
```
|
||||
Note that your can have more than one code for triggered, since every sensor generates it's own code. arm, disarm, armhome and standby will all be one code.
|
||||
Note that you can have more than one code for triggered since every sensor generates its own code. arm, disarm, armhome and standby will all be one code.
|
||||
5. Start the `egardiaserver.py` script on boot of your Home Assistant machine, for example by adding the following to your `/etc/rc.local`:
|
||||
```bash
|
||||
python3 [path/to/]egardiaserver.py &
|
||||
```
|
||||
**Do not forget the trailing & here, otherwise you will be having a hard time logging back in to the machine.**
|
||||
**Do not forget the trailing & here; otherwise you will be having a hard time logging back into the machine.**
|
||||
6. Test your setup and enjoy. The component will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish.
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ Configuration variables:
|
|||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
In this section you find some real life examples of how to use this panel.
|
||||
In this section, you find some real-life examples of how to use this panel.
|
||||
|
||||
### {% linkable_title Sensors %}
|
||||
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ All configuration variables from the base manual alarm platform are available:
|
|||
Additionally, the following MQTT configuration variables are also available:
|
||||
|
||||
- **state_topic** (*Required*): The MQTT topic HA will publish state updates to.
|
||||
- **command_topic** (*Required*): The MQTT topic HA will subscribe to to receive commands from a remote device to change the alarm state.
|
||||
- **command_topic** (*Required*): The MQTT topic HA will subscribe to, to receive commands from a remote device to change the alarm state.
|
||||
- **qos** (*Optional*): The maximum QoS level for subscribing and publishing to MQTT messages. Default is 0.
|
||||
- **payload_disarm** (*Optional*): The payload to disarm this Alarm Panel. Default is "DISARM".
|
||||
- **payload_arm_home** (*Optional*): The payload to set armed-home mode on this Alarm Panel. Default is "ARM_HOME".
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ The component will accept the following states from your Alarm Panel (in lower c
|
|||
- 'pending'
|
||||
- 'triggered'
|
||||
|
||||
The component is able to control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
|
||||
The component can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
|
||||
|
||||
To enable this platform, add the following lines to your `configuration.yaml`:
|
||||
|
||||
|
|
|
|||
|
|
@ -26,6 +26,6 @@ The requirement is that you have setup [Wink](/components/wink/).
|
|||
|
||||
|
||||
<p class='note'>
|
||||
The above devices are confimed to work, but others may work as well.
|
||||
The above devices are confirmed to work, but others may work as well.
|
||||
</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ ha_release: 0.43
|
|||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and it's sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
|
||||
The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
|
||||
|
||||
Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for further information about the AlarmDecoder devices.
|
||||
|
||||
|
|
@ -46,10 +46,10 @@ alarmdecoder:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **type** (*Required*): The type of AlarmDecoder device: socket, serial or usb
|
||||
- **type** (*Required*): The type of AlarmDecoder device: socket, serial or USB
|
||||
- **host** (*Optional*): The IP address of the AlarmDecoder device on your home network, if using socket type. Default: `localhost`
|
||||
- **port** (*Optional*): The port of the AlarmDecoder device on your home network, if using socket type. Default: `10000`
|
||||
- **path** (*Optional*): The path of the AlarmDecoder device, if using socket type. Default: `/dev/ttyUSB0`
|
||||
- **baud** (*Optional*): The baud rate of the AlarmDecoder device, if using serial type. Default: `115200`
|
||||
- **panel_display** (*Optional*): Create a sensor called sensor.alarm_display to match the Alarm Keypad dispaly. Default: `off`
|
||||
- **panel_display** (*Optional*): Create a sensor called sensor.alarm_display to match the Alarm Keypad display. Default: `off`
|
||||
- **zones** (*Optional*): AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
|
||||
|
|
|
|||
|
|
@ -12,11 +12,11 @@ ha_category: Automation
|
|||
ha_release: 0.38
|
||||
---
|
||||
|
||||
The `alert` component is designed to notify you when problematic issues arise. For example, if the garage door is left open, the `alert` component can be used remind you of this by sending you repeating notifications at customizable intervals. This is also useful for low battery sensors, water leak sensors, or any condition that may need your attention.
|
||||
The `alert` component is designed to notify you when problematic issues arise. For example, if the garage door is left open, the `alert` component can be used remind you of this by sending you repeating notifications at customizable intervals. This is also used for low battery sensors, water leak sensors, or any condition that may need your attention.
|
||||
|
||||
Alerts will add an entity to the front end only when they are firing. This entity allows you to silence an alert until it is resolved.
|
||||
|
||||
When using the `alert` component it is important that the timezone used for Home Assistant and the underlying operating system match. Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` timezone but the operating system uses `UTC`).
|
||||
When using the `alert` component, it is important that the time zone used for Home Assistant and the underlying operating system match. Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` time zone but the operating system uses `UTC`).
|
||||
|
||||
### {% linkable_title Basic Example %}
|
||||
|
||||
|
|
@ -44,7 +44,7 @@ Configuration variables:
|
|||
- **entity_id** (*Required*): The ID of the entity to watch.
|
||||
- **state** (*Optional*): The problem condition for the entity. Defaults to `on`.
|
||||
- **repeat** (*Required*): Number of minutes before the notification should be repeated. Can be either a number or a list of numbers.
|
||||
- **can_acknowledge** (*Optional*): Allows the alert to be unacknowledgable. Defaults to `true`.
|
||||
- **can_acknowledge** (*Optional*): Allows the alert to be unacknowledgeable. Defaults to `true`.
|
||||
- **skip_first** (*Optional*): Controls whether the notification should be sent immediately or after the first delay. Defaults to `false`.
|
||||
- **notifiers** (*Required*): List of `notification` components to use for alerts.
|
||||
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ When activated, the Alexa component will have Home Assistant's native intent sup
|
|||
|
||||
One of the most useful applications of Alexa integrations is to call scenes directly. This is easily achieved with some simple setup on the Home Assistant side and by letting Alexa know which scenes you want to run.
|
||||
|
||||
First we will configure Alexa. In the Amazon Interaction module add this to the intent schema:
|
||||
First, we will configure Alexa. In the Amazon Interaction module add this to the intent schema:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -144,7 +144,7 @@ intent_script:
|
|||
|
||||
Here we are using [templates] to take the name we gave to Alexa e.g. `downstairs on` and replace the space with an underscore so it becomes `downstairs_on` as Home Assistant expects.
|
||||
|
||||
Now say `Alexa ask homeassistant to activate <some scene>` and Alexa will activate that scene for you.
|
||||
Now say `Alexa ask Home Assistant to activate <some scene>` and Alexa will activate that scene for you.
|
||||
|
||||
### {% linkable_title Adding Scripts %}
|
||||
|
||||
|
|
@ -190,7 +190,30 @@ intent_script:
|
|||
text: OK
|
||||
```
|
||||
|
||||
Now say `Alexa ask homeassistant to run <some script>` and Alexa will run that script for you.
|
||||
Now say `Alexa ask Home Assistant to run <some script>` and Alexa will run that script for you.
|
||||
|
||||
### {% linkable_title Support for Launch Requests %}
|
||||
There may be times when you want to respond to a launch request initiated from a command such as "Alexa, Red Alert!".
|
||||
|
||||
To start, you need to get the skill id:
|
||||
|
||||
- Log into [Amazon developer console][amazon-dev-console]
|
||||
- Click the Alexa button at the top of the console
|
||||
- Click the Alexa Skills Kit Get Started button
|
||||
- Locate the skill for which you would like Launch Request support
|
||||
- Click the "View Skill ID" link and copy the ID
|
||||
|
||||
The configuration is the same as an intent with the exception being you will use your skill ID instead of the intent name.
|
||||
```yaml
|
||||
intent_script:
|
||||
amzn1.ask.skill.08888888-7777-6666-5555-444444444444:
|
||||
action:
|
||||
service: script.turn_on
|
||||
entity_id: script.red_alert
|
||||
speech:
|
||||
type: plain
|
||||
text: OK
|
||||
```
|
||||
|
||||
## {% linkable_title Giving Alexa Some Personality %}
|
||||
|
||||
|
|
@ -282,7 +305,7 @@ Please refer to the [Amazon documentation][flash-briefing-api-docs] for more inf
|
|||
- All other settings are up to you
|
||||
- Hit "Next"
|
||||
- Test
|
||||
- Having passed all validations to reach this screen you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.
|
||||
- Having passed all validations to reach this screen, you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.
|
||||
- To invoke your flash briefing, open the Alexa app on your phone or go to the [Alexa Settings Site][alexa-settings-site], open the "Skills" configuration section, select "Your Skills", scroll to the bottom, tap on the Flash Briefing Skill you just created, enable it, then manage Flash Briefing and adjust ordering as necessary. Finally ask your Echo for your "news","flash briefing", or "briefing".
|
||||
|
||||
[amazon-dev-console]: https://developer.amazon.com
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ amcrest:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): The IP address or hostname of your camera. If using hostname, make sure the DNS works as expected.
|
||||
- **host** (*Required*): The IP address or hostname of your camera. If using a hostname, make sure the DNS works as expected.
|
||||
- **username** (*Required*): The username for accessing your camera.
|
||||
- **password** (*Required*): The password for accessing your camera.
|
||||
- **name** (*Optional*): This parameter allows you to override the name of your camera. The default is "Amcrest Camera".
|
||||
|
|
@ -46,14 +46,14 @@ Configuration variables:
|
|||
- **resolution** (*Optional*): This parameter allows you to specify the camera resolution. For a high resolution (1080/720p), specify the option `high`. For VGA resolution (640x480p), specify the option `low`. If omitted, it defaults to *high*.
|
||||
- **stream_source** (*Optional*): The data source for the live stream. `mjpeg` will use the camera's native MJPEG stream, whereas `snapshot` will use the camera's snapshot API to create a stream from still images. You can also set the `rtsp` option to generate the streaming via RTSP protocol. If omitted, it defaults to *snapshot*.
|
||||
- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options.
|
||||
- **authentication**: (*Optional*): Defines which authentication method to use only when **stream_source** is **mjpeg**. Currently *aiohttp* only support *basic*. It defaults to *basic*.
|
||||
- **authentication**: (*Optional*): Defines which authentication method to use only when **stream_source** is **mjpeg**. Currently, *aiohttp* only support *basic*. It defaults to *basic*.
|
||||
- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. The default is 10 seconds.
|
||||
- **sensors** array (*Optional*): Conditions to display in the frontend. By default, *none* of the conditions are enabled. The following conditions can be monitored.
|
||||
- **motion_detector**: Return True/False when a motion is detected
|
||||
- **sdcard**: Return the SD card usage by reporting the total and used space
|
||||
- **ptz_preset**: Return the number of PTZ preset positions configured for the given camera
|
||||
|
||||
**Note:** Amcrest cameras with newer firmwares no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead. If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager. If you defined the *stream_source* to **mjpeg**, make sure your camera supports *Basic* HTTP authentication. Newer Amcrest firwmares may not work, then **rtsp** is recommended instead.
|
||||
**Note:** Amcrest cameras with newer firmware no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead. If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager. If you defined the *stream_source* to **mjpeg**, make sure your camera supports *Basic* HTTP authentication. Newer Amcrest firmware may not work, then **rtsp** is recommended instead.
|
||||
|
||||
**Note:** If you set the `stream_source` option to `rtsp`, make sure to follow the steps mentioned at
|
||||
[FFMPEG](https://home-assistant.io/components/ffmpeg/) documentation to install the `ffmpeg`.
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
The `android_ip_webcam` component turns an Android phone into a network camera with multiple viewing options.
|
||||
|
||||
It's setup as a mjpeg camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list.
|
||||
It's setup as an M-JPEG camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list.
|
||||
|
||||
To set it up, download [the IP Webcam app][app], and add the following information to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -33,8 +33,8 @@ Configuration variables:
|
|||
- **username** (*Optional*): The username to access the phone.
|
||||
- **password** (*Optional*): The password to access the phone.
|
||||
- **scan_interval** (*Optional*): Default is 10 seconds. Defines the update interval of the phone.
|
||||
- **sensors** array (*Optional*): Conditions to display sensor in the frontend. See list of supported sensors.
|
||||
- **switches** array (*Optional*): Conditions to display settings in the frontend. See list of supported settings.
|
||||
- **sensors** array (*Optional*): Conditions to display sensor in the frontend. See the list of supported sensors.
|
||||
- **switches** array (*Optional*): Conditions to display settings in the frontend. See the list of supported settings.
|
||||
- **motion_sensor** (*Optional*): Activate motion sensor if auto_discovery is disabled.
|
||||
|
||||
### {% linkable_title Supported features %}
|
||||
|
|
|
|||
|
|
@ -13,9 +13,9 @@ featured: false
|
|||
ha_release: 0.38
|
||||
---
|
||||
|
||||
This component is designed to be used with the "webhook" integration in [api.ai][apiai-web]. When a conversation ends with an user, api.ai sends an action and parameters to the webhook.
|
||||
This component is designed to be used with the "webhook" integration in [api.ai][apiai-web]. When a conversation ends with a user, api.ai sends an action and parameters to the webhook.
|
||||
|
||||
api.ai requires a public endpoint (HTTPS recommended), so your Home Assistant should be exposed to Internet. api.ai will return fallback answers if your server do not answer, or takes too long (more than 5 seconds).
|
||||
api.ai requires a public endpoint (HTTPS recommended), so your Home Assistant should be exposed to the Internet. api.ai will return fallback answers if your server does not answer, or takes too long (more than 5 seconds).
|
||||
|
||||
api.ai could be integrated with many popular messaging, virtual assistant and IoT platforms, eg.: Google Assistant (Google Actions), Skype, Messenger. [See here](https://docs.api.ai/docs/integrations) the complete list.
|
||||
|
||||
|
|
@ -33,7 +33,7 @@ Using Api.ai will be easy to create conversations like:
|
|||
>
|
||||
> Bot: Turning on kitchen light
|
||||
|
||||
To use this integration you should define a conversation (intent) in Api.ai, configure Home Assistant with the speech to return and, optionally, the action to execute.
|
||||
To use this integration, you should define a conversation (intent) in Api.ai, configure Home Assistant with the speech to return and, optionally, the action to execute.
|
||||
|
||||
### {% linkable_title Configuring your api.ai account %}
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ To use this integration you should define a conversation (intent) in Api.ai, con
|
|||
- Click on "Create Agent"
|
||||
- Select name, language (if you are planning to use it with Google Actions check [here](https://support.google.com/assistant/answer/7108196?hl=en) supported languages) and time zone
|
||||
- Click "Save"
|
||||
- Go to "Fullfiment" (in the left menu)
|
||||
- Go to "Fulfillment" (in the left menu)
|
||||
- Enable Webhook and set your Home Assistant URL with the Api.ai endpoint. Eg.: ``https://myhome.duckdns.org/api/apiai?api_password=HA_PASSWORD``
|
||||
- Click "Save"
|
||||
- Create a new intent
|
||||
|
|
@ -70,29 +70,33 @@ apiai:
|
|||
|
||||
intent_script:
|
||||
Temperature:
|
||||
speech: The temperature at home is {{ states('sensor.home_temp') }} degrees
|
||||
speech:
|
||||
text: The temperature at home is {{ states('sensor.home_temp') }} degrees
|
||||
LocateIntent:
|
||||
speech: >
|
||||
{%- for state in states.device_tracker -%}
|
||||
{%- if state.name.lower() == User.lower() -%}
|
||||
{{ state.name }} is at {{ state.state }}
|
||||
{%- elif loop.last -%}
|
||||
I am sorry, I do not know where {{ User }} is.
|
||||
{%- endif -%}
|
||||
{%- else -%}
|
||||
Sorry, I don't have any trackers registered.
|
||||
{%- endfor -%}
|
||||
speech:
|
||||
text: >
|
||||
{%- for state in states.device_tracker -%}
|
||||
{%- if state.name.lower() == User.lower() -%}
|
||||
{{ state.name }} is at {{ state.state }}
|
||||
{%- elif loop.last -%}
|
||||
I am sorry, I do not know where {{ User }} is.
|
||||
{%- endif -%}
|
||||
{%- else -%}
|
||||
Sorry, I don't have any trackers registered.
|
||||
{%- endfor -%}
|
||||
WhereAreWeIntent:
|
||||
speech: >
|
||||
{%- if is_state('device_tracker.adri', 'home') and
|
||||
is_state('device_tracker.bea', 'home') -%}
|
||||
You are both home, you silly
|
||||
{%- else -%}
|
||||
Bea is at {{ states("device_tracker.bea") }}
|
||||
and Adri is at {{ states("device_tracker.adri") }}
|
||||
{% endif %}
|
||||
speech:
|
||||
text: >
|
||||
{%- if is_state('device_tracker.adri', 'home') and
|
||||
is_state('device_tracker.bea', 'home') -%}
|
||||
You are both home, you silly
|
||||
{%- else -%}
|
||||
Bea is at {{ states("device_tracker.bea") }}
|
||||
and Adri is at {{ states("device_tracker.adri") }}
|
||||
{% endif %}
|
||||
TurnLights:
|
||||
speech: Turning {{ Room }} lights {{ OnOff }}
|
||||
speech:
|
||||
text: Turning {{ Room }} lights {{ OnOff }}
|
||||
action:
|
||||
- service: notify.pushbullet
|
||||
data_template:
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ featured: true
|
|||
The `apple_tv` platform allows you to control an Apple TV (3rd and 4th generation). See the [remote platform](/components/remote.apple_tv/) if you want to send remote control buttons, e.g. arrow keys.
|
||||
|
||||
<p class='note'>
|
||||
Currently you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.
|
||||
Currently, you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.
|
||||
</p>
|
||||
|
||||
To use this component, you must first install some system libraries and a compiler. For Debian or a similar system, this should be enough:
|
||||
|
|
@ -26,7 +26,7 @@ To use this component, you must first install some system libraries and a compil
|
|||
$ sudo apt-get install build-essential libssl-dev libffi-dev python-dev
|
||||
```
|
||||
|
||||
If you want to automatically discover new devices, just make sure you have `discovery:` in your `configuration.yaml` file. To manually add one or more Apple TVs to your installation, add the following to your `configuration.yaml` file:
|
||||
If you want to discover new devices automatically, just make sure you have `discovery:` in your `configuration.yaml` file. To manually add one or more Apple TVs to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
@ -48,10 +48,10 @@ Configuration variables:
|
|||
- **host** (*Required*): The IP-address of the device.
|
||||
- **login_id** (*Required*): An identifier used to login to the device, see below.
|
||||
- **name** (*Optional*): The name of the device used in the frontend.
|
||||
- **start_off** (*Optional*): Set to true if device should start in fake standby.
|
||||
- **start_off** (*Optional*): Set to true if the device should start in fake standby.
|
||||
- **credentials** (*Optional*): Credentials used for AirPlay playback.
|
||||
|
||||
In order to connect to the device you need a *login id*. The easiest way to obtain this identifier is to use the `apple_tv_scan` service (described below). Additional information about `start_off` and `credentials` can also be found under the guides section.
|
||||
In order to connect to the device, you need a *login id*. The easiest way to obtain this identifier is to use the `apple_tv_scan` service (described below). Additional information about `start_off` and `credentials` can also be found under the guides section.
|
||||
|
||||
## {% linkable_title Guides %}
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ Scanning will be done for three seconds and notification will be shown in the st
|
|||
|
||||
<img src='/images/components/apple_tv/scan_result.jpg' />
|
||||
|
||||
Alternatively you may use the application ``atvremote``. Install it with ``pip3 install --upgrade pyatv`` in your Home Assistant environment (note: do *not* use sudo). Then run ``atvremote scan`` to scan for all devices (try again if a device is missing):
|
||||
Alternatively, you may use the application ``atvremote``. Install it with ``pip3 install --upgrade pyatv`` in your Home Assistant environment (note: do *not* use sudo). Then run ``atvremote scan`` to scan for all devices (try again if a device is missing):
|
||||
|
||||
```bash
|
||||
$ atvremote scan
|
||||
|
|
@ -83,20 +83,20 @@ Just copy and paste the login id from the device you want to add. For more detai
|
|||
|
||||
### {% linkable_title My Apple TV turns on when I restart Home Assistant %}
|
||||
|
||||
The Apple TV will automatically turn on if a request is sent to it, e.g. if a button is pressed, something is streamed to it via AirPlay or if current state (currently playing) is accessed. This is how Apple has designed it and it will cause problems if you are using HDMI CEC. Every time Home Assistant is started, a new request is sent to the device to figure out what is currently playing. When using CEC, this will wake up your TV and other devices you have configured.
|
||||
The Apple TV will automatically turn on if a request is sent to it, e.g., if a button is pressed, something is streamed to it via AirPlay or if current state (currently playing) is accessed. This is how Apple has designed it, and it will cause problems if you are using HDMI CEC. Every time Home Assistant is started, a new request is sent to the device to figure out what is currently playing. When using CEC, this will wake up your TV and other devices you have configured.
|
||||
|
||||
So, if your TV is randomly turning on, this is probably the reason. As stated, this is by design and there is no real fix for it. There's also no known way to turn off the Apple TV via the procotol used for communication. You basically have the following options:
|
||||
So, if your TV is randomly turning on, this is probably the reason. As stated, this is by design, and there is no real fix for it. There's also no known way to turn off the Apple TV via the protocol used for communication. You have the following options:
|
||||
|
||||
- Do not use this platform
|
||||
- Disable HDMI CEC on your Apple TV
|
||||
- Use "fake standby"
|
||||
|
||||
The first two points are quite obvious. Fake standby is a concept implemented in this platform that disables all requests to the device and make it appear as being "off" in the web interface. This will make sure that the device is not woken up, but it will of course not show any information or allow you to control it. It is however easy to turn it on (or off) in the web interface or using an automation with `turn_on`. To make it more useful, you can write automations that turns it on or off depending on some other device, like the input source on your receiver.
|
||||
The first two points are quite obvious. Fake standby is a concept implemented in this platform that disables all requests to the device and makes it appear as being "off" in the web interface. This will make sure that the device is not woken up, but it will of course not show any information or allow you to control it. It is however easy to turn it on (or off) in the web interface or to use an automation with `turn_on`. To make it more useful, you can write automations that turn it on or off depending on some other device, like the input source on your receiver.
|
||||
|
||||
To put a device into fake standby when starting Home Assistant, add `start_off: true` to your configuration.
|
||||
|
||||
<p class='note warning'>
|
||||
Turning the device on/off in the user interface will *not* turn the physical device on/off according to description above.
|
||||
Turning the device on/off in the user interface will *not* turn the physical device on/off according to the description above.
|
||||
</p>
|
||||
|
||||
|
||||
|
|
@ -128,13 +128,13 @@ apple_tv:
|
|||
credentials: 1B8C387DDB59BDF6:CF5ABB6A2C070688F5926ADB7C010F6DF847252C15F9BDB6DA3E09D6591E90E5
|
||||
```
|
||||
|
||||
Restart Home Assistant and you should now be able to use `play_url` as before.
|
||||
Restart Home Assistant, and you should now be able to use `play_url` as before.
|
||||
|
||||
## {% linkable_title Services %}
|
||||
|
||||
### {% linkable_title Service `apple_tv_authenticate` %}
|
||||
|
||||
In order to play media on an Apple TV with device authentication enabled (e.g. ATV4 with tvOS 10.2+), Home Assistant must properly authenticated. This method starts the process and presents the credentials needed for playback as a persistent notification. Please see guide above for usage.
|
||||
To play media on an Apple TV with device authentication enabled (e.g., ATV4 with tvOS 10.2+), Home Assistant must be properly authenticated. This method starts the process and presents the credentials needed for playback as a persistent notification. Please see guide above for usage.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
|
|
|
|||
|
|
@ -14,13 +14,13 @@ ha_release: pre 0.7
|
|||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The [Arduino](https://www.arduino.cc/) device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection. The equipment depends on the [type](https://www.arduino.cc/en/Main/Products) of board. The most common ones are the Arduino Uno and the Arduino Leonardo with 14 digital input/output pins and 6 analog input pins.
|
||||
The [Arduino](https://www.arduino.cc/) device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection. The equipment depends on the [type](https://www.arduino.cc/en/Main/Products) of the board. The most common ones are the Arduino Uno and the Arduino Leonardo with 14 digital input/output pins and 6 analog input pins.
|
||||
|
||||
There are a lot of extensions (so called [shields](https://www.arduino.cc/en/Main/ArduinoShields)) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards.
|
||||
There are a lot of extensions (so-called [shields](https://www.arduino.cc/en/Main/ArduinoShields)) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards.
|
||||
|
||||
The `arduino` component is designed to let you use a directly attached board to your Home Assistant host over USB.
|
||||
|
||||
You need to have the [Firmata firmware](https://github.com/firmata/) on your board. Please upload the `StandardFirmata` sketch to your board, please refer to the [Arduino documentation](https://www.arduino.cc/en/Main/Howto) for further information.
|
||||
You need to have the [Firmata firmware](https://github.com/firmata/) on your board. Please upload the `StandardFirmata` sketch to your board; please refer to the [Arduino documentation](https://www.arduino.cc/en/Main/Howto) for further information.
|
||||
|
||||
To integrate an Arduino boards with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ arduino:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **port** (*Required*): The port where your board is connected to your Home Assistant host. If you are using an original Arduino the port will be named `ttyACM*` otherwise `ttyUSB*`.
|
||||
- **port** (*Required*): The port where your board is connected to your Home Assistant host. If you are using an original Arduino, the port will be named `ttyACM*` otherwise `ttyUSB*`.
|
||||
|
||||
The exact number can be determined with the command shown below.
|
||||
|
||||
|
|
@ -40,7 +40,7 @@ The exact number can be determined with the command shown below.
|
|||
$ ls /dev/ttyACM*
|
||||
```
|
||||
|
||||
If that's not working, check your `dmesg` or `journalctl -f` output. Keep in mind that Arduino clones are often using a different name for the port (eg. `/dev/ttyUSB*`).
|
||||
If that's not working, check your `dmesg` or `journalctl -f` output. Keep in mind that Arduino clones are often using a different name for the port (e.g. `/dev/ttyUSB*`).
|
||||
|
||||
<p class='note warning'>
|
||||
A word of caution: The Arduino boards are not storing states. This means that with every initialization the pins are set to off/low.
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ The Arlo component also provides a service to enable/disable the motion detectio
|
|||
- alias: Enable Arlo upton HA start'
|
||||
initial_state: 'on'
|
||||
trigger:
|
||||
platform: homeassitant
|
||||
platform: homeassistant
|
||||
event: start
|
||||
action:
|
||||
service: camera.enable_motion_detection
|
||||
|
|
|
|||
|
|
@ -12,11 +12,11 @@ ha_version: 0.51
|
|||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The Asterisk Voicemail integration for Home Assistant allows you to view, listen-to, and delete voicemails from a Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that provides an indication of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.
|
||||
The Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.
|
||||
|
||||
To enable the component, configuration is required in both Home Assistant as well as on the Asterisk server.
|
||||
To enable the component, a configuration is required in both Home Assistant as well as on the Asterisk server.
|
||||
|
||||
First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox) to setup the necessary server on the Asterisk PBX server (this is necessary even if Asterisk and Home Assistant are running on the same server)
|
||||
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)
|
||||
|
||||
Once that is complete, add the the following entry `configuration.yaml` file:
|
||||
|
||||
|
|
@ -32,11 +32,11 @@ This will add a new 'Mailbox' side-panel, as well as a sensor to indicate # of m
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **password** (*Required*): The password that was set during Asterisk PBX confguration
|
||||
- **password** (*Required*): The password that was set during Asterisk PBX configuration
|
||||
- **host** (*Required*): The ip-address of the server that is running the Asterisk PBX
|
||||
- **port** (*Required*): The port on the Asterisk PBX server that was configured during Asterisk PBX confguration
|
||||
- **port** (*Required*): The port on the Asterisk PBX server that was configured during Asterisk PBX configuration
|
||||
|
||||
<p class='note warning'>
|
||||
Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this component when communication will be contained within a local area network.
|
||||
Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this component when communication is contained within a local area network.
|
||||
</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ ha_release: "0.45"
|
|||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
[Axis Communications](https://www.axis.com/) devices are surveillance cameras and other security related network connected hardware. Sensor API works with firmware 5.50 and newer.
|
||||
[Axis Communications](https://www.axis.com/) devices are surveillance cameras and other security-related network connected hardware. Sensor API works with firmware 5.50 and newer.
|
||||
|
||||
Home Assistant will automatically discover their presence on your network.
|
||||
|
||||
|
|
@ -62,7 +62,7 @@ Configuration variables:
|
|||
- **camera**: Stream MJPEG video to Home Assistant.
|
||||
- **motion**: The built-in motion detection in Axis cameras.
|
||||
- **vmd3**: ACAP Motion Detection app which has better algorithms for motion detection.
|
||||
- **pir**: PIR sensor that can trigger on motion.
|
||||
- **pir**: PIR sensor that can trigger on a motion.
|
||||
- **sound**: Sound detector.
|
||||
- **daynight**: Certain cameras have day/night mode if they have built-in IR lights.
|
||||
- **tampering**: Signals when camera believes that it has been tampered with.
|
||||
|
|
@ -88,7 +88,7 @@ axis:
|
|||
```
|
||||
|
||||
<p class='note'>
|
||||
If you are using Python3.6 you might need to replace the 34m with 36m in the _gi.*.so filename in the gi folder.
|
||||
If you are using Python 3.6, you might need to replace the 34m with 36m in the _gi.*.so filename in the gi folder.
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
|
|
@ -96,7 +96,7 @@ Any specific levels for triggers needs to be configured on the device.
|
|||
</p>
|
||||
|
||||
<p class='note'>
|
||||
It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality it is enough to create a user belonging to user group viewer.
|
||||
It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality, it is enough to create a user belonging to user group viewer.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Device services %}
|
||||
|
|
@ -109,7 +109,7 @@ Send a command using [Vapix](https://www.axis.com/support/developer-support/vapi
|
|||
|---------------------------|----------|--------------------------------------------------|
|
||||
| `name` | no | Name of device to communicate with. |
|
||||
| `param` | no | What parameter to operate on. |
|
||||
| `cgi` | yes | Which cgi to call on device. Default is `param.cgi`. |
|
||||
| `cgi` | yes | Which cgi to call on the device. Default is `param.cgi`. |
|
||||
| `action` | yes | What type of call. Default is `update`. |
|
||||
|
||||
Response to call can be subscribed to on event `vapix_call_response`
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ footer: true
|
|||
logo: xiaomi.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: "0.50"
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
|
||||
|
|
@ -20,12 +20,21 @@ The requirement is that you have setup the [`xiaomi` component](/components/xiao
|
|||
|
||||
|
||||
### {% linkable_title Type of sensors supported %}
|
||||
- Motion
|
||||
- Door / Window
|
||||
- Smoke
|
||||
- Gas
|
||||
- Xiaomi Wireless Button
|
||||
- Xiaomi Cube
|
||||
|
||||
| Name | ZigBee entity | Model no. | States | Event | Event key | Event values |
|
||||
|-----------------------------------|---------------------|----------------------|----------------------------------------------------|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
|
||||
| Motion Sensor (1st gen) | motion | RTCGQ01LM | on, off | `motion` | | |
|
||||
| Motion Sensor (2nd gen) | sensor_motion.aq2 | RTCGQ11LM | on, off | `motion` | | |
|
||||
| Door and Window Sensor (1st gen) | magnet | WSDCGQ01LM | on, off | | | |
|
||||
| Door and Window Sensor (2nd gen) | sensor_magnet.aq2 | MCCGQ11LM | on, off | | | |
|
||||
| Smoke Detector | smoke | JTYJ-GD-01LM/BW | on, off | | | |
|
||||
| Gas Leak Detector | natgas | JTQJ-BF-01LM/BW | on, off | | | |
|
||||
| Button (1st gen) | switch | WXKG01LM | on (thru long_click_press), off | `click` | `click_type` | `long_click_press`, `long_click_release`, `hold`, `single`, `double` |
|
||||
| Button (2nd gen) | sensor_switch.aq2 | WXKG11LM | off (always) | `click` | `click_type` | `single`, `double` |
|
||||
| Aqara Wireless Switch (Single) | 86sw1 | WXKG03LM | off (always) | `click` | `click_type` | `single` |
|
||||
| Aqara Wireless Switch (Double) | 86sw2 | WXKG02LM | off (always) | `click` | `click_type` | `single`, `both` |
|
||||
| Cube | cube | MFKZQ01LM | off (always) | `cube_action` | `action_type`, `action_value` (rotate) | `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall`, `rotate` (degrees at action_value) |
|
||||
|
||||
|
||||
### {% linkable_title Automation examples %}
|
||||
|
||||
|
|
@ -65,7 +74,7 @@ The requirement is that you have setup the [`xiaomi` component](/components/xiao
|
|||
data:
|
||||
entity_id: automation.Motion_off
|
||||
```
|
||||
|
||||
|
||||
#### {% linkable_title Door and/or Window %}
|
||||
|
||||
```yaml
|
||||
|
|
@ -194,8 +203,8 @@ Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swi
|
|||
platform: event
|
||||
event_type: cube_action
|
||||
event_data:
|
||||
entity_id: binary_sensor.cube_15xxxxxxxxxxxx
|
||||
action_type: flip180
|
||||
entity_id: binary_sensor.cube_15xxxxxxxxxxxx
|
||||
action_type: flip180
|
||||
action:
|
||||
- service: light.turn_on
|
||||
entity_id: light.gateway_light_28xxxxxxxxxx
|
||||
|
|
@ -203,10 +212,10 @@ Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swi
|
|||
color_name: "darkviolet"
|
||||
- alias: Cube event move
|
||||
trigger:
|
||||
platform: event
|
||||
platform: event
|
||||
event_type: cube_action
|
||||
event_data:
|
||||
entity_id: binary_sensor.cube_15xxxxxxxxxxxx
|
||||
event_data:
|
||||
entity_id: binary_sensor.cube_15xxxxxxxxxxxx
|
||||
action_type: move
|
||||
action:
|
||||
- service: light.turn_on
|
||||
|
|
@ -238,7 +247,8 @@ Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swi
|
|||
data:
|
||||
color_name: "blue"
|
||||
```
|
||||
#### #### {% linkable_title Aqara Wireless Switch %}
|
||||
|
||||
#### {% linkable_title Aqara Wireless Switch %}
|
||||
|
||||
The Aqara Wireless Switch is available as single-key and double-key version. Each key behaves like the Wireless Button limited to the click event `single`. The double key version adds a third device called `binary_sensor.wall_switch_both_158xxxxxxxxx12` which reports a click event called `both` if both keys are pressed.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ footer: true
|
|||
logo: myq.png
|
||||
ha_category: Cover
|
||||
ha_release: 0.39
|
||||
ha_iot_class: Cloud Polling
|
||||
---
|
||||
|
||||
The `myq` cover platform lets you control MyQ-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your MyQ Device mobile app.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ footer: true
|
|||
logo: xiaomi.png
|
||||
ha_category: Cover
|
||||
ha_release: "0.50"
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -12,10 +12,18 @@ logo: linksys.png
|
|||
ha_release: 0.48
|
||||
---
|
||||
|
||||
The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wifi based
|
||||
router. It was tested with a LINKSYS WRT3200ACM MU-MIMO Gigabit Wi-Fi Wireless Router.
|
||||
The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wifi based router.
|
||||
|
||||
To use a Linksys Smart Wifi Router in your installation, add the following to your `configuration.yaml` file:
|
||||
Tested routers:
|
||||
LINKSYS WRT3200ACM MU-MIMO Gigabit Wi-Fi Wireless Router
|
||||
LINKSYS WRT1900ACS Dual-band Wi-Fi Router
|
||||
|
||||
|
||||
<p class='note'>
|
||||
For this platform to work correctly, it is necessary to disable the "Access via wireless" feature in the Local Management Access section of the router administration page. If "Access via wireless" is not disabled, a connectivity conflict arises because the Home Assistant integration is trying to pass userid and password, but the router is only expecting a password.
|
||||
</p>
|
||||
|
||||
To use a Linksys Smart Wifi Router in your Home Assistant installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
|
|||
|
|
@ -34,4 +34,7 @@ Configuration variables:
|
|||
- **password** (*Required*): The password for your given admin account.
|
||||
- **port** (*Optional*): The port your router communicates with (defaults to 5000, but 80 is also known to be used on some models)
|
||||
|
||||
List of models that are known to use port 80:
|
||||
- Nighthawk X4S - AC2600 (R7800)
|
||||
|
||||
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
|
||||
|
|
|
|||
|
|
@ -14,8 +14,7 @@ ha_release: 0.37
|
|||
|
||||
The `tado` device tracker is using the [Tado Smart Thermostat](https://www.tado.com/) and it's support for person presence detection based on smartphone location by geofencing.
|
||||
|
||||
This tracker uses the Tado API to determine if a mobile device is at home.
|
||||
It tracks all devices in your home that Tado knows about.
|
||||
This tracker uses the Tado API to determine if a mobile device is at home. It tracks all devices in your home that Tado knows about.
|
||||
|
||||
To use the Tado platform in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -37,15 +36,25 @@ Configuration variables:
|
|||
After configuration, your device has to be at home at least once before showing up as *home* or *away*.
|
||||
Polling Tado API for presence information will happen at most once every 30 seconds.
|
||||
|
||||
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
|
||||
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. Beware that the Tado (v2) API does not provide GPS location of devices, only a bearing, therefore Home Assistant only uses `home`/`not-home` status.
|
||||
|
||||
### {% linkable_title Finding your `home_id` %}
|
||||
Find your `home_id` by browsing to `https://my.tado.com/api/v2/me?username=YOUR_USERNAME&password=YOUR_PASSWORD`. There you'll see something like the following:
|
||||
|
||||
```json
|
||||
{"name":"Mark","email":"your@email.tld","username":"your@email.tld",
|
||||
"homes":[{"id":12345,"name":"Home Sweet Home"}],"locale":"en_US",
|
||||
"mobileDevices":[]}
|
||||
{
|
||||
"name": "Mark",
|
||||
"email": "your@email.tld",
|
||||
"username": "your@email.tld",
|
||||
"homes": [
|
||||
{
|
||||
"id": 12345,
|
||||
"name": "Home Sweet Home"
|
||||
}
|
||||
],
|
||||
"locale": "en_US",
|
||||
"mobileDevices": []
|
||||
}
|
||||
```
|
||||
|
||||
In this example `12345` is the `home_id` you'll need to configure.
|
||||
|
|
|
|||
|
|
@ -43,6 +43,8 @@ There are 2 themes-related services:
|
|||
|
||||
Example in automation:
|
||||
|
||||
Set a theme at the startup of Home Assistant:
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
- alias: 'Set theme at startup'
|
||||
|
|
@ -55,3 +57,22 @@ automation:
|
|||
data:
|
||||
name: happy
|
||||
```
|
||||
|
||||
To enable "night mode":
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
- alias: 'Set dark theme for the night'
|
||||
initial_state: True
|
||||
trigger:
|
||||
- platform: time
|
||||
at: '21:00'
|
||||
action:
|
||||
- service: frontend.set_theme
|
||||
data:
|
||||
name: darkred
|
||||
```
|
||||
|
||||
### {% linkable_title Manual Theme Selection %}
|
||||
|
||||
When themes are enabled in the `configuration.yaml` file, a new option will show up in the Configuration panel under `configuration.yaml` called "Set a theme." You can then choose any installed theme from the dropdown list and it will be applied immediately.
|
||||
|
|
|
|||
|
|
@ -15,18 +15,23 @@ og_image: /images/screenshots/ssocr.png
|
|||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/components/camera/). `ssocr` need to be available on your system. Check the installation instruction for Fedora below or use `$ sudo apt-get install ssocr` on a Debian-based system:
|
||||
The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/components/camera/).
|
||||
|
||||
<p class='note'>
|
||||
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fullfilled.
|
||||
</p>
|
||||
|
||||
`ssocr` needs to be available on your system. Check the installation instruction below:
|
||||
|
||||
```bash
|
||||
$ sudo dnf -y install imlib2-devel
|
||||
$ sudo dnf -y install imlib2-devel # Fedora
|
||||
$ sudo apt install libimlib2-dev # Ubuntu
|
||||
$ brew install imlib2 # macOS
|
||||
$ git clone https://github.com/auerswal/ssocr.git
|
||||
$ cd ssocr
|
||||
$ make
|
||||
$ sudo make PREFIX=/usr install
|
||||
$ sudo make PREFIX=/usr install # On most systems
|
||||
$ make deb # (Optional) This allows you to make a deb so that you apt is aware of ssocr
|
||||
```
|
||||
|
||||
To enable the OCR of a seven segement display in your installation, add the following to your `configuration.yaml` file:
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ footer: true
|
|||
logo: xiaomi.png
|
||||
ha_category: Light
|
||||
ha_release: "0.50"
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ footer: true
|
|||
|
||||
Mailboxes provide an list of messages with short information about each. Mailbox messages appear on a separate panel in the frontend.
|
||||
|
||||
Home Assistant currently supports only the [Asterisk Vaoicemail](/component/mailbox.asterisk_mbox) mailbox.
|
||||
Home Assistant currently supports only the [Asterisk Voicemail](/component/mailbox.asterisk_mbox) mailbox.
|
||||
|
||||
Each mailbox also provides an entity to indicate the number of messages available on the main page.
|
||||
|
||||
|
|
|
|||
|
|
@ -35,8 +35,8 @@ Configuration variables:
|
|||
- **port** (*Optional*): Port of communication to the device (default: 11000)
|
||||
|
||||
## Advanced configuration example
|
||||
|
||||
```yaml
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry with manually specified addresses
|
||||
media_player:
|
||||
- platform: bluesound
|
||||
|
|
|
|||
|
|
@ -12,22 +12,28 @@ ha_category: Notifications
|
|||
ha_release: "0.40"
|
||||
---
|
||||
|
||||
The `Cisco Spark` platform allows you to deliver notifications from Home Assistant to [Cisco Spark](https://ciscospark.com/).
|
||||
The `ciscospark` notification platform allows you to deliver notifications from Home Assistant to [Cisco Spark](https://ciscospark.com/).
|
||||
|
||||
To use this notification platform you need to get a developer token. To obtain a token visit [Spark for Devleopers](https://developer.ciscospark.com/index.html)
|
||||
|
||||
At this time you also need to specify the `Cisco Spark` `roomid`. The `roomid` can also be found at [Spark for Devleopers](https://developer.ciscospark.com/index.html).
|
||||
Just look in the Doumentation under Rooms.
|
||||
At this time you also need to specify the `Cisco Spark` `roomid`. The `roomid` can also be found at [Spark for Devleopers](https://developer.ciscospark.com/index.html). Just look in the Doumentation under Rooms.
|
||||
|
||||
To enable the `Cisco Spark` notification in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable the Cisco Spark notification in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
- name: NOTIFIER_NAME
|
||||
platform: ciscospark
|
||||
token: <YOUR_DEVELOPER_TOKEN>
|
||||
roomid: <CISCO_SPARK_ROOMID>
|
||||
token: YOUR_DEVELOPER_TOKEN
|
||||
roomid: CISCO_SPARK_ROOMID
|
||||
```
|
||||
|
||||
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`.
|
||||
- **token** (*Required*): Your development token.
|
||||
- **roomid** (*Required*): The Room ID.
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
||||
|
|
|
|||
|
|
@ -26,13 +26,13 @@ notify:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **page_access_token** (*Required*): Access token for your facebook page. Checkout [Facebook Messenger Platform](https://developers.facebook.com/docs/messenger-platform/guides/setup) for more information.
|
||||
- **page_access_token** (*Required*): Access token for your Facebook page. Checkout [Facebook Messenger Platform](https://developers.facebook.com/docs/messenger-platform/guides/setup) for more information.
|
||||
- **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`.
|
||||
|
||||
### {% linkable_title Usage %}
|
||||
|
||||
With Facebook notify service, you can send your notifications to your facebook messenger with help of your facebook page. You have to create a [Facebook Page and App](https://developers.facebook.com/docs/messenger-platform/guides/quick-start) for this service. You can control it by calling the notify service [as described here](/components/notify/). It will send a message on messenger to user specified by **target** on behalf of your page. See the [quick start](https://developers.facebook.com/docs/messenger-platform/guides/quick-start) guide for more information.
|
||||
The phone number used in **target** should be registered with facebook messenger. Phone number of the recipient should be in +1(212)555-2368 format. If your app is not approved by facebook then the recipient should by either admin, developer or tester for your facebook app. [More...](https://developers.facebook.com/docs/messenger-platform/send-api-reference#phone_number)
|
||||
With Facebook notify service, you can send your notifications to your Facebook messenger with help of your Facebook page. You have to create a [Facebook Page and App](https://developers.facebook.com/docs/messenger-platform/guides/quick-start) for this service. You can control it by calling the notify service [as described here](/components/notify/). It will send a message on messenger to user specified by **target** on behalf of your page. See the [quick start](https://developers.facebook.com/docs/messenger-platform/guides/quick-start) guide for more information.
|
||||
The phone number used in **target** should be registered with Facebook messenger. Phone number of the recipient should be in +1(212)555-2368 format. If your app is not approved by Facebook then the recipient should by either admin, developer or tester for your Facebook app. [More information](https://developers.facebook.com/docs/messenger-platform/send-api-reference#phone_number) about the phone number.
|
||||
|
||||
```yaml
|
||||
# Example automation notification entry
|
||||
|
|
|
|||
|
|
@ -34,3 +34,5 @@ Configuration variables:
|
|||
- **hostname** (*Optional*): The hostname or IP address of the GNTP server to contact.
|
||||
- **password** (*Optional*): The password to authenticate to the GNTP server with.
|
||||
- **port** (*Optional*): The port that the GNTP server runs on. The specification states that servers should not allow users to use any port other than 23053 but `port` is provided here just in case.
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
|
|
|||
|
|
@ -59,8 +59,6 @@ To use notifications, please see the [getting started with automation page](/get
|
|||
### {% linkable_title URL support %}
|
||||
|
||||
```yaml
|
||||
...
|
||||
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
|
|
@ -70,5 +68,23 @@ action:
|
|||
url: google.com
|
||||
```
|
||||
|
||||
- **url** (*Required*): Page URL to send with pushbullet.
|
||||
- **url** (*Required*): Page URL to send with Pushbullet.
|
||||
|
||||
### {% linkable_title File support %}
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
title: Send file
|
||||
message: This is a file
|
||||
data:
|
||||
file: /path/to/my/file
|
||||
```
|
||||
|
||||
- **file** (*Required*): File to send with Pushbullet.
|
||||
|
||||
<p class='note'>
|
||||
Don't forget to [whitelist external directories](/docs/configuration/basic/), so Home Assistant has access to them.
|
||||
</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ notify:
|
|||
sender_name: My Home Assistant
|
||||
```
|
||||
|
||||
Keep in mind that Google has some extra layers of protection which need special attention (Hint: 'Less secure apps').
|
||||
Keep in mind that Google has some extra layers of protection which need special attention (Hint: 'Less secure apps'). If you have 2-step verification enabled on your Google account, you'll need to use [an application-specific password](https://support.google.com/mail/answer/185833?hl=en).
|
||||
|
||||
To use the SMTP notification, refer to it in an automation or script like in this example:
|
||||
|
||||
|
|
|
|||
|
|
@ -12,10 +12,9 @@ ha_category: Front end
|
|||
ha_release: 0.44
|
||||
---
|
||||
|
||||
The `rss_feed_template` component can export any information from Home Assistant as static RSS feed. This can be used to display those information on several devices using RSS readers. While native apps for Home Assistant are not widely available, native RSS readers exists for almost any platform.
|
||||
|
||||
E.g. on android, the app "Simple RSS Widget" can be used to display temperatures on the home screen.
|
||||
The `rss_feed_template` component can export any information from Home Assistant as a static RSS feed. This can be used to display that information on many types of devices using an RSS reader. While native apps for Home Assistant are not widely available, native RSS readers exist for almost any platform.
|
||||
|
||||
For example, on Android, the app "Simple RSS Widget" can be used to display temperatures on the home screen.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
|
|
@ -30,9 +29,9 @@ rss_feed_template:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **requires_api_password:** (*Optional*): If true and an api password is set, the password must be passed via '?api_password=...' parameter (Default: True)
|
||||
- **feed_id** (*Required*): The key is used as id of the feed. The feed can be accessed at /api/rss_template/feed_id (example: 'garden')
|
||||
- **requires_api_password:** (*Optional*): If true and an API password is set, the password must be passed via '?api_password=...' parameter (Default: True)
|
||||
- **feed_id** (*Required*): The key is used as the ID of the feed. The feed can be accessed at /api/rss_template/feed_id (example: 'garden')
|
||||
- **title** (*Optional*): The title of the feed, which is parsed as [template](/topics/templating/).
|
||||
- **items** (*Required*): A list of feed items
|
||||
- **items** (*Required*): A list of feed items.
|
||||
- **items/title** (*Optional*): The title of the item, which is parsed as [template](/topics/templating/).
|
||||
- **items/description** (*Optional*): The description of the item, which is parsed as [template](/topics/templating/).
|
||||
|
|
|
|||
|
|
@ -24,4 +24,4 @@ sensor:
|
|||
- platform: moon
|
||||
```
|
||||
This sensor will return one of the following values:
|
||||
`Full moon`, `Last quarter`, `First quarter` or `New moon`.
|
||||
`New moon`, `Waxing crescent`, `First quarter`, `Waxing gibbous`, `Full moon`, `Waning gibbous`, `Last quarter` or `Waning crescent` .
|
||||
|
|
|
|||
|
|
@ -47,6 +47,6 @@ The following conditions are available by device:
|
|||
- Nest Protect:
|
||||
- co\_status
|
||||
- smoke\_status
|
||||
- batter\_health
|
||||
- battery\_health
|
||||
- Nest Camera: none
|
||||
|
||||
|
|
|
|||
|
|
@ -30,3 +30,7 @@ Configuration variables:
|
|||
- **host** (*Required*): The IP address or hostname of your Open Hardware Monitor.
|
||||
- **port** (*Optional*): The port of your Open Hardware Monitor API. Default to 8085.
|
||||
|
||||
<p class='note'>
|
||||
OpenHardwareMonitor must be running on the host, with "Remote web server" active.
|
||||
You also need to open an inbound port for (TPC 8085) in the advanced firewall settings.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -34,11 +34,17 @@ Configuration variables:
|
|||
A simple way to generate a `token` for a new sensor is to run this snippet of python code in your Home Assistant virtual environment:
|
||||
|
||||
```shell
|
||||
$ pip install pyotp
|
||||
$ python -c 'import pyotp; print("Token: " + pyotp.random_base32())'
|
||||
$ pip3 install pyotp
|
||||
$ python3 -c 'import pyotp; print("Token:", pyotp.random_base32())'
|
||||
Token: IHEDPEBEVA2WVHB7
|
||||
```
|
||||
|
||||
To run in a Docker container:
|
||||
|
||||
```shell
|
||||
$ docker exec -it home-assistant python -c 'import pyotp; print("Token:", pyotp.random_base32())'
|
||||
Token: IHEDPEBEVA2WVHB7
|
||||
```
|
||||
Copy and paste the token into your Home Assistant configuration and add it to your OTP generator. Verify that they generate the same code.
|
||||
|
||||
<p class='note warning'>
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ ha_release: 0.51
|
|||
---
|
||||
|
||||
|
||||
The `shodan` sensor platform is displaying the total of result of a [Shodan](https://pi-hole.net/) query.
|
||||
The `shodan` sensor platform is displaying the total of result of a [Shodan](https://www.shodan.io/) query.
|
||||
|
||||
Use "Show API Key" in the upper right corner when you are logged in or got to your "My Account" page to retrieve your API key.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ footer: true
|
|||
logo: xiaomi.png
|
||||
ha_category: Sensor
|
||||
ha_release: "0.50"
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -23,10 +23,6 @@ switch:
|
|||
- platform: broadlink
|
||||
host: IP_ADDRESS
|
||||
mac: 'MAC_ADDRESS'
|
||||
switches:
|
||||
reciever:
|
||||
command_on: 'switch_packet on'
|
||||
command_off: 'switch_packet off'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
|
@ -35,7 +31,7 @@ Configuration variables:
|
|||
- **mac** (*Required*): Device MAC address.
|
||||
- **timeout** (*Optional*): Timeout in seconds for the connection to the device.
|
||||
- **friendly_name** (*Optional*): The name used to display the switch in the frontend.
|
||||
- **type** (*Optional*): Switch type. Choose one from: `rm`, `rm2`, `rm_mini`, `rm_pro_phicomm`, `rm2_home_plus`, `rm2_home_plus_gdt`, `rm2_pro_plus`, `rm2_pro_plus2`, `rm2_pro_plus_bl`, `rm_mini_shate`, `sp1`, `sp2`, `honeywell_sp2`, `sp3`, `spmini2` or `spminiplus`.
|
||||
- **type** (*Required for some models*): Switch type. Choose one from: `rm`, `rm2`, `rm_mini`, `rm_pro_phicomm`, `rm2_home_plus`, `rm2_home_plus_gdt`, `rm2_pro_plus`, `rm2_pro_plus2`, `rm2_pro_plus_bl`, `rm_mini_shate`, `sp1`, `sp2`, `honeywell_sp2`, `sp3`, `spmini2` or `spminiplus`.
|
||||
- **switches** (*Optional*): The array that contains all switches.
|
||||
- **identifier** (*Required*): Name of the command switch as slug. Multiple entries are possible.
|
||||
- **friendly_name** (*Optional*): The name used to display the switch in the frontend.
|
||||
|
|
|
|||
|
|
@ -9,6 +9,8 @@ sharing: true
|
|||
footer: true
|
||||
logo: mystrom.png
|
||||
ha_category: Switch
|
||||
ha_release: 0.9
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -13,11 +13,11 @@ ha_iot_class: "Local Push"
|
|||
logo: home-assistant.png
|
||||
---
|
||||
|
||||
The `template` platform creates switches that combine components.
|
||||
The `template` platform creates switches that combines components.
|
||||
|
||||
For example, if you have a garage door with a toggle switch that operates the motor and a sensor that allows you know whether the door is open or closed, you can combine these into a switch that knows whether the garage door is open or closed.
|
||||
|
||||
This can simplify the gui, and make it easier to write automations. You can mark the components you have combined as `hidden` so they don't appear themselves.
|
||||
This can simplify the GUI and make it easier to write automations. You can mark the components you have combined as `hidden` so they don't appear themselves.
|
||||
|
||||
To enable Template switches in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -48,8 +48,8 @@ Configuration variables:
|
|||
|
||||
## {% linkable_title Considerations %}
|
||||
|
||||
If you are using the state of a platform that takes extra time to load, the template switch may get an 'unknown' state during startup. This results in error messages in your log file until that platform has completed loading. If you use is_state() function in your template, you can avoid this situation. For example, you would replace {% raw %}'{{ states.switch.source.state }}'{% endraw %} with this equivalent that returns true/false and never gives an unknown result:
|
||||
{% raw %}'{{ is_state('switch.source', 'on') }}'{% endraw %}
|
||||
If you are using the state of a platform that takes extra time to load, the template switch may get an 'unknown' state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace {% raw %}`{{ states.switch.source.state }}`{% endraw %} with this equivalent that returns true/false and never gives an unknown result:
|
||||
{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
|
|
@ -128,4 +128,3 @@ switch:
|
|||
entity_id: cover.garage_door
|
||||
icon_template: {% raw %}"{% if is_state('cover.garage_door', 'open') %}mdi:garage-open{% else %}mdi:garage{% endif %}"{% endraw %}
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ footer: true
|
|||
logo: xiaomi.png
|
||||
ha_category: Switch
|
||||
ha_release: "0.50"
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -18,6 +18,9 @@ The `tradfri` component supports for the IKEA Trådfri (Tradfri) gateway. The ga
|
|||
|
||||
For this to work, you need to install a modified lib-coap library.
|
||||
|
||||
<p class='note warning'>
|
||||
This component does **not** work on Windows, as the modified lib-coap doesn't exists for Windows.
|
||||
</p>
|
||||
<p class='note'>
|
||||
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fullfilled.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -11,9 +11,9 @@ logo: home-assistant.png
|
|||
ha_category: Other
|
||||
---
|
||||
|
||||
The `updater` component will check daily for new releases. It will show a badge in the frontend if a new version was found.
|
||||
The `updater` component will check daily for new releases. It will show a badge in the frontend if a new version is found.
|
||||
|
||||
The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the timezone, Python version and operating system information. No identifiable information (i.e. IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). For further information about the Updater's data please check the [detailed overview](/docs/backend/updater/).
|
||||
The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). For further information about the Updater's data, please check the [detailed overview](/docs/backend/updater/).
|
||||
|
||||
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -86,7 +86,7 @@ Tell the vacuum cleaner to do a spot clean-up.
|
|||
|
||||
#### {% linkable_title Service `vacuum/set_fanspeed` %}
|
||||
|
||||
Set the fan speed of the botvac. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number, it depends of the `vacuum` platform.
|
||||
Set the fan speed of the botvac. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number; it depends on the `vacuum` platform.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
|
|
|
|||
|
|
@ -12,20 +12,18 @@ ha_category: Vacuum
|
|||
ha_release: 0.51
|
||||
---
|
||||
|
||||
The `roomba` component allows you to control your [Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx).
|
||||
The `roomba` component allows you to control your [iRobot Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx) vacuum.
|
||||
|
||||
<p class='note'>
|
||||
This platform has only been tested with an iRobot Roomba 980, but should work find
|
||||
with any Wi-Fi enabled Roomba like the 690, 890 or the 960.
|
||||
This platform has only been tested with an iRobot Roomba 980 but should work find with any Wi-Fi enabled Roomba like the 690, 890 or the 960.
|
||||
</p>
|
||||
|
||||
To add your roomba vacuum to your installation, add the following to your `configuration.yaml` file:
|
||||
To add your Roomba vacuum to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
vacuum:
|
||||
- platform: roomba
|
||||
name: My Roomba
|
||||
host: IP_ADDRESS_OR_HOSTNAME
|
||||
username: BLID
|
||||
password: PASSWORD
|
||||
|
|
@ -34,16 +32,16 @@ vacuum:
|
|||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): Hostname or IP address of the Roomba.
|
||||
- **username** (*Required*): Username (BLID).
|
||||
- **password** (*Required*): Password.
|
||||
- **certificate** (*Optional*): Path to your certificate store (Default: `/etc/ssl/certs/ca-certificates.crt`)
|
||||
- **continuous** (*Optional*): Whether to operate in continuous mode (Default: `True`).
|
||||
- **username** (*Required*): The username (BLID) fro your device.
|
||||
- **password** (*Required*): The password for your device.
|
||||
- **name** (*Optional*): The name of the vacuum.
|
||||
- **certificate** (*Optional*): Path to your certificate store. Defaults to `/etc/ssl/certs/ca-certificates.crt`.
|
||||
- **continuous** (*Optional*): Whether to operate in continuous mode. Defaults to `True`.
|
||||
|
||||
<p class='note'>
|
||||
The Roomba's MQTT server only allows a single connection. Enabling continuous
|
||||
mode will force the App to connect via the cloud to your Roomba. [More info here](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes)
|
||||
The Roomba's MQTT server only allows a single connection. Enabling continuous mode will force the App to connect via the cloud to your Roomba. [More info here](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes)
|
||||
</p>
|
||||
|
||||
### Retrieving your credentials
|
||||
### {% linkable_title Retrieving your credentials %}
|
||||
|
||||
Please refer to [here](https://github.com/NickWaterton/Roomba980-Python#how-to-get-your-usernameblid-and-password) or [here](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) to retrieve both the BLID (username) and the password.
|
||||
|
|
|
|||
|
|
@ -34,17 +34,17 @@ $ sudo su -s /bin/bash homeassistant
|
|||
$ source /srv/homeassistant/bin/activate
|
||||
```
|
||||
|
||||
In order to fetch the token follow these instructions depending on your mobile phone platform.
|
||||
To fetch the token follow these instructions depending on your mobile phone platform.
|
||||
|
||||
### Windows and Android
|
||||
1. Configure the robot with the Mi-Home app.
|
||||
2. Enable developer mode and USB debugging on the Android phone and plug it into the computer.
|
||||
3. Get ADB tool for Windows : https://developer.android.com/studio/releases/platform-tools.html
|
||||
3. Get ADB tool for Windows: https://developer.android.com/studio/releases/platform-tools.html
|
||||
4. Create a backup of the application com.xiaomi.smarthome:
|
||||
```bash
|
||||
.\adb backup -noapk com.xiaomi.smarthome -f backup.ab
|
||||
```
|
||||
5. If you have this message : "More than one device or emulator", use this command to list all devices:
|
||||
5. If you have this message: "More than one device or emulator", use this command to list all devices:
|
||||
```bash
|
||||
.\adb devices
|
||||
```
|
||||
|
|
@ -53,14 +53,14 @@ and execute this command:
|
|||
.\adb -s DEVICEID backup -noapk com.xiaomi.smarthome -f backup.ab # (with DEVICEID the device id from the previous command)
|
||||
```
|
||||
6. On the phone, you must confirm the backup. DO NOT enter any password and press button to make the backup.
|
||||
7. Get ADB Backup Extractor : https://sourceforge.net/projects/adbextractor/
|
||||
7. Get ADB Backup Extractor: https://sourceforge.net/projects/adbextractor/
|
||||
8. Extract All files from the backup:
|
||||
```bash
|
||||
java.exe -jar ../android-backup-extractor/abe.jar unpack backup.ab backup.tar ""
|
||||
```
|
||||
9. Unzip the ".tar" file.
|
||||
10. Open the sqlite DB miio2.db with a tool like SQLite Manager extension for FireFox.
|
||||
11. Get token from "devicerecord" table.
|
||||
10. Open the SQLite DB miio2.db with a tool like SQLite Manager extension for FireFox.
|
||||
11. Get the token from "devicerecord" table.
|
||||
|
||||
|
||||
### macOS and iOS
|
||||
|
|
@ -122,7 +122,7 @@ Remote control the vacuum cleaner, make sure you first set it in remote control
|
|||
|
||||
#### {% linkable_title Service `vacuum/xiaomi_remote_control_move_step` %}
|
||||
|
||||
Use this call to enter the remote control mode, make one movement, and stop and exit the remote control mode.
|
||||
Use this call to enter the remote control mode, make one move, and stop and exit the remote control mode.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
|
|
|
|||
|
|
@ -33,9 +33,9 @@ Configuration variables:
|
|||
|
||||
### {% linkable_title Configure devices %}
|
||||
|
||||
By default your switches will be added to Home Assistant as switches, however if some of them are light switches, you can tell Home Assistant this using the optional `lights` parameter as shown below.
|
||||
By default your switches will be added to Home Assistant as switches, however, if some of them are light switches, you can tell Home Assistant this using the optional `lights` parameter as shown below.
|
||||
|
||||
Vera imports detailed Z-Wave devices into Home Assistant. This can include system devices and other devices that you don't use, you can tell Home Assistant not to load these devices using the `exclude:` parameter as shown below.
|
||||
Vera imports detailed Z-Wave devices into Home Assistant. This can include system devices and other devices that you don't use; you can tell Home Assistant not to load these devices using the `exclude:` parameter as shown below.
|
||||
|
||||
You can find the Vera device id either via the advanced properties of the device in the Vera UI or by checking the `Vera Device Id` attribute on each device imported into Home Assistant (under the developer tools).
|
||||
|
||||
|
|
@ -50,4 +50,4 @@ vera:
|
|||
|
||||
### {% linkable_title Using Z-Wave devices in automation %}
|
||||
|
||||
If you want to use a Z-Wave device from the Vera controller in Home Assistant automation, you'll need the entity id. In the Home Assistant UI you'll find all entities listed under the <img src='/images/screenshots/developer-tool-states-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> icon of the Developer Tools section. Look for entities that contain 'Vera Device Id' in their attributes, you'll find the entity id on the left.
|
||||
If you want to use a Z-Wave device from the Vera controller in Home Assistant automation, you'll need the entity id. In the Home Assistant UI you'll find all entities listed under the <img src='/images/screenshots/developer-tool-states-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> icon of the Developer Tools section. Look for entities that contain 'Vera Device Id' in their attributes, and you'll find the entity id on the left.
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
The `volvooncall` platform offers integrates with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level.
|
||||
The `volvooncall` platform offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level.
|
||||
|
||||
To use Volvo On Call in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ ha_release: "0.49"
|
|||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `wake_on_lan` component enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, in order to turn them on.
|
||||
The `wake_on_lan` component enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, to them on.
|
||||
|
||||
To use this component in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -13,10 +13,10 @@ ha_release: 0.47
|
|||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands.
|
||||
The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). A map of all available weatherstations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0).
|
||||
The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands.
|
||||
The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor component). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0).
|
||||
|
||||
To add the buienradar weather to your installation, add the following to your `configuration.yaml` file:
|
||||
To add the Buienradar weather to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
@ -26,9 +26,9 @@ weather:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of 'weather.[name]'; if no name is specified, it will try to set its name to 'weather.BR_[stationname]'. However at the moment in time the entity is created, no data has been retrieved yet, so the entity will get named 'weather.BR_unknown_station'. Later the station name will be known and get updated, but the entity name remains.
|
||||
- **latitude** (*Optional*): Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.
|
||||
- **longitude**(*Optional*): Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.
|
||||
- **name** (*Optional*): You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of 'weather.[name]'; if no name is specified, it will try to set its name to 'weather.BR_[stationname]'. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named 'weather.BR_unknown_station'. Later the station name will be known and get updated, but the entity name remains.
|
||||
- **latitude** (*Optional*): Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar.
|
||||
- **longitude**(*Optional*): Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar.
|
||||
- **forecast** (*Optional*): 'True' to add a temperature forecast, 'False' to suppress it.
|
||||
|
||||
|
||||
|
|
@ -51,4 +51,4 @@ The weather platform is easier to configure but less customisable.
|
|||
</p>
|
||||
|
||||
[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
|
||||
> Buienradar makes free weatherdata available for use by individuals and businesses (website/intranet). The use of the weatherdata is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your usage or to request permission.
|
||||
> Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your use or to request permission.
|
||||
|
|
|
|||
|
|
@ -9,8 +9,8 @@ sharing: true
|
|||
footer: true
|
||||
---
|
||||
|
||||
The `weather` platforms are gathering meteorological information from web services and displays the conditions and other details about the weather at the given location.
|
||||
The `weather` platforms are gathering meteorological information from web services and display the conditions and other details about the weather at the given location.
|
||||
|
||||
Home Assistant currently supports free web services and such which requires a registration. Please check the sidebar for a full list of supported `weather` platforms.
|
||||
Home Assistant currently supports free web services and such which require a registration. Please check the sidebar for a full list of supported `weather` platforms.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ ha_iot_class: "Cloud Polling"
|
|||
|
||||
The `metoffice` weather platform uses the Met Office's [DataPoint API][datapoint] for weather data.
|
||||
|
||||
To add the Met Office weather platform to your installation you'll need to register for a free api key at the link above and then add the following to your `configuration.yaml` file:
|
||||
To add the Met Office weather platform to your installation, you'll need to register for a free API key at the link above and then add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
weather:
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ ha_release: 0.32
|
|||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `openweathermap` weather platform uses [OpenWeatherMap](http://openweathermap.org/) as an source for current meteorological data for your location.
|
||||
The `openweathermap` weather platform uses [OpenWeatherMap](http://openweathermap.org/) as a source for current meteorological data for your location.
|
||||
|
||||
You need an API key which is free but requires a [registration](http://home.openweathermap.org/users/sign_up).
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ Configuration variables:
|
|||
|
||||
- **api_key** (*Required*): Your API key for http://openweathermap.org/.
|
||||
- **name** (*Optional*): Name to use in the frontend.
|
||||
- **latitude** (*Optional*): Latitude of the location to display the weather. Defaults to the latitude in your your `configuration.yaml` file.
|
||||
- **latitude** (*Optional*): Latitude of the location to display the weather. Defaults to the latitude in your `configuration.yaml` file.
|
||||
- **longitude** (*Optional*): Longitude of the location to display the weather. Defaults to the longitude in your `configuration.yaml` file.
|
||||
|
||||
<p class='note'>
|
||||
|
|
|
|||
|
|
@ -13,13 +13,13 @@ ha_release: 0.47
|
|||
---
|
||||
|
||||
|
||||
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as an source for current meteorological data. This component will show you the condition and tempratures for max. 10 days.
|
||||
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as a source for current meteorological data. This component will show you the condition and temperatures for max. 10 days.
|
||||
|
||||
<p class='note warning'>
|
||||
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2000 signed calls per day.
|
||||
</p>
|
||||
|
||||
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID it generate it from Home Assistant's latitude and longitude.
|
||||
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID, it will be generated from Home Assistant's latitude and longitude.
|
||||
|
||||
To add Yahoo Weather to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -15,14 +15,14 @@ ha_release: pre 0.7
|
|||
|
||||
The `wemo` component is the main component to integrate various [Belkin WeMo](http://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/) devices with Home Assistant.
|
||||
|
||||
Supported devices will be automatically discovered if the discovery component is enabled. If you are not using the discovery component, loading the `wemo` component will scan for WeMo devices on the local network.
|
||||
Supported devices will be automatically discovered if the discovery component is enabled. Loading the `wemo` component will scan the local network for WeMo devices, even if you are not using the discovery component
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
wemo:
|
||||
```
|
||||
|
||||
Alternately, WeMo devices that are not discoverable can be statically configured. If you have WeMo devices on subnets other than where Home Assistant is running, and/or devices in a remote location reachable over a VPN, you will need to manually configure them. This is also useful if you wish to disable discovery for some wemos, even if they are local. Example static configuration:
|
||||
Alternately, WeMo devices that are not discoverable can be statically configured. If you have WeMo devices on subnets other than where Home Assistant is running, or devices in a remote location reachable over a VPN, you will need to configure them manually. This is also useful if you wish to disable discovery for some WeMo's, even if they are local. Example static configuration:
|
||||
|
||||
```yaml
|
||||
wemo:
|
||||
|
|
@ -33,6 +33,6 @@ wemo:
|
|||
|
||||
Any WeMo devices that are not statically configured but reachable via discovery will still be added automatically.
|
||||
|
||||
Note that if you use this, you may want to configure your router (or whatever runs your DHCP server) to force your WeMo devices to use a static IP address. Check the DHCP section of your router configuration for this ability.
|
||||
Note that if you use this, you may want to set up your router (or whatever runs your DHCP server) to force your WeMo devices to use a static IP address. Check the DHCP section of your router configuration for this ability.
|
||||
|
||||
If the device doesn't seem to work and all you see is the state "unavailable" on your dashboard, check that your firewall doesn't block incoming request on port 8989 since this is the address to which the WeMo devices sends their update.
|
||||
If the device doesn't seem to work and all you see is the state "unavailable" on your dashboard, check that your firewall doesn't block incoming request on port 8989 since this is the address to which the WeMo devices send their update.
|
||||
|
|
|
|||
|
|
@ -22,14 +22,14 @@ ha_release: pre 0.7
|
|||
|
||||
Home Assistant integrates with the Wink API and automatically sets up any switches, lights, locks, fans, climate devices, covers, sensors, and alarms.
|
||||
|
||||
Check the related components pages for actual devices that are support.
|
||||
Check the related components pages for actual devices that are supported.
|
||||
|
||||
Home Assistant offers multiple ways to authenticate to the Wink API. Each authentication method is described below.
|
||||
|
||||
### Authenticate using [developer.wink.com](https://developer.wink.com)
|
||||
|
||||
|
||||
This method will require you to setup a developer account with Wink. This process can take a few days to get approved, but is the recommended form of authentication. If you would like to use Wink in Home Assistant while you wait, you can use the email and password authentication below.
|
||||
This method will require you to setup a developer account with Wink. This process can take a few days to get approved but is the recommended form of authentication. If you would like to use Wink in Home Assistant while you wait, you can use the email and password authentication below.
|
||||
|
||||
This form of authentication doesn't require any settings in the configuration.yaml other than `wink:` this is because you will be guided through setup via the configurator on the frontend.
|
||||
|
||||
|
|
@ -68,27 +68,27 @@ wink:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **email** (*Required for email/password auth or legacy oauth*): Your Wink login email.
|
||||
- **password** (*Required for email/password auth or legacy oauth*): Your Wink login password.
|
||||
- **client_id** (*Required for legacy oauth*): Your provided Wink client_id.
|
||||
- **client_secret** (*Required for legacy oauth*): Your provided Wink client_secret.
|
||||
- **local_control** (*Optional*): If set to `True` state changes for lights, locks, and switches will be issue to the local hub.
|
||||
- **email** (*Required for email/password auth or legacy OAuth*): Your Wink login email.
|
||||
- **password** (*Required for email/password auth or legacy OAuth*): Your Wink login password.
|
||||
- **client_id** (*Required for legacy OAuth*): Your provided Wink client_id.
|
||||
- **client_secret** (*Required for legacy OAuth*): Your provided Wink client_secret.
|
||||
- **local_control** (*Optional*): If set to `True` state changes for lights, locks, and switches will be an issue to the local hub.
|
||||
|
||||
Local control:
|
||||
- Wink's local control API isn't officially documented and therefore could be broken by a hub update. For these reasons `local_control` defaults to `False`
|
||||
- Wink's local control API isn't officially documented and therefore could be broken by a hub update. For these reasons `local_control` defaults to `False`.
|
||||
|
||||
- Using local control doesn't appear to make commands any quicker, but does function in an internet/Wink outage.
|
||||
|
||||
- Local control is also only available for the Wink hub v1 and v2, not the Wink relay.
|
||||
|
||||
- Local control isn't used during startup of Home Assistant, this means initial setup requires an active internet connection.
|
||||
- Local control isn't used during start-up of Home Assistant; this means initial setup requires an active internet connection.
|
||||
|
||||
- Local control requests are first sent to the controlling hub. In the event that a request fails, that request will attempt to go online.
|
||||
- Local control requests are first sent to the controlling hub. If a request fails, that request will attempt to go online.
|
||||
|
||||
<p class='note'>
|
||||
It is possible for the hub to get into a bad state where it stops accepting local control request. If this happens you will notice requests taking significantly longer as they are redirected online. This doesn't happen often, but when it does, it appears to be resolved by rebooting the hub.
|
||||
It is possible for the hub to get into a bad state where it stops accepting local control request. If this happens, you will notice requests taking significantly longer as they are redirected online. This doesn't happen often, but when it does, it appears to be resolved by rebooting the hub.
|
||||
|
||||
The following error will be logged in the event that the hub is rejecting local requests.
|
||||
The following error will be logged if the hub is rejecting local requests.
|
||||
|
||||
```
|
||||
Error sending local control request. Sending request online
|
||||
|
|
@ -98,7 +98,7 @@ Error sending local control request. Sending request online
|
|||
|
||||
### {% linkable_title Service `refresh_state_from_wink` %}
|
||||
|
||||
The Wink component only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions were an update isn't pushed device states can be out of sync.
|
||||
The Wink component only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions where an update isn't pushed device states can be out of sync.
|
||||
|
||||
You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If `local_control` is set to `True` states will be pulled from the devices controlling hub, not the online API.
|
||||
|
||||
|
|
@ -107,6 +107,6 @@ You can use the service wink/refresh_state_from_wink to pull the most recent sta
|
|||
You can use the service wink/add_new_devices to pull any newly paired Wink devices to an already running instance of Home-Assistant. Any new devices will also be added if Home-Assistant is restarted.
|
||||
|
||||
<p class='note'>
|
||||
The Wink hub, by default can only be accessed via the cloud. This means it requires an active internet connection and you will experience delays when controlling and updating devices (~3s).
|
||||
The Wink hub, by default, can only be accessed via the cloud. This means it requires an active internet connection and you will experience delays when controlling and updating devices (~3s).
|
||||
</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -10,15 +10,15 @@ footer: true
|
|||
logo: xiaomi.png
|
||||
ha_category: Hub
|
||||
ha_release: "0.50"
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `xiaomi_gw` platform allows you to integrate the following [Xiaomi](http://www.mi.com/en/) devices into Home Assistant.
|
||||
The `xiaomi` platform allows you to integrate the following [Xiaomi](http://www.mi.com/en/) devices into Home Assistant.
|
||||
|
||||
- Temperature and Humidity Sensor (old and new version)
|
||||
- Motion Sensor (old and new version)
|
||||
- Door and Window Sensor (old and new version)
|
||||
- Button (old and new version)
|
||||
- Temperature and Humidity Sensor (1st and 2nd generation)
|
||||
- Motion Sensor (1st and 2nd generation)
|
||||
- Door and Window Sensor (1st and 2nd generation)
|
||||
- Button (1st and 2nd generation)
|
||||
- Plug aka Socket (ZigBee version, reports power consumed, power load, state and if device in use)
|
||||
- Wall Plug (reports power consumed, power load and state)
|
||||
- Aqara Wall Switch (Single)
|
||||
|
|
@ -96,7 +96,7 @@ Configuration variables:
|
|||
|
||||
## {% linkable_title Services %}
|
||||
|
||||
The gateway provides two services: `xiaomi.play_ringtone` and `xiaomi.stop_ringtone`. To play ringtones by Home Assistant the version of the gateway firmware must be `1.4.1_145` at least. A `ringtone_id` and `gw_mac` must be supplied. The parameter `ringtone_vol` (percent) is optional. Allowed values of the `ringtone_id` are:
|
||||
The gateway provides two services: `xiaomi.play_ringtone` and `xiaomi.stop_ringtone`. To play ringtones by Home Assistant, the version of the gateway firmware must be `1.4.1_145` at least. A `ringtone_id` and `gw_mac` must be supplied. The parameter `ringtone_vol` (percent) is optional. Allowed values of the `ringtone_id` are:
|
||||
|
||||
- alarm ringtones [0-8]
|
||||
- doorbell ring [10-13]
|
||||
|
|
@ -132,3 +132,20 @@ Automation example
|
|||
data:
|
||||
gw_mac: xxxxxxxxxxxx
|
||||
```
|
||||
|
||||
|
||||
### {% linkable_title Troubleshooting %}
|
||||
|
||||
**Connection problem**
|
||||
|
||||
```
|
||||
2017-08-20 16:51:19 ERROR (SyncWorker_0) [homeassistant.components.xiaomi] No gateway discovered
|
||||
2017-08-20 16:51:20 ERROR (MainThread) [homeassistant.setup] Setup failed for xiaomi: Component failed to initialize.
|
||||
```
|
||||
|
||||
That means that Home Assistant is not getting any response from your Xiaomi gateway. Might be a local network problem or your firewall.
|
||||
- Make sure you have enabled LAN access: https://community.home-assistant.io/t/beta-xiaomi-gateway-integration/8213/1832
|
||||
- Turn off the firewall on the HA computer
|
||||
- Try to leave the mac address blank.
|
||||
- Try to set `discovery_retry: 10`
|
||||
- Try to disable and then enable LAN access
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ ha_category: "Other"
|
|||
ha_release: 0.18
|
||||
---
|
||||
|
||||
The `zeroconf` component exposes your Home Assistant to the local network using [Zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking). Zeroconf is also sometimes known as Bonjour, Rendezvous and Avahi.
|
||||
The `zeroconf` component exposes your Home Assistant to the local network using [Zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking). Zeroconf is also sometimes known as Bonjour, Rendezvous, and Avahi.
|
||||
|
||||
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -42,4 +42,4 @@ Configuration variables:
|
|||
- **usb_path** (*Required*): Path to the serial device for the radio.
|
||||
- **database_path** (*Required*): Path to the database which will keep persistent network data.
|
||||
|
||||
To add new devices to the network, call the `permit` service on the `zha` domain, and then follow the device instructions.
|
||||
To add new devices to the network, call the `permit` service on the `zha` domain, and then follow the device instructions for doing a scan or factory reset. In case you want to add Philips Hue bulbs that have previously been added to another bridge, have a look at: https://github.com/vanviegen/hue-thief
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ ha_release: 0.12
|
|||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
[ZigBee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilise modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local ZigBee device to be connected over a serial port. Through this it will send and receive commands to and from other devices on the ZigBee mesh network.
|
||||
[ZigBee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local ZigBee device to be connected to a serial port. Through this it will send and receive commands to and from other devices on the ZigBee mesh network.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
|
|
|||
|
|
@ -40,18 +40,18 @@ zone 3:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Friendly name of entry.
|
||||
- **name** (*Optional*): Friendly name of the zone.
|
||||
- **latitude** (*Required*): Latitude of the center point of the zone.
|
||||
- **longitude** (*Required*): Longitude of the center point of the zone.
|
||||
- **radius** (*Optional*): Optional radius in meters. Defaults to 100 meters.
|
||||
- **icon** (*Optional*): Optional icon to show instead of name.
|
||||
- **passive** (*Optional*): Optional boolean to only use the zone for automation and hide it from the UI and not use the zone for device tracker name. Defaults to false.
|
||||
|
||||
To find your latitude / longtitude of a certain place you can use for example [Google Maps](https://www.google.nl/maps/) or [Bing Maps](https://www.bing.com/maps). Just right click and copy the coordinates from there (Bing) or click on the "What is here?" (Google)
|
||||
To find your latitude/longitude of a certain place you can use for example [Google Maps](https://www.google.nl/maps/) or [Bing Maps](https://www.bing.com/maps). Just right click and copy the coordinates from there (Bing) or click on the "What is here?" (Google)
|
||||
|
||||
#### {% linkable_title Home zone %}
|
||||
|
||||
If no configuration is given, the `zone` component will create a zone for home. This zone will use location given in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it **'Home'**.
|
||||
If no configuration is given, the `zone` component will create a zone for home. This zone will use location provided in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it **'Home'**.
|
||||
|
||||
<p class='note'>
|
||||
Devices that are in the zone **'Home'** will not appear on the map in the Home Assistant UI.
|
||||
|
|
@ -63,4 +63,4 @@ It is preferred to pick an icon to use for your zone. Pick any icon that you can
|
|||
|
||||
#### State
|
||||
|
||||
`zoning` is the state a `zone` has when it is configured. A `zone` doesn't have another state, all configured zones are `zoning` all the time.
|
||||
`zoning` is the state a `zone` has when it is configured. A `zone` doesn't have another state; all configured zones are `zoning` all the time.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue