FR: Support of more than one Lock

[henfri]

Hi again :-)

The python version supports multiple locks (https://www.mikrocontroller.net/topic/458856#8056425)
Would that be possible with the esphome version as well?

Best regards,
Hendrik

[digaus]

Try it out: #49

Have only tested with one lock yet

[digaus]

@henfri
just specify the id of which lock you want to control:

      - eqiva_key_ble.open:
          id: lock_front

Full Example

# Example: two Eqiva locks on a single ESP32, configured via input fields.
#
# Like example.yaml, each lock's mac_address / user_id / user_key (and the card_key
# used for pairing) are entered through template inputs (restored across reboots),
# not hardcoded. Each lock gets its own set of inputs, suffixed _front / _back, and
# its own eqiva_key_ble instance. Connecting is done with the connect action, which
# reads the matching inputs.
#
# Workflow per lock:
#   1. Enter the lock's mac_address (discover it via the eqiva_ble logger, see README).
#   2. Pair: enter card_key, press "Pair", hold the lock's open button 5 s. The log
#      prints the resulting user_key + user_id — copy them into the input fields.
#   3. From then on the lock connects on boot using the stored inputs.
#
# HARDWARE LIMIT: an ESP32 can only hold a few simultaneous BLE connections.
# More than ~3 permanently-connected locks is not reliable on one ESP32 — use one
# ESP32 per lock (group) instead. Every extra connection also competes for the single
# BLE radio, so connect/reconnect times get worse the more locks you add.

esphome:
  name: esphome-eqiva-twolocks
  friendly_name: esphome-eqiva-twolocks

esp32:
  variant: ESP32S3
  board: seeed_xiao_esp32s3
  flash_size: 8MB
  framework:
    type: esp-idf
    sdkconfig_options:
      CONFIG_BOOTLOADER_WDT_TIME_MS: "60000"

logger:
  hardware_uart: USB_SERIAL_JTAG

api:
  encryption:
    key: "44535345342523452354235dfasgfgdfatre="

web_server:
  port: 80
  version: 3
  local: true
  # One sorting group per lock so the web UI groups all of a lock's entities.
  sorting_groups:
    - id: group_front
      name: "Front Lock"
      sorting_weight: -20
    - id: group_back
      name: "Back Lock"
      sorting_weight: -10

ota:
  - platform: esphome
    password: "7ff7838674a21d7be6b41f404c399bd7"

safe_mode:

wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password
  ap:
    ssid: "Esphome-Eqiva-TwoLocks"
    password: "12345678"
  # Start scanning after wifi is up, then connect both locks from their inputs.
  on_connect:
    - esp32_ble_tracker.start_scan:
        continuous: true
    - eqiva_key_ble.connect:
        id: lock_front
        mac_address: !lambda 'return id(mac_address_front).state;'
        user_id: !lambda 'return id(user_id_front).state;'
        user_key: !lambda 'return id(user_key_front).state;'
    - eqiva_key_ble.connect:
        id: lock_back
        mac_address: !lambda 'return id(mac_address_back).state;'
        user_id: !lambda 'return id(user_id_back).state;'
        user_key: !lambda 'return id(user_key_back).state;'
  on_disconnect:
    - esp32_ble_tracker.stop_scan:

captive_portal:

external_components:
  - source: github://digaus/esphome-components-eqiva

esp32_ble_tracker:
  id: ble_tracker
  max_connections: 2          # one slot per lock
  scan_parameters:
    window: 300ms
    continuous: false

# Used for discovering a lock and reading its mac_address (check the logger).
eqiva_ble:

# Two lock instances. Credentials come from the inputs below, not from config.
eqiva_key_ble:
  - id: lock_front
  - id: lock_back

# ---------------------------------------------------------------------------
# Input fields, one set per lock (suffix _front / _back).
# ---------------------------------------------------------------------------
text:
  - platform: template
    name: "Front - Mac Address"
    id: mac_address_front
    icon: "mdi:info"
    mode: text
    optimistic: true
    restore_value: true
    web_server:
      sorting_group_id: group_front
  - platform: template
    name: "Front - User Key"
    id: user_key_front
    icon: "mdi:key"
    mode: text
    optimistic: true
    restore_value: true
    web_server:
      sorting_group_id: group_front
  - platform: template
    name: "Front - Pairing Card Key"
    id: card_key_front
    icon: "mdi:card-account-details"
    mode: text
    optimistic: true
    web_server:
      sorting_group_id: group_front

  - platform: template
    name: "Back - Mac Address"
    id: mac_address_back
    icon: "mdi:info"
    mode: text
    optimistic: true
    restore_value: true
    web_server:
      sorting_group_id: group_back
  - platform: template
    name: "Back - User Key"
    id: user_key_back
    icon: "mdi:key"
    mode: text
    optimistic: true
    restore_value: true
    web_server:
      sorting_group_id: group_back
  - platform: template
    name: "Back - Pairing Card Key"
    id: card_key_back
    icon: "mdi:card-account-details"
    mode: text
    optimistic: true
    web_server:
      sorting_group_id: group_back

number:
  - platform: template
    name: "Front - User ID"
    id: user_id_front
    icon: "mdi:info"
    mode: box
    min_value: 0
    max_value: 7
    step: 1
    optimistic: true
    restore_value: true
    web_server:
      sorting_group_id: group_front
  - platform: template
    name: "Back - User ID"
    id: user_id_back
    icon: "mdi:info"
    mode: box
    min_value: 0
    max_value: 7
    step: 1
    optimistic: true
    restore_value: true
    web_server:
      sorting_group_id: group_back

# ---------------------------------------------------------------------------
# Per-lock buttons: connect / disconnect / pair (each reads its own inputs).
# ---------------------------------------------------------------------------
button:
  - platform: template
    name: "Front - Connect"
    icon: "mdi:access-point-check"
    web_server:
      sorting_group_id: group_front
    on_press:
      - eqiva_key_ble.connect:
          id: lock_front
          mac_address: !lambda 'return id(mac_address_front).state;'
          user_id: !lambda 'return id(user_id_front).state;'
          user_key: !lambda 'return id(user_key_front).state;'
  - platform: template
    name: "Front - Disconnect"
    icon: "mdi:access-point-off"
    web_server:
      sorting_group_id: group_front
    on_press:
      - eqiva_key_ble.disconnect:
          id: lock_front
  - platform: template
    name: "Front - Pair"
    icon: "mdi:access-point-plus"
    web_server:
      sorting_group_id: group_front
    on_press:
      - eqiva_key_ble.pair:
          id: lock_front
          card_key: !lambda 'return id(card_key_front).state;'
          mac_address: !lambda 'return id(mac_address_front).state;'

  - platform: template
    name: "Back - Connect"
    icon: "mdi:access-point-check"
    web_server:
      sorting_group_id: group_back
    on_press:
      - eqiva_key_ble.connect:
          id: lock_back
          mac_address: !lambda 'return id(mac_address_back).state;'
          user_id: !lambda 'return id(user_id_back).state;'
          user_key: !lambda 'return id(user_key_back).state;'
  - platform: template
    name: "Back - Disconnect"
    icon: "mdi:access-point-off"
    web_server:
      sorting_group_id: group_back
    on_press:
      - eqiva_key_ble.disconnect:
          id: lock_back
  - platform: template
    name: "Back - Pair"
    icon: "mdi:access-point-plus"
    web_server:
      sorting_group_id: group_back
    on_press:
      - eqiva_key_ble.pair:
          id: lock_back
          card_key: !lambda 'return id(card_key_back).state;'
          mac_address: !lambda 'return id(mac_address_back).state;'

# ---------------------------------------------------------------------------
# Per-lock state sensors. Each block binds to one instance via eqiva_key_ble_id.
# ---------------------------------------------------------------------------
text_sensor:
  - platform: eqiva_key_ble
    eqiva_key_ble_id: lock_front
    lock_status:
      id: lock_front_state
      name: "Front - Lock State"
      web_server:
        sorting_group_id: group_front
    lock_ble_state:
      name: "Front - BLE State"
      icon: mdi:bluetooth-settings
      web_server:
        sorting_group_id: group_front
    low_battery:
      name: "Front - Low Battery"
      web_server:
        sorting_group_id: group_front
    mac_address:
      name: "Front - Connected Mac"
      web_server:
        sorting_group_id: group_front

  - platform: eqiva_key_ble
    eqiva_key_ble_id: lock_back
    lock_status:
      id: lock_back_state
      name: "Back - Lock State"
      web_server:
        sorting_group_id: group_back
    lock_ble_state:
      name: "Back - BLE State"
      icon: mdi:bluetooth-settings
      web_server:
        sorting_group_id: group_back
    low_battery:
      name: "Back - Low Battery"
      web_server:
        sorting_group_id: group_back
    mac_address:
      name: "Back - Connected Mac"
      web_server:
        sorting_group_id: group_back

# ---------------------------------------------------------------------------
# Per-lock lock entities. Actions need an explicit id: to pick the instance.
# ---------------------------------------------------------------------------
lock:
  - platform: template
    name: "Front Lock"
    icon: "mdi:lock"
    web_server:
      sorting_group_id: group_front
    lambda: |-
      if (id(lock_front_state).state == "LOCKED") return LOCK_STATE_LOCKED;
      if (id(lock_front_state).state == "UNLOCKED" || id(lock_front_state).state == "OPENED") return LOCK_STATE_UNLOCKED;
      if (id(lock_front_state).state == "MOVING") return {};
      if (id(lock_front_state).state == "UNKNOWN") return LOCK_STATE_JAMMED;
      return LOCK_STATE_LOCKED;
    lock_action:
      - eqiva_key_ble.lock:
          id: lock_front
    unlock_action:
      - eqiva_key_ble.unlock:
          id: lock_front
    open_action:
      - eqiva_key_ble.open:
          id: lock_front

  - platform: template
    name: "Back Lock"
    icon: "mdi:lock"
    web_server:
      sorting_group_id: group_back
    lambda: |-
      if (id(lock_back_state).state == "LOCKED") return LOCK_STATE_LOCKED;
      if (id(lock_back_state).state == "UNLOCKED" || id(lock_back_state).state == "OPENED") return LOCK_STATE_UNLOCKED;
      if (id(lock_back_state).state == "MOVING") return {};
      if (id(lock_back_state).state == "UNKNOWN") return LOCK_STATE_JAMMED;
      return LOCK_STATE_LOCKED;
    lock_action:
      - eqiva_key_ble.lock:
          id: lock_back
    unlock_action:
      - eqiva_key_ble.unlock:
          id: lock_back
    open_action:
      - eqiva_key_ble.open:
          id: lock_back

# ---------------------------------------------------------------------------
# Poll status of both locks periodically.
# ---------------------------------------------------------------------------
time:
  - platform: sntp
    id: sntptime
    on_time:
      - seconds: 0
        minutes: /4
        then:
          - eqiva_key_ble.status:
              id: lock_front
          - eqiva_key_ble.status:
              id: lock_back

sensor:
  - platform: internal_temperature
    name: "Internal Temperature"
    icon: mdi:thermometer
  - platform: uptime
    name: Uptime Sensor