RF Bridge Component

The RF Bridge Component provides the ability to send and receive 433MHz remote codes without hardware hacking the circuit board to bypass the efm8bb1 MCU. This component implements the communication protocol that the original efm8bb1 firmware implements. The device is connected via the UART bus. The uart bus must be configured at the same speed of the module which is 19200bps.

Warning

If you are using the Logger Component make sure you disable the uart logging with the baud_rate: 0 option.

../_images/rf_bridge-full.jpg
# Example configuration entry
uart:
  baud_rate: 19200

rf_bridge:
  on_code_received:
    - homeassistant.event:
        event: esphome.rf_code_received
        data:
          sync: !lambda 'char buffer [10];return itoa(data.sync,buffer,16);'
          low: !lambda 'char buffer [10];return itoa(data.low,buffer,16);'
          high: !lambda 'char buffer [10];return itoa(data.high,buffer,16);'
          code: !lambda 'char buffer [10];return itoa(data.code,buffer,16);'

Configuration variables:

  • uart_id (Optional, ID): Manually specify the ID of the UART hub.

  • id (Optional, ID): Manually specify the ID used for code generation.

  • on_code_received (Optional, Automation): An action to be performed when a code is received. See on_code_received Trigger.

on_code_received Trigger

With this configuration option you can write complex automations whenever a code is received. To use the code, use a lambda template, the code and the corresponding protocol timings are available inside that lambda under the variables named code, sync, high and low.

on_code_received:
  - homeassistant.event:
      event: esphome.rf_code_received
      data:
        sync: !lambda 'char buffer [10];return itoa(data.sync,buffer,16);'
        low: !lambda 'char buffer [10];return itoa(data.low,buffer,16);'
        high: !lambda 'char buffer [10];return itoa(data.high,buffer,16);'
        code: !lambda 'char buffer [10];return itoa(data.code,buffer,16);'

rf_bridge.send_code Action

Send an RF code using this action in automations.

on_...:
  then:
    - rf_bridge.send_code:
        sync: 0x700
        low: 0x800
        high: 0x1000
        code: 0xABC123

Configuration options:

  • sync (Required, int, templatable): RF Sync timing

  • low (Required, int, templatable): RF Low timing

  • high (Required, int, templatable): RF high timing

  • code (Required, int, templatable): RF code

  • id (Optional, ID): Manually specify the ID of the RF Bridge if you have multiple components.

Note

This action can also be written in lambdas:

id(rf_bridge).send_code(0x700, 0x800, 0x1000, 0xABC123);

rf_bridge.send_raw Action

Send a raw command to the onboard EFM8BB1 chip. You can see a list of available commands and format in the Portisch Wiki

This can be used to send raw RF codes in automation’s, mainly for protocols that are not supported. If you have Portisch firmware installed, these raw codes can be obtained with the help of rf_bridge.start_bucket_sniffing Action

on_...:
  then:
    - rf_bridge.send_raw:
        raw: AAA5070008001000ABC12355

Configuration options:

  • raw (Required, string, templatable): RF raw string

  • id (Optional, ID): Manually specify the ID of the RF Bridge if you have multiple components.

Note

This action can also be written in lambdas:

id(rf_bridge).send_raw("AAA5070008001000ABC12355");

rf_bridge.learn Action

Tell the RF Bridge to learn new protocol timings using this action in automations. A new code with timings will be returned to on_code_received Trigger

on_...:
  then:
    - rf_bridge.learn

Configuration options:

  • id (Optional, ID): Manually specify the ID of the RF Bridge if you have multiple components.

Note

This action can also be written in lambdas:

id(rf_bridge).learn();

Portisch firmware

If you have flashed the secondary MCU with the Portisch firmware, ESPHome is able to receive the extra protocols that can be decoded as well as activate the other modes supported.

on_advanced_code_received Trigger

Similar to on_code_received Trigger, this trigger receives the codes after advanced sniffing is started. To use the code, use a lambda template, the code and the corresponding protocol and length are available inside that lambda under the variables named code, protocol and length.

on_advanced_code_received:
  - homeassistant.event:
      event: esphome.rf_advanced_code_received
      data:
        length: !lambda 'char buffer [10];return itoa(data.length,buffer,16);'
        protocol: !lambda 'char buffer [10];return itoa(data.protocol,buffer,16);'
        code: !lambda 'return data.code;'

