esp-kyo-alarm.yaml

substitutions:
  name: esp-kyo-alarm-generic
  friendly_name: "ESP KYO Alarm Generic"

esphome:
  name: ${name}
  platform: ESP8266
  board: d1_mini
  comment: "ESP KYO alarm integration"
  includes:
    - kyo-alarm/

# Global values
globals:
  # Arm home partitions (bitfield, LSB first) as configured in alarm (IDD)
  - id: armed_home
    type: uint8_t
    restore_value: no
    initial_value: '0x1'
  # Arm night partitions (bitfield, LSB first) as configured in alarm (IID)
  - id: armed_night
    type: uint8_t
    restore_value: no
    initial_value: '0x3'
  # Arm away partitions (bitfield, LSB first) as configured in alarm (III)
  - id: armed_away
    type: uint8_t
    restore_value: no
    initial_value: '0x7'

# Disable UART logging
logger:
  baud_rate: 0
  level: INFO

# Encrypted native API
api:
  encryption:
    key: !secret api_encryption_key

# Enable Over-the-Air flash
ota:
  password: !secret ota_password

# Enable WiFi, keep captive portal disabled
wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

# Reference time
time:
  - platform: homeassistant
    id: ha_time
    timezone: Europe/Rome
    on_time_sync:
      then:
        lambda: |-
          KyoAlarmComponent* k = (KyoAlarmComponent*) kyo;
          k->onTimeSync(id(ha_time).now());

# Configure UART link to KYO alarm
uart:
  id: uart_bus
  tx_pin: GPIO5
  rx_pin: GPIO4
  baud_rate: 9600
  data_bits: 8
  parity: EVEN

# Restart buttons
button:
  - platform: restart
    name: "${friendly_name} Restart"
  - platform: safe_mode
    name: "${friendly_name} Restart (Safe Mode)"
    disabled_by_default: true

# Custom Kyo component
custom_component:
  - lambda: |-
      auto kyo = new KyoAlarmComponent(id(uart_bus));
      App.register_component(kyo);
      return {kyo};
    components:
      - id: kyo

# Text sensors
text_sensor:
  # Alarm status
  - platform: custom
    lambda: |-
      KyoAlarmComponent* k = (KyoAlarmComponent*) kyo;
      return {k->alarmStatusSensor};
    text_sensors:
      - id: kyo_alarm_status
        name: "Alarm Status"
        icon: "mdi:shield"
  # Model and firmware version
  - platform: custom
    lambda: |-
      KyoAlarmComponent* k = (KyoAlarmComponent*) kyo;
      return {k->modelSensor, k->firmwareSensor};
    text_sensors:
      - id: kyo_model
        name: "Model"
        icon: "mdi:shield-home"
        entity_category: "diagnostic"
      - id: kyo_firmware
        name: "Firmware"
        icon: "mdi:memory"
        entity_category: "diagnostic"

# Generic sensors
sensor:
  # Warning and tamper flags (used internally)
  - platform: custom
    lambda: |-
      KyoAlarmComponent* k = (KyoAlarmComponent*) kyo;
      return {k->warningSensor, k->tamperSensor};
    sensors:
      - id: kyo_warning
        name: "Warning flags"
        internal: true
      - id: kyo_tamper
        name: "Tamper flags"
        internal: true

# Binary sensors
binary_sensor:
  # Zones status
  - platform: custom
    lambda: |-
      KyoAlarmComponent* k = (KyoAlarmComponent*) kyo;
      return {&k->zoneSensor[0], &k->zoneSensor[1],
              &k->zoneSensor[2], &k->zoneSensor[3]};
    binary_sensors:
      - id: kyo_zone1
        name: "Zone 1"
        device_class: "motion"
      - id: kyo_zone2
        name: "Zone 2"
        device_class: "window"
      - id: kyo_zone3
        name: "Zone 3"
        device_class: "door"
      - id: kyo_zone4
        name: "Zone 4"
        device_class: "garage_door"

  # Warnings
  # 00000001 - Mains failure
  # 00000010 - Missing BPI
  # 00000100 - Fuse warning
  # 00001000 - Low battery
  # 00010000 - Telephone line
  # 00100000 - Default code
  # 01000000 - Wireless warning
  - platform: template
    id: kyo_warn_mains
    name: "Mains failure"
    device_class: "problem"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_warning).state) & 0x01) > 0);
  - platform: template
    id: kyo_warn_bpi
    name: "Missing BPI"
    device_class: "problem"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_warning).state) & 0x02) > 0);
  - platform: template
    id: kyo_warn_fuse
    name: "Fuse warning"
    device_class: "problem"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_warning).state) & 0x04) > 0);
  - platform: template
    id: kyo_warn_batt
    name: "Low battery"
    device_class: "problem"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_warning).state) & 0x08) > 0);
  - platform: template
    id: kyo_warn_phone
    name: "Telephone line"
    device_class: "problem"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_warning).state) & 0x10) > 0);
  - platform: template
    id: kyo_warn_code
    name: "Default code"
    device_class: "problem"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_warning).state) & 0x20) > 0);
  - platform: template
    id: kyo_warn_wireless
    name: "Wireless warning"
    device_class: "problem"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_warning).state) & 0x40) > 0);
  # Tampers
  # 00000100 - Zone tamper
  # 00001000 - False key
  # 00010000 - BPI tamper
  # 00100000 - System tamper
  # 01000000 - Jam
  # 10000000 - Wireless tamper
  - platform: template
    id: kyo_tamp_zone
    name: "Zone tamper"
    device_class: "tamper"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_tamper).state) & 0x04) > 0);
  - platform: template
    id: kyo_tamp_key
    name: "False key"
    device_class: "tamper"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_tamper).state) & 0x08) > 0);
  - platform: template
    id: kyo_tamp_bpi
    name: "BPI tamper"
    device_class: "tamper"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_tamper).state) & 0x10) > 0);
  - platform: template
    id: kyo_tamp_sys
    name: "System tamper"
    device_class: "tamper"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_tamper).state) & 0x20) > 0);
  - platform: template
    id: kyo_tamp_jam
    name: "Jam"
    device_class: "tamper"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_tamper).state) & 0x40) > 0);
  - platform: template
    id: kyo_tamp_wireless
    name: "Wireless tamper"
    device_class: "tamper"
    lambda: |-
      return((static_cast<uint8_t>(id(kyo_tamper).state) & 0x80) > 0);

# Switches
switch:
# Zones bypass switch
- platform: custom
  id: zoneSwitches
  lambda: |-
    for(int i = 0; i < 32; i++) {
        auto s = new KyoZoneSwitch(i);
        App.register_component(s);
        ((KyoAlarmComponent*) kyo)->zoneSwitches.push_back(s);
    }
    return {((KyoAlarmComponent*) kyo)->zoneSwitches};
  switches:
    - id: kyo_zone1_sw
      name: "Zone 1"
      icon: "mdi:motion-sensor"
      entity_category: "config"
      inverted: true
    - id: kyo_zone2_sw
      name: "Zone 2"
      icon: "mdi:leak"
      entity_category: "config"
      inverted: true
    - id: kyo_zone3_sw
      name: "Zone 3"
      icon: "mdi:leak"
      entity_category: "config"
      inverted: true
    - id: kyo_zone4_sw
      name: "Zone 3"
      icon: "mdi:leak"
      entity_category: "config"
      inverted: true