Szczepan's esphome custom components

This repository contains a collection of my custom components for ESPHome.

1. Usage

Use latest ESPHome with external components and add this to your .yaml definition:

external_components:
  - source: github://SzczepanLeon/esphome-components@main

2. Components

2.1. wmbus

Component to receive wMBus frame (via CC1101), create HA sensor and send decoded value. You can also use this component with wmbusmeters HA addon: https://github.com/SzczepanLeon/esphome-components/blob/main/docs/wmbus.md

NOTE: From version 2.0 YAML configuration is changed. You can define multiple sensors for one meter.

NOTE: From version 1.3 features from wmbusgw are included in this component. It means that you need time component in yaml.

2.1.1. Example for version 2.x

time:
  - platform: sntp
    id: time_sntp

external_components:
  - source: github://SzczepanLeon/esphome-components@main
    components: [ wmbus ]

wmbus:
  mosi_pin: GPIO13
  miso_pin: GPIO5
  clk_pin:  GPIO2
  cs_pin:   GPIO14
  gdo0_pin: GPIO15
  gdo2_pin: GPIO16

  led_pin: GPIO0
  led_blink_time: "1s"

  clients:
    - name: "wmbusmeters"
      ip_address: "10.0.0.1"
      port: 7227

sensor:
  - platform: wmbus
    meter_id: 0x24202020
    type: apator162
    key: "00000000000000000000000000000000"
    lqi:
      name: "My lqi"
    rssi:
      name: "My RSSI"
    total_water_m3:
      name: "My cold water"

  - platform: wmbus
    meter_id: 0x12345678
    type: amiplus
    rssi:
      name: "My RSSI"
    total_energy_consumption_kwh:
      name: "My consumption in kWh"
      icon: "mdi:power-plug"
    voltage_at_phase_1_v:
      name: "My V1"

  - platform: wmbus
    meter_id: 0xAB125432
    type: bmeters
    key: "00004000000300000500001000000600"
    lqi:
      name: "My lqi"
    total_water_m3:
      id: "my_hot_water"
      filters:
        - offset: 325.0

Configuration variables:

In wmbus platform:

• mosi_pin (Optional): CC1101 MOSI pin connection. Defaults to GPIO13.
• miso_pin (Optional): CC1101 MISO pin connection. Defaults to GPIO12.
• clk_pin (Optional): CC1101 CLK pin connection. Defaults to GPIO14.
• cs_pin (Optional): CC1101 CS pin connection. Defaults to GPIO2.
• gdo0_pin (Optional): CC1101 GDO0 pin connection. Defaults to GPIO5.
• gdo2_pin (Optional): CC1101 GDO2 pin connection. Defaults to GPIO4.
• led_pin (Optional): Pin where LED is connected. It will blink on each telegram. You can use all options from Pin Schema.
• led_blink_time (Optional): How long LED will stay ON. Defaults to 300 ms.
• log_unknown (Optional): Show telegrams from not configured meters in log. Defaults to False.
• clients (Optional):
  • name (Required): The name for this client.
  • ip_address (Required): IP address.
  • port (Required): Port number.
  • format (Optional): Telegram format to send. HEX or RTLWMBUS. Defaults to RTLWMBUS.
  • transport (Optional): TCP or UDP. Defaults to TCP.

Meter/sensor:

• meter_id (Optional, int): Meter ID. Can be specified as decimal or hex. Defaults to 0.
• type (Optional, string): Meter type. Currently amiplus, apator08, apator162, apatoreitn, bmeters, compact5, elf, evo868, fhkvdataiii, hydrocalm3, hydrus, iperl, itron, izar, mkradio3, mkradio4, qheat, qwater, sharky774, topaseskr, ultrimis, unismart, vario451 are supported. Defaults to unknown.
• key (Optional): Key for meter, used in payload decoding process. Defaults to "".
• add_prefix (Optional): Add prefix (meter_id) to sensor name. Defaults to True.
• sensor_type (Optional): Sensor type from list below. For example total_water_m3
  • id (Optional, string): Manually specify the ID for code generation. At least one of id and name must be specified.
  • name (Optional, string): The name for the sensor. At least one of id and name must be specified.
  • All other options from Sensor.

