Add documentation for binary sensors in the bosch alarm integration (#38345)

This commit is contained in:
Sanjay Govind 2025-05-15 18:19:42 +12:00 committed by GitHub
parent f6c2a7d7ee
commit 0f49eb7453
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -3,8 +3,9 @@ title: Bosch Alarm
description: Integrate Bosch Alarms. description: Integrate Bosch Alarms.
ha_category: ha_category:
- Alarm - Alarm
- Switch - Binary Sensor
- Sensor - Sensor
- Switch
ha_release: 2025.4 ha_release: 2025.4
ha_iot_class: Local Push ha_iot_class: Local Push
ha_config_flow: true ha_config_flow: true
@ -14,9 +15,10 @@ ha_codeowners:
ha_domain: bosch_alarm ha_domain: bosch_alarm
ha_platforms: ha_platforms:
- alarm_control_panel - alarm_control_panel
- switch - binary_sensor
- diagnostics - diagnostics
- sensor - sensor
- switch
ha_integration_type: device ha_integration_type: device
ha_quality_scale: bronze ha_quality_scale: bronze
--- ---
@ -40,24 +42,31 @@ The **Bosch Alarm Panel** {% term integration %} allows you to connect your [Bos
The following {% term entities %} are provided: The following {% term entities %} are provided:
- [Alarm Control Panel](#alarm-control-panel) - [Alarm Control Panel](#alarm-control-panel)
- [Switch](#switch) - [Binary Sensor](#binary-sensor)
- [Sensor](#sensor) - [Sensor](#sensor)
- [Switch](#switch)
### Alarm Control Panel ### Alarm Control Panel
This integration adds an Alarm Control Panel device for each configured area, with the ability to issue arm/disarm commands. This integration adds an Alarm Control Panel device for each configured area, with the ability to issue arm/disarm commands.
This entity reports state (_disarmed_, _armed_away_, etc.). This entity reports state (_disarmed_, _armed_away_, etc.).
### Binary Sensor
A binary sensor is added for each point configured on your alarm.
Two binary sensors are added for each area to indicate whether it can be armed away or armed home.
### Sensor
A sensor is provided per area that lists how many points are currently in a faulted state.
### Switch ### Switch
A switch is added for each output configured on the panel. Note that for some panels, only outputs with the type set to **remote output** can be controlled via _Mode 2_ API. A switch is added for each output configured on the panel. Note that for some panels, only outputs with the type set to **remote output** can be controlled via _Mode 2_ API.
Three switches are added per door, which allow for locking, securing, or momentarily unlocking the door. Three switches are added per door, which allow for locking, securing, or momentarily unlocking the door.
### Sensor
A sensor is provided per area that lists how many points are currently in a faulted state.
## Authentication ## Authentication
The primary means of authentication for the _Mode 2_ API is the _Automation_ passcode. It needs to be at least 10 characters long, and it is different from the _User_ code -- a shorter numeric pin used to arm/disarm the panel. The primary means of authentication for the _Mode 2_ API is the _Automation_ passcode. It needs to be at least 10 characters long, and it is different from the _User_ code -- a shorter numeric pin used to arm/disarm the panel.
@ -82,6 +91,34 @@ The **Bosch Alarm** {% term integration %} fetches data from the device every 30
Newer devices and firmware revisions have the possibility to push data instead of needing to rely on {% term polling %}. Newer devices and firmware revisions have the possibility to push data instead of needing to rely on {% term polling %}.
At startup, the integration checks whether your panel supports push data updates and falls back to {% term polling %} if not. At startup, the integration checks whether your panel supports push data updates and falls back to {% term polling %} if not.
## Examples
### Turning on lights when walking into a room
{% raw %}
```yaml
automation:
- alias: "Turn on light when walking into room"
triggers:
- platform: state
entity_id:
- binary_sensor.bosch_solution_3000_bedroom
to: "on"
actions:
- action: light.turn_on
target:
entity_id: light.bedroom_light
```
{% endraw %}
## Reconfiguration
This integration supports reconfiguration, so it is possible to change the configuration such as the IP Address after it is configured.
## Troubleshooting ## Troubleshooting
### Issues with Bosch Solution 2000/3000/4000 panels ### Issues with Bosch Solution 2000/3000/4000 panels