Door sensor deep sleep for bk7231n board

[yaminahacs]

Door sensor deep sleep for bk7231n board

Describe the problem you have/What new integration you would like

Add door sensor deep sleep for bk7231n board

Please describe your use case for this integration and alternatives you've tried:

ESPHOME deep sleep not working for bk72xx platform

Additional context

[imorlxs]

I didn't know how to enable deep sleep too

[Mostalk]

My temporary solution

script:
    - id: scr
      then:
        - wifi.enable:
        - delay: 30s
        - wifi.disable:
      mode: restart
      
binary_sensor:
  - platform: gpio
    device_class: door
    name: Door
    pin: P22
    on_state:
      then:
        - script.execute: scr

[yaminahacs]

ThanksMy iPad will find youOn Dec 24, 2023, at 08:44, Ivan Shevchenko ***@***.***> wrote: My temporary solution script: - id: scr then: - wifi.enable: - delay: 30s - wifi.disable: mode: restart binary_sensor: - platform: gpio device_class: door name: Door pin: P22 on_state: then: - script.execute: scr —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you authored the thread.Message ID: ***@***.***>

[YuraBogdan]

Having functional deep sleep will help in a long run.

in mean time, I've been trying to get up to speed with the project

[grego1981]

I've implemented your solution as I'm trying to find the deep sleep code for the exact same type of sensor... Below my running ESPHome config as it works now, quite well. Please comments are needed as I'm not really sure it is efficent enough!

esphome:
  name: basement-door-sensor
  friendly_name: basement_door_sensor
  on_boot:
    priority: 10
    then:
      - switch.turn_on: batt_dv
      - script.execute: scr
bk72xx:
  board: cb3s
  framework:
    version: dev

# Enable logging
logger:

# Enable Home Assistant API
api:
  encryption:
    key: ""

ota:

wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

  # Enable fallback hotspot in case wifi connection fails
  ap:
    ssid: "Basement-Door-Sensor"
    password: "1234567890"

web_server:
  port: 80
  version: 2
  include_internal: true
  ota: true

captive_portal:

script:
    - id: scr
      then:
        - wifi.enable:
        - delay: 30s
        - wifi.disable:
      mode: restart    
binary_sensor:
  - platform: gpio
    device_class: door
    name: Door
    pin: P8
    on_state:
      then:
        - output.turn_on: light_output
        - delay: 500ms
        - output.turn_off: light_output 
        - script.execute: scr    
switch:
  - platform: gpio
    id: batt_dv
    pin: P14
sensor:
  - platform: adc
    pin: ADC3
    id: "VCC"
    name: "Battery Level"
    filters:
      - multiply: 2.4
  - platform: template
    name: "Battery Level (%)"
    unit_of_measurement: '%'
    update_interval: 240s
    lambda: |-
      return ((id(VCC).state /3.0) * 100.00);
light:
  - platform: binary
    name: "Activity LED"
    output: light_output

output:
  - id: light_output
    platform: gpio
    pin: P26

[Mostalk]

Any updates?

[0x3333]

There is some work going on the LibreTiny to support it in ESPHome, but I believe it will take some time until we have Deep Sleep for these chips.

[jon-daemon]

Does the above script work? What is the power consumption? I have two water sensors operating with 2xAAA batteries and I'd really like to replace the tuya firmware with something else.

[AlenHodnik]

grego1981's code works great.
The only thing I can't figure out is why it doesn't show me battery level correctly. Just states 0V.

[afarago]

I have found a nice deep_sleep component for bk72xx / cb3s processor.

Additionally added code for delayed deep sleep and forced manual mode as well.
I would love to see the deep_sleep code from @Xmister merged if someone has the right knowledge.

It took 2-3 days for me to fine tune this, pasting it here to share the info and love of bkn :D hope it helps someone.

