ESPHome Simplebus2

[!WARNING]
This component is experimental. It will currently not work using the same voltage level/gain settings as the official firmware.

The simplebus2 component allows you to connect your Simpebus2 bridge to Home Assistant via de native API. Inspired by both the original Simplebus2 MQTT bridge code and comelit-esphome (read: mashed the projects together so I could have the bridge running ESPHome)

How to use:

    external_components:
      - source: github://se-bastiaan/esphome-simplebus2

    simplebus2:

    binary_sensor:
      - platform: simplebus2
        address: 42
    button:
      - platform: template
        name: Open Door
        on_press:
          - simplebus2.send:
              command: 16
              address: 42

Configuration variables:

• gain (int): See Simpebus2 bridge documentation
• voltage_level (int): See Simpebus2 bridge documentation
• rx_pin (Optional, pin): You do not need this as it is the correct pin for the bridge by default
• tx_pin (Optional, pin): You do not need this as it is the correct pin for the bridge by default
• event (Optional, string): The name of the event that will be generated on Home Assistant when receiving a command on the bus. For example, if set to simplebus2, the event generated will be "esphome.simplebus2". Read more about how to use it in the event section Default to simplebus2. If this parameter is set to none no event will be generated.

Binary sensor

You can configure binary sensors will trigger when a particular combination of command and address is received from the bus.

You can also set only the address, in this case the default command is 50, which occurs when a call is made from the outside intercom to the inside intercom.

Configuration examples:

binary_sensor:
  - platform: simplebus2
    address: 16
  - platform: simplebus2
    command: 29
    address: 1
    name: Internal Door opened
    auto_off: 60s

• address (Required, int): The address that when received sets the sensor to on .
• command (Optional, int): The command that when received sets the sensor to on . Defaults to 50.
• auto_off (Optional, Time): The time after which the sensor returns to off. If set to 0s the sensor once it goes on, it stays there until it is turned off by an automation. Defaults to 30s.
• icon (Optional, icon): Manually set the icon to use for the sensor in the frontend. Default to mdi:doorbell.
• id (Optional, string): Manually specify the ID for code generation.

• name (Optional, string): The name for the sensor. Default to Incoming call.

  Note: If you have friendly_name set for your device and you want the sensor to use that name, you can set name: None.

Text sensor

You can configure a text sensor that will output the last received command on the bus.

Configuration example:

text_sensor:
  - platform: simplebus2

Number

You can configure a number that will allow you to dynanmically configure the voltage level and gain settings.

Configuration example:

number:
- platform: simplebus2
  gain:
    name: gain
  voltage_level:
    name: voltage level

Event

If the event parameter is not set to none, an event will be generated each time a command is received.

You can intercept events in Home Assistant on the page "developer tools -> event"

Each time a command is received, an event like this will be generated:

event_type: esphome.simplebus2
data:
  device_id: xxxxxxxxxxxxxxxxxxxxxxxxx
  address: "13"
  command: "50"
origin: LOCAL
time_fired: "2024-01-01T00:00:00.000000+00:00"
context:
  id: xxxxxxxxxxxxxxxxxxxxxxxx
  parent_id: null
  user_id: null

To intercept this event to trigger an Home Assistant automation, you can use a trigger of type "event."

The trigger configuration will look like this:

platform: event
event_type: esphome.simplebus2
event_data:
  command: "50"
  address: "13"

You have to change the address and the name of the event you have chosen, if you have set a different one.

Send a command

To send commands to the bus, the following action is available:

- simplebus2.send:
    command: 16
    address: 1

• command (Required, int)
• address (Required, int)

Button:

The action can be easily inserted into a button type entity:

button:
  - platform: template
    name: Open Door
    on_press:
      - simplebus2.send:
          command: 16
          address: 5

Service:

You can create a Home Assistant service, which can easily be invoked by an automation or script:

