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

Textlint (#39688)

Browse Source
This commit is contained in:
c0ffeeca7 2025-06-24 13:55:32 +02:00 committed by GitHub
parent ed34f40180
commit 253cf98563
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 87 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_integrations/device_tracker.markdown
View File

@ -17,10 +17,10 @@ The device tracker allows you to track devices in Home Assistant. This can happe
## Configuring a `device_tracker` platform
To get started add the following lines to your {% term "`configuration.yaml`" %} (example for Netgear):
To get started add the following lines to your {% term "`configuration.yaml`" %} (example for NETGEAR):
```yaml
# Example configuration.yaml entry for Netgear device
# Example configuration.yaml entry for NETGEAR device
device_tracker:
- platform: netgear
host: IP_ADDRESS
@ -50,7 +50,7 @@ Note that setting `track_new_devices: false` will still result in new devices be
In the {% term "`configuration.yaml`" %}, the extended example from above would look like the following sample:
```yaml
# Example configuration.yaml entry for Netgear device
# Example configuration.yaml entry for NETGEAR device
device_tracker:
- platform: netgear
host: IP_ADDRESS

4
source/_integrations/doorbird.markdown
View File

@ -32,7 +32,7 @@ There is currently support for the following device types within Home Assistant:
## Setup
It is recommended to set up a new & dedicated account on your DoorBird App/web portal for use with Home Assistant. The instructions in this document refer specifically to the DoorBird IOS/Android app. Still, most actions can also be performed using the web-based [DoorBird - WebAdmin](https://webadmin.doorbird.com) portal and logging in on your DoorBird admin account.
It is recommended to set up a new & dedicated account on your DoorBird App/web portal for use with Home Assistant. The instructions in this document refer specifically to the DoorBird iOS/Android app. Still, most actions can also be performed using the web-based [DoorBird - WebAdmin](https://webadmin.doorbird.com) portal and logging in on your DoorBird admin account.
To setup a new account for Home Assistant, open the DoorBird App by selecting **Settings** (cog icon) > **Administration** > **LOGIN** (using your DoorBird App Administration details). Under the **USER** section, choose **Add**. This new user account requires specific permissions enabled (depending on what functionality you want). Permissions can be found under **Permissions**. The following permissions are recommended (or amend depending on your requirements:
@ -84,7 +84,7 @@ The URLs on the event will be based on the configuration used to connect to your
Once events have been registered on the DoorBird device, they must be attached to a schedule using the official DoorBird app on Android or iOS or the [DoorBird - WebAdmin](https://webadmin.doorbird.com) portal. Currently, there are schedules available for doorbell, motion, relay, and RFID events (on supported DoorBird devices). Essentially, you can enable an HTTP(S) call from your DoorBird device to the Home Assistant DoorBird API by configuring an action/event (by enabling a schedule).
The schedules can be found by navigating to the following area of the DoorBird app (Android or IOS):
The schedules can be found by navigating to the following area of the DoorBird app (Android or iOS):
**Settings** (cog icon) > **Administration** > **LOGIN** (using your App Administration details) > (under **EXPERT SETTINGS**) Schedule for doorbell.

2
source/_integrations/itach.markdown
View File

@ -90,7 +90,7 @@ An example to call the integration from developer tools using the `remote.send_c
Note: Global Cache devices expect data in their own format of "sendir...". This integration converts hex code to Global Cache IR form.
API Docs:
API Documentation:
- [iTach](https://www.globalcache.com/files/docs/API-iTach.pdf)
- [GC-100](https://www.globalcache.com/files/docs/API-GC-100.pdf)

24
source/_integrations/kodi.markdown
View File

@ -71,22 +71,22 @@ automation:
Add music to the default playlist (i.e., playlistid=0).
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Name(s) of the Kodi entities where to add the media. |
| `media_type` | yes | Media type identifier. It must be one of SONG or ALBUM. |
| `media_id` | no | Unique Id of the media entry to add (`songid` or `albumid`). If not defined, `media_name` and `artist_name` are needed to search the Kodi music library. |
| `media_name` | no | Optional media name for filtering media. Can be 'ALL' when `media_type` is 'ALBUM' and `artist_name` is specified, to add all songs from one artist. |
| `artist_name` | no | Optional artist name for filtering media. |
| -------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Name(s) of the Kodi entities where to add the media. |
| `media_type` | yes | Media type identifier. It must be one of SONG or ALBUM. |
| `media_id` | no | Unique Id of the media entry to add (`songid` or `albumid`). If not defined, `media_name` and `artist_name` are needed to search the Kodi music library. |
| `media_name` | no | Optional media name for filtering media. Can be 'ALL' when `media_type` is 'ALBUM' and `artist_name` is specified, to add all songs from one artist. |
| `artist_name` | no | Optional artist name for filtering media. |
#### Action `kodi.call_method`
Call a [Kodi JSON-RPC API](https://kodi.wiki/?title=JSON-RPC_API) method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`.
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------- |
| `entity_id` | no | Name(s) of the Kodi entities where to run the API method. |
| `method` | yes | Name of the Kodi JSON-RPC API method to be called. |
| any other parameter | no | Optional parameters for the Kodi API call. |
| Data attribute | Optional | Description |
| ------------------- | -------- | --------------------------------------------------------- |
| `entity_id` | no | Name(s) of the Kodi entities where to run the API method. |
| `method` | yes | Name of the Kodi JSON-RPC API method to be called. |
| any other parameter | no | Optional parameters for the Kodi API call. |
### Event triggering
@ -392,7 +392,7 @@ key presses of keyboards/remotes can be overwritten in Kodi and configured to se
A keypress can be overwritten in Kodi by using the [Kodi keymap XML](https://kodi.wiki/view/Keymap) or from within the Kodi GUI using the [Keymap Editor add-on](https://kodi.wiki/view/Add-on:Keymap_Editor).
An example of the Kodi keymap configuration using XML, which will overwrite the volume_up/volume_down buttons and instead send an event to HomeAssistant:
An example of the Kodi keymap configuration using XML, which will overwrite the volume_up/volume_down buttons and instead send an event to Home Assistant:
```xml
<keymap>

38
source/_integrations/snmp.markdown
View File

@ -38,24 +38,24 @@ This device tracker needs SNMP to be enabled on the router. It could be that you
The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker integration page](/integrations/device_tracker/) than desirable. It is recommended to use [Ping](/integrations/ping) or [Nmap](/integrations/nmap_tracker) instead.
| Brand | Device/Firmware | OID |
| --- | --- | --- |
| Aerohive | AP230 | `1.3.6.1.4.1.26928.1.1.1.2.1.2.1.1` |
| Apple | Airport Express (2nd gen.) 7.6.9 | `1.3.6.1.2.1.3.1.1.2` or `1.3.6.1.2.1.4.22.1.2`|
| Aruba | IAP325 on AOS 6.5.4.8 | `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.1` |
| BiPAC | 7800DXL Firmware 2.32e | `1.3.6.1.2.1.17.7.1.2.2.1.1` |
| DD-WRT | unknown version/model | `1.3.6.1.2.1.4.22.1.2` |
| IPFire | 2.25 | `1.3.6.1.2.1.4.22.1.2` |
| MikroTik | unknown RouterOS version/model | `1.3.6.1.4.1.14988.1.1.1.2.1.1` |
| MikroTik | RouterOS 6.x on RB2011 | `1.3.6.1.2.1.4.22.1.2` |
| OpenWrt | Chaos Calmer 15.05 | `1.3.6.1.2.1.4.22.1.2` |
| OPNSense | 19.1 | `1.3.6.1.2.1.4.22.1.2` |
| pfSense | 2.2.4 | `1.3.6.1.2.1.4.22.1.2` |
| Ruckus | ZoneDirector 9.13.3 | `1.3.6.1.4.1.25053.1.2.2.1.1.3.1.1.1.6` |
| TP-Link | Archer VR1600v | `1.3.6.1.2.1.3.1.1.2.16.1` |
| TP-Link | Archer VR2600v | `1.3.6.1.2.1.3.1.1.2.19.1` |
| TP-Link | Archer VR600 | `1.3.6.1.2.1.3.1.1.2` |
| Ubiquiti | Edgerouter Lite v1.9.0 | `1.3.6.1.2.1.4.22.1.2` |
| Brand | Device/Firmware | OID |
| -------- | -------------------------------- | ----------------------------------------------- |
| Aerohive | AP230 | `1.3.6.1.4.1.26928.1.1.1.2.1.2.1.1` |
| Apple | Airport Express (2nd gen.) 7.6.9 | `1.3.6.1.2.1.3.1.1.2` or `1.3.6.1.2.1.4.22.1.2` |
| Aruba | IAP325 on AOS 6.5.4.8 | `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.1` |
| BiPAC | 7800DXL Firmware 2.32e | `1.3.6.1.2.1.17.7.1.2.2.1.1` |
| DD-WRT | unknown version/model | `1.3.6.1.2.1.4.22.1.2` |
| IPFire | 2.25 | `1.3.6.1.2.1.4.22.1.2` |
| MikroTik | unknown RouterOS version/model | `1.3.6.1.4.1.14988.1.1.1.2.1.1` |
| MikroTik | RouterOS 6.x on RB2011 | `1.3.6.1.2.1.4.22.1.2` |
| OpenWrt | Chaos Calmer 15.05 | `1.3.6.1.2.1.4.22.1.2` |
| OPNSense | 19.1 | `1.3.6.1.2.1.4.22.1.2` |
| pfSense | 2.2.4 | `1.3.6.1.2.1.4.22.1.2` |
| Ruckus | ZoneDirector 9.13.3 | `1.3.6.1.4.1.25053.1.2.2.1.1.3.1.1.1.6` |
| TP-Link | Archer VR1600v | `1.3.6.1.2.1.3.1.1.2.16.1` |
| TP-Link | Archer VR2600v | `1.3.6.1.2.1.3.1.1.2.19.1` |
| TP-Link | Archer VR600 | `1.3.6.1.2.1.3.1.1.2` |
| Ubiquiti | Edgerouter Lite v1.9.0 | `1.3.6.1.2.1.4.22.1.2` |
To use the SNMP version 1 or 2c platform in your installation, add the following to your `configuration.yaml` file:
@ -434,7 +434,7 @@ switch:
payload_off: 0
- platform: snmp
name: Enable PoE on Netgear switch port 2 using SNMP v3
name: Enable PoE on NETGEAR switch port 2 using SNMP v3
host: 192.168.0.4
version: "3"
username: "myusername"

100
source/_integrations/xiaomi_miio.markdown
View File

@ -136,7 +136,7 @@ Not yet implemented features (but possible):
### Supported subdevices
These subdevices are fully implemented in HomeAssistant:
These subdevices are fully implemented in Home Assistant:
- **Weather sensor (WSDCGQ01LM)**
- Zigbee ID: `lumi.sensor_ht`
@ -1205,53 +1205,53 @@ Clean mode and Motor speed can only be set when the device is turned on.
Set the target humidity.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
| `humidity` | no | Target humidity |
| -------------- | -------- | ----------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
| `humidity` | no | Target humidity |
### Action `humidifier.set_mode`
Set the humidifier operation mode.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
| `mode` | no | The Xiaomi miIO operation mode |
| -------------- | -------- | ----------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
| `mode` | no | The Xiaomi miIO operation mode |
### Action `fan.set_percentage`
Set the fan speed percentage.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `percentage` | no | Fan speed. Percentage speed setting |
| -------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `percentage` | no | Fan speed. Percentage speed setting |
### Action `fan.set_preset_mode`
Set the fan operation mode.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `preset_mode` | no | The Xiaomi miIO operation mode |
| -------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `preset_mode` | no | The Xiaomi miIO operation mode |
### Action `xiaomi_miio.fan_reset_filter` (Air Purifier 2 only)
Reset the filter lifetime and usage.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| -------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
### Action `xiaomi_miio.fan_set_extra_features` (Air Purifier only)
Set the extra features.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `features` | no | Integer, known values are 0 and 1. |
| -------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
| `features` | no | Integer, known values are 0 and 1. |
## Xiaomi Air Quality Monitor
@ -1654,16 +1654,16 @@ Note: If your vacuum is in motion and does not respond to the `xiaomi_miio.vacuu
Start the remote control mode of the robot. You can then move it with `remote_control_move`; when done, call `remote_control_stop`.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------- |
| `entity_id` | no | Only act on a specific robot |
| -------------- | -------- | ---------------------------- |
| `entity_id` | no | Only act on a specific robot |
### Action `xiaomi_miio.vacuum_remote_control_stop`
Exit the remote control mode of the robot.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------- |
| `entity_id` | no | Only act on a specific robot |
| -------------- | -------- | ---------------------------- |
| `entity_id` | no | Only act on a specific robot |
### Action `xiaomi_miio.vacuuNm_remote_control_move`
@ -1923,66 +1923,66 @@ Supported models: `philips.light.moonlight`
Set one of the 4 available fixed scenes.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `scene` | no | Scene, between 1 and 4. |
| -------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `scene` | no | Scene, between 1 and 4. |
### Action `xiaomi_miio.light_set_delayed_turn_off`
Delayed turn off.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `time_period` | no | Time period for the delayed turn off. |
| -------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| `time_period` | no | Time period for the delayed turn off. |
### Action `xiaomi_miio.light_reminder_on` (Eyecare Smart Lamp 2 only)
Enable the eye fatigue reminder/notification.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| -------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
### Action `xiaomi_miio.light_reminder_off` (Eyecare Smart Lamp 2 only)
Disable the eye fatigue reminder/notification.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| -------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
### Action `xiaomi_miio.light_night_light_mode_on` (Eyecare Smart Lamp 2 only)
Turn the smart night light mode on.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| -------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
### Action `xiaomi_miio.light_night_light_mode_off` (Eyecare Smart Lamp 2 only)
Turn the smart night light mode off.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| -------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
### Action `xiaomi_miio.light_eyecare_mode_on` (Eyecare Smart Lamp 2 only)
Turn the eyecare mode on.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| -------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
### Action `xiaomi_miio.light_eyecare_mode_off` (Eyecare Smart Lamp 2 only)
Turn the eyecare mode off.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
| -------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
## Xiaomi Smart WiFi Socket and Smart Power Strip
@ -2037,34 +2037,34 @@ Supported models: `lumi.acpartner.v3` (the socket of the `acpartner.v1` and `v2`
Turn the wifi LED on.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
| -------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
### Action `xiaomi_miio.switch_set_wifi_led_off` (Power Strip only)
Turn the wifi LED off.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
| -------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
### Action `xiaomi_miio.switch_set_power_price` (Power Strip)
Set the power price.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
| `price` | no | Power price, between 0 and 999. |
| -------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
| `price` | no | Power price, between 0 and 999. |
### Action `xiaomi_miio.switch_set_power_mode` (Power Strip V1 only)
Set the power mode.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
| `mode` | no | Power mode, valid values are 'normal' and 'green' |
| -------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
| `mode` | no | Power mode, valid values are 'normal' and 'green' |
## Retrieving the Access Token