# PINOUT: CB3S Module Datasheet - https://developer.tuya.com/en/docs/iot/cb3s?id=Kai94mec0s076
# UART flash with: https://github.com/libretiny-eu/ltchiptool
# UART flashing: GND(pin9),VCC3V(pin8),TX(pin16),RX(pin15) / connect CEN(pin3) to GND(pin9)
# CB3S / tuya chip - https://community.home-assistant.io/t/tuya-door-sensor-configuration/673484
# MORE INFO on the board: https://www.elektroda.com/rtvforum/topic3960149.html
# MORE INFO on the board: https://www.elektroda.com/rtvforum/topic3914412-30.html#gallery-2

### TODO & FURTHER IDEAS
# - additional pins?
# - explore manual "stored" server side update switch
# - switch off w restore LED on activate
# - support Bluetooth LE.

bk72xx:
  # board: generic-bk7231n-qfn32-tuya
  board: cb3s # FAMILY_BK7231N
  framework:
    version: dev

esphome:
  name: z-test-door
  friendly_name: z-test-door
  on_boot:
    # https://esphome.io/components/esphome.html#on-boot
    - priority: 600.0 # 600.0: This is where most sensors are set up.
      then:
        - component.update: VCC
        - switch.turn_on: batt_dv # start measuring voltage
    - priority: 100.0
      then:
        - output.turn_on: activity_led_output
    - priority: -100 # 200.0: Network connections like MQTT/native API are set up at this priority.
      then:
        - component.update: VCC
        - component.update: homeassistant_time
        - component.update: update_time
        - script.execute: scr

logger:
  # level: info

api:

globals:
  - id: first_connect_ms_int
    type: uint32_t
    initial_value: "0"

ota:
  on_begin:
    - output.turn_on: activity_led_output
  # on_progress:
  #   - output.toggle: light_output

wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password
  # fast_connect: True
  # manual_ip:
  #   gateway: 192.168.0.1
  #   static_ip: 192.168.0.212
  #   subnet: 255.255.255.0
  on_connect:
    - lambda: |-
        if (id(first_connect_ms_int) == 0) id(first_connect_ms_int) = esphome::millis();
    - component.update: first_connect_ms

web_server:
  version: 3

### we need this reset as there is no reset action with deep_sleep
### see: https://github.com/esphome/feature-requests/issues/2467 - original idea for workaround
### see: https://github.com/esphome/feature-requests/issues/1653 - feature request
script:
  - id: scr
    then:
      - deep_sleep.prevent
      # - wifi.enable:
      - delay: 10s
      # - wifi.disable:
      - script.execute: check_deep_sleep
    mode: restart
  - id: check_deep_sleep
    then:
      - deep_sleep.prevent
      - if:
          condition:
            - switch.is_off: manual_mode
          then:
            - output.turn_off: activity_led_output
            - deep_sleep.allow
    mode: restart

binary_sensor:
  - platform: gpio
    device_class: door
    name: Door
    pin:
      number: P8 # pin-13 hall sensor, GPIOP_8, which corresponds to P8 of the IC, PWM 2
      allow_other_uses: true
    on_state:
      - if:
          condition:
            - switch.is_off: manual_mode
          then:
            - output.turn_on: activity_led_output
            - delay: 1000ms
            - output.turn_off: activity_led_output
          else:
            - light.turn_on:
                id: activity_led
                effect: pulse
      - script.execute: scr
    icon: mdi:door

  - platform: gpio
    id: bottom_button
    pin:
      number: P7 # pin-14 bottom button, GPIOP_7, which corresponds to P7 of the IC, PWM 1
      inverted: true
      allow_other_uses: true
    name: "Bottom button"
    icon: mdi:button-pointer
    on_state:
      - script.execute: check_deep_sleep
    on_multi_click:
      - timing:
          - on for at least 1s
        then:
          - switch.toggle: manual_mode

switch:
  - platform: gpio
    # enables measuring voltage - see https://www.elektroda.com/rtvforum/topic3914412-30.html#gallery-2
    id: batt_dv
    pin: P14

  - platform: template
    # manual mode for OTA
    optimistic: True
    name: Manual mode
    id: manual_mode
    on_turn_off:
      - script.execute: check_deep_sleep
    on_turn_on:
      - script.execute: check_deep_sleep
      - light.turn_on:
          id: activity_led
          effect: pulse
    entity_category: config
    icon: mdi:sleep-off