api:
services:
  - service: simplebus2_send
    variables:
      command: int
      address: int
    then:
      - simplebus2.send:
          command: !lambda 'return command;'
          address: !lambda 'return address;'

Sending multiple commands:

There are some special configurations that require sending 2 or more commands consecutively on the bus. In this case, a delay of at least 200ms must be inserted between the commands (one command takes about 180ms to be sent)

- simplebus2.send:
    command: 29
    address: 1
- delay: 200ms
- simplebus2.send:
    command: 16
    address: 1

Useful automations in Home Assistant

Logging events in the logbook

alias: Log simplebus2 events
description: "Log all events coming from the simplebus2 bridge"
trigger:
  - platform: event
    event_type: esphome.simplebus2
condition: []
action:
  - service: logbook.log
    metadata: {}
    data:
      name: Simplebus2 event
      entity_id: binary_sensor.doorbell_bridge_incoming_call
      message: |
        {{ trigger.event.data.command }} - {{ trigger.event.data.address }}
mode: parallel
max: 10

Sending a push notification to your phone

alias: Pushnotification Doorbell
description: "Send a push notification to the Home Assistant app when someone rings the doorbell"
trigger:
  - platform: state
    entity_id:
      - binary_sensor.utility_doorbell_bridge_incoming_call # You could also do this using an event instead
    from: "off"
    to: "on"
condition:
  - condition: template
    value_template: >-
      {{ (as_timestamp(now()) -
      as_timestamp(state_attr('automation.pushnotification_doorbell',
      'last_triggered') | default(0)) | int > 5)}}
action:
  - service: notify.mobile_app
    metadata: {}
    data:
      message: There is someone at the door!
mode: single

Automatically open the door

This automation requires two helper entities:

• input_select.auto_open_door is a selection entity with options for how long the door should be automatically opened
• timer.auto_open_door_timer is a timer that will be set when a selection is chosen, it will trigger the automation again to end the behaviour

alias: Automatically open the door when someone rings the bell
description: "Imitate comelit doctor mode"
trigger:
  - platform: state
    entity_id:
      - input_select.auto_open_door
    id: state_select
  - platform: state
    entity_id:
      - timer.auto_open_door_timer
    to: idle
    id: timer_ended
  - platform: state
    entity_id:
      - binary_sensor.utility_doorbell_bridge_incoming_call
    id: ring
    to: "on"
condition: []
action:
  - if:
      - condition: trigger
        id:
          - state_select
    then:
      - choose:
          - conditions:
              - condition: state
                entity_id: input_select.auto_open_door
                state: 15 minutes
            sequence:
              - service: timer.start
                metadata: {}
                data:
                  duration: "15:00:00"
                target:
                  entity_id: timer.auto_open_door_timer
          ... any other options
          - conditions:
              - condition: state
                entity_id: input_select.auto_open_door
                state: 8 hours
            sequence:
              - service: timer.start
                metadata: {}
                data:
                  duration: "480:00:00"
                target:
                  entity_id: timer.auto_open_door_timer
          - conditions:
              - condition: state
                entity_id: input_select.deur_openen
                state: Off
            sequence:
              - service: timer.finish # This should immediately trigger this automation again
                target:
                  entity_id:
                    - timer.auto_open_door_timer
  - if:
      - condition: trigger
        id:
          - timer_ended
    then:
      - service: input_select.select_option
        target:
          entity_id: input_select.auto_open_door
        data:
          option: Off
    alias: Reset select when timer ends
  - alias: Doorbell is triggered
    if:
      - condition: trigger
        id:
          - ring
      - condition: state
        entity_id: timer.auto_open_door_timer
        state: active
    then:
      - delay:
          hours: 0
          minutes: 0
          seconds: 2 # Without some delay the send signal will probably not get through
          milliseconds: 0
      - service: button.press
          target:
          entity_id: button.utility_doorbell_bridge_open_door
mode: queued
max: 2