---

Supported sensors (sensor_type) for meters:

• amiplus
  • total_energy_consumption_kwh
  • current_power_consumption_kw
  • total_energy_production_kwh
  • current_power_production_kw
  • voltage_at_phase_1_v
  • voltage_at_phase_2_v
  • voltage_at_phase_3_v
• apatoreitn
  • current_hca
  • previous_hca
  • temp_room_avg_c
• apator08
  • total_water_m3
• apator162
  • total_water_m3
• bmeters
  • total_water_m3
• compact5
  • current_heating_kwh
  • previous_heating_kwh
• elf
  • total_energy_consumption_kwh
  • current_power_consumption_kw
  • total_water_m3
• evo868
  • total_water_m3
• fhkvdataiii
  • current_hca
  • previous_hca
• hydrocalm3
  • total_heating_kwh
• hydrus
  • total_water_m3
• itron
  • total_water_m3
• izar
  • total_water_m3
  • last_month_total_water_m3
  • transmit_period_s
  • remaining_battery_life_y
  • current_alarms
  • previous_alarms
• mkradio3
  • total_water_m3
• mkradio4
  • total_water_m3
• qheat
  • total_energy_consumption_kwh
• qwater
  • total_water_m3
• sharky774
  • total_energy_consumption_kwh
• topaseskr
  • total_water_m3
• ultrimis
  • total_water_m3
• unismart
  • total_gas_m3
• vario451
  • total_heating_kwh

2.1.2. Example for version 1.x

time:
  - platform: sntp
    id: time_sntp

external_components:
  - source: github://SzczepanLeon/[email protected]
    components: [ wmbus ]

wmbus:
  mosi_pin: GPIO13
  miso_pin: GPIO5
  clk_pin:  GPIO2
  cs_pin:   GPIO14
  gdo0_pin: GPIO15
  gdo2_pin: GPIO16

  led_pin: GPIO0
  led_blink_time: "1s"

  clients:
    - name: "wmbusmeters"
      ip_address: "10.0.0.1"
      port: 7227

sensor:
  - platform: wmbus
    name: "My water from Apator"
    meter_id: 0x24202020
    type: apator162
    key: "00000000000000000000000000000000"
  - platform: wmbus
    name: "My Water from Izar"
    meter_id: 306029916
    type: izar
    accuracy_decimals: 3

Configuration variables:

In wmbus platform:

• mosi_pin (Optional): CC1101 MOSI pin connection. Defaults to GPIO13.
• miso_pin (Optional): CC1101 MISO pin connection. Defaults to GPIO12.
• clk_pin (Optional): CC1101 CLK pin connection. Defaults to GPIO14.
• cs_pin (Optional): CC1101 CS pin connection. Defaults to GPIO2.
• gdo0_pin (Optional): CC1101 GDO0 pin connection. Defaults to GPIO5.
• gdo2_pin (Optional): CC1101 GDO2 pin connection. Defaults to GPIO4.
• led_pin (Optional): Pin where LED is connected. It will blink on each telegram. You can use all options from Pin Schema.
• led_blink_time (Optional): How long LED will stay ON. Defaults to 300 ms.
• clients (Optional):
  • name (Required): The name for this client.
  • ip_address (Required): IP address.
  • port (Required): Port number.
  • format (Optional): Telegram format to send. HEX or RTLWMBUS. Defaults to RTLWMBUS.
  • transport (Optional): TCP or UDP. Defaults to TCP.

Sensor

• meter_id (Required, int): Meter ID (usually from sticker). Can be specified as decimal or hex.
• type (Required, string): Meter type.
• key (Optional): Key for meter, used in payload decoding process. Defaults to "".
• All other options from Sensor.

2.2. wmbusgw

NOTE: Please switch to wmbus

3. Author & License

Szczepan, GPL, 2022-2023