mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Merge branch 'next' into add_alias_as_lookup_for_areas_and_floors
This commit is contained in:
Andrii Mitnovych
GitHub
commit
c5dc0e0df2
@ -634,7 +634,7 @@ source/_integrations/prometheus.markdown @knyar
|
||||
source/_integrations/prosegur.markdown @dgomes
|
||||
source/_integrations/proximity.markdown @mib1185
|
||||
source/_integrations/proxmoxve.markdown @jhollowe @Corbeno
|
||||
source/_integrations/prusalink.markdown @balloob @Skaronator
|
||||
source/_integrations/prusalink.markdown @balloob
|
||||
source/_integrations/ps4.markdown @ktnrg45
|
||||
source/_integrations/pse.markdown @tronikos
|
||||
source/_integrations/psoklahoma.markdown @tronikos
|
||||
|
||||
@ -79,6 +79,14 @@ icon_tap_action:
|
||||
required: false
|
||||
description: Action taken on icon card tap. See [action documentation](/dashboards/actions/#tap-action). By default, it will `toggle` the entity (if possible), otherwise, show the "more-info" dialog.
|
||||
type: map
|
||||
icon_hold_action:
|
||||
required: false
|
||||
description: Action taken on icon tap-and-hold. See [action documentation](/dashboards/actions/#hold-action).
|
||||
type: map
|
||||
icon_double_tap_action:
|
||||
required: false
|
||||
description: Action taken on icon double tap. See [action documentation](/dashboards/actions/#double-tap-action).
|
||||
type: map
|
||||
features:
|
||||
required: false
|
||||
description: Additional widgets to control your entity. See [available features](/dashboards/features).
|
||||
|
||||
@ -8,6 +8,7 @@ ha_category:
|
||||
- Light
|
||||
- Sensor
|
||||
- Switch
|
||||
- Valve
|
||||
ha_release: '0.60'
|
||||
ha_iot_class: Local Push
|
||||
ha_domain: ads
|
||||
@ -17,6 +18,7 @@ ha_platforms:
|
||||
- light
|
||||
- sensor
|
||||
- switch
|
||||
- valve
|
||||
ha_integration_type: integration
|
||||
related:
|
||||
- docs: /docs/configuration/
|
||||
@ -32,7 +34,10 @@ There is currently support for the following device types within Home Assistant:
|
||||
- [Sensor](#sensor)
|
||||
- [Switch](#switch)
|
||||
- [Cover](#cover)
|
||||
- [Select](#select)
|
||||
- [Valve](#valve)
|
||||
|
||||
<!-- omit in toc -->
|
||||
## Configuration
|
||||
|
||||
To enable ADS, add the following lines to your {% term "`configuration.yaml`" %} file.
|
||||
@ -60,6 +65,7 @@ ip_address:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
<!-- omit in toc -->
|
||||
## Action
|
||||
|
||||
The ADS integration will register the `write_by_name` action allowing you to write a value to a variable on your ADS device.
|
||||
@ -139,7 +145,7 @@ name:
|
||||
|
||||
## Sensor
|
||||
|
||||
The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *INT*, *UINT*, *BYTE*, *DINT* or *UDINT*.
|
||||
The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *BOOL*, *BYTE*, *INT*, *UINT*, *SINT*, *USINT*, *DINT*, *UDINT*, *WORD*, *DWORD*, *REAL*, or *LREAL*.
|
||||
|
||||
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
|
||||
file:
|
||||
@ -160,7 +166,7 @@ adsvar:
|
||||
type: string
|
||||
adstype:
|
||||
required: false
|
||||
description: The datatype of the ADS variable, possible values are int, uint, byte, dint, udint.
|
||||
description: The datatype of the ADS variable, possible values are bool, byte, int, uint, sint, usint, dint, udint, word, dword, real and lreal.
|
||||
default: int
|
||||
type: string
|
||||
name:
|
||||
@ -253,3 +259,56 @@ device_class:
|
||||
description: Sets the [class of the device](/integrations/cover/), changing the device state and icon that is displayed on the frontend.
|
||||
type: device_class
|
||||
{% endconfiguration %}
|
||||
|
||||
## Select
|
||||
|
||||
The `ads` select entity accesses an ENUM (int) variable on the connected ADS device. The variable is identified by its name. You have to set up a corresponding ENUM in the TwinCAT PLC. It is recommended to use explicit values starting from `0`.
|
||||
|
||||
```yaml
|
||||
TYPE E_SampleA :
|
||||
(
|
||||
e1 := 0,
|
||||
e2 := 1,
|
||||
e3 := 2,
|
||||
);
|
||||
END_TYPE
|
||||
```
|
||||
|
||||
## Valve
|
||||
|
||||
The `ads` valve entity accesses a boolean variable on the connected ADS device. The variable is identified by its name.
|
||||
|
||||
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
|
||||
file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
select:
|
||||
- platform: ads
|
||||
adsvar: MAIN.eMyEnum
|
||||
options:
|
||||
- "Off"
|
||||
- "Setup"
|
||||
- "Automatic"
|
||||
- "Manual"
|
||||
- "Guest"
|
||||
- "Error"
|
||||
valve:
|
||||
- platform: ads
|
||||
adsvar: MAIN.bValveControl
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
adsvar:
|
||||
required: true
|
||||
description: The name of the variable which you want to access on the ADS device.
|
||||
type: string
|
||||
options:
|
||||
required: true
|
||||
description: The available options to select from.
|
||||
type: string
|
||||
name:
|
||||
required: false
|
||||
description: An identifier for the valve in the frontend.
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
@ -4,7 +4,7 @@ description: Get energy usage from Arizona Public Service (APS) using the Opower
|
||||
ha_category:
|
||||
- Energy
|
||||
- Sensor
|
||||
ha_release: 2024.10
|
||||
ha_release: "2024.10"
|
||||
ha_domain: aps
|
||||
ha_integration_type: virtual
|
||||
ha_supporting_domain: opower
|
||||
|
||||
@ -3,6 +3,7 @@ title: BSB-Lan
|
||||
description: Instructions on how to integrate BSBLan device into Home Assistant.
|
||||
ha_category:
|
||||
- Climate
|
||||
- Sensor
|
||||
ha_release: '0.110'
|
||||
ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
@ -12,31 +13,32 @@ ha_domain: bsblan
|
||||
ha_platforms:
|
||||
- climate
|
||||
- diagnostics
|
||||
- sensor
|
||||
ha_integration_type: device
|
||||
---
|
||||
|
||||
The **BSB-Lan** {% term integration %} integrates [BSBLan](https://github.com/fredlcore/BSB-LAN) devices into Home Assistant.
|
||||
|
||||
BSBLan is a device that is made by `Frederik Holst` and `Ulf Dieckmann` for documentation and with
|
||||
BSBLan is a device that is made by `Frederik Holst` and with
|
||||
the help of many other contributors.
|
||||
The new board v3 is designed for an Arduino Due with an Ethernet-Shield for web-based controlling
|
||||
The board v3 is designed for an Arduino Due with an Ethernet-Shield for web-based controlling
|
||||
of heating systems such as `Elco Thision`, `Brötje` and similar systems.
|
||||
Also, available is an ESP32 version of the board.
|
||||
|
||||
It can interface with the heating system over Boiler-System-Bus, Local Process Bus and PPS (Punkt-zu-Punkt Schnittstelle)
|
||||
For more information of which system it supports, have a look at their [documentation](https://1coderookie.github.io/BSB-LPB-LAN_EN/).
|
||||
For more information of which system it supports, take a look at their [documentation](https://docs.bsb-lan.de).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
{% include integrations/config_flow.md %},
|
||||
For authentication HTTP authentication using a username and password,
|
||||
or using a passkey is supported. Use either one.
|
||||
|
||||
For more documentation of the BSBLan device, check the [manual](https://1coderookie.github.io/BSB-LPB-LAN_EN/).
|
||||
For more documentation of the BSBLan device, check the [manual](https://docs.bsb-lan.de).
|
||||
|
||||
To see a more detailed listing of the reported systems which are successfully used with BSB-LAN please follow the corresponding link:
|
||||
To see a more detailed listing of the reported systems which are successfully used with BSB-LAN, please follow the corresponding link:
|
||||
|
||||
- [`Brötje`](https://1coderookie.github.io/BSB-LPB-LAN_EN/chap03.html#311-broetje)
|
||||
- [`Elco`](https://1coderookie.github.io/BSB-LPB-LAN_EN/chap03.html#312-elco)
|
||||
- [`Other Manufacturers (e.g. Fujitsu, Atlantic, Weishaupt)`](https://1coderookie.github.io/BSB-LPB-LAN_EN/chap03.html#313-other-manufacturers)
|
||||
[Supported heating systems](https://docs.bsb-lan.de/supported_heating_systems.html)
|
||||
|
||||
The integration is tested with the stable firmware version `1.00`. A newer firmware versions will not work, because the parameters are changed of the specific info that is needed.
|
||||
Please use the latest release. [release 1.0](https://github.com/fredlcore/BSB-LAN/releases/tag/v1.0)
|
||||
The integration is tested with the stable firmware version `3.1.6-20230327101530`. A newer firmware version may not work because the API could have changed.
|
||||
Please use this release. [release 3.1](https://github.com/fredlcore/BSB-LAN/releases/tag/v3.1)
|
||||
|
||||
@ -21,7 +21,7 @@ ha_integration_type: helper
|
||||
The derivative ([Wikipedia](https://en.wikipedia.org/wiki/Derivative)) integration creates a sensor that estimates the derivative of the
|
||||
values provided by another sensor (the **source sensor**). Derivative sensors are updated upon changes of the **source sensor**.
|
||||
|
||||
For sensors that reset to zero after a power interruption and need a "non-negative derivative", such as bandwidth counters in routers, or rain gauges, consider using the [Utility Meter](/integrations/utility_meter/) integration instead. Otherwise, each reset will register a significant change in the derivative sensor.
|
||||
For sensors that reset to zero after a power interruption and need a "non-negative derivative", such as bandwidth counters in routers, or rain gauges, you can now use this integration directly. Ensure that the input sensor has a `total_increasing` state class, as this is necessary for the integration to handle resets correctly without registering significant changes in the derivative sensor.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
{% configuration_basic %}
|
||||
|
||||
39
source/_integrations/duke_energy.markdown
Normal file
39
source/_integrations/duke_energy.markdown
Normal file
@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Duke Energy
|
||||
description: Instructions on how to integrate Duke Energy within Home Assistant.
|
||||
ha_category:
|
||||
- Energy
|
||||
ha_release: "2024.10"
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_codeowners:
|
||||
- '@hunterjm'
|
||||
ha_domain: duke_energy
|
||||
ha_config_flow: true
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The **Duke Energy** {% term integration %} allows you to get energy information from [Duke Energy](https://www.duke-energy.com/).
|
||||
|
||||
## Supported devices
|
||||
|
||||
Currently, this integration only supports electric meters.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You need a Duke Energy account to use this integration. During installation of the integration, you will need the username and password to access your account.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Energy
|
||||
|
||||
Because Duke Energy only releases usage data with around a 48-hour delay, the integration inserts data into statistic objects.
|
||||
You can find the statistics in {% my developer_statistics title="**Developer Tools** > **Statistics**"%} and search for "duke_energy".
|
||||
**This delay means that there will be no data in the energy dashboard for today and likely yesterday** (depending on time of day you are checking).
|
||||
|
||||
At the initial setup, the integration pulls historical hourly usage since the account activation. Duke Energy typically only keeps this data for the past 3 years.
|
||||
After the initial setup, the integration keeps pulling data (twice per day) for the past 30 days to allow for any corrections in the data.
|
||||
|
||||
In the configuration of the energy dashboard ({% my config_energy title="**Settings** > **Dashboards** > **Energy**" %}):
|
||||
|
||||
1. Select **Add consumption** for the **Electricity grid**.
|
||||
2. Select **Duke Energy Electric {meter serial number} Consumption** for the **consumed energy**.
|
||||
@ -21,8 +21,10 @@ related:
|
||||
title: Google Developers Console
|
||||
---
|
||||
|
||||
The **Google Photos** integration allows you to connect your [Google Photos](https://photos.google.com/) to Home Assistant. The integration adds a [media source](/integrations/media_source) with
|
||||
recent photos allowing you to view or cast your photos from the media browser.
|
||||
The **Google Photos** integration allows you to upload photos to your [Google Photos](https://photos.google.com/) using Home Assistant. The integration adds an action for uploading photos and a
|
||||
[media source](/integrations/media_source) to view or cast the content uploaded by
|
||||
Home Assistant. This integration does not give Home Assistant access to your
|
||||
entire Google Photos library.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@ -76,6 +78,22 @@ The integration setup will next give you instructions to enter the [Application
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
|
||||
### Action `google_photos.upload`
|
||||
|
||||
You can use the `google_photos.upload` action to upload Photos from Home Assistant
|
||||
to Google Photos.
|
||||
|
||||
{% details "Create event action details" %}
|
||||
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | --------|
|
||||
| `filename` | no | Path to the image to upload. | /mnt/image.jpg
|
||||
| `config_entry_id` | no | The ID of the Google Photos config entry. | a1bee602deade2b09bc522749bbce48e |
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you have an error with your credentials, you can delete them in the [Application Credentials](/integrations/application_credentials/) user interface.
|
||||
|
||||
@ -33,23 +33,33 @@ H6062,
|
||||
H6065,
|
||||
H6066,
|
||||
H6067,
|
||||
H606A,
|
||||
H6072,
|
||||
H6073,
|
||||
H6076,
|
||||
H6078,
|
||||
H6079,
|
||||
H607C,
|
||||
H6087,
|
||||
H6088,
|
||||
H608A,
|
||||
H608B,
|
||||
H610A,
|
||||
H610B,
|
||||
H6110,
|
||||
H6117,
|
||||
H6159,
|
||||
H615A,
|
||||
H615B,
|
||||
H615C,
|
||||
H615D,
|
||||
H615E,
|
||||
H6163,
|
||||
H6168,
|
||||
H6172,
|
||||
H6173,
|
||||
H6175,
|
||||
H6176,
|
||||
H618A,
|
||||
H618C,
|
||||
H618E,
|
||||
@ -68,25 +78,40 @@ H61A5,
|
||||
H61A8,
|
||||
H61B2,
|
||||
H61B5,
|
||||
H61BA,
|
||||
H61BE,
|
||||
H61C3,
|
||||
H61C5,
|
||||
H61D3,
|
||||
H61D5,
|
||||
H61E0,
|
||||
H61E1,
|
||||
H7012,
|
||||
H7013,
|
||||
H7020,
|
||||
H7021,
|
||||
H7028,
|
||||
H7033,
|
||||
H7037,
|
||||
H7038,
|
||||
H7039,
|
||||
H7041,
|
||||
H7042,
|
||||
H7050,
|
||||
H7051,
|
||||
H7052,
|
||||
H7055,
|
||||
H705A,
|
||||
H705B,
|
||||
H705C,
|
||||
H7060,
|
||||
H7061,
|
||||
H7062,
|
||||
H7063,
|
||||
H7065,
|
||||
H706A,
|
||||
H70C1
|
||||
H7066,
|
||||
H7075,
|
||||
H70A1,
|
||||
H70B1,
|
||||
H70C1,
|
||||
H70C2
|
||||
34
source/_integrations/monarch_money.markdown
Normal file
34
source/_integrations/monarch_money.markdown
Normal file
@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Monarch Money
|
||||
description: Instructions on the Monarch Money Integration for personal finance.
|
||||
ha_category:
|
||||
- Sensor
|
||||
- Finance
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: "2024.10"
|
||||
ha_codeowners:
|
||||
- '@jeeftor'
|
||||
ha_domain: monarch_money
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- sensor
|
||||
ha_integration_type: service
|
||||
---
|
||||
|
||||
[Monarch Money](https://www.monarchmoney.com) is a personal finance aggregation and budgeting service that integrates with Plaid, MX, and FinCity, the three major financial backends.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- You need a Monarch Money account to use this integration.
|
||||
- You need account credentials. This integration supports both `username` and `password` login, as well as accounts configured with `MFA`.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
### Accounts & devices
|
||||
|
||||
Each `account` is set up as a device in Home Assistant and contain the following sensors:
|
||||
|
||||
|Sensor|Description|
|
||||
|-------|---------------|
|
||||
|Balance|Account balance|
|
||||
|Age| This sensor shows when the data was retrieved by Monarch's back end |
|
||||
29
source/_integrations/nyt_games.markdown
Normal file
29
source/_integrations/nyt_games.markdown
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
title: NYT Games
|
||||
description: Instructions on how to setup NYT Games in Home Assistant.
|
||||
ha_category:
|
||||
- Sensor
|
||||
ha_config_flow: true
|
||||
ha_release: "2024.10"
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_codeowners:
|
||||
- '@joostlek'
|
||||
ha_domain: nyt_games
|
||||
ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
The [NYT Games](https://www.nytimes.com/crosswords) integration fetches data about your progress on their daily puzzles.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before setting up the integration, you need to fetch the token from the dev tools of your browser.
|
||||
|
||||
1. On your computer, go to [NYT Games](https://www.nytimes.com/crosswords).
|
||||
2. Login with your account.
|
||||
3. Open the developer tools via right-click or by pressing F12.
|
||||
4. Open the network tab and refresh the page.
|
||||
5. Select a request with `.json` in the name and go to the cookie tab.
|
||||
6. The token can be found in the `NYT-S` cookie.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
@ -19,44 +19,32 @@ ha_platforms:
|
||||
- sensor
|
||||
ha_integration_type: integration
|
||||
related:
|
||||
- docs: /docs/configuration/
|
||||
title: Configuration file
|
||||
- docs: /integrations/application_credentials/
|
||||
title: Application credentials
|
||||
---
|
||||
|
||||
The Point hub enables integration with the [Minut Point](https://minut.com/). To connect with Point, you will have to [sign up for a developer account and have a Pro subscription](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant URL + `/api/minut`, e.g., `http://homeassistant.local:8123/api/minut`. The `client_id` and `client_secret` should be used as below.
|
||||
The Point hub enables integration with the [Minut Point](https://minut.com/).
|
||||
|
||||
Once Home Assistant is started, a configurator will pop up asking you to Authenticate your Point account via a link. When you follow the link and click on **Accept** you will be redirected to the `callback url` and the Point integration will be automatically configured and you can go back to the original dialog and press **Submit**.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
## Prerequisites
|
||||
|
||||
- [Alarm](#alarm)
|
||||
- [Binary sensor](#binary-sensor)
|
||||
- [Sensor](#sensor)
|
||||
Before adding the integration to Home Assistant, you need to get Minut Point application credentials.
|
||||
|
||||
### Configuration
|
||||
1. Navigate to the [API-client | Minut](https://web.minut.com/settings/api-clients) dashboard and **Create client**:
|
||||
|
||||
To use the Minut Point {% term integration %} in your installation, add it to your {% term "`configuration.yaml`" %} file.
|
||||
{% include integrations/restart_ha_after_config_inclusion.md %}
|
||||
- Enter a **Name** for your client (this is just an identifier).
|
||||
- Enter `https://my.home-assistant.io/redirect/oauth` in the **Redirect URI** field.
|
||||
2. Get the **ClientID** and **ClientSecret** for the new client and store them in a safe place. You need them to complete the integration setup in Home Assistant.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
point:
|
||||
client_id: CLIENT_ID
|
||||
client_secret: CLIENT_SECRET
|
||||
```
|
||||
<div class='note'>
|
||||
|
||||
{% configuration %}
|
||||
client_id:
|
||||
description: Your Minut Point developer client ID.
|
||||
required: true
|
||||
type: string
|
||||
client_secret:
|
||||
description: Your Minut Point developer client secret.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
If you are a Kickstarter backer, you need to send an email to hello@minut.com to retrieve the **ClientID** and **ClientSecret**. Don't forget to mention that the **Redirect URI** should be `https://my.home-assistant.io/redirect/oauth`.
|
||||
|
||||
# Device types
|
||||
</div>
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Device types
|
||||
|
||||
The integration supports the following device types within Home Assistant:
|
||||
- [Alarm](#alarm)
|
||||
|
||||
@ -8,7 +8,6 @@ ha_release: '2022.9'
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@balloob'
|
||||
- '@Skaronator'
|
||||
ha_domain: prusalink
|
||||
ha_integration_type: integration
|
||||
ha_platforms:
|
||||
|
||||
@ -58,6 +58,37 @@ Cancel A/C on vehicle.
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `vehicle`| yes | device_id of the vehicle |
|
||||
|
||||
### Action `renault.ac_set_schedules`
|
||||
|
||||
Update AC schedule on vehicle.
|
||||
|
||||
| Data attribute | Required | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | ------- |
|
||||
| `vehicle`| yes | device_id of the vehicle | |
|
||||
| `schedules` | yes | Schedule details. Can be a single schedule or a list of schedules | see [example below](#ac_schedule_example) |
|
||||
|
||||
Notes:
|
||||
|
||||
- `schedules` can contain one or more schedules which are set within the same call.
|
||||
- The `id` is compulsory on each `schedule` (should be 1 to 5, depending on the vehicle).
|
||||
- The `activated` flag is an optional boolean. If it is not provided, then the existing flag will be kept as is.
|
||||
- The `monday` to `sunday` elements are optional. If they are not provided, then the existing settings will be kept for each day. If they are provided as None, then the existing setting will be cleared. If a value is provided, it must contain the key `readyAtTime` (in UTC format).
|
||||
|
||||
<a name="ac_schedule_example">Example</a>:
|
||||
|
||||
```yaml
|
||||
- id: 1
|
||||
activated: true
|
||||
monday:
|
||||
readyAtTime: 'T12:00Z'
|
||||
- id: 2
|
||||
activated: false
|
||||
monday:
|
||||
readyAtTime: 'T12:00Z'
|
||||
tuesday:
|
||||
readyAtTime: 'T12:00Z'
|
||||
```
|
||||
|
||||
### Action `renault.charge_set_schedules`
|
||||
|
||||
Update charge schedule on vehicle.
|
||||
@ -69,24 +100,22 @@ Update charge schedule on vehicle.
|
||||
|
||||
Notes:
|
||||
|
||||
- `schedules` can be in the form `{'id':1,...}` when updating a single schedules, or in the form `[{'id':1,...},{'id':2,...},...]` when updating multiple schedules within the same call
|
||||
- `schedules` can contain one or more schedules which are set within the same call
|
||||
- the `id` is compulsory on each `schedule` (should be 1 to 5 depending on the vehicle)
|
||||
- the `activated` flag is an optional boolean. If it is not provided, then the existing flag will be kept as is.
|
||||
- the `monday` to `sunday` elements are optional. If they are not provided, then the existing settings will be kept for each day. If they are provided as None, then the existing setting will be cleared. If a value is provided, it must conform to this format `{'startTime':'T12:00Z','duration':15}` where start time is in UTC format and the duration is in minutes.
|
||||
- the `monday` to `sunday` elements are optional. If they are not provided, then the existing settings will be kept for each day. If they are provided as None, then the existing setting will be cleared. If a value is provided, it must contain the keys `startTime` (in UTC format) and `duration` (in minutes).
|
||||
|
||||
<a name="schedule_example">Example</a>:
|
||||
|
||||
```yaml
|
||||
[
|
||||
{
|
||||
'id': 1,
|
||||
'activated': true,
|
||||
'monday': {'startTime':'T12:00Z', 'duration':15}
|
||||
},
|
||||
{
|
||||
'id': 2,
|
||||
'activated': false,
|
||||
'monday': {'startTime':'T12:00Z', 'duration':240}
|
||||
},
|
||||
]
|
||||
- id: 1
|
||||
activated: true
|
||||
monday:
|
||||
startTime: 'T12:00Z'
|
||||
duration: 15
|
||||
- id: 1
|
||||
activated: false
|
||||
monday:
|
||||
startTime: 'T12:00Z'
|
||||
duration: 15
|
||||
```
|
||||
|
||||
@ -89,7 +89,10 @@ Depending on the supported features of the camera, number entities are added for
|
||||
- Optical zoom control
|
||||
- Focus control
|
||||
- Floodlight turn on brightness
|
||||
- Volume
|
||||
- Volume (Camera)
|
||||
- Alarm volume (Home Hub)
|
||||
- Message volume (Home Hub)
|
||||
- Chime volume
|
||||
- Guard return time
|
||||
- Motion sensitivity
|
||||
- PIR sensitivity
|
||||
@ -116,7 +119,6 @@ Depending on the supported features of the camera, number entities are added for
|
||||
- Image saturation* (default 128)
|
||||
- Image sharpness* (default 128)
|
||||
- Image hue* (default 128)
|
||||
- Chime volume
|
||||
|
||||
**Floodlight turn on brightness** controls the brightness of the floodlight when it is turned on internally by the camera (see **Floodlight mode** select entity) or when using the **Floodlight** light entity.
|
||||
|
||||
@ -172,6 +174,8 @@ Depending on the supported features of the camera, select entities are added for
|
||||
- Chime motion ringtone
|
||||
- Chime person ringtone
|
||||
- Chime visitor ringtone
|
||||
- Hub alarm ringtone
|
||||
- Hub visitor ringtone
|
||||
|
||||
**PTZ preset** positions can be set in the Reolink app/windows/web client, the names of the presets will be loaded into Home Assistant at the start of the integration. When adding new preset positions, please restart the Reolink integration.
|
||||
|
||||
@ -208,7 +212,7 @@ Depending on the supported features of the camera, switch entities are added for
|
||||
- Record
|
||||
- Manual record
|
||||
- Push notifications
|
||||
- Buzzer on event
|
||||
- Hub ringtone on event
|
||||
- Email on event
|
||||
- FTP upload
|
||||
- PIR enabled*
|
||||
@ -217,7 +221,7 @@ Depending on the supported features of the camera, switch entities are added for
|
||||
|
||||
When the **Infrared lights in night mode** entity is set to OFF, the infrared LEDs are always OFF. When the **Infrared lights in night mode** entity is set to ON, the infrared LEDs will be on when the camera is in night vision mode. For more information, see the **Day night mode** select entity.
|
||||
|
||||
For NVRs, a global switch for **Record**, **Push**, **Buzzer**, **Email**, and **FTP** will be available under the NVR device as well as a switch per channel of the NVR under the camera device. The respective feature will only be active for a given channel if both the global and that channel switch are enabled (as is also the case in the Reolink app/client).
|
||||
For NVRs, a global switch for **Record**, **Push**, **Hub ringtone on event**, **Email**, and **FTP** will be available under the NVR device as well as a switch per channel of the NVR under the camera device. The respective feature will only be active for a given channel if both the global and that channel switch are enabled (as is also the case in the Reolink app/client).
|
||||
|
||||
**Push** notifications to a phone will only be provided if the following conditions are met:
|
||||
- The **Push notifications** switch in Home Assistant is ON.
|
||||
@ -243,6 +247,7 @@ Depending on the supported features of the camera, the following sensor entities
|
||||
|
||||
- PTZ pan position
|
||||
- Wi-Fi signal*
|
||||
- CPU usage*
|
||||
- HDD/SD storage*
|
||||
- Battery percentage
|
||||
- Battery temperature*
|
||||
|
||||
@ -73,6 +73,7 @@ The following buttons will be created:
|
||||
- **Core restart** - Restart core ESP32
|
||||
- **Zigbee restart** - Restart Zigbee CCCC2652 or EFR32 chip
|
||||
- **Zigbee flash mode** - Trigger the Zigbee chip into bootloader flash mode so it can be flashed. It is possible to flash Zigbee firmware over a network socket once this is activated.
|
||||
- **Reconnect Zigbee router** - Place the router into pairing mode to join a new Zigbee network. This is only created if the SLZB-06x device is in Zibgee router mode.
|
||||
|
||||
### Switches
|
||||
|
||||
|
||||
@ -16,22 +16,26 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `solarlog` integration uses the open JSON interface on [Solar-Log PV monitoring systems](https://www.solar-log.com/) to allow you to get details from your Solar-Log device and integrate these into your Home Assistant installation.
|
||||
The **Solarlog** {% term integration %} uses the open JSON interface on [Solar-Log PV monitoring systems](https://www.solar-log.com/) to get details from your Solar-Log device and integrate these into your Home Assistant installation.
|
||||
|
||||
Before being able to use the integration, you have to activate the open JSON interface on your Solar-Log device. This can be activated from the Configuration | System | Access control menu of your Solar-Log device.
|
||||
When activating the interface, a red warning triangle with security information and risks is displayed.
|
||||
## Prerequisites
|
||||
|
||||
Before you can use the integration, you either need the password of the Solar-Log user or you must activate the open JSON interface on your Solar-Log device.
|
||||
- To activate the JSON interface on your Solar-Log device, on the device, go to the Configuration | System | Access control menu.
|
||||
- When activating the interface, a red warning triangle with security information and risks is displayed. For security reasons, it is recommended to activate password protection and use the integration with the respective password.
|
||||
|
||||
The `solarlog` integration uses the default host address "http://solar-log" if you don't specify a host. If your device isn't accessible on this address, use its IP Address instead.
|
||||
|
||||
{% important %}
|
||||
The open JSON interface is deactivated by default. To activate the open JSON interface, a user password should be set for security purposes. The password isn't needed for accessing the open JSON interface.
|
||||
If password protection for the general user is deactivated, the open JSON interface is activated by default. For security reasons, it is recommended to activate the user's password.
|
||||
Please note that the open JSON interface only exposes a limited amount of data. Even if the open JSON interface has been activated, without the user's password, only limited data is available in the integration [see available sensors](#sensors). For [full functionality](#additional-data), you either need the user's password or the user password should be deactivated (not recommended).
|
||||
{% endimportant %}
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Additional template sensor
|
||||
|
||||
In case you would like to convert the values, for example, to Wh instead of the default kWh, you can use the [template platform](/integrations/template/).
|
||||
In case you would like to get additional calculated sensors such as the amount of excess solar power available, you can use the [template platform](/integrations/template/).
|
||||
|
||||
{% raw %}
|
||||
|
||||
@ -47,7 +51,7 @@ template:
|
||||
|
||||
## Sensors
|
||||
|
||||
The following sensors are available in the library:
|
||||
The following sensors are available via the open JSON intervace:
|
||||
|
||||
| name | Unit | Description |
|
||||
|-----------------------|--------|:-------------------------------------------|
|
||||
@ -67,7 +71,6 @@ The following sensors are available in the library:
|
||||
| consumption_month | kWh | Total consumption for the month from all of the consumption meters. |
|
||||
| consumption_year | kWh | Total consumption for the year from all of the consumption meters. |
|
||||
| consumption_total | kWh | Accumulated total consumption from all consumption meters. |
|
||||
| self_consumption_year | kWh | Accumulated total self-consumption. |
|
||||
| installed_peak_power | W | Installed solar peak power. |
|
||||
| alternator_loss | W | Altenator loss (equals to power_dc - power_ac) |
|
||||
| capacity | % | Capacity (equals to power_dc / total power) |
|
||||
@ -78,11 +81,9 @@ The following sensors are available in the library:
|
||||
## Additional data
|
||||
|
||||
{% important %}
|
||||
The additional data is only accessible if the user's password protection is deactivated. Obviously, deactivating password protection is a security risk and should only be done in specific circumstances. In any event, you do this at your own risk.
|
||||
The additional data is only accessible if the user's password is available (or password protection is deactivated). Obviously, deactivating password protection is a security risk and should only be done in specific circumstances. In any event, you do this at your own risk.
|
||||
{% endimportant %}
|
||||
|
||||
You can get additional data from the Solar-Log device. To enable this, select the checkbox for extended data in the integration's system options.
|
||||
|
||||
The following additional sensor becomes available:
|
||||
|
||||
| Name | Unit | Description |
|
||||
|
||||
@ -34,9 +34,27 @@ Supported devices:
|
||||
- Switcher V4
|
||||
- Switcher Breeze
|
||||
- Switcher Runner
|
||||
- Switcher Runner S11
|
||||
|
||||
Devices that require a token:
|
||||
|
||||
- Switcher Runner S11
|
||||
|
||||
If you completed the integration setup but are still unable to control the device, please make sure your device's firmware is up-to-date.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To enhance security, certain Switcher devices require a token for operation. In order to integrate your token-based Switcher devices with Home Assistant, you'll need the following information:
|
||||
|
||||
- **The username of your Switcher Account**: To find the username, open the Switcher app.
|
||||
- **Local control key token**: To find the local control key token, browse to the
|
||||
[Switcher GetKey API][token], enter your Switcher account username (which is an email address), and press
|
||||
**Send Me The Code**.
|
||||
|
||||
The token will be sent to you by email. It will look something like this: `zvVvd7JxtN7CgvkD1Psujw==`
|
||||
|
||||
[token]: https://switcher.co.il/GetKey/
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Buttons
|
||||
@ -87,5 +105,5 @@ Note: This does not affect the auto off timer.
|
||||
|
||||
## Notes
|
||||
|
||||
Make sure that Home Assistant host's firewall allows incoming traffic on UDP ports 10002, 20002 & 20003 and outgoing connections to Switcher device(s) on TCP ports 9957 & 10000.
|
||||
Make sure that Home Assistant host's firewall allows incoming traffic on UDP ports 10002, 10003, 20002 & 20003 and outgoing connections to Switcher device(s) on TCP ports 9957 & 10000.
|
||||
If Home Assistant and the Switcher device(s) are not on the same network, you will also need to have their traffic properly forwarded between the two networks.
|
||||
|
||||
@ -18,6 +18,7 @@ ha_integration_type: integration
|
||||
Support for [Tami4 Edge / Edge+ by Strauss](https://www.tami4.co.il/tami4edge-collection) in Home Assistant.
|
||||
|
||||
You can boil water and get filter / UV information, such as when you need to replace them.
|
||||
Also, all of your personal drinks will be available as buttons for you to use.
|
||||
|
||||
You can easily pair your device by confirming your phone number which is registered with your Edge app account.
|
||||
|
||||
|
||||
@ -3,9 +3,13 @@ title: Tesla Fleet
|
||||
description: Instructions on how to integrate the Tesla Fleet API within Home Assistant.
|
||||
ha_category:
|
||||
- Binary sensor
|
||||
- Button
|
||||
- Car
|
||||
- Climate
|
||||
- Cover
|
||||
- Device tracker
|
||||
- Lock
|
||||
- Media player
|
||||
- Number
|
||||
- Select
|
||||
- Sensor
|
||||
@ -18,9 +22,13 @@ ha_codeowners:
|
||||
ha_domain: tesla_fleet
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- button
|
||||
- climate
|
||||
- cover
|
||||
- device_tracker
|
||||
- diagnostics
|
||||
- lock
|
||||
- media_player
|
||||
- number
|
||||
- select
|
||||
- sensor
|
||||
@ -88,10 +96,24 @@ These are the entities available in the Tesla Fleet integration. Not all entitie
|
||||
|Binary sensor|Tire pressure warning rear right|No|
|
||||
|Binary sensor|Trip charging|No|
|
||||
|Binary sensor|User present|Yes|
|
||||
|Button|Flash lights|Yes|
|
||||
|Button|Homelink|Yes|
|
||||
|Button|Honk horn|Yes|
|
||||
|Button|Keyless driving|Yes|
|
||||
|Button|Play fart|Yes|
|
||||
|Button|Wake|Yes|
|
||||
|Climate|Cabin overheat protection|No|
|
||||
|Climate|Climate|Yes|
|
||||
|Cover|Charge port door|Yes|
|
||||
|Cover|Frunk|Yes|
|
||||
|Cover|Sunroof|No|
|
||||
|Cover|Trunk|Yes|
|
||||
|Cover|Vent windows|Yes|
|
||||
|Device tracker|Location|Yes|
|
||||
|Device tracker|Route|Yes|
|
||||
|Lock|Charge cable lock|Yes|
|
||||
|Lock|Lock|Yes|
|
||||
|Media player|Media player|Yes|
|
||||
|Number|Charge current|Yes|
|
||||
|Number|Charge limit|Yes|
|
||||
|Select|Seat heater front left|Yes|
|
||||
|
||||
36
source/_integrations/triggercmd.markdown
Normal file
36
source/_integrations/triggercmd.markdown
Normal file
@ -0,0 +1,36 @@
|
||||
---
|
||||
title: TRIGGERcmd
|
||||
description: How to integrate TRIGGERcmd with Home Assistant.
|
||||
ha_category:
|
||||
- Switch
|
||||
- Automation
|
||||
ha_release: "2024.10"
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@rvmey'
|
||||
ha_domain: triggercmd
|
||||
ha_platforms:
|
||||
- switch
|
||||
ha_zeroconf: false
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The TRIGGERcmd {% term integration %} allows you to run commands on computers via [TRIGGERcmd](https://triggercmd.com/) with Home Assistant.
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To use TRIGGERcmd, you need the following:
|
||||
|
||||
- A [TRIGGERcmd account](https://www.triggercmd.com/user/auth/signup)
|
||||
- A computer with the TRIGGERcmd agent running on it
|
||||
- For instructions on installing and using TRIGGERcmd itself, refer to the [TRIGGERcmd Quick Start Guide](https://docs.triggercmd.com/#/./QuickStart).
|
||||
- After adding the TRIGGERcmd integration, you will be prompted for your **user token**. This can be found at the bottom of your TRIGGERcmd profile page or the instructions page.
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Using TRIGGERcmd with Home Assistant
|
||||
|
||||
All of your TRIGGERcmd commands should show up as **switch** devices. You can change the rooms of your devices, or select **Finish** to leave them without rooms.
|
||||
|
||||
Using the switch will trigger the respective command. If you have **Allow parameters** enabled, your command will run with an "on" or "off" parameter, depending on whether you flip the switch in Home Assistant on or off.
|
||||
36
source/_integrations/wmspro.markdown
Normal file
36
source/_integrations/wmspro.markdown
Normal file
@ -0,0 +1,36 @@
|
||||
---
|
||||
title: WMS WebControl pro
|
||||
description: Instructions on how to integrate WAREMA devices via WMS WebControl pro within Home Assistant.
|
||||
ha_category:
|
||||
- Cover
|
||||
- Hub
|
||||
ha_release: "2024.10"
|
||||
ha_iot_class: Local Polling
|
||||
ha_codeowners:
|
||||
- '@mback2k'
|
||||
ha_domain: wmspro
|
||||
ha_config_flow: true
|
||||
ha_platforms:
|
||||
- cover
|
||||
ha_integration_type: integration
|
||||
related:
|
||||
- url: https://www.warema.com/en/smart-home/wms-webcontrol-pro/
|
||||
title: Consumer information about WMS WebControl pro
|
||||
- url: https://smartbuildings.warema.com/en/control-systems/radio-systems/wms/wms-webcontrol-pro/
|
||||
title: Technical documentation for WMS WebControl pro
|
||||
---
|
||||
|
||||
The **WMS WebControl pro** {% term integration %} allows you to integrate WAREMA devices into Home Assistant.
|
||||
|
||||
This integration uses a local API which is available with firmware container version 11H.
|
||||
|
||||
See device section for support information: [covers](#covers).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
The WMS WebControl pro *may* also be discovered on your local network via DHCP.
|
||||
|
||||
## Covers
|
||||
|
||||
- *Patio awnings* can be opened, closed, set to a certain position and their movement stopped.
|
||||
- The integration and library *may* already support other types of awnings with a single motor.
|
||||
@ -7,6 +7,7 @@ ha_category:
|
||||
- Button
|
||||
- Lock
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_release: 0.78
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_config_flow: true
|
||||
@ -20,6 +21,7 @@ ha_platforms:
|
||||
- diagnostics
|
||||
- lock
|
||||
- sensor
|
||||
- switch
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
@ -32,6 +34,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
- Button
|
||||
- Lock
|
||||
- Sensor
|
||||
- Switch
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -57,4 +60,8 @@ The lock platform requires a code for unlocking but no code for locking.
|
||||
|
||||
Provides support for smoke detector temperature sensors.
|
||||
|
||||
## Switch
|
||||
|
||||
Provides support for enable/disable autolock on locks. Entity is only available for supported door locks.
|
||||
|
||||
The {% term integration %} can be configured to provide a default code that is used if no code is supplied and the number of digits required.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user