8000 Merge branch 'Adding-documentation-for-smart-meter-b-route' of https:… · home-assistant/home-assistant.io@5e98197 · GitHub
[go: up one dir, main page]
Skip to content

Commit 5e98197

Browse files
SeraphicRavSeraphicRav
committed
Merge branch 'Adding-documentation-for-smart-meter-b-route' of https://github.com/SeraphicCorp/home-assistant.io into Adding-documentation-for-smart-meter-b-route
2 parents d3a5fe3 + 5d0250f commit 5e98197

File tree

9 files changed

+211
-30
lines changed

9 files changed

+211
-30
lines changed

‎source/_docs/configuration/templating.markdown

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1284,7 +1284,7 @@ For actions, command templates are defined to format the outgoing MQTT payload t
12841284

12851285
{% note %}
12861286

1287-
Example command template:
1287+
**Example command template with JSON data:**
12881288

12891289
With given value `21.9` template {% raw %}`{"temperature": {{ value }} }`{% endraw %} renders to:
12901290

@@ -1298,6 +1298,14 @@ Additional the MQTT entity attributes `entity_id`, `name` and `this` can be used
12981298

12991299
{% endnote %}
13001300

1301+
**Example command template with raw data:**
1302+
1303+
When a command template renders to a valid `bytes` literal, then MQTT will publish this data as raw data. In other cases, a string representation will be published. So:
1304+
1305+
- Template {% raw %}`{{ "16" }}`{% endraw %} renders to payload encoded string `"16"`.
1306+
- Template {% raw %}`{{ 16 }}`{% endraw %} renders to payload encoded string `"16"`.
1307+
- Template {% raw %}`{{ pack(0x10, ">B") }}`{% endraw %} renders to a raw 1 byte payload `0x10`.
1308+
13011309
## Some more things to keep in mind
13021310

13031311
### `entity_id` that begins with a number

‎source/_integrations/apsystems.markdown

Lines changed: 33 additions & 11 deletions
< A93C tr class="diff-line-row">
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,42 @@ ha_codeowners:
1818
- '@SonnenladenGmbH'
1919
---
2020

