mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-04-19 10:57:33 +00:00
Enforce Markdown headers are incremental (#28158)
This commit is contained in:
parent
ce2fd10c6d
commit
e4e0f96aa3
@ -3,6 +3,7 @@ _source/developers/credits.markdown
|
||||
|
||||
# Third party
|
||||
sass/inuitcss/*
|
||||
LICENSE.md
|
||||
|
||||
# Changelogs are made out of commit messages
|
||||
# We don't want to correct them
|
||||
|
@ -12,6 +12,7 @@ var remarkrc = {
|
||||
["frontmatter"],
|
||||
["lint-fenced-code-flag"],
|
||||
["lint-no-shell-dollars"],
|
||||
["remark-lint-heading-increment"],
|
||||
["remark-lint-heading-style", "atx"],
|
||||
[
|
||||
"remark-lint-prohibited-strings",
|
||||
|
18
package-lock.json
generated
18
package-lock.json
generated
@ -12,6 +12,7 @@
|
||||
"remark-frontmatter": "^4.0.1",
|
||||
"remark-lint": "^9.1.2",
|
||||
"remark-lint-fenced-code-flag": "^3.1.2",
|
||||
"remark-lint-heading-increment": "^3.1.2",
|
||||
"remark-lint-heading-style": "^3.1.2",
|
||||
"remark-lint-no-shell-dollars": "^3.1.2",
|
||||
"remark-lint-prohibited-strings": "^3.1.0",
|
||||
@ -3536,6 +3537,23 @@
|
||||
"url": "https://opencollective.com/unified"
|
||||
}
|
||||
},
|
||||
"node_modules/remark-lint-heading-increment": {
|
||||
"version": "3.1.2",
|
||||
"resolved": "https://registry.npmjs.org/remark-lint-heading-increment/-/remark-lint-heading-increment-3.1.2.tgz",
|
||||
"integrity": "sha512-+fMfZmFh6ie6MmbRCVW77Rha15zDmnHWKiA0Do08OTrfngPTv8ZKXYLmxhUpL+xV9ts9q+9Kz5rv0L4QD4sEwQ==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@types/mdast": "^3.0.0",
|
||||
"unified": "^10.0.0",
|
||||
"unified-lint-rule": "^2.0.0",
|
||||
"unist-util-generated": "^2.0.0",
|
||||
"unist-util-visit": "^4.0.0"
|
||||
},
|
||||
"funding": {
|
||||
"type": "opencollective",
|
||||
"url": "https://opencollective.com/unified"
|
||||
}
|
||||
},
|
||||
"node_modules/remark-lint-heading-style": {
|
||||
"version": "3.1.2",
|
||||
"resolved": "https://registry.npmjs.org/remark-lint-heading-style/-/remark-lint-heading-style-3.1.2.tgz",
|
||||
|
@ -7,6 +7,7 @@
|
||||
"remark-frontmatter": "^4.0.1",
|
||||
"remark-lint": "^9.1.2",
|
||||
"remark-lint-fenced-code-flag": "^3.1.2",
|
||||
"remark-lint-heading-increment": "^3.1.2",
|
||||
"remark-lint-heading-style": "^3.1.2",
|
||||
"remark-lint-no-shell-dollars": "^3.1.2",
|
||||
"remark-lint-prohibited-strings": "^3.1.0",
|
||||
|
@ -18,7 +18,7 @@ At the moment there are no configuration options available for these cards, you
|
||||
|
||||
This card will allow you to pick what data to show. Changing it in this card will influence the data in all other cards.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
```yaml
|
||||
type: energy-date-selection
|
||||
```
|
||||
@ -33,7 +33,7 @@ type: energy-date-selection
|
||||
The energy usage graph card shows the amount of energy your house has consumed, and from what source this energy came.
|
||||
It will also show the amount of energy your have returned to the grid.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
```yaml
|
||||
type: energy-usage-graph
|
||||
```
|
||||
@ -47,7 +47,7 @@ type: energy-usage-graph
|
||||
|
||||
The solar production graph card shows the amount of energy your solar panels have produced per source, and if setup and available the forecast of the solar production.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
```yaml
|
||||
type: energy-solar-graph
|
||||
```
|
||||
@ -61,7 +61,7 @@ type: energy-solar-graph
|
||||
|
||||
The gas consumption graph card shows the amount of gas consumed per source.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
type: energy-gas-graph
|
||||
@ -76,7 +76,7 @@ type: energy-gas-graph
|
||||
|
||||
The water consumption graph card shows the amount of water consumed per source.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
type: energy-water-graph
|
||||
@ -95,7 +95,7 @@ If setup, it will also tell you how many kWh of the energy you got from the grid
|
||||
|
||||
If you set `link_dashboard` to `true`, the card will include a link to the energy dashboard.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
```yaml
|
||||
type: energy-distribution
|
||||
link_dashboard: true
|
||||
@ -111,7 +111,7 @@ link_dashboard: true
|
||||
The energy sources table card shows all your energy sources, and the corresponding amount of energy.
|
||||
If setup, it will also show the costs and compensation per source and the total.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
```yaml
|
||||
type: energy-sources-table
|
||||
```
|
||||
@ -125,7 +125,7 @@ type: energy-sources-table
|
||||
|
||||
The grid neutrality gauge card represents your energy dependency. If the needle is in the purple, you returned more energy to the grid than you consumed from it. If it's in the blue, you consumed more energy from the grid than you returned.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
```yaml
|
||||
type: energy-grid-neutrality-gauge
|
||||
```
|
||||
@ -139,7 +139,7 @@ type: energy-grid-neutrality-gauge
|
||||
|
||||
The solar consumed gauge represents how much of the solar energy was used by your home and was not returned to the grid. If you frequently return a lot, try to conserve this energy by installing a battery or buying an electric car to charge.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
```yaml
|
||||
type: energy-solar-consumed-gauge
|
||||
```
|
||||
@ -153,7 +153,7 @@ type: energy-solar-consumed-gauge
|
||||
|
||||
The carbon consumed gauge card represents how much of the energy consumed by your home was generated using non-fossil fuels like solar, wind and nuclear. It includes the solar energy you generated your self.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
```yaml
|
||||
type: energy-carbon-consumed-gauge
|
||||
```
|
||||
@ -167,7 +167,7 @@ type: energy-carbon-consumed-gauge
|
||||
|
||||
The self-sufficiency gauge represents how self-sufficient your home is. If you rely on grid imports, this value decreases. You can increase this value by adding more solar capacity or battery storage.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
```yaml
|
||||
type: energy-self-sufficiency-gauge
|
||||
```
|
||||
@ -181,7 +181,7 @@ type: energy-self-sufficiency-gauge
|
||||
|
||||
The devices energy graph show the energy usage per device, it is sorted by usage.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
```yaml
|
||||
type: energy-devices-graph
|
||||
```
|
||||
|
@ -25,7 +25,7 @@ type:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
Alternatively, the position of the card can be configured using YAML with the `view_layout` option:
|
||||
|
||||
|
@ -20,7 +20,7 @@ If your entity is not supported, or you cannot customize what you need via this
|
||||
|
||||
By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities.
|
||||
|
||||
#### Possible values
|
||||
### Possible values
|
||||
|
||||
{% configuration customize %}
|
||||
friendly_name:
|
||||
@ -57,7 +57,7 @@ initial_state:
|
||||
default: None
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Device Class
|
||||
### Device Class
|
||||
|
||||
Device class is currently supported by the following platforms:
|
||||
|
||||
|
@ -4,7 +4,7 @@ Home Assistant can be flashed to an ODROID-N2+ by connecting the device directly
|
||||
|
||||
_All these instructions work the same for the ODROID-N2 (non-plus version)._
|
||||
|
||||
#### What you will need
|
||||
### What you will need
|
||||
|
||||
To flash your eMMC using Petitboot and OTG-USB, you will need the following items:
|
||||
|
||||
@ -13,7 +13,7 @@ To flash your eMMC using Petitboot and OTG-USB, you will need the following item
|
||||
- USB 2.0 to micro-USB cable
|
||||
- If your board came in a Home Assistant Blue: No.2 hex key to open the case
|
||||
|
||||
#### Enabling SPI boot mode
|
||||
### Enabling SPI boot mode
|
||||
|
||||
To enable the SPI boot mode:
|
||||
|
||||
@ -30,7 +30,7 @@ To enable the SPI boot mode:
|
||||
1. Connect a USB keyboard and a monitor (using HDMI) to your ODROID-N2+.
|
||||
1. Plug in the power cable to power on the ODROID-N2+.
|
||||
|
||||
#### Enabling USB drive mode
|
||||
### Enabling USB drive mode
|
||||
|
||||
After The ODROID-N2+ is set to SPI boot mode and powered on, it boots into a terminal. To enable the USB drive mode:
|
||||
|
||||
@ -59,7 +59,7 @@ This will configure the ODROID-N2+ and OTG to act as a memory card reader:
|
||||
ums /dev/mmcblk0
|
||||
```
|
||||
|
||||
#### Flashing Home Assistant
|
||||
### Flashing Home Assistant
|
||||
|
||||
1. Connect the ODROID-N2+ to your PC via the micro-USB port at the front of the ODROID-N2+.
|
||||
1. When the ODROID-N2 is recognized as a USB connected storage device, you can flash the eMMC with [Etcher](https://www.balena.io/etcher/).
|
||||
|
@ -51,7 +51,7 @@ For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo >
|
||||
|
||||
When configured, the platform will create three sensors for each air quality standard:
|
||||
|
||||
#### Air Quality Index
|
||||
### Air Quality Index
|
||||
|
||||
- **Description:** This sensor displays a numeric air quality index (AQI), a metric for the overall "health" of the air.
|
||||
- **Example Sensor Name:** `sensor.chinese_air_quality_index`
|
||||
@ -67,13 +67,13 @@ AQI | Status | Description
|
||||
201 - 300 | **Very unhealthy** | Health warnings of emergency conditions. The entire population is more likely to be affected
|
||||
301+ | **Hazardous** | Health alert: everyone may experience more serious health effects
|
||||
|
||||
#### Air Pollution Level
|
||||
### Air Pollution Level
|
||||
|
||||
- **Description:** This sensor displays the associated `Status` (from the above table) for the current AQI.
|
||||
- **Sample Sensor Name:** `sensor.us_air_pollution_level`
|
||||
- **Example Sensor Value:** `Moderate`
|
||||
|
||||
#### Main Pollutant
|
||||
### Main Pollutant
|
||||
|
||||
- **Description:** This sensor displays the pollutant whose value is currently highest.
|
||||
- **Sample Sensor Name:** `sensor.us_main_pollutant`
|
||||
|
@ -200,7 +200,7 @@ Available services:
|
||||
`start_tour`, `stop_tour`, and
|
||||
`ptz_control`
|
||||
|
||||
#### Service `enable_audio`/`disable_audio`
|
||||
### Service `enable_audio`/`disable_audio`
|
||||
|
||||
These services enable or disable the camera's audio stream.
|
||||
|
||||
@ -208,7 +208,7 @@ Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
|
||||
|
||||
#### Service `enable_motion_recording`/`disable_motion_recording`
|
||||
### Service `enable_motion_recording`/`disable_motion_recording`
|
||||
|
||||
These services enable or disable the camera to record a clip to its configured storage location when motion is detected.
|
||||
|
||||
@ -216,7 +216,7 @@ Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
|
||||
|
||||
#### Service `enable_recording`/`disable_recording`
|
||||
### Service `enable_recording`/`disable_recording`
|
||||
|
||||
These services enable or disable the camera to continuously record to its configured storage location.
|
||||
|
||||
@ -224,7 +224,7 @@ Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
|
||||
|
||||
#### Service `goto_preset`
|
||||
### Service `goto_preset`
|
||||
|
||||
This service will cause the camera to move to one of the PTZ locations configured within the camera.
|
||||
|
||||
@ -233,7 +233,7 @@ Service data attribute | Optional | Description
|
||||
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
|
||||
`preset` | no | Preset number, starting from 1.
|
||||
|
||||
#### Service `set_color_bw`
|
||||
### Service `set_color_bw`
|
||||
|
||||
This service will set the color mode of the camera.
|
||||
|
||||
@ -242,7 +242,7 @@ Service data attribute | Optional | Description
|
||||
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
|
||||
`color_bw` | no | One of `auto`, `bw` or `color`.
|
||||
|
||||
#### Service `start_tour`/`stop_tour`
|
||||
### Service `start_tour`/`stop_tour`
|
||||
|
||||
These services start or stop the camera's PTZ tour function.
|
||||
|
||||
@ -250,7 +250,7 @@ Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
|
||||
|
||||
#### Service `ptz_control`
|
||||
### Service `ptz_control`
|
||||
|
||||
If your Amcrest or Dahua camera supports PTZ, you will be able to pan, tilt or zoom your camera.
|
||||
|
||||
@ -260,12 +260,12 @@ Service data attribute | Optional | Description
|
||||
`movement` | no | Direction of the movement. Allowed values: `zoom_in`, `zoom_out`, `up`, `down`, `left`, `right`, `right_up`, `right_down`, `left_up`, `left_down`
|
||||
`travel_time` | yes |Travel time in fractional seconds. Allowed values: `0` to `1`. Default: `0.2`.
|
||||
|
||||
#### Notes
|
||||
## Notes
|
||||
|
||||
- PTZ zoom capability does not control VariFocal lens adjustments.
|
||||
- There can be several seconds of lag before the video (snapshot or live) reflects the camera movement.
|
||||
|
||||
### Example card with controls
|
||||
## Example card with controls
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/integrations/amcrest/amcrest_ptz.jpg' alt='Screenshot using a picture-elements with PTZ controls.'>
|
||||
|
@ -54,7 +54,7 @@ See [Automation Example](#automation-example) section below for details on how t
|
||||
Events will not be received in Home Assistant until a schedule is defined via the DoorBird app.
|
||||
</div>
|
||||
|
||||
#### Clearing Registered Events
|
||||
### Clearing Registered Events
|
||||
Events can be cleared from DoorBird devices by visiting a special URL.
|
||||
|
||||
Simply open a new browser window and navigate to `{Home Assistant URL}/api/doorbird/clear?token={DEVICE_TOKEN}`. Replace `{Home Assistant URL}` with the full path to your running instance, such as `
|
||||
@ -64,7 +64,7 @@ Please note that clearing device events will require configuration steps above t
|
||||
<br><br>
|
||||
If DoorBird was setup using UI prompts, a token can be discovered through DoorBird App by clicking settings (cog icon) -> Administration-> LOGIN (using your App Administration details). Under the "FAVORITES" section, choose "HTTP(S) Calls". This displays all events and the associated HTTP URL. In that URL field, you will be able to see the token that was auto-generated by Home Assistant.
|
||||
|
||||
#### Event Data
|
||||
### Event Data
|
||||
|
||||
Each event will include live image and video URLs for the DoorBird device that triggered the event. These URLs can be found on the event data and are helpful in automation actions. For example, you could use `html5_viewer_url` on a notification to be linked directly to the live view of the device that triggered the automation.
|
||||
|
||||
@ -80,7 +80,7 @@ The following keys are available on `event_data`:
|
||||
The URLs on the event will be based on the configuration used to connect to your DoorBird device. The ability to connect from outside your network will depend on your configuration.
|
||||
</div>
|
||||
|
||||
#### Schedules
|
||||
## Schedules
|
||||
|
||||
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).
|
||||
|
||||
@ -98,7 +98,7 @@ On the desired event, you should be able to specify blocks of time for when you
|
||||
|
||||
Note: Remember to complete the schedule assignment steps above for each event type you registered. If you are configuring HTTP Call(s) schedules for registered RFID tags, please note that you will have to enable/configure the schedule for each RFID tag.
|
||||
|
||||
### Automation Example
|
||||
## Automation Example
|
||||
|
||||
The example automation below shows how to turn on a light when somebody presses the DoorBird call button:
|
||||
|
||||
|
@ -58,7 +58,7 @@ manual:
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Time period dictionary example
|
||||
### Time period dictionary example
|
||||
|
||||
```yaml
|
||||
scan_interval:
|
||||
@ -70,7 +70,7 @@ scan_interval:
|
||||
milliseconds: 0
|
||||
```
|
||||
|
||||
### Service
|
||||
## Service
|
||||
|
||||
Once loaded, the `fastdotcom` integration will expose a service (`fastdotcom.speedtest`) that can be called to run a Fast.com speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode.
|
||||
|
||||
|
@ -64,7 +64,7 @@ Start an activity. Will start the default `activity` from `configuration.yaml` i
|
||||
| `entity_id` | no | Entity ID to target.
|
||||
| `activity` | yes | Activity ID or Activity Name to start.
|
||||
|
||||
##### Example
|
||||
#### Example
|
||||
|
||||
In the file 'harmony_REMOTENAME.conf' you can find the available activities, for example:
|
||||
|
||||
|
@ -89,7 +89,7 @@ Configuration variables (host):
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Time period dictionary example
|
||||
### Time period dictionary example
|
||||
|
||||
```yaml
|
||||
scan_interval:
|
||||
@ -109,7 +109,7 @@ Parallel streams can help in some situations. As TCP attempts to be fair and con
|
||||
|
||||
You can use the service `sensor.iperf3_update` to trigger a manual speed test for all sensors. Iperf3 has its own service call that allow to perform a speed test on a particular entity.
|
||||
|
||||
### Service
|
||||
## Service
|
||||
|
||||
Once loaded, the `iperf3` integration will expose a service (`iperf3.speedtest`) that can be called to run a speed test on demand. This can be useful if you have enabled manual mode.
|
||||
|
||||
|
@ -189,7 +189,7 @@ Visit the [library API][MySensors library api] of MySensors for more information
|
||||
|
||||
The following binary sensor types are supported:
|
||||
|
||||
#### MySensors version 1.4 and higher
|
||||
### MySensors version 1.4 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| -------- | --------- |
|
||||
@ -197,7 +197,7 @@ The following binary sensor types are supported:
|
||||
| S_MOTION | V_TRIPPED |
|
||||
| S_SMOKE | V_TRIPPED |
|
||||
|
||||
#### MySensors version 1.5 and higher
|
||||
### MySensors version 1.5 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------------ | --------- |
|
||||
@ -207,7 +207,7 @@ The following binary sensor types are supported:
|
||||
| S_VIBRATION | V_TRIPPED |
|
||||
| S_MOISTURE | V_TRIPPED |
|
||||
|
||||
#### Binary Sensor example sketch
|
||||
### Binary Sensor example sketch
|
||||
|
||||
```cpp
|
||||
/**
|
||||
@ -259,7 +259,7 @@ void loop()
|
||||
|
||||
The following actuator types are supported:
|
||||
|
||||
#### MySensors version 1.5 and higher
|
||||
### MySensors version 1.5 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------ | ------------------------------------------------------------------------------------ |
|
||||
@ -282,7 +282,7 @@ You can use V_HVAC_SPEED to control the Speed setting of the Fan in the HVAC.
|
||||
|
||||
You can use V_TEMP to send the current temperature from the node to Home Assistant.
|
||||
|
||||
#### Climate example sketch for MySensors 2.x
|
||||
### Climate example sketch for MySensors 2.x
|
||||
|
||||
```cpp
|
||||
/*
|
||||
@ -462,13 +462,13 @@ void sendHeatpumpCommand() {
|
||||
|
||||
The following actuator types are supported:
|
||||
|
||||
#### MySensors version 1.4
|
||||
### MySensors version 1.4
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------- | ------------------------------------------- |
|
||||
| S_COVER | V_UP, V_DOWN, V_STOP, [V_DIMMER or V_LIGHT] |
|
||||
|
||||
#### MySensors version 1.5 and higher
|
||||
### MySensors version 1.5 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------- | ------------------------------------------------ |
|
||||
@ -476,7 +476,7 @@ The following actuator types are supported:
|
||||
|
||||
All V_TYPES above are required. Use V_PERCENTAGE (or V_DIMMER) if you know the exact position of the cover in percent, use V_STATUS (or V_LIGHT) if you don't.
|
||||
|
||||
#### Cover example sketch
|
||||
### Cover example sketch
|
||||
|
||||
```cpp
|
||||
/*
|
||||
@ -608,13 +608,13 @@ This sketch is ideally for star topology wiring. You can run up to 12 covers wit
|
||||
|
||||
The following sensor types are supported:
|
||||
|
||||
#### MySensors version 2.0 and higher
|
||||
### MySensors version 2.0 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------ | ---------- |
|
||||
| S_GPS | V_POSITION |
|
||||
|
||||
#### Device Tracker example sketch for MySensors 2.x
|
||||
### Device Tracker example sketch for MySensors 2.x
|
||||
|
||||
```cpp
|
||||
/**
|
||||
@ -691,13 +691,13 @@ void loop()
|
||||
|
||||
The following actuator types are supported:
|
||||
|
||||
#### MySensors version 1.4
|
||||
### MySensors version 1.4
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| -------- | --------------------- |
|
||||
| S_DIMMER | V_DIMMER\*, V_LIGHT\* |
|
||||
|
||||
#### MySensors version 1.5 and higher
|
||||
### MySensors version 1.5 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------------ | -------------------------------------------------------------- |
|
||||
@ -844,21 +844,21 @@ void send_status_message()
|
||||
|
||||
The following type combinations are supported:
|
||||
|
||||
#### MySensors version 1.4 and higher
|
||||
### MySensors version 1.4 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| -------- | ------------------ |
|
||||
| S_IR | V_IR_SEND, V_LIGHT |
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------ | ------------------ |
|
||||
| S_IR | V_IR_SEND, V_LIGHT |
|
||||
|
||||
#### MySensors version 1.5 and higher
|
||||
### MySensors version 1.5 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------------ | --------------------- |
|
||||
| S_IR | V_IR_SEND, V_STATUS |
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------ | ------------------- |
|
||||
| S_IR | V_IR_SEND, V_STATUS |
|
||||
|
||||
V_LIGHT or V_STATUS is required to report the on / off state of the remote. Use either V_LIGHT or V_STATUS depending on library version.
|
||||
|
||||
#### IR transceiver example sketch
|
||||
### IR transceiver example sketch
|
||||
|
||||
```cpp
|
||||
/*
|
||||
@ -934,7 +934,7 @@ void incomingMessage(const MyMessage &message) {
|
||||
|
||||
The following sensor types are supported:
|
||||
|
||||
#### MySensors version 1.4 and higher
|
||||
### MySensors version 1.4 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------------------ | -------------------------------------- |
|
||||
@ -968,7 +968,7 @@ The following sensor types are supported:
|
||||
| S_AIR_QUALITY | V_LEVEL (replaces V_DUST_LEVEL) |
|
||||
| S_DUST | V_LEVEL (replaces V_DUST_LEVEL) |
|
||||
|
||||
#### MySensors version 2.0 and higher
|
||||
### MySensors version 2.0 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| --------------- | ------------------------- |
|
||||
@ -984,7 +984,7 @@ Some sensor value types are not specific for a certain sensor type. These do not
|
||||
|
||||
By using V_UNIT_PREFIX, it's possible to set a custom unit for any sensor. The string value that is sent for V_UNIT_PREFIX will be used in preference to any other unit of measurement, for the defined sensors. V_UNIT_PREFIX can't be used as a stand-alone sensor value type. Sending a supported value type and value from the tables above is also required. V_UNIT_PREFIX is available with MySensors version 1.5 and later.
|
||||
|
||||
#### Sensor example sketch for MySensors 2.x
|
||||
### Sensor example sketch for MySensors 2.x
|
||||
|
||||
```cpp
|
||||
/**
|
||||
@ -1053,17 +1053,17 @@ void receive(const MyMessage &message) {
|
||||
|
||||
The following actuator types are supported:
|
||||
|
||||
#### MySensors version 1.4 and higher
|
||||
### MySensors version 1.4 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| -------- | ------------------ |
|
||||
| S_DOOR | V_ARMED |
|
||||
| S_MOTION | V_ARMED |
|
||||
| S_SMOKE | V_ARMED |
|
||||
| S_LIGHT | V_LIGHT |
|
||||
| S_LOCK | V_LOCK_STATUS |
|
||||
| S_TYPE | V_TYPE |
|
||||
| -------- | ------------- |
|
||||
| S_DOOR | V_ARMED |
|
||||
| S_MOTION | V_ARMED |
|
||||
| S_SMOKE | V_ARMED |
|
||||
| S_LIGHT | V_LIGHT |
|
||||
| S_LOCK | V_LOCK_STATUS |
|
||||
|
||||
#### MySensors version 1.5 and higher
|
||||
### MySensors version 1.5 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------------ | --------------------- |
|
||||
@ -1075,7 +1075,7 @@ The following actuator types are supported:
|
||||
| S_VIBRATION | V_ARMED |
|
||||
| S_MOISTURE | V_ARMED |
|
||||
|
||||
#### MySensors version 2.0 and higher
|
||||
### MySensors version 2.0 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| --------------- | -------- |
|
||||
@ -1083,7 +1083,7 @@ The following actuator types are supported:
|
||||
|
||||
All V_TYPES for each S_TYPE above are required to activate the actuator for the platform. Use either V_LIGHT or V_STATUS depending on library version for cases where that V_TYPE is required.
|
||||
|
||||
#### Switch example sketch
|
||||
### Switch example sketch
|
||||
|
||||
```cpp
|
||||
/*
|
||||
@ -1133,13 +1133,13 @@ void incomingMessage(const MyMessage &message)
|
||||
|
||||
The following sensor types are supported:
|
||||
|
||||
#### MySensors version 2.0 and higher
|
||||
### MySensors version 2.0 and higher
|
||||
|
||||
| S_TYPE | V_TYPE |
|
||||
| ------ | ------ |
|
||||
| S_INFO | V_TEXT |
|
||||
|
||||
#### Text example sketch
|
||||
### Text example sketch
|
||||
|
||||
```cpp
|
||||
/*
|
||||
|
@ -86,7 +86,7 @@ zones:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Time period dictionary example
|
||||
### Time period dictionary example
|
||||
|
||||
```yaml
|
||||
scan_interval:
|
||||
|
@ -344,7 +344,7 @@ To play Plex music directly to Sonos speakers, the following requirements must b
|
||||
|
||||
Call the `media_player.play_media` service with the `entity_id` of a Sonos integration device and `media_content_type` prepended with `plex://`. Both [music](#music) and [playlist](#playlist) `media_content_type` values are supported.
|
||||
|
||||
##### Examples:
|
||||
### Examples:
|
||||
|
||||
Play a track with advanced filtering on a Sonos Speaker
|
||||
|
||||
|
@ -29,15 +29,15 @@ This integration uses Roon Core, a Roon application that runs on a machine on yo
|
||||
|
||||
## Services
|
||||
|
||||
#### Service `media_player.play_media`
|
||||
### Service `media_player.play_media`
|
||||
|
||||
Roon uses a path based on the roon browser hierarchy to specify which media to play. You can find this by using the media browser, or by following the examples below. If roon can't follow the path you will find an error in the log that will show which part of the path roon could not follow, and the possibilities at that point.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
|
||||
| `media_content_id` | no | A path to specify the media you want to play, see examples below. |
|
||||
| `media_content_type` | no | Only `music` is supported |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
|
||||
| `media_content_id` | no | A path to specify the media you want to play, see examples below. |
|
||||
| `media_content_type` | no | Only `music` is supported |
|
||||
|
||||
For example to play the album Harvest by Neil Young you should set `media_content_id` to `Library/Artists/Neil Young/Harvest` and to play BBC Radio 4 you would set `media_content_id` to `My Live Radio/BBC Radio 4`
|
||||
|
||||
@ -45,7 +45,7 @@ Roon uses a path based on the roon browser hierarchy to specify which media to p
|
||||
|
||||
Transfer playback from one player to another.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | id of the source player.
|
||||
| `transfer_id` | no | id of the destination player.
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------- |
|
||||
| `entity_id` | yes | id of the source player. |
|
||||
| `transfer_id` | no | id of the destination player. |
|
||||
|
@ -19,69 +19,69 @@ Available services: `start`, `pause`, `stop`, `return_to_base`, `locate`, `clean
|
||||
|
||||
Before calling one of these services, make sure your vacuum platform supports it.
|
||||
|
||||
#### Service `vacuum.start`
|
||||
### Service `vacuum.start`
|
||||
|
||||
Start or resume a cleaning task.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
|
||||
#### Service `vacuum.pause`
|
||||
### Service `vacuum.pause`
|
||||
|
||||
Pause a cleaning task.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
|
||||
#### Service `vacuum.stop`
|
||||
### Service `vacuum.stop`
|
||||
|
||||
Stop the current activity of the vacuum.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
|
||||
#### Service `vacuum.return_to_base`
|
||||
### Service `vacuum.return_to_base`
|
||||
|
||||
Tell the vacuum to return home.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
|
||||
#### Service `vacuum.locate`
|
||||
### Service `vacuum.locate`
|
||||
|
||||
Locate the vacuum cleaner robot.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
|
||||
#### Service `vacuum.clean_spot`
|
||||
### Service `vacuum.clean_spot`
|
||||
|
||||
Tell the vacuum cleaner to do a spot clean-up.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
|
||||
#### Service `vacuum.set_fan_speed`
|
||||
### Service `vacuum.set_fan_speed`
|
||||
|
||||
Set the fan speed of the vacuum. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number; it depends on the `vacuum` platform.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
| `fan_speed` | no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
| `fan_speed` | no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. |
|
||||
|
||||
#### Service `vacuum.send_command`
|
||||
### Service `vacuum.send_command`
|
||||
|
||||
Send a platform-specific command to the vacuum cleaner.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
| `command` | no | Command to execute. |
|
||||
| `params` | yes | Parameters for the command. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
|
||||
| `command` | no | Command to execute. |
|
||||
| `params` | yes | Parameters for the command. |
|
||||
|
@ -154,13 +154,13 @@ a new pop-up asking for a radio type. In the pop-up:
|
||||
|
||||
- Radio Type
|
||||
|
||||
| Radio Type | Zigbee Radio Hardware |
|
||||
| ------------- | ------------- |
|
||||
| `ezsp` | Silicon Labs EmberZNet protocol (e.g., Home Assistant SkyConnect, Elelabs, HUSBZB-1, Telegesis) |
|
||||
| `deconz` | dresden elektronik deCONZ protocol (e.g., ConBee I/II, RaspBee I/II) |
|
||||
| `znp` | Texas Instruments (e.g., CC253x, CC26x2, CC13x2) |
|
||||
| `zigate` | ZiGate Serial protocol (e.g., ZiGate USB-TTL, PiZiGate, ZiGate WiFi) |
|
||||
| `xbee` | Digi XBee ZB Coordinator Firmware protocol (e.g., Digi XBee Series 2, 2C, 3) |
|
||||
| Radio Type | Zigbee Radio Hardware |
|
||||
| ---------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `ezsp` | Silicon Labs EmberZNet protocol (e.g., Home Assistant SkyConnect, Elelabs, HUSBZB-1, Telegesis) |
|
||||
| `deconz` | dresden elektronik deCONZ protocol (e.g., ConBee I/II, RaspBee I/II) |
|
||||
| `znp` | Texas Instruments (e.g., CC253x, CC26x2, CC13x2) |
|
||||
| `zigate` | ZiGate Serial protocol (e.g., ZiGate USB-TTL, PiZiGate, ZiGate WiFi) |
|
||||
| `xbee` | Digi XBee ZB Coordinator Firmware protocol (e.g., Digi XBee Series 2, 2C, 3) |
|
||||
|
||||
- Submit
|
||||
|
||||
@ -191,22 +191,22 @@ If you are use ZiGate or Sonoff ZBBridge you have to use some special usb_path c
|
||||
|
||||
Some devices can be auto-discovered, which can simplify the ZHA setup process. The following devices have been tested with discovery and offer a quick setup experience:
|
||||
|
||||
| Device | Discovery Method | Identifier |
|
||||
| -------| ---------------- | ---------- |
|
||||
| [ITead SONOFF Zigbee 3.0 USB Dongle Plus V2 Model "ZBDongle-E" (EFR32MG21 variant)](https://itead.cc/product/zigbee-3-0-usb-dongle/) | USB | 1A86:55D4 |
|
||||
| [ITead SONOFF Zigbee 3.0 USB Dongle Plus Model "ZBDongle-P" (CC2652P variant)](https://itead.cc/product/sonoff-zigbee-3-0-usb-dongle-plus/) | USB | 10C4:EA60 |
|
||||
| [Bitron Video/SMaBiT BV AV2010/10](https://bv.smabit.eu/index.php/smart-home-produkte/zb-funkstick/) | USB | 10C4:8B34 |
|
||||
| [ConBee II](https://phoscon.de/conbee2) | USB | 1CF1:0030 |
|
||||
| [Nortek HUSBZB-1](https://www.nortekcontrol.com/products/2gig/husbzb-1-gocontrol-quickstick-combo/) | USB | 10C4:8A2A |
|
||||
| [slae.sh CC2652RB development stick](https://slae.sh/projects/cc2652/) | USB | 10C4:EA60 |
|
||||
| [ZigStar Stick (CC2652 + CH340B variant)](https://zig-star.com/projects/zigbee-stick-v4/) | USB | 1A86:7523 |
|
||||
| [Tube’s EFR32 Pro Ethernet/Serial Coordinator](https://www.tubeszb.com/) | USB| 10C4:EA60 |
|
||||
| [ZigStar Coordinators](https://zig-star.com/) | USB| 1A86:7523 |
|
||||
| [SMLIGHT SLZB-06 POE Zigbee LAN WiFi USB Adapter](https://smlight.tech/product/slzb-06/) | Zeroconf | slzb-06.local. |
|
||||
| [ZigStar LAN/POE Coordinators](https://zig-star.com/projects/zigbee-gw-lan/) | Zeroconf | zigstargw.local. |
|
||||
| [Tube's CC2652P2 USB-powered Zigbee to Ethernet Serial Coordinator)](https://www.tubeszb.com/) | Zeroconf | tube_zb_gw_cc2652p2.local. |
|
||||
| [Tube's CC2652P2 PoE-powered Zigbee to Ethernet Serial Coordinator)](https://www.tubeszb.com/) | Zeroconf | tube_zb_gw_cc2652p2_poe.local. |
|
||||
| [Tube's EFR32 Based Zigbee to Ethernet Serial Coordinator)](https://www.tubeszb.com/) | Zeroconf | tube_zb_gw_efr32.local. |
|
||||
| Device | Discovery Method | Identifier |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ------------------------------ |
|
||||
| [ITead SONOFF Zigbee 3.0 USB Dongle Plus V2 Model "ZBDongle-E" (EFR32MG21 variant)](https://itead.cc/product/zigbee-3-0-usb-dongle/) | USB | 1A86:55D4 |
|
||||
| [ITead SONOFF Zigbee 3.0 USB Dongle Plus Model "ZBDongle-P" (CC2652P variant)](https://itead.cc/product/sonoff-zigbee-3-0-usb-dongle-plus/) | USB | 10C4:EA60 |
|
||||
| [Bitron Video/SMaBiT BV AV2010/10](https://bv.smabit.eu/index.php/smart-home-produkte/zb-funkstick/) | USB | 10C4:8B34 |
|
||||
| [ConBee II](https://phoscon.de/conbee2) | USB | 1CF1:0030 |
|
||||
| [Nortek HUSBZB-1](https://www.nortekcontrol.com/products/2gig/husbzb-1-gocontrol-quickstick-combo/) | USB | 10C4:8A2A |
|
||||
| [slae.sh CC2652RB development stick](https://slae.sh/projects/cc2652/) | USB | 10C4:EA60 |
|
||||
| [ZigStar Stick (CC2652 + CH340B variant)](https://zig-star.com/projects/zigbee-stick-v4/) | USB | 1A86:7523 |
|
||||
| [Tube’s EFR32 Pro Ethernet/Serial Coordinator](https://www.tubeszb.com/) | USB | 10C4:EA60 |
|
||||
| [ZigStar Coordinators](https://zig-star.com/) | USB | 1A86:7523 |
|
||||
| [SMLIGHT SLZB-06 POE Zigbee LAN WiFi USB Adapter](https://smlight.tech/product/slzb-06/) | Zeroconf | slzb-06.local. |
|
||||
| [ZigStar LAN/POE Coordinators](https://zig-star.com/projects/zigbee-gw-lan/) | Zeroconf | zigstargw.local. |
|
||||
| [Tube's CC2652P2 USB-powered Zigbee to Ethernet Serial Coordinator)](https://www.tubeszb.com/) | Zeroconf | tube_zb_gw_cc2652p2.local. |
|
||||
| [Tube's CC2652P2 PoE-powered Zigbee to Ethernet Serial Coordinator)](https://www.tubeszb.com/) | Zeroconf | tube_zb_gw_cc2652p2_poe.local. |
|
||||
| [Tube's EFR32 Based Zigbee to Ethernet Serial Coordinator)](https://www.tubeszb.com/) | Zeroconf | tube_zb_gw_efr32.local. |
|
||||
|
||||
Additional devices in the [Known working Zigbee radio modules](#known-working-zigbee-radio-modules) list may be discoverable, however, only devices that have been confirmed discoverable are listed above.
|
||||
|
||||
@ -316,19 +316,19 @@ To add new devices to the network, call the `permit` service on the `zha` domain
|
||||
|
||||
This service opens network for joining new devices.
|
||||
|
||||
| Data | Optional | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| `duration` | yes | For how long to allow new devices to join, default 60s
|
||||
| `ieee` | yes | allow new devices to join via an existing device
|
||||
| Data | Optional | Description |
|
||||
| ---------- | -------- | ------------------------------------------------------ |
|
||||
| `duration` | yes | For how long to allow new devices to join, default 60s |
|
||||
| `ieee` | yes | allow new devices to join via an existing device |
|
||||
|
||||
To join a new device using an install code (ZB3 devices) use the following data attributes (must use parameters only
|
||||
from the same group:
|
||||
|
||||
| Data | Parameter Group | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| `src_ieee` | install_code | The IEEE address of the joining ZB3 device. Use with `install_code`
|
||||
| `install_code` | install_code | Install Code of the joining device. Use with `src_ieee`
|
||||
| `qr_code` | qr_code | QR code containing IEEE and Install Code of the joining ZB3 device
|
||||
| Data | Parameter Group | Description |
|
||||
| -------------- | --------------- | ------------------------------------------------------------------- |
|
||||
| `src_ieee` | install_code | The IEEE address of the joining ZB3 device. Use with `install_code` |
|
||||
| `install_code` | install_code | Install Code of the joining device. Use with `src_ieee` |
|
||||
| `qr_code` | qr_code | QR code containing IEEE and Install Code of the joining ZB3 device |
|
||||
|
||||
<div class='note'>
|
||||
Currently `qr_code` supports QR Install Codes from:
|
||||
@ -343,42 +343,42 @@ from the same group:
|
||||
|
||||
This service removes an existing device from the network. You can find the IEEE address of the device on the device card of Zigbee devices. An example of an IEEE address data parameter format is `00:0d::6f:00:05:7d:2d:34`.
|
||||
|
||||
| Data | Optional | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| `ieee` | no | IEEE address of the device to remove
|
||||
| Data | Optional | Description |
|
||||
| ------ | -------- | ------------------------------------ |
|
||||
| `ieee` | no | IEEE address of the device to remove |
|
||||
|
||||
### Service `zha.set_lock_user_code`
|
||||
|
||||
This service sets a lock code on a Zigbee lock.
|
||||
|
||||
| Data | Optional | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `code_slot` | no | Which lock code slot to store the code. Ex. 1-32 will work for Kwikset 954
|
||||
| `user_code` | no | Code to set on the lock. Ex. Kwikset accepts numbers 4-8 digits in length
|
||||
| Data | Optional | Description |
|
||||
| ----------- | -------- | -------------------------------------------------------------------------- |
|
||||
| `code_slot` | no | Which lock code slot to store the code. Ex. 1-32 will work for Kwikset 954 |
|
||||
| `user_code` | no | Code to set on the lock. Ex. Kwikset accepts numbers 4-8 digits in length |
|
||||
|
||||
### Service `zha.clear_lock_user_code`
|
||||
|
||||
This service clears a lock code from a Zigbee lock.
|
||||
|
||||
| Data | Optional | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `code_slot` | no | Which lock code slot to clear
|
||||
| Data | Optional | Description |
|
||||
| ----------- | -------- | ----------------------------- |
|
||||
| `code_slot` | no | Which lock code slot to clear |
|
||||
|
||||
### Service `zha.enable_lock_user_code`
|
||||
|
||||
This service enables a lock code on a Zigbee lock.
|
||||
|
||||
| Data | Optional | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `code_slot` | no | Which lock code slot to enable
|
||||
| Data | Optional | Description |
|
||||
| ----------- | -------- | ------------------------------ |
|
||||
| `code_slot` | no | Which lock code slot to enable |
|
||||
|
||||
### Service `zha.disable_lock_user_code`
|
||||
|
||||
This service disables a lock code on a Zigbee lock.
|
||||
|
||||
| Data | Optional | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `code_slot` | no | Which lock code slot to disable
|
||||
| Data | Optional | Description |
|
||||
| ----------- | -------- | ------------------------------- |
|
||||
| `code_slot` | no | Which lock code slot to disable |
|
||||
|
||||
## Adding devices
|
||||
|
||||
@ -505,7 +505,7 @@ For example, interference from USB 3.x ports, unshielded USB 3.x devices, and no
|
||||
|
||||
Zigbee also uses [mesh networking topology](https://en.wikipedia.org/wiki/Mesh_networking), which means that most mains-powered devices are a "Zigbee Router" that can act as a signal repeater and range extended by transmitting data over long distances by passing data messages through the Zigbee network mesh of intermediate devices to reach more distant Zigbee devices. Thus to have a healthy Zigbee network, you need many Zigbee Router devices relatively close to each other in order to achieve good coverage and range.
|
||||
|
||||
##### Actions to optimize Zigbee Coordinator radio hardware
|
||||
#### Actions to optimize Zigbee Coordinator radio hardware
|
||||
|
||||
Common root causes of unreliable performance are often seen with outdated Zigbee Coordinator radio adapter hardware, limited by obsolete chips, bad antenna designs, or old/buggy firmware. You can improve most Zigbee setups by using a good Zigbee Coordinator radio adapter and maintaining it.
|
||||
|
||||
@ -522,7 +522,7 @@ Common root causes of unreliable performance are often seen with outdated Zigbee
|
||||
|
||||
While using an older Zigbee Coordinator radio adapter hardware might work, using obsolete hardware and/or old firmware can prevent reliable operation. It is also generally a good idea to upgrade Zigbee Coordinator firmware before troubleshooting any further if and when run into problems with devices.
|
||||
|
||||
##### Actions to avoid or workaround EMI/EMF/RMI interference
|
||||
#### Actions to avoid or workaround EMI/EMF/RMI interference
|
||||
|
||||
Since all Zigbee Coordinator radio adapters are very sensitive/susceptible to all types of EMI/EMF/RMI you should always try to optimize the placement of the Zigbee Coordinator and avoid known sources of interference.
|
||||
|
||||
|
@ -18,7 +18,7 @@ Click the `+` button in the top menu bar.
|
||||
|
||||
You can link to one view from a card in another view when using cards that support navigation (`navigation_path`). The string supplied here will be appended to the string `/lovelace/` to create the path to the view. Do not use special characters in paths. Do not begin a path with a number. This will cause the parser to read your path as a view index.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
View configuration:
|
||||
|
||||
@ -42,7 +42,7 @@ Picture card configuration:
|
||||
|
||||
If you define a view icon, the icon instead of the title will be displayed, the title will then be used as a tool-tip.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- title: Garden
|
||||
@ -53,7 +53,7 @@ If you define a view icon, the icon instead of the title will be displayed, the
|
||||
|
||||
You can specify the visibility of views as a whole or per-user. (Note: This is only for the display of the tabs. The URL path is still accessible)
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
views:
|
||||
@ -88,7 +88,7 @@ user:
|
||||
|
||||
You can change the layout of a view by using a different view type. The default is [`masonry`](/dashboards/masonry).
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- title: Map
|
||||
@ -104,7 +104,7 @@ You can change the layout of a view by using a different view type. The default
|
||||
|
||||
Set a separate [theme](/integrations/frontend/#themes) for the view and its cards.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- title: Home
|
||||
@ -115,7 +115,7 @@ Set a separate [theme](/integrations/frontend/#themes) for the view and its card
|
||||
|
||||
You can style the background of your views with a [theme](/integrations/frontend/#themes). You can use the CSS variable `lovelace-background`. For wallpapers you probably want to use the example below, more options can be found [here](https://developer.mozilla.org/en-US/docs/Web/CSS/background).
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -134,7 +134,7 @@ By default, clicking on back button will navigate to the previous view but a cus
|
||||
|
||||
You can access subviews from other parts of your dashboard by using [cards that support the `navigate` action](/dashboards/actions).
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
Simple subview:
|
||||
|
||||
@ -207,7 +207,7 @@ views:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
View configuration:
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user