rf_bridge.send_advanced_code Action

Send an RF code using this action in automations.

on_...:
  then:
    - rf_bridge.send_advanced_code:
        length: 0x04
        protocol: 0x01
        code: "ABC123"

Configuration options:

  • length (Required, int, templatable): Length of code plus protocol

  • protocol (Required, int, templatable): RF Protocol

  • code (Required, string, templatable): RF code

  • id (Optional, ID): Manually specify the ID of the RF Bridge if you have multiple components.

Note

This action can also be written in lambdas:

id(rf_bridge).send_advanced_code(0x04, 0x01, "ABC123");

rf_bridge.start_advanced_sniffing Action

Tell the RF Bridge to listen for the advanced/extra protocols defined in the portisch firmware. The decoded codes with length and protocol will be returned to on_advanced_code_received Trigger

on_...:
  then:
    - rf_bridge.start_advanced_sniffing

Configuration options:

  • id (Optional, ID): Manually specify the ID of the RF Bridge if you have multiple components.

Note

This action can also be written in lambdas:

id(rf_bridge).start_advanced_sniffing();

rf_bridge.stop_advanced_sniffing Action

Tell the RF Bridge to stop listening for the advanced/extra protocols defined in the portisch firmware.

on_...:
  then:
    - rf_bridge.stop_advanced_sniffing

Configuration options:

  • id (Optional, ID): Manually specify the ID of the RF Bridge if you have multiple components.

Note

This action can also be written in lambdas:

id(rf_bridge).stop_advanced_sniffing();

rf_bridge.start_bucket_sniffing Action

Tell the RF Bridge to dump raw sniffing data. Useful for getting codes for unsupported protocols. The raw data will be available in the log and can later be used with rf_bridge.send_raw Action action.

Note

A conversion from B1 (received) raw format to B0 (send) raw command format should be applied. For this, you can use the tool BitBucket Converter

Note

There seems to be an overflow problem in Portisch firmware and after a short while, the bucket sniffing stops. You should re-call the action to reset and start sniffing again.

on_...:
  then:
    - rf_bridge.start_bucket_sniffing

Configuration options:

  • id (Optional, ID): Manually specify the ID of the RF Bridge if you have multiple components.

Note

This action can also be written in lambdas:

id(rf_bridge).start_bucket_sniffing();

rf_bridge.beep Action

Activate the internal buzzer to make a beep.

on_...:
  then:
    - rf_bridge.beep:
        duration: 100

Configuration options:

  • duration (Required, string, templatable): beep duration in milliseconds.

  • id (Optional, ID): Manually specify the ID of the RF Bridge if you have multiple components.

Note

This action can also be written in lambdas:

id(rf_bridge).beep(100);

Getting started with Home Assistant

The following code will get you up and running with a configuration sending codes to Home Assistant as events and will also setup a service so you can send codes with your RF Bridge.

api:
  services:
    - service: send_rf_code
      variables:
        sync: int
        low: int
        high: int
        code: int
      then:
        - rf_bridge.send_code:
            sync: !lambda 'return sync;'
            low: !lambda 'return low;'
            high: !lambda 'return high;'
            code: !lambda 'return code;'
    - service: learn
      then:
        - rf_bridge.learn

uart:
  tx_pin: 1
  rx_pin: 3
  baud_rate: 19200

logger:
  baud_rate: 0

rf_bridge:
  on_code_received:
    then:
      - homeassistant.event:
          event: esphome.rf_code_received
          data:
            sync: !lambda 'char buffer [10];return itoa(data.sync,buffer,16);'
            low: !lambda 'char buffer [10];return itoa(data.low,buffer,16);'
            high: !lambda 'char buffer [10];return itoa(data.high,buffer,16);'
            code: !lambda 'char buffer [10];return itoa(data.code,buffer,16);'

Now your latest received code will be in an event.

To trigger the automation from Home Assistant you can invoke the service with this code:

automation:
  # ...
  action:
  - service: esphome.rf_bridge_send_rf_code
    data:
      sync: 0x700
      low: 0x800
      high: 0x1000
      code: 0xABC123

See Also