21-
The **APsystems** {% term integration %} allows you to read the data from your [APsystems EZ1](https://emea.apsystems.com/diy/ez1/) microinverter. It also allows you to set the output limit to any number between 30 and 800 watts.
22-
The following data is provided by the integration:
21+
The **APsystems** {% term integration %} allows you to read the data from your [APsystems EZ1](https://emea.apsystems.com/diy/ez1/) microinverter. It also allows you to set the output limit to anything above 30 watts.
22+
23+
## Sensors
24+
25+
### Numerical sensors
26+
27+
| Sensor ID | Unit | Description
28+
|---|---| ---|
29+
| total_power | W | Total current output of the inverter
30+
| lifetime_production_p1 | kWh | Lifetime production of first input
31+
| lifetime_production_p2 | kWh | Lifetime production of second input
32+
| lifetime_production | kWh | Lifetime production of both inputs combined
33+
| total_power_p1 | W | Current input on first input
34+
| total_power_p2 | W | Current input on second input
35+
| today_production | kWh | Today's production of both inputs combined
36+
| today_production_p1 | kWh | Today's production of first input
37+
| today_production_p2 | kWh | Today's production of second input
38+
39+
### Binary sensors
40+
41+
| Sensor ID | Description
42+
|---|---|
43+
| off_grid_status | On when the inverter is not connected to the power grid
44+
| dc_1_short_circuit_error_status | Short circuit detected on first input
45+
| dc_2_short_circuit_error_status | Short circuit detected on second input
46+
| output_fault_status | Output because of any error deactivated
47+
48+
## Settings
49+
50+
| Setting ID | Type | Description
51+
|---|---|---|
52+
| inverter_status | switch | Enables or disables the inverter's output
53+
| output_limit | number | Sets the max output of the inverter
2354

24-
- Lifetime production (Per input and in total)
25-
- Current production (Per input and in total)
26-
- Today's production (Per input and in total)
27-
- Short circuit error status (per input)
28-
- Off grid status
29-
- Output status
3055

31-
The following data can be set by the integration:
3256

33-
- Maximal output in watts
34-
- Inverter status (on or off)
3557

3658
## Prerequisites
3759

‎source/_integrations/aquacell.markdown

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Aquacell
2+
title: AquaCell
33
description: Instructions on how to integrate AquaCell with Home Assistant.
44
ha_category:
55
- Sensor
@@ -17,10 +17,12 @@ ha_integration_type: device
1717
AquaCell is a water-softening device. The **AquaCell** {% term integration %} allows you to monitor your AquaCell device in Home Assistant.
1818
You will need your Aquacell account information as used in the **AquaCell** app.
1919

20+
This integration also supports **Harvey** softeners.
21+
2022
{% include integrations/config_flow.md %}
2123

2224
<div class='note warning'>
23-
This integration only works with <b>AquaCell</b> devices which have an <b>i-Lid</b> and are configured through the 'Mijn AquaCell' mobile app.
25+
This integration only works with <b>AquaCell</b> or <b>Harvey</b> devices which have an <b>i-Lid</b> and are configured through the 'Mijn AquaCell' or 'My Harvey' mobile app.
2426
</div>
2527

2628
## Sensors

‎source/_integrations/artsound.markdown

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: ArtSound
3+
description: Connect and control your ArtSound media players using the LinkPlay integration
4+
ha_release: 2024.9
5+
ha_category:
6+
- Media player
7+
ha_domain: artsound
8+
ha_integration_type: virtual
9+
works_with:
10+
- linkplay
11+
---
12+
13+
The **ArtSound** {% term integration %} allows users to control their ArtSound media players through the **LinkPlay** {% term integration %}.
14+
15+
[Learn more about LinkPlay in Home Assistant.](/integrations/linkplay/)
16+
17+
{% include integrations/supported_brand.md %}

‎source/_integrations/fujitsu_fglair.markdown

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Fujitsu FGLair
3+
description: Control your Fujitsu heat pump or air conditioner that uses the FGLair app
4+
ha_category:
5+
- Climate
6+
ha_release: 2024.9
7+
ha_domain: fujitsu_fglair
8+
ha_integration_type: integration
9+
ha_codeowners:
10+
- '@crevetor'
11+
ha_config_flow: true
12+
ha_platforms:
13+
- climate
14+
ha_iot_class: "Cloud Polling"
15+
---
16+
17+
The {{ page.title }} {% term integration %} provides support for Fujitsu heat pumps and air conditioners that use the FGLair app.
18+
To find out which app to use for your heat pump, check [the Fujitsu FGLair FAQ](https://www.fujitsu-general.com/global/support/faq/airstage-mobile/0127.html).
19+
20+
## Prerequisites
21+
22+
First, set up your device in the FGLair app before using this integration.
23+
To configure this integration, you will need the credentials (login and password) used to connect to the FGLair application.
24+
25+
{% include integrations/config_flow.md %}
26+
27+
## Climate
28+
29+
This integration supports the following functionalities (if the devices support them):
30+
31+
- [`set_hvac_mode`](/integrations/climate/#action-climateset_hvac_mode)
32+
- [`target temperature`](/integrations/climate#action-climateset_temperature)
33+
- [`turn on/off`](/integrations/climate#action-climateturn_on)
34+
- [`fan mode`](/integrations/climate#action-climateset_fan_mode)
35+
- [`swing mode`](/integrations/climate#action-climateset_swing_mode)
36+

‎source/_integrations/knx.markdown

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -787,29 +787,28 @@ knx:
787787
```
788788

789789
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` / `operation_mode_standby_address` are not necessary if `operation_mode_address` is specified.
790-
If the actor doesn't support explicit state group objects the `*_state_address` can be configured with the same group address as the writeable `*_address`. The read flag for the `*_state_address` group object has to be set in ETS to support initial reading e.g., when starting Home Assistant.
791790

792791
The following values are valid for the `heat_cool_address` and the `heat_cool_state_address`:
793792

794793
- `0` (cooling)
795794
- `1` (heating)
796795

797-
The following values are valid for the Home Assistant [Climate](/integrations/climate/) `hvac_mode` attribute. Supported values for your KNX thermostats can be specified via `controller_modes` configuration variable:
796+
Supported HVAC modes for your KNX thermostats are found automatically. This can be overridden by using the `controller_modes` configuration variable. The following values are valid controller modes:
798797

799-
- `off` (maps internally to `HVAC_MODE_OFF` within Home Assistant)
800-
- `auto` (maps internally to `HVAC_MODE_AUTO` within Home Assistant)
801-
- `heat` (maps internally to `HVAC_MODE_HEAT` within Home Assistant)
802-
- `cool` (maps internally to `HVAC_MODE_COOL` within Home Assistant)
803-
- `fan_only` (maps internally to `HVAC_MODE_FAN_ONLY` within Home Assistant)
804-
- `dehumidification` (maps internally to `HVAC_MODE_DRY` within Home Assistant)
798+
- `off`
799+
- `auto`
800+
- `heat`
801+
- `cool`
802+
- `fan_only`
803+
- `dehumidification`
805804

806-
The following presets are valid for the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute. Supported values for your KNX thermostats can be specified via `operation_modes` configuration variable:
805+
Supported preset modes for your KNX thermostats are found automatically. This can be overridden by using the `operation_modes` configuration variable. The following values are valid operation modes:
807806

808-
- `auto` (maps to `none` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute)
809-
- `comfort` (maps to `comfort` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute)
810-
- `standby` (maps to `away` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute)
811-
- `economy` (maps to `sleep` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute)
812-
- `building_protection` (maps to `eco` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute)
807+
- `auto`
808+
- `comfort`
809+
- `standby`
810+
- `economy`
811+
- `building_protection`
813812

814813
{% configuration %}
815814
name:
@@ -914,11 +913,11 @@ operation_mode_standby_address:
914913
required: false
915914
type: [string, list]
916915
operation_modes:
917-
description: Overrides the supported operation modes. Provide the supported `preset_mode` values for your device.
916+
description: Overrides the supported operation modes. Provide the supported `preset_modes` value for your device.
918917
required: false
919918
type: list
920919
controller_modes:
921-
description: Overrides the supported controller modes. Provide the supported `hvac_mode` values for your device.
920+
description: Overrides the supported controller modes. Provide the supported `hvac_modes` value for your device.
922921
required: false
923922
type: list
924923
default_controller_mode:

‎source/_integrations/mqtt.markdown

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1110,9 +1110,13 @@ The MQTT integration will register the `mqtt.publish` action, which allows publi
11101110
| ---------------------- | -------- | ------------------------------------------------------------ |
11111111
| `topic` | no | Topic to publish payload to. |
11121112
| `payload` | no | Payload to publish. |
1113+
| `evaluate_payload` | yes | If a `bytes` literal in `payload` should be evaluated to publish raw data. (default: false)|
11131114
| `qos` | yes | Quality of Service to use. (default: 0) |
11141115
| `retain` | yes | If message should have the retain flag set. (default: false) |
11151116

1117+
{% note %}
1118+
When `payload` is rendered from [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) in a YAML script or automation, and the template renders to a `bytes` literal, the outgoing MQTT payload will only be sent as `raw` data, if the `evaluate_payload` option flag is set to `true`.
1119+
{% endnote %}
11161120

11171121
{% important %}
11181122
You must include either `topic` or `topic_template`, but not both. If providing a payload, you need to include either `payload` or `payload_template`, but not both.

‎source/_integrations/nice_go.markdown

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Nice G.O.
3+
description: Control Nice G.O. garage doors
4+
ha_release: '2024.9'
5+
ha_category:
6+
- Cover
7+
- Event
8+
- Light
9+
- Switch
10+
ha_iot_class: Cloud Push
11+
ha_config_flow: true
12+
ha_codeowners:
13+
- '@IceBotYT'
14+
ha_domain: nice_go
15+
ha_platforms:
16+
- cover
17+
- diagnostics
18+
- event
19+
- light
20+
- switch
21+
ha_integration_type: integration
22+
---
23+
24+
The **Nice G.O.** {% term integration %} lets you control Nice G.O. garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your Nice G.O. mobile app.
25+
26+
## Prerequisites
27+
28+
Make sure you have a working account with the Nice G.O. app and have your email and password ready.
29+
30+
{% include integrations/config_flow.md %}
31+
32+
## Cover
33+
34+
Garage doors linked to your Nice G.O. account will appear as covers.
35+
36+
## Event
37+
38+
The barrier obstructed event entity will be triggered whenever the barrier gets obstructed. This could be triggered by anything that results in the closure being unsuccessful. This may include beam block during closure, beam block before closure, and an object in the way.
39+
40+
## Light
41+
42+
Lights on your garage door will appear as lights.
43+
44+
## Switch
45+
46+
A switch for turning vacation mode on and off will be made available for each device. Vacation mode prevents the operation of the door from physical control points such as a wall station, wireless keypad, remote control, or HomeLink. It can still be controlled from Home Assistant.

‎source/_integrations/smlight.markdown

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: SMLIGHT SLZB
3+
description: The SMLIGHT SLZB integration allows users to monitor and manage their SMLIGHT SLZB-06x devices from directly within Home Assistant.
4+
ha_category:
5+
- Sensor
6+
ha_release: 2024.9
7+
ha_iot_class: Local Polling
8+
ha_config_flow: true
9+
ha_domain: smlight
10+
ha_zeroconf: true
11+
ha_platforms:
12+
- sensor
13+
ha_codeowners:
14+
- '@tl-sl'
15+
ha_integration_type: device
16+
---
17+
18+
The [SMLIGHT](https://smlight.tech) SLZB-06x Ethernet Zigbee coordinators
19+
provide a convenient way to add Zigbee to your smart home setup.
20+
21+
The **SMLIGHT SLZB** {% term integration %} allows users to monitor and manage their SLZB-06x devices
22+
directly from within Home Assistant and to directly access many of the
23+
features found in the SMLIGHT web UI. You can also use these in your automations.
24+
25+
## Prerequisites
26+
27+
You need a supported SLZB-06 adapter.
28+
29+
This integration has been tested with the following devices:
30+
31+
- [SLZB-06](https://smlight.tech/product/slzb-06)
32+
- [SLZB-06M](https://smlight.tech/product/slzb-06m)
33+
- [SLZB-06p7](https://smlight.tech/product/slzb-06p7)
34+
- [SLZB-06p10](https://smlight.tech/product/slzb-06p10/)
35+
36+
{% include integrations/config_flow.md %}
37+
38+
## Integration entities
39+
40+
The following sensors will be created:
41+
42+
- **Core Temperature** - Temperature of core ESP32
43+
- **Zigbee Temperature** - Temperature of Zigbee CC2652 or EFR32 chip
44+
- **Core Uptime** - Uptime of Core device
45+
- **Zigbee Uptime** - Uptime of Zigbee connection to ZHA/Z2M
46+
- **RAM Usage** - Monitor RAM Usage
47+
- **FS Usage** - Monitor filesystem usage

0 commit comments

Comments
 (0)
0