light:
  # - platform: binary
  #   name: "Activity LED"
  #   output: light_output
  #   id: activity_led_output
  #   icon: mdi:lamp
  #   effects:
  #     - strobe:
  - platform: monochromatic
    name: "Activity LED"
    output: activity_led_output
    id: activity_led
    icon: mdi:lamp
    effects:
      - strobe:
      - pulse:
          transition_length:
            on_length: 1s
            off_length: 2s
          update_interval: 3s

output:
  # - id: light_output
  #   platform: gpio
  #   pin:
  #     number: P26 # P26=pin-5
  #     inverted: true
  - id: activity_led_output
    platform: libretiny_pwm
    frequency: 1000 Hz
    pin:
      number: P26 # P26=pin-5
      inverted: true

time:
  - platform: homeassistant
    id: homeassistant_time
    on_time_sync:
      then:
        - component.update: update_time

sensor:
  - platform: adc
    pin: ADC3 # ADC3 = pin-2 (internally connnected), gives valid only if "batt_dv" is enabled (see more info there)
    id: "VCC"
    name: "Battery Level"
    filters:
      - multiply: 2.4
      - clamp:
          min_value: 0.0
          max_value: 3.0
          ignore_out_of_range: true
    on_value:
      then:
        - component.update: battery_level
    icon: mdi:battery

  - platform: template
    name: "Battery Level (%)"
    unit_of_measurement: "%"
    update_interval: 86400s
    id: battery_level
    lambda: |-
      return ((id(VCC).state /3.0) * 100.00);
    icon: mdi:battery

  - platform: template
    # temporary solution to measure startup time
    name: first_connect_ms
    id: first_connect_ms
    lambda: |-
      return id(first_connect_ms_int);

  - platform: internal_temperature
    name: Internal Temperature
    icon: mdi:thermometer

text_sensor:
  - platform: template
    id: update_time
    name: "Current time"
    lambda: |-
      char str[17];
      time_t currTime = id(homeassistant_time).now().timestamp;
      strftime(str, sizeof(str), "%Y-%m-%d %H:%M", localtime(&currTime));
      return  { str };
    icon: "mdi:clock"

external_components:
  - source: github://Xmister/libretuya-esphome@deep-sleep
    components: [deep_sleep]
  # - source: github://libretiny-eu/libretiny-esphome@dev
  #   components: [ deep_sleep ]
  # - source:
  #     type: git
  #     url: https://github.com/bkaufx/esphome
  #   components: [ web_server_base ]

deep_sleep:
  id: deep_sleep_control
  sleep_duration: 24h
  run_duration: 10s
  wakeup_pins:
    - pin:
        number: P7 # pin-14 bottom button
        allow_other_uses: true
      wakeup_pin_mode: IGNORE
    - pin:
        number: P8 # pin-13 hall sensor
        allow_other_uses: true
      wakeup_pin_mode: INVERT_WAKEUP

[Xmister]

@afarago Welcome to the club 🥲 This was my initial PR to prepare the deep sleep for BKN: esphome/esphome#5739

[afarago]

@afarago Welcome to the club 🥲 This was my initial PR to prepare the deep sleep for BKN: esphome/esphome#5739

Thanks for your awesome work! Is there anything missing for the PR to be merged?
I love it and it seems to work flawlessly on my device after testing it for a few days.

[AlenHodnik]

How fast does it use batteries with this code?
All seem to work good, showing battery, deep_sleep checking, manual override, ... but it doesn't change state of the binary_sensor. Wrong pin maybe?
If I use generic tuya board (generic-bk7231n-qfn32-tuya), it's P16.
In board: cb3s, pin P8 doesn't work.

[afarago]

I have not measured the deep_sleep current, yet it should be the same as the original tuya firmware.
Power consumption seems to be almost zero after a few days.

PIN depends on your board, mine is as above in the links. You could check the integrated circuit by eyes or by a manual multimeter.

[AlenHodnik]

Found right pin. But seems smth wrong in my case. Doesnt change to open at all, battery -30% over night.