mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 23:36:51 +00:00
Merge branch 'rc' into current
This commit is contained in:
commit
6b7972413c
@ -138,9 +138,9 @@ social:
|
||||
|
||||
# Home Assistant release details
|
||||
current_major_version: 0
|
||||
current_minor_version: 90
|
||||
current_patch_version: 2
|
||||
date_released: 2019-03-26
|
||||
current_minor_version: 91
|
||||
current_patch_version: 0
|
||||
date_released: 2019-04-03
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
@ -11,6 +11,8 @@ logo: acer.png
|
||||
ha_category: Multimedia
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.19
|
||||
redirect_from:
|
||||
- /components/switch.acer_projector/
|
||||
---
|
||||
|
||||
The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](http://www.acer.com).
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: actiontec.png
|
||||
ha_category: Presence Detection
|
||||
ha_release: 0.7
|
||||
redirect_from:
|
||||
- /components/device_tracker.actiontec/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ logo: aftership.png
|
||||
ha_category: Postal Service
|
||||
ha_release: 0.85
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.aftership/
|
||||
---
|
||||
|
||||
The `aftership` platform allows one to track deliveries by [AfterShip](https://www.aftership.com), a service that supports 490+ couriers worldwide. It is free to use up to 100 tracked packages per month, after that there is a fee.
|
@ -11,6 +11,8 @@ logo: airvisual.jpg
|
||||
ha_category: Health
|
||||
ha_release: 0.53
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.airvisual/
|
||||
---
|
||||
|
||||
The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) API for air quality data. Data can be collected via latitude/longitude or by city/state/country. The resulting information creates sensors for the Air Quality Index (AQI), the human-friendly air quality level, and the main pollutant of that area. Sensors that conform to either/both the [U.S. and Chinese air quality standards](http://www.clm.com/publication.cfm?ID=366) can be created.
|
||||
@ -138,6 +140,8 @@ When configured, the platform will create three sensors for each configured air
|
||||
- **Explanation:**
|
||||
|
||||
AQI | Status | Description
|
||||
redirect_from:
|
||||
- /components/sensor.airvisual/
|
||||
------- | :----------------: | ----------
|
||||
0 - 50 | **Good** | Air quality is considered satisfactory, and air pollution poses little or no risk
|
||||
51 - 100 | **Moderate** | Air quality is acceptable; however, for some pollutants there may be a moderate health concern for a very small number of people who are unusually sensitive to air pollution
|
||||
@ -160,6 +164,8 @@ AQI | Status | Description
|
||||
- **Explanation:**
|
||||
|
||||
Pollutant | Symbol | More Info
|
||||
redirect_from:
|
||||
- /components/sensor.airvisual/
|
||||
------- | :----------------: | ----------
|
||||
Particulate (<= 2.5 μm) | PM2.5 | [EPA: Particulate Matter (PM) Pollution ](https://www.epa.gov/pm-pollution)
|
||||
Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution ](https://www.epa.gov/pm-pollution)
|
@ -11,6 +11,8 @@ logo: aladdin_connect.png
|
||||
ha_category: Cover
|
||||
ha_release: 0.75
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/cover.aladdin_connect/
|
||||
---
|
||||
|
||||
The `aladdin_connect` cover platform lets you control Genie Aladdin Connect garage doors through Home Assistant.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: alarmdotcom.png
|
||||
ha_category: Alarm
|
||||
ha_release: 0.11
|
||||
redirect_from:
|
||||
- /components/alarm_control_panel.alarmdotcom/
|
||||
---
|
||||
|
||||
The `alarmdotcom` platform is consuming the information provided by [Alarm.com](https://www.alarm.com/).
|
@ -11,6 +11,8 @@ logo: alpha_vantage.png
|
||||
ha_category: Finance
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: "0.60"
|
||||
redirect_from:
|
||||
- /components/sensor.alpha_vantage/
|
||||
---
|
||||
|
||||
The `alpha_vantage` sensor platform uses [Alpha Vantage](https://www.alphavantage.co) to monitor the stock market. This platform also provides detail about exchange rates.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: polly.png
|
||||
ha_category: Text-to-speech
|
||||
ha_release: 0.37
|
||||
redirect_from:
|
||||
- /components/tts.amazon_polly/
|
||||
---
|
||||
|
||||
The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output.
|
@ -97,6 +97,14 @@ device_class:
|
||||
required: false
|
||||
default: auto
|
||||
type: string
|
||||
turn_on_command:
|
||||
description: An ADB shell command that will override the default `turn_on` command.
|
||||
required: false
|
||||
type: string
|
||||
turn_off_command:
|
||||
description: An ADB shell command that will override the default `turn_off` command.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Full Configuration %}
|
||||
@ -104,8 +112,8 @@ device_class:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
# Use an ADB server to setup an Android TV device
|
||||
# and provide an app name
|
||||
# Use an ADB server to setup an Android TV device, provide
|
||||
# an app name, and override the default turn on/off commands
|
||||
- platform: androidtv
|
||||
name: Android TV
|
||||
device_class: androidtv
|
||||
@ -113,6 +121,8 @@ media_player:
|
||||
adb_server_ip: 127.0.0.1
|
||||
apps:
|
||||
com.amazon.tv.launcher: "Fire TV"
|
||||
turn_on_command: "input keyevent 3"
|
||||
turn_off_command: "input keyevent 223"
|
||||
|
||||
# Use the Python ADB implementation with authentication
|
||||
# to setup a Fire TV device and don't get the running apps
|
||||
|
@ -11,6 +11,8 @@ logo: anel.png
|
||||
ha_category: Switch
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: "0.30"
|
||||
redirect_from:
|
||||
- /components/switch.anel_pwrctrl/
|
||||
---
|
||||
|
||||
The `anel_pwrctrl` switch platform allows you to control [ANEL PwrCtrl](http://anel-elektronik.de/SITE/produkte/produkte.htm) devices.
|
@ -11,6 +11,8 @@ logo: anthemav.png
|
||||
ha_category: Media Player
|
||||
ha_iot_class: Local Push
|
||||
ha_release: 0.37
|
||||
redirect_from:
|
||||
- /components/media_player.anthemav/
|
||||
---
|
||||
|
||||
Both [Anthem]'s current and last generation of A/V Receivers and Processors support IP-based, network control. This Home Assistant platform adds proper "local push" support for any of these receivers on your network.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: apple.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.31
|
||||
redirect_from:
|
||||
- /components/notify.apns/
|
||||
---
|
||||
|
||||
The `apns` platform uses the Apple Push Notification service (APNS) to deliver notifications from Home Assistant.
|
@ -11,6 +11,8 @@ logo: sharp_aquos.png
|
||||
ha_category: Media Player
|
||||
ha_release: 0.35
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/media_player.aquostv/
|
||||
---
|
||||
|
||||
The `aquostv` platform allows you to control a [Sharp Aquos TV](http://www.sharp.ca/en-CA/ForHome/HomeEntertainment/LEDTV/QuattronPlus.aspx).
|
@ -11,6 +11,8 @@ logo: arest.png
|
||||
ha_category: DIY
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.9
|
||||
redirect_from:
|
||||
- /components/binary_sensor.arest/
|
||||
---
|
||||
|
||||
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: aruba.png
|
||||
ha_category: Presence Detection
|
||||
ha_release: 0.7
|
||||
redirect_from:
|
||||
- /components/device_tracker.aruba/
|
||||
---
|
||||
|
||||
|
@ -10,6 +10,8 @@ footer: true
|
||||
ha_category: Sensor
|
||||
ha_release: 0.31
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/sensor.arwn/
|
||||
---
|
||||
|
||||
The `arwn` sensor platform is a client for the [Ambient Radio Weather Network](http://github.com/sdague/arwn) project. This collects weather station data and makes it available in an MQTT subtree.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: asterisk.png
|
||||
ha_category: Mailbox
|
||||
ha_release: 0.79
|
||||
redirect_from:
|
||||
- /components/mailbox.asterisk_cdr/
|
||||
---
|
||||
|
||||
The Asterisk Call Data Recorder provides access to Asterisk call logs on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail component](/components/asterisk_mbox/) configuration if the `asterisk_mbox_server` is configured to provide CDR data. More information on configuring the server can be found in the [Asterisk PBX configuration guide](/docs/asterisk_mbox/).
|
@ -10,6 +10,8 @@ footer: true
|
||||
ha_category: Environment
|
||||
ha_release: 0.39
|
||||
logo: noaa.png
|
||||
redirect_from:
|
||||
- /components/binary_sensor.aurora/
|
||||
---
|
||||
|
||||
The `aurora` platform uses the [NOAA aurora forecast](http://www.swpc.noaa.gov/products/aurora-30-minute-forecast) service to let you know if an aurora might be visible at your home location in the next 30 minutes, based off of current solar flare activity.
|
@ -11,6 +11,8 @@ logo: automatic.png
|
||||
ha_category: Car
|
||||
ha_release: 0.28
|
||||
ha_iot_class: Cloud Push
|
||||
redirect_from:
|
||||
- /components/device_tracker.automatic/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ ha_category: Light
|
||||
ha_iot_class: Assumed State
|
||||
logo: avi-on.png
|
||||
ha_release: 0.37
|
||||
redirect_from:
|
||||
- /components/light.avion/
|
||||
---
|
||||
|
||||
Support for the Avi-on Bluetooth dimmer switch [Avi-On](http://avi-on.com/).
|
@ -11,6 +11,8 @@ logo: awair.jpg
|
||||
ha_category: Health
|
||||
ha_release: 0.84
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.awair/
|
||||
---
|
||||
|
||||
The `awair` sensor platform will fetch data from your [Awair device(s)](https://getawair.com).
|
185
source/_components/aws.markdown
Normal file
185
source/_components/aws.markdown
Normal file
@ -0,0 +1,185 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Amazon Web Services"
|
||||
description: "Instructions on how to integrate Amazon Web Services with Home Assistant."
|
||||
date: 2019-03-21 00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: aws.png
|
||||
ha_category:
|
||||
- Notifications
|
||||
ha_release: "0.91"
|
||||
---
|
||||
|
||||
The `aws` integration provides a single place to interact [Amazon Web Services](https://aws.amazon.com/). Current it provide a notification platform can send a message to [AWS SQS](https://aws.amazon.com/sqs/), [AWS SNS](https://aws.amazon.com/sns/), or invoke [AWS Lambda](https://aws.amazon.com/lambda/) functions.
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
|
||||
You have to have an AWS account to use Amazon Web Services, create one [here](https://aws.amazon.com/free/) with a 12 months free tier benefit. Please note, even in the first 12-months, you may still be billed if you use more resources than offered in the free tier. We advise you to monitor your costs in the [AWS Billing Console](https://console.aws.amazon.com/billing/) closely. You can read the [Control your AWS costs](https://aws.amazon.com/getting-started/tutorials/control-your-costs-free-tier-budgets/) guide for more information.
|
||||
|
||||
The `lambda`, `sns` and `sqs` services, used in the `aws` component, all provide an **Always Free** tier for all users even after the 12-month period. The general usage in Home Automation will most likely not reach the free tier limit. Please read [Lambda Pricing](https://aws.amazon.com/lambda/pricing/), [SNS Pricing](https://aws.amazon.com/sns/pricing/) and [SQS Pricing](https://aws.amazon.com/sqs/pricing/) for more details.
|
||||
|
||||
The `aws` component is using [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html) to communicate with Amazon Web Services, which is also used by the [AWS Command Client Interface](https://aws.amazon.com/cli/) tool. Therefore, `aws` shares the same credential and profiles with `awscli` tool. Please read [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) to learn how to get access keys and how to manage them on your local system securely.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use the `aws` component and the `notify` platform in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
aws:
|
||||
credentials:
|
||||
- name: My AWS Account
|
||||
aws_access_key_id: AWS_ID
|
||||
aws_secret_access_key: AWS_SECRET
|
||||
notify:
|
||||
# use the first credential defined in aws component by default
|
||||
- service: lambda
|
||||
region_name: us-east-1
|
||||
```
|
||||
|
||||
### {% linkable_title Configuration for credentials %}
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: Give your AWS credential a name, so that you can refer it in other AWS platforms.
|
||||
required: true
|
||||
type: string
|
||||
aws_access_key_id:
|
||||
description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
|
||||
required: Required if aws_secret_access_key is provided
|
||||
type: string
|
||||
aws_secret_access_key:
|
||||
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
|
||||
required: Required if aws_access_key_id is provided
|
||||
type: string
|
||||
profile_name:
|
||||
description: A credentials profile name.
|
||||
required: false
|
||||
type: string
|
||||
region_name:
|
||||
description: The region identifier to connect to.
|
||||
required: true
|
||||
default: "`us-east-1`"
|
||||
type: string
|
||||
name:
|
||||
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
required: false
|
||||
default: notify
|
||||
type: string
|
||||
context:
|
||||
description: An optional dictionary you can provide to pass custom context through to the Lambda function.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Configuration for notify %}
|
||||
|
||||
{% configuration %}
|
||||
service:
|
||||
description: Amazon Web Services will be used for notification. You can choose from `lambda`, `sns`, or `sqs`.
|
||||
required: true
|
||||
type: string
|
||||
region_name:
|
||||
description: The region identifier to connect to, for example, `us-east-1`.
|
||||
required: true
|
||||
type: string
|
||||
credential_name:
|
||||
description: A reference to a `aws` credential. Notify platform will use the `default profile` defined in `~/.aws` if none of `credential_name`, `aws_access_key_id`, or `profile_name` was given.
|
||||
required: false
|
||||
type: string
|
||||
aws_access_key_id:
|
||||
description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key`.
|
||||
required: false
|
||||
type: string
|
||||
aws_secret_access_key:
|
||||
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id`.
|
||||
required: Required if aws_access_key_id is provided
|
||||
type: string
|
||||
profile_name:
|
||||
description: A credentials profile name.
|
||||
required: false
|
||||
type: string
|
||||
name:
|
||||
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
required: false
|
||||
default: notify
|
||||
type: string
|
||||
context:
|
||||
description: An optional dictionary you can provide to pass custom context through to the notification handler.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Lambda Notify Usage %}
|
||||
|
||||
AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) or a partial ARN. For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda.html#Lambda.Client.invoke).
|
||||
|
||||
The Lambda event payload will contain everything passed in the service call payload. Here is an example payload that would be sent to Lambda:
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Test message!",
|
||||
"target": "arn:aws:lambda:us-east-1:123456789012:function:ProcessKinesisRecords",
|
||||
"data": {
|
||||
"test": "okay"
|
||||
},
|
||||
"message": "Hello world!"
|
||||
}
|
||||
```
|
||||
|
||||
The context will look like this:
|
||||
|
||||
```json
|
||||
{
|
||||
"custom": {
|
||||
"two": "three",
|
||||
"test": "one"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## {% linkable_title SNS Notify Usage %}
|
||||
|
||||
AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)). For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns.html#SNS.Client.publish).
|
||||
|
||||
If one exists, the SNS Subject will be set to the title. All attributes from the payload, except the message, will be sent as stringified message attributes.
|
||||
|
||||
### {% linkable_title Setting up SNS within AWS %}
|
||||
|
||||
- Log into your AWS console and under "Security and Identity", select "Identity & Access Management".
|
||||
- On the left-hand side, select "Users" then click "Create New Users". Enter a name here and then click "Create".
|
||||
- You can either download the credentials or click the arrow to display them one time.
|
||||
|
||||
<p class='note warning'>
|
||||
If you do not download them, you will lose them and will have to recreate a new user.
|
||||
</p>
|
||||
|
||||
- Copy/Paste the two keys that are shown here in your `configuration.yaml` file.
|
||||
- On the left-hand side of the screen go back to "Users" and select the user you just created. On the "Permissions" tab click the "Attach Policy" icon. Search for "SNS" and attach the policy "AmazonSNSFUullAccess".
|
||||
- Back to the AWS Console you now need to find "SNS" and click in to that service. It is under the Mobile Services group.
|
||||
- On the left-hand side, select "Topics" then "Create new topic".
|
||||
- Choose a Topic Name and Display Name.
|
||||
- Now check the box next to the Topic you just created and under Actions, select "Subscribe to topic".
|
||||
- In the box that pops up, select the Protocol = SMS and enter in the phone number next to "Endpoint" you wish to SMS. Now click "Create".
|
||||
- Repeat for additional numbers.
|
||||
- Back in the "Users" section you will see a long alphanumeric line that starts with "arn:" and ends with the Topic Name you choose previously. This is what your "target" in Home Assistant will be.
|
||||
|
||||
## {% linkable_title SQS Notify Usage %}
|
||||
|
||||
AWS SQS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS docs](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html) and [bototcore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html#SQS.Client.send_message)
|
||||
|
||||
The SQS event payload will contain everything passed in the service call payload. SQS payloads will be published as stringified JSON. All attributes from the payload, except message, will also be sent as stringified message attributes. Here is an example message that would be published to the SQS queue:
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Test message!",
|
||||
"target": "http://sqs.us-east-1.amazonaws.com/123456789012/queue2",
|
||||
"data": {
|
||||
"test": "okay"
|
||||
},
|
||||
"message": "Hello world!"
|
||||
}
|
||||
```
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: aws_lambda.png
|
||||
ha_category: Notifications
|
||||
ha_release: "0.20"
|
||||
redirect_from:
|
||||
- /components/notify.aws_lambda/
|
||||
---
|
||||
|
||||
The `aws_lambda` notification platform enables invoking [AWS Lambda](https://aws.amazon.com/lambda/) functions.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: aws_sns.png
|
||||
ha_category: Notifications
|
||||
ha_release: "0.20"
|
||||
redirect_from:
|
||||
- /components/notify.aws_sns/
|
||||
---
|
||||
|
||||
The `aws_sns` notification platform enables publishing to an [AWS SNS](https://aws.amazon.com/sns/) topic or application.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: aws_sqs.png
|
||||
ha_category: Notifications
|
||||
ha_release: "0.20"
|
||||
redirect_from:
|
||||
- /components/notify.aws_sqs/
|
||||
---
|
||||
|
||||
The `aws_sqs` notification platform enables publishing to an [AWS SQS](https://aws.amazon.com/sqs/) message queue.
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Axis"
|
||||
description: "Instructions on how to setup devices from Axis Communications within Home Assistant."
|
||||
description: "Integration between network devices from Axis Communications with Home Assistant."
|
||||
date: 2017-04-30 23:04
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -11,143 +11,35 @@ logo: axis.png
|
||||
ha_category:
|
||||
- Camera
|
||||
- Binary Sensor
|
||||
ha_config_flow: true
|
||||
ha_release: 0.45
|
||||
ha_iot_class: Local Polling
|
||||
ha_iot_class: Local Push
|
||||
redirect_from:
|
||||
- /components/binary_sensor.axis/
|
||||
- /components/camera.axis/
|
||||
---
|
||||
|
||||
[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, speakers, access control and other security-related network connected hardware. Event API works with firmware 5.50 and newer.
|
||||
|
||||
Home Assistant will automatically discover their presence on your network.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
You can also manually configure your devices by adding the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
axis:
|
||||
m1065lw:
|
||||
host: IP ADDRESS
|
||||
include:
|
||||
- camera
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
device:
|
||||
description: A unique name
|
||||
required: true
|
||||
type: string
|
||||
host:
|
||||
description: The IP address to your Axis device.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: The username to your Axis device.
|
||||
required: false
|
||||
type: string
|
||||
default: root
|
||||
password:
|
||||
description: The password to your Axis device.
|
||||
required: false
|
||||
type: string
|
||||
default: pass
|
||||
trigger_time:
|
||||
description: Minimum time (in seconds) a sensor should keep its positive value.
|
||||
required: false
|
||||
type: integer
|
||||
default: 0
|
||||
port:
|
||||
description: Configure port web server of device is accessible from.
|
||||
required: false
|
||||
type: integer
|
||||
default: 80
|
||||
location:
|
||||
description: Physical location of your Axis device.
|
||||
required: false
|
||||
type: string
|
||||
include:
|
||||
description: This cannot be empty else there would be no use adding the device at all.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
camera:
|
||||
description: Stream MJPEG video to Home Assistant.
|
||||
motion:
|
||||
description: The built-in motion detection in Axis cameras.
|
||||
vmd3:
|
||||
description: ACAP Motion Detection app which has better algorithms for motion detection.
|
||||
pir:
|
||||
description: PIR sensor that can trigger on a motion.
|
||||
sound:
|
||||
description: Sound detector.
|
||||
daynight:
|
||||
description: Certain cameras have day/night mode if they have built-in IR lights.
|
||||
tampering:
|
||||
description: Signals when camera believes that it has been tampered with.
|
||||
input:
|
||||
description: Trigger on whatever you have connected to device input port.
|
||||
{% endconfiguration %}
|
||||
|
||||
A full configuration example could look like this:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
axis:
|
||||
m1065lw:
|
||||
host: IP ADDRESS
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
include:
|
||||
- camera
|
||||
- motion
|
||||
- pir
|
||||
- sound
|
||||
- daynight
|
||||
trigger_time: 0
|
||||
location: köket
|
||||
```
|
||||
|
||||
<p class='note'>
|
||||
Any specific levels for triggers needs to be configured on the device.
|
||||
</p>
|
||||
For configuration go to the `Integrations pane` on your Home Assistant instance.
|
||||
|
||||
<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.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Device services %}
|
||||
|
||||
Available services: `vapix_call`.
|
||||
|
||||
### {% linkable_title Service `axis/vapix_call` %}
|
||||
|
||||
Send a command using [Vapix](https://www.axis.com/support/developer-support/vapix). For details please read the API specifications.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|--------------------------------------------------|
|
||||
| `name` | no | Name of device to communicate with. |
|
||||
| `param` | no | What parameter to operate on. |
|
||||
| `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`
|
||||
|
||||
## {% linkable_title Troubleshooting discovery %}
|
||||
|
||||
If a `169.x.x.x` address is discovered. On your camera, go to **System Options** -> **Advanced** -> **Plain Config**. Change the drop-down box to `network` and click `Select Group`. If `Network Interface I0 ZeroConf` contains the `169.x.x.x` IP address, unchecked the box next to `Enabled` for this section and click `Save`.
|
||||
If your device is not discovered. On your camera, go to **System Options** -> **Advanced** -> **Plain Config**. Change the drop-down box to `network` and click `Select Group`. If `Network Interface I0 ZeroConf` contains the `169.x.x.x` IP address, unchecked the box next to `Enabled` for this section and click `Save`.
|
||||
|
||||
## {% linkable_title Binary Sensor %}
|
||||
|
||||
The `Axis` platform allows you to get data from your [Axis](https://www.axis.com/) devices from within Home Assistant.
|
||||
|
||||
The following sensor types are supported:
|
||||
|
||||
- Motion detection
|
||||
- Motion detection (VMD3/VMD4)
|
||||
- Passive IR motion detection
|
||||
- Sound detection
|
||||
- Day/night mode
|
||||
- Tampering detection
|
||||
- Input port
|
||||
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: baiducloud.png
|
||||
ha_category: Text-to-speech
|
||||
ha_release: 0.59
|
||||
redirect_from:
|
||||
- /components/tts.baidu/
|
||||
---
|
||||
|
||||
The `baidu` text-to-speech platform uses [Baidu TTS engine](https://cloud.baidu.com/product/speech/tts) to read a text with natural sounding voices.
|
@ -12,6 +12,8 @@ ha_category: Utility
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.53
|
||||
ha_qa_scale: internal
|
||||
redirect_from:
|
||||
- /components/binary_sensor.bayesian/
|
||||
---
|
||||
|
||||
The `bayesian` binary sensor platform observes the state from multiple sensors and uses [Bayes' rule](https://en.wikipedia.org/wiki/Bayes%27_theorem) to estimate the probability that an event has occurred given the state of the observed sensors. If the estimated posterior probability is above the `probability_threshold`, the sensor is `on` otherwise it is `off`.
|
@ -11,6 +11,8 @@ logo: bbox.png
|
||||
ha_category: Network
|
||||
ha_release: 0.31
|
||||
ha_iot_class: Local Push
|
||||
redirect_from:
|
||||
- /components/sensor.bbox/
|
||||
---
|
||||
|
||||
The `bbox` platform uses the [Bbox Modem Router](https://fr.wikipedia.org/wiki/Bbox/) from the French Internet provider Bouygues Telecom. Sensors are mainly bandwidth measures.
|
@ -11,6 +11,8 @@ logo: raspberry-pi.png
|
||||
ha_category: DIY
|
||||
ha_release: 0.48
|
||||
ha_iot_class: Local Push
|
||||
redirect_from:
|
||||
- /components/sensor.bh1750/
|
||||
---
|
||||
|
||||
The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet.
|
@ -11,6 +11,8 @@ logo: bitcoin.png
|
||||
ha_category: Finance
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.bitcoin/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ logo: monoprice.svg
|
||||
ha_category: Media Player
|
||||
ha_release: 0.68
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/media_player.blackbird/
|
||||
---
|
||||
|
||||
The `blackbird` platform allows you to control [Monoprice Blackbird Matrix Switch](https://www.monoprice.com/product?p_id=21819) using a serial connection.
|
@ -11,6 +11,8 @@ logo: blinkstick.png
|
||||
ha_category: DIY
|
||||
ha_release: 0.7.5
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/light.blinksticklight/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ logo: raspberry-pi.png
|
||||
ha_category: DIY
|
||||
ha_iot_class: Local Push
|
||||
ha_release: 0.44
|
||||
redirect_from:
|
||||
- /components/light.blinkt/
|
||||
---
|
||||
|
||||
The `blinkt` light platform lets you control the [Blinkt!](https://shop.pimoroni.com/products/blinkt) board, featuring eight super-bright RGB LEDs.
|
@ -11,6 +11,8 @@ logo: blockchain.png
|
||||
ha_category: Finance
|
||||
ha_release: 0.47
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.blockchain/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ logo: bluesound.png
|
||||
ha_category: Media Player
|
||||
ha_release: 0.51
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/media_player.bluesound/
|
||||
---
|
||||
|
||||
The `bluesound` platform allows you to control your [Bluesound](http://www.bluesound.com/) HiFi wireless speakers and audio components from Home Assistant.
|
@ -11,6 +11,8 @@ logo: bluetooth.png
|
||||
ha_category: Presence Detection
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.27
|
||||
redirect_from:
|
||||
- /components/device_tracker.bluetooth_le_tracker/
|
||||
---
|
||||
|
||||
This tracker discovers new devices on boot and in regular intervals and tracks Bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other.
|
@ -11,6 +11,8 @@ logo: bluetooth.png
|
||||
ha_category: Presence Detection
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.18
|
||||
redirect_from:
|
||||
- /components/device_tracker.bluetooth_tracker/
|
||||
---
|
||||
|
||||
This tracker discovers new devices on boot and tracks Bluetooth devices periodically based on `interval_seconds` value. It is not required to pair the devices with each other! Devices discovered are stored with 'bt_' as the prefix for device MAC addresses in `known_devices.yaml`.
|
@ -11,6 +11,8 @@ logo: raspberry-pi.png
|
||||
ha_category: DIY
|
||||
ha_release: 0.48
|
||||
ha_iot_class: Local Push
|
||||
redirect_from:
|
||||
- /components/sensor.bme280/
|
||||
---
|
||||
|
||||
The `bme280` sensor platform allows you to read temperature, humidity and pressure values of a [Bosch BME280 Environmental sensor](https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet.
|
@ -11,6 +11,8 @@ logo: raspberry-pi.png
|
||||
ha_category: DIY
|
||||
ha_release: 0.62
|
||||
ha_iot_class: Local Push
|
||||
redirect_from:
|
||||
- /components/sensor.bme680/
|
||||
---
|
||||
|
||||
The `bme680` sensor platform allows you to read temperature, humidity, pressure and gas resistance values of a [Bosch BME680 Environmental sensor](https://cdn-shop.adafruit.com/product-files/3660/BME680.pdf) connected via an [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. In addition, it includes a basic air quality calculation that uses gas resistance and humidity measurements to calculate a percentage based air quality measurement.
|
@ -11,6 +11,8 @@ logo: bom.png
|
||||
ha_category: Weather
|
||||
ha_release: 0.36
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/weather.bom/
|
||||
---
|
||||
|
||||
The `bom` weather platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for current (half-hourly) meteorological data.
|
@ -11,6 +11,8 @@ logo: bravia.png
|
||||
ha_category: Media Player
|
||||
ha_release: 0.23
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/media_player.braviatv/
|
||||
---
|
||||
|
||||
The `braviatv` platform allows you to control a [Sony Bravia TV](http://www.sony.com).
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: telegram.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.48
|
||||
redirect_from:
|
||||
- /components/telegram_bot.broadcast/
|
||||
---
|
||||
|
||||
Telegram implementation to support **sending messages only**. Your Home Assistant instance does not have to be exposed to the Internet and there is no polling to receive messages sent to the bot.
|
@ -11,6 +11,8 @@ logo: broadlink.png
|
||||
ha_category: Switch
|
||||
ha_release: 0.35
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/switch.broadlink/
|
||||
---
|
||||
|
||||
This `Broadlink` switch platform allow to you control Broadlink [devices](http://www.ibroadlink.com/).
|
@ -11,6 +11,8 @@ ha_category: Social
|
||||
logo: brottsplatskartan.png
|
||||
ha_release: 0.85
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.brottsplatskartan/
|
||||
---
|
||||
|
||||
The `brottsplatskartan` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Brottsplatskartan](https://brottsplatskartan.se). The sensor only counts incidents from the current day.
|
@ -11,6 +11,8 @@ logo: brunt.png
|
||||
ha_category: Cover
|
||||
ha_release: 0.75
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/cover.brunt/
|
||||
---
|
||||
|
||||
The `brunt` platform allows one to control Blind Engines by [Brunt](https://www.brunt.co). To use this sensor, you need a Brunt App Account. All Brunt Blind devices registered to your account are automatically added to your Home Assistant with the names given them through the Brunt app.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: bt.png
|
||||
ha_category: Presence Detection
|
||||
ha_release: 0.22
|
||||
redirect_from:
|
||||
- /components/device_tracker.bt_home_hub_5/
|
||||
---
|
||||
|
||||
This platform offers presence detection by looking at connected devices to a [BT Home Hub 5](https://en.wikipedia.org/wiki/BT_Home_Hub) based router.
|
@ -11,6 +11,8 @@ logo: bt.png
|
||||
ha_category: Presence Detection
|
||||
ha_release: 0.82
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/device_tracker.bt_smarthub/
|
||||
---
|
||||
|
||||
This platform offers presence detection by looking at connected devices to a [BT Smart Hub](https://en.wikipedia.org/wiki/BT_Smart_Hub) based router.
|
@ -11,6 +11,8 @@ logo: buienradar.png
|
||||
ha_category: Weather
|
||||
ha_release: 0.47
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/weather.buienradar/
|
||||
---
|
||||
|
||||
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.
|
@ -10,6 +10,8 @@ footer: true
|
||||
ha_category: Calendar
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: "0.60"
|
||||
redirect_from:
|
||||
- /components/calendar.caldav/
|
||||
---
|
||||
|
||||
The `caldav` platform allows you to connect to your WebDav calendar and generate
|
@ -11,6 +11,8 @@ logo: home-assistant.png
|
||||
ha_category: Network
|
||||
ha_release: 0.44
|
||||
ha_iot_class: Configurable
|
||||
redirect_from:
|
||||
- /components/sensor.cert_expiry/
|
||||
---
|
||||
|
||||
The `cert_expiry` sensor fetches information from a configured URL and displays the certificate expiry in days.
|
@ -11,6 +11,8 @@ logo: channels.png
|
||||
ha_category: Media Player
|
||||
ha_release: 0.65
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/media_player.channels/
|
||||
---
|
||||
|
||||
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: cisco.png
|
||||
ha_category: Presence Detection
|
||||
ha_release: 0.33
|
||||
redirect_from:
|
||||
- /components/device_tracker.cisco_ios/
|
||||
---
|
||||
|
||||
This is a presence detection scanner for [Cisco](http://www.cisco.com) IOS devices.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: ciscospark.png
|
||||
ha_category: Notifications
|
||||
ha_release: "0.40"
|
||||
redirect_from:
|
||||
- /components/notify.ciscospark/
|
||||
---
|
||||
|
||||
The `ciscospark` notification platform allows you to deliver notifications from Home Assistant to [Cisco Spark](https://ciscospark.com/).
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: citybikes.png
|
||||
ha_category: Transport
|
||||
ha_release: 0.49
|
||||
redirect_from:
|
||||
- /components/sensor.citybikes/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ logo: clementine.png
|
||||
ha_category: Media Player
|
||||
ha_release: 0.39
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/media_player.clementine/
|
||||
---
|
||||
|
||||
The `clementine` platform allows you to control a [Clementine Music Player](https://www.clementine-player.org).
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: clickatell.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.56
|
||||
redirect_from:
|
||||
- /components/notify.clickatell/
|
||||
---
|
||||
|
||||
The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: clicksend.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.48
|
||||
redirect_from:
|
||||
- /components/notify.clicksend/
|
||||
---
|
||||
|
||||
|
@ -8,9 +8,13 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: clicksend.png
|
||||
ha_category: Notifications
|
||||
ha_category:
|
||||
- Notifications
|
||||
ha_release: 0.55
|
||||
redirect_from: /components/notify.clicksendaudio/
|
||||
redirect_from:
|
||||
- /components/notify.clicksendaudio/
|
||||
redirect_from:
|
||||
- /components/notify.clicksend_tts/
|
||||
---
|
||||
|
||||
The `clicksend_tts` platform uses [ClickSend](https://clicksend.com) to deliver text-to-speech (TTS) notifications from Home Assistant.
|
||||
@ -22,7 +26,6 @@ To add ClickSend to your installation, add the following to your Home Assistant
|
||||
```yaml
|
||||
notify:
|
||||
- platform: clicksend_tts
|
||||
name: ClickSend
|
||||
username: CLICKSEND_USERNAME
|
||||
api_key: CLICKSEND_API_KEY
|
||||
recipient: PHONE_NO
|
||||
@ -43,9 +46,13 @@ api_key:
|
||||
required: true
|
||||
type: string
|
||||
recipient:
|
||||
description: Your phone number. This is where you want to send your notification SMS messages (e.g., `09171234567`).
|
||||
description: Recipient phone number. This is the phone number that you want to call and notify via TTS (e.g., `09171234567`).
|
||||
required: true
|
||||
type: string
|
||||
caller:
|
||||
description: Caller phone number. This is the phone number that you want to be the TTS call originator (e.g., `09181234567`). If not defined the recipient number is used.
|
||||
required: false
|
||||
type: string
|
||||
language:
|
||||
description: The language you want to use to convert the message to audio. Accepted values are found in the [ClickSend Documentation](http://docs.clicksend.apiary.io/#reference/voice/voice-languages).
|
||||
required: false
|
@ -11,6 +11,8 @@ footer: true
|
||||
ha_category: Media Player
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.23
|
||||
redirect_from:
|
||||
- /components/media_player.cmus/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ logo: co2signal.png
|
||||
ha_category: Environment
|
||||
ha_release: 0.87
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.co2signal/
|
||||
---
|
||||
|
||||
The `co2signal` sensor platform queries the [CO2Signal](https://www.co2signal.com/) API for the CO2 intensity of a specific region. Data can be collected via latitude/longitude or by country code. This API uses the same data as https://www.electricitymap.org/. Not all countries/regions in the world are supported so please consult this website to check local availability.
|
@ -11,6 +11,8 @@ logo: coinmarketcap.png
|
||||
ha_category: Finance
|
||||
ha_release: 0.28
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.coinmarketcap/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ logo: comed.png
|
||||
ha_category: Energy
|
||||
ha_release: "0.40"
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.comed_hourly_pricing/
|
||||
---
|
||||
|
||||
The ComEd Hourly Pricing program is an optional program available to ComEd electric subscribers which charges customers a variable rate for electricity supply based on current demand rather than a traditional fixed rate. Live prices are published [here](https://hourlypricing.comed.com/live-prices/) and also via an [API](https://hourlypricing.comed.com/hp-api/) which we can integrate as a sensor in Home Assistant.
|
@ -11,6 +11,8 @@ logo: command_line.png
|
||||
ha_category: Utility
|
||||
ha_release: 0.12
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/binary_sensor.command_line/
|
||||
---
|
||||
|
||||
The `command_line` binary sensor platform issues specific commands to get data.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: interlogix.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: 0.31
|
||||
redirect_from:
|
||||
- /components/binary_sensor.concord232/
|
||||
---
|
||||
|
||||
The `concord232` platform provides integration with GE, Interlogix (and other brands) alarm panels that support the RS-232 Automation Control Panel interface module (or have it built in). Supported panels include Concord 4.
|
@ -11,6 +11,8 @@ logo: coolautomation.png
|
||||
ha_category: Climate
|
||||
ha_release: 0.88
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/climate.coolmaster/
|
||||
---
|
||||
|
||||
|
@ -20,7 +20,7 @@ Supported platforms (tested):
|
||||
- Aruba ClearPass 6.7.5
|
||||
|
||||
<p class='note warning'>
|
||||
You must first creat an API client from here: https://clearpass.server.com/guest/api_clients.php
|
||||
You must first create an API client [here](https://clearpass.server.com/guest/api_clients.php).
|
||||
</p>
|
||||
|
||||
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
|
||||
@ -40,11 +40,11 @@ host:
|
||||
required: true
|
||||
type: string
|
||||
client_id:
|
||||
description: "The client ID from here: `https://clearpass.server.com/guest/api_clients.php`"
|
||||
description: "The client ID from the API Clients page."
|
||||
required: true
|
||||
type: string
|
||||
api_key:
|
||||
description: "Secret from here: `https://clearpass.server.com/guest/api_clients.php`"
|
||||
description: "The secret from the API Clients page."
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
@ -11,6 +11,8 @@ logo: cpu.png
|
||||
ha_category: System Monitor
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: Local Push
|
||||
redirect_from:
|
||||
- /components/sensor.cpuspeed/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ ha_category: Social
|
||||
logo: crimereports.png
|
||||
ha_release: 0.42
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.crimereports/
|
||||
---
|
||||
|
||||
The `crimereports` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Crime Reports](https://www.crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day.
|
@ -11,6 +11,8 @@ logo: cups.png
|
||||
ha_category: System Monitor
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.32
|
||||
redirect_from:
|
||||
- /components/sensor.cups/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ ha_category: Finance
|
||||
logo: currencylayer.png
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: 0.32
|
||||
redirect_from:
|
||||
- /components/sensor.currencylayer/
|
||||
---
|
||||
|
||||
|
@ -12,6 +12,8 @@ ha_category: Weather
|
||||
ha_release: "0.30"
|
||||
redirect_from: /components/sensor.forecast/
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.darksky/
|
||||
---
|
||||
|
||||
The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as a source for meteorological data for your location. The location is based on the `longitude` and `latitude` coordinates configured in your `configuration.yaml` file. The coordinates are auto-detected but to take advantage of the hyper-local weather reported by Dark Sky, you can refine them down to your exact home address. GPS coordinates can be found by using [Google Maps](https://www.google.com/maps) and clicking on your home or [Openstreetmap](http://www.openstreetmap.org/).
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: ddwrt.png
|
||||
ha_category: Presence Detection
|
||||
ha_release: pre 0.7
|
||||
redirect_from:
|
||||
- /components/device_tracker.ddwrt/
|
||||
---
|
||||
|
||||
This platform offers presence detection by looking at connected devices to a [DD-WRT](http://www.dd-wrt.com/site/index) based router.
|
@ -11,6 +11,8 @@ ha_category: Light
|
||||
ha_iot_class: Local Polling
|
||||
logo: leviton.png
|
||||
ha_release: 0.37
|
||||
redirect_from:
|
||||
- /components/light.decora/
|
||||
---
|
||||
|
||||
Support for the Decora Bluetooth dimmer switch [Leviton](https://www.leviton.com/en/products/residential/dimmers/automation-smart-home/decora-digital-with-bluetooth-dimmers#t=Products&sort=%40wcs_site_tree_rank%20ascending&layout=card).
|
@ -11,6 +11,8 @@ ha_category: Light
|
||||
ha_iot_class: Cloud Polling
|
||||
logo: leviton.png
|
||||
ha_release: 0.51
|
||||
redirect_from:
|
||||
- /components/light.decora_wifi/
|
||||
---
|
||||
|
||||
Support for [Leviton Decora Wi-Fi](http://www.leviton.com/en/products/lighting-controls/decora-smart-with-wifi) dimmers/switches via the MyLeviton API.
|
@ -11,6 +11,8 @@ logo: deluge.png
|
||||
ha_category: Downloading
|
||||
ha_release: 0.57
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/switch.deluge/
|
||||
---
|
||||
|
||||
The `deluge` switch platform allows you to control your [Deluge](http://deluge-torrent.org/) client from within Home Assistant. The platform enables you switch all your torrents in pause, and then unpause them all.
|
@ -11,6 +11,8 @@ logo: denon.png
|
||||
ha_category: Media Player
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.7.2
|
||||
redirect_from:
|
||||
- /components/media_player.denon/
|
||||
---
|
||||
|
||||
The `denon` platform allows you to control a [Denon Network Receivers](http://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo) from Home Assistant. It might be that your device is supported by the [Denon AVR] platform.
|
@ -11,6 +11,8 @@ logo: denon.png
|
||||
ha_category: Media Player
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.7.2
|
||||
redirect_from:
|
||||
- /components/media_player.denonavr/
|
||||
---
|
||||
|
||||
The `denonavr` platform allows you to control a [Denon Network Receivers](http://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo) from Home Assistant. It might be that your device is supported by the [Denon] platform.
|
@ -11,6 +11,8 @@ ha_category: Transport
|
||||
logo: db.png
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: 0.14
|
||||
redirect_from:
|
||||
- /components/sensor.deutsche_bahn/
|
||||
---
|
||||
|
||||
|
@ -1,76 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Traccar GPS tracker"
|
||||
description: "Instructions how to use Traccar GPS tracker to track devices in Home Assistant."
|
||||
date: 2018-11-04 00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: traccar.png
|
||||
ha_release: 0.83
|
||||
ha_category: Presence Detection
|
||||
ha_iot_class: Local Polling
|
||||
---
|
||||
|
||||
`Traccar` uses GPS for tracking and has support for over 1500 different types of devices.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate Traccar GPS tracker in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
- platform: traccar
|
||||
host: IP_ADDRESS
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The DNS name or IP Address of the server running Traccar.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: The username for the Traccar server.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for your given account on the Traccar server.
|
||||
required: true
|
||||
type: string
|
||||
host:
|
||||
description: The DNS name or IP Address of the server running Traccar.
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: The port of your Traccar server.
|
||||
required: false
|
||||
default: 8082
|
||||
type: integer
|
||||
ssl:
|
||||
description: Use HTTPS to connect to Traccar server. *NOTE* A host *cannot* be an IP address when this option is enabled.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
verify_ssl:
|
||||
description: Verify the certification of the system.
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
monitored_conditions:
|
||||
description: Additional traccar computed attributes or device-related attributes to include in the scan.
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
The parameter `monitored_conditions` allows you to track non standard attributes from the traccar platform and use them in your Home Assistant. For example if you need to monitor the state of the non standard attribute `alarm` and a custom computed attribute `mycomputedattribute` just fill the configuration with:
|
||||
|
||||
```yaml
|
||||
device_tracker:
|
||||
- platform: traccar
|
||||
...
|
||||
monitored_conditions: ['alarm', 'mycomputedattribute']
|
||||
```
|
@ -11,6 +11,8 @@ ha_category: DIY
|
||||
ha_release: 0.7
|
||||
logo: dht.png
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/sensor.dht/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ logo: digitalloggers.png
|
||||
ha_category: Switch
|
||||
ha_release: 0.35
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/switch.digitalloggers/
|
||||
---
|
||||
|
||||
The `digitalloggers` switch platform allows you to control the state of your [Digital Loggers](http://www.digital-loggers.com/dinfaqs.html) switches.
|
@ -11,6 +11,8 @@ logo: directv.png
|
||||
ha_category: Media Player
|
||||
ha_release: 0.25
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/media_player.directv/
|
||||
---
|
||||
|
||||
Master [DirecTV](http://www.directv.com/) receivers (ie: those that have tuners) will be automatically discovered if you enable the [discovery component](/components/discovery/) and the receiver is powered-on. Slave/RVU client/Genie boxes will also be discovered, but only if they are also online at the time of discovery.
|
@ -11,6 +11,8 @@ ha_category: Multimedia
|
||||
ha_release: 0.61
|
||||
logo: discogs.png
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.discogs/
|
||||
---
|
||||
|
||||
The `discogs` platform allows you to see the current amount of records in your [Discogs](https://discogs.com) collection.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: discord.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.37
|
||||
redirect_from:
|
||||
- /components/notify.discord/
|
||||
---
|
||||
|
||||
The [Discord service](https://discordapp.com/) is a platform for the notify component. This allows components to send messages to the user using Discord.
|
@ -11,6 +11,8 @@ ha_category: Camera
|
||||
logo: camcorder.png
|
||||
ha_release: "0.40"
|
||||
ha_iot_class: Configurable
|
||||
redirect_from:
|
||||
- /components/camera.dispatcher/
|
||||
---
|
||||
|
||||
<p class='note'>
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: dlib.png
|
||||
ha_category: Image Processing
|
||||
ha_release: 0.44
|
||||
redirect_from:
|
||||
- /components/image_processing.dlib_face_detect/
|
||||
---
|
||||
|
||||
The `dlib_face_detect` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform enables face detection from cameras, and can fire events with attributes.
|
@ -10,6 +10,8 @@ footer: true
|
||||
logo: dlib.png
|
||||
ha_category: Image Processing
|
||||
ha_release: 0.44
|
||||
redirect_from:
|
||||
- /components/image_processing.dlib_face_identify/
|
||||
---
|
||||
|
||||
The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons.
|
@ -11,6 +11,8 @@ logo: dlink.png
|
||||
ha_category: Switch
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.14
|
||||
redirect_from:
|
||||
- /components/switch.dlink/
|
||||
---
|
||||
|
||||
The `dlink` switch platform allows you to control the state of your [D-Link Wi-Fi Smart Plugs](http://us.dlink.com/product-category/home-solutions/connected-home/smart-plugs/).
|
@ -11,6 +11,8 @@ logo: dlna.png
|
||||
ha_category: Media Player
|
||||
ha_release: 0.76
|
||||
ha_iot_class: Local Push
|
||||
redirect_from:
|
||||
- /components/media_player.dlna_dmr/
|
||||
---
|
||||
|
||||
The `dlna_dmr` platform allows you to control a [DLNA Digital Media Renderer](https://www.dlna.org/), such as DLNA enabled TVs or radios.
|
@ -11,6 +11,8 @@ logo: home-assistant.png
|
||||
ha_category: Network
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: "0.40"
|
||||
redirect_from:
|
||||
- /components/sensor.dnsip/
|
||||
---
|
||||
|
||||
The `dnsip` sensor will expose an IP address, fetched via DNS resolution, as its value. There are two operational modes:
|
@ -11,6 +11,8 @@ logo: netbeheernederland.jpg
|
||||
ha_category: Energy
|
||||
ha_release: 0.34
|
||||
ha_iot_class: Local Push
|
||||
redirect_from:
|
||||
- /components/sensor.dsmr/
|
||||
---
|
||||
|
||||
A sensor platform for Dutch Smart Meters which comply to DSMR (Dutch Smart Meter Requirements), also known as 'Slimme meter' or 'P1 poort'.
|
@ -11,6 +11,8 @@ logo: dte_energy.png
|
||||
ha_category: Energy
|
||||
ha_release: 0.21
|
||||
ha_iot_class: Local Polling
|
||||
redirect_from:
|
||||
- /components/sensor.dte_energy_bridge/
|
||||
---
|
||||
|
||||
A sensor platform for the [DTE](https://www.dteenergy.com/) Energy Bridge. To find out which version of the DTE Energy Bridge sensor you have, find the status LED on your box.
|
@ -11,6 +11,8 @@ logo: dublin_bus.png
|
||||
ha_category: Transport
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: 0.36
|
||||
redirect_from:
|
||||
- /components/sensor.dublin_bus_transport/
|
||||
---
|
||||
|
||||
The `dublin_bus_transport` sensor will give you the time until the next two departures from a Dublin bus stop using the RTPI information.
|
@ -11,6 +11,8 @@ logo: duke_energy.png
|
||||
ha_category: Energy
|
||||
ha_release: 0.74
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.duke_energy/
|
||||
---
|
||||
|
||||
The `duke_energy` sensor platform allows you get the previous days usage for all of your Duke Energy smart meters.
|
@ -11,6 +11,8 @@ logo: dunehd.png
|
||||
ha_category: Media Player
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.34
|
||||
redirect_from:
|
||||
- /components/media_player.dunehd/
|
||||
---
|
||||
|
||||
|
@ -11,6 +11,8 @@ footer: true
|
||||
ha_category: Weather
|
||||
ha_release: 0.51
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.dwd_weather_warnings/
|
||||
---
|
||||
|
||||
The `dwd_weather_warnings` sensor platform uses the [Deutsche Wetter Dienst (DWD)](https://www.dwd.de) as a source for current and advance warnings.
|
@ -11,6 +11,8 @@ logo: ebox.png
|
||||
ha_category: Network
|
||||
ha_release: 0.39
|
||||
ha_iot_class: Cloud Polling
|
||||
redirect_from:
|
||||
- /components/sensor.ebox/
|
||||
---
|
||||
|
||||
Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant.
|
@ -149,7 +149,7 @@ auto, and off.
|
||||
The following attributes are provided by the Ecobee Thermostat:
|
||||
`name`, `temperature_unit`, `current_temperature`, `target_temperature`,
|
||||
`target_temperature_low`, `target_temperature_high`, `desired_fan_mode`,
|
||||
`fan`, `current_hold_mode`, `current_operation`, `operation_list`,
|
||||
`fan`, `current_hold_mode`, `operation`, `operation_list`, `equipment_running`,
|
||||
`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`,
|
||||
`is_away_mode_on`, `vacation`, `climate_list`, `aux_heat`.
|
||||
The attributes `min_temp` and `max_temp` are meaningless constant values.
|
||||
@ -229,7 +229,7 @@ Returns the current temperature hold, if any.
|
||||
| ---------------| ----------- |
|
||||
| String | 'temp', 'vacation', 'home', 'away', etc., None
|
||||
|
||||
### {% linkable_title Attribute `current_operation` %}
|
||||
### {% linkable_title Attribute `operation` %}
|
||||
|
||||
Returns the current operation of the thermostat.
|
||||
|
||||
@ -253,6 +253,14 @@ Returns the current operation mode of the thermostat.
|
||||
| ---------------| ----------- |
|
||||
| String | Currently active operation mode
|
||||
|
||||
### {% linkable_title Attribute `equipment_running` %}
|
||||
|
||||
Returns the list of equipment that is currently operating from the thermostat.
|
||||
|
||||
| Attribute type | Description |
|
||||
| ---------------| ----------- |
|
||||
| String | If no equipment is currently running empty string is returned. Possible values are a comma separated list of any of the following: heatPump, heatPump2, heatPump3, compCool1, compCool2, auxHeat1, auxHeat2, auxHeat3, fan, humidifier, dehumidifier, ventilator, economizer, compHotWater, auxHotWater.
|
||||
|
||||
### {% linkable_title Attribute `mode` %}
|
||||
|
||||
Returns the climate currently active on the thermostat. The mode
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user