DscAlarm.yaml

#for documentation see project at https://github.com/Dilbert66/esphome-dsckeybus
#this is a fork modified for my setup
substitutions:
  name: "dscalarm" #unique network name
  friendlyName: "DSC Alarm" #friendly name for this device
  panelId: DSCAlarm  #used as the service variable name.
  
dsc_alarm_panel:
  id: $panelId
  #you can enter a list of user codes mapped to their names for display in armed/disarmed event messages
  usercodes: "1:Family,2:Helper,40:Master" # 
  # usercodes: "1:John,2:Sally,3:Bob" #
  
  #Only comes into effect if a password prompt occurs when arming eg. night mode
  accesscode: !secret DSC_access_code 
  
  #used to select the default partition associated with the alarm panel messages
  defaultpartition: "1" 
  
  maxzones: "64" # maximum amount of zones your system supports
  
  # dsc debug level: 0 = off, 1 = minimal, 2 = all packets shown on console  3 =  + serial port debugging
  dscdebuglevel: "0"  
   
  #zone expander addresses:
  # 9  - zones 9-16
  # 10 - zones 17-24
  # 11 - zones 25-32
  # 12 - zones 33-40 (for systems with 64 zone support)
  # 13 - zones 41-48 (for systems with 64 zone support)
  # 14 - zones 49-56 (for systems with 64 zone support)
  # 16 - zones 57-64 (for systems with 64 zone support)  
  expanderaddr1: "0" # 1st zone expander emulator address to use . Set to 0 to disable. 
  expanderaddr2: "0" # 2nd expander emulator address to use . Set to 0 to disable. 

  ##ESP32 Pins
  dscclockpin: "21"
  dscreadpin: "22"
  dscwritepin: "05"
  
  ##ESP8266 Pins
  #dscclockpin: "5"
  #dscreadpin: "4"
  #dscwritepin: "15" 
  

  clean_build: "false" #default is false.  set to true if getting duplication errors in linking step.  

esp32: 
  board: nodemcu-32s
  framework: 
    type: arduino
    version: recommended

#esp8266:    
  #board: nodemcuv2
  #framework:
    #version: recommended 

#location of alarm panel code.  You can use the github release version  or 
#copy the code to directory "my_components" in your main esphome directory   
# see here for more info: https://esphome.io/components/external_components       
external_components:
  - source: github://brucehat/esphome-components@main #uncomment to use github repository
  #- source:  my_components #uncomment to use local directory 
    components: [dsc_alarm_panel,binary_sensor,text_sensor] 
    refresh: 10min
  
esphome:
  name: $name
  friendly_name: $friendlyName

#output sympols to output.map for debugging. You can remove if not needed
  platformio_options:
    build_flags: 
        - "-Wl,-Map,output.map"  

#you can remove/disable this section if you don't want your panel time updated automatically  
interval:
  - interval: 7200s
    then:
      - lambda: |-
          $panelId->set_panel_time();
  
wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password
  
  ap:
    ssid: "$name"
    password: !secret wifi_password

logger:
  baud_rate: 115200
  level: DEBUG

api:
   encryption:
    key: !secret DSC_api_encryption_key
    
    
#to use mqtt disable the api: section above. This enables you to use esphome with 
#non homeassistant systems
#modify the mqtt section to your needs
#See: https://esphome.io/components/mqtt.html

#mqtt:
  #broker: 192.168.2.175
  #port: 1883
  #username: mqttuser
  #password: mqttuser
  #discovery_prefix: "homeassistant"
  #topic_prefix: $name
 
safe_mode: 

ota:
   platform: esphome
   password: !secret DSC_ota_password
   on_begin:
       switch.turn_off: connection_status_switch   
   
time:
 - platform: sntp


################################################################################
# Edit binary and text sensors below to suit your alarm setup. 
# The id code is entered using the "id_code:" tag.  Alternatively you can
# add the id code in round brackets  at the end of the sensor name: eg. (z1)
# You can safely add or remove any sensors as needed.

binary_sensor:
### zone setup ###
# zone status open/close for each zone 
# zone id code = z+zone number  
  - platform: template
    id_code: z1
    name: "Front door (z1)"
    device_class: door
    publish_initial_state: true        

  - platform: template
    id_code: z2
    name: "Entrance Area (z2)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z3  
    name: "Play Room (z3)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z4  
    name: "Play Room Door (z4)"
    device_class: door
    publish_initial_state: true         

  - platform: template
    id_code: z5
    name: "Lounge (z5)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z6  
    name: "Lounge Door (z6)"
    device_class: door
    publish_initial_state: true         

  - platform: template
    id_code: z7  
    name: "Dining Room (z7)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z8  
    name: "Dining Room Door (z8)"
    device_class: door
    publish_initial_state: true        

  - platform: template
    id_code: z17
    name: "Kitchen Wall (z17)"
    device_class: motion
    publish_initial_state: true        

  - platform: template
    id_code: z18  
    name: "Kitchen Window (z18)"
    device_class: motion
    publish_initial_state: true        

  - platform: template
    id_code: z19  
    name: "Vegetable Garden (z19)"
    device_class: motion
    publish_initial_state: true        

  - platform: template
    id_code: z20  
    name: "Atrium Door (z20)"
    device_class: door    
    publish_initial_state: true        

  - platform: template
    id_code: z21
    name: "Garage Internal (z21)"
    device_class: motion
    publish_initial_state: true        

  - platform: template
    id_code: z22
    name: "Linen Room (z22)"
    device_class: window
    publish_initial_state: true         

  - platform: template
    id_code: z23  
    name: "Shower Door (z23)"
    device_class: door
    publish_initial_state: true         

  - platform: template
    id_code: z24  
    name: "Garage Outside (z24)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z25
    name: "Patio Garden (z25)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z26  
    name: "Pool Garden (z26)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z33  
    name: "Family Room (z33)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z34  
    name: "Family Room Door (z34)"
    device_class: door
    publish_initial_state: true        

  - platform: template
    id_code: z35
    name: "Kitchen Door (z35)"
    device_class: door
    publish_initial_state: true        

  - platform: template
    id_code: z36  
    name: "Kitchen (z36)"
    device_class: motion
    publish_initial_state: true        

  - platform: template
    id_code: z37  
    name: "Outside Playroom (z37)"
    device_class: motion
    publish_initial_state: true        

  - platform: template
    id_code: z38  
    name: "Cameron Room Door (z38)"
    device_class: door    
    publish_initial_state: true        

  - platform: template
    id_code: z39
    name: "Main Bed Door (z39)"
    device_class: door
    publish_initial_state: true        

  - platform: template
    id_code: z40
    name: "Spare Room Door (z40)"
    device_class: door
    publish_initial_state: true         

  - platform: template
    id_code: z41  
    name: "Main Bedroom (z41)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z42  
    name: "Upstairs Passage (z42)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z44
    name: "Outside Garage (z44)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z45  
    name: "Driveway (z45)"
    device_class: motion
    publish_initial_state: true         

  - platform: template
    id_code: z47  
    name: "Garage Door (z47)"
    device_class: door
    publish_initial_state: true         

  - platform: template
    id_code: z48  
    name: "Garage Internal Door (z48)"
    device_class: door
    publish_initial_state: true        

  - platform: template
    id_code: z49
    name: "Garage Roof (z49)"
    device_class: motion
    publish_initial_state: true        

  - platform: template
    id_code: z50  
    name: "Main Bathroom Roof (z50)"
    device_class: motion
    publish_initial_state: true        

  - platform: template
    id_code: z51  
    name: "Upstairs Patio (z51)"
    device_class: motion
    publish_initial_state: true        
      
### non zone sensors ###
# partition ready indicators
# ready id code = rdy_ + partition number
  - platform: template
    id_code: rdy_1  
    name: "Partition 1 Ready (rdy_1)"
    publish_initial_state: true        

  - platform: template
    id_code: rdy_2  
    name: "Partition 2 Ready (rdy_2)"    
    publish_initial_state: true        

# partition arm indicators
# arm id code = arm_ + partition number
  - platform: template
    id_code: arm_1  
    name: "Partition 1 Armed (arm_1)"
    publish_initial_state: true        

  - platform: template
    id_code: arm_2  
    name: "Partition 2 Armed (arm_2)"   
    publish_initial_state: true         

# panel trouble status indicator
# trouble id code = tr
  - platform: template
    id_code: tr  
    name: "Trouble Status (tr)"
    device_class: problem
    publish_initial_state: true        

# bat id code = bat
# panel battery status indicator
  - platform: template
    id_code: bat  
    name: "Battery Status (bat)"
    device_class: problem
    publish_initial_state: true        

# ac id code = ac
# panel AC power indicator
  - platform: template
    id_code: ac  
    name: "AC Status (ac)"
    device_class: plug
    publish_initial_state: true        
    
# partition fire alarm indicators
# fire id code = fa_ + partition number  
  - platform: template
    id_code: fa_1  
    device_class: smoke
    name: "Fire partition 1 Status (fa_1)"
    publish_initial_state: true        
    
  - platform: template
    id_code: fa_2  
    device_class: smoke
    name: "Fire partition 2 Status (fa_2)"  
    publish_initial_state: true          

# partition in alarm indicators
# alarm id code = al_ + partition number  
  - platform: template
    id_code: al_1  
    name: "partition 1 Alarm Status (al_1)"
    publish_initial_state: true        
    
  - platform: template
    id_code: al_2  
    name: "partition 2 Alarm Status (al_2)"  
    publish_initial_state: true        
    
# relay PGM channels. Will show the state of the activate relay channel on/off
# relay id code = r + channel number
  - platform: template
    id_code: r1  
    name: "PGM 1 (r1)"
    publish_initial_state: true        

  - platform: template
    id_code: r2  
    name: "PGM 2 (r2)"
    publish_initial_state: true        

  - platform: template
    id_code: r3  
    name: "PGM 3 (r3)"
    publish_initial_state: true        

  - platform: template
    id_code: r4  
    name: "PGM 4 (r4)"
    publish_initial_state: true        

  #- platform: template
  #  name: "PGM 5 (r5)"

  #- platform: template
  #  name: "PGM 6 (r6)"

  #- platform: template
  #  name: "PGM 7 (r7)"

  #- platform: template
  #  name: "PGM 8 (r8)"
              
text_sensor:
# general system status online/disconnected 
# system status id code = ss
  - platform: template
    id_code: ss  
    name: "System Status (ss)"
    icon: "mdi:shield"

# battery level status for wireless channels, tamper , in alarm, etc for individual zones
# zone status id code = zs    
  - platform: template
    id_code: zs  
    name: "zone status (zs)"
    icon: "mdi:shield"  

# partition status ie ready/not ready, triggered, etc
# partition status id code = ps_ + partition number   
  - platform: template
    id_code: ps_1  
    name: "Partition 1 Status (ps_1)"
    icon: "mdi:shield"

  - platform: template
    id_code: ps_2  
    name: "Partition 2 Status (ps_2)" 
    icon: "mdi:shield"  

# more verbose message regarding the partition status. ie zones open, bypassed, etc
# partition message id code = msg_ + partition number    
  - platform: template
    id_code: msg_1  
    name: "Partition 1 Msg (msg_1)"
    icon: "mdi:alert-box"

  - platform: template
    id_code: msg_2  
    name: "Partition 2 Msg (msg_2)"
    icon: "mdi:alert-box"

# virtual lcd keypad line1 and line2 messages for each partition   
# partition line1 id code = ln1_ + partition number
# partition line2 id code = ln2_ + partition number
# partition 1
  - platform: template
    id_code: ln1_1  
    name: "line1 Partition 1 (ln1_1)"
    icon: "mdi:alert-box"

  - platform: template
    id_code: ln2_1  
    name: "line2 Partition 1 (ln2_1)"
    icon: "mdi:alert-box"  

# partition 2
  - platform: template
    id_code: ln1_2  
    name: "line1 partition 2 (ln1_2)"
    icon: "mdi:alert-box"

  - platform: template
    id_code: ln2_2  
    name: "line2 partition 2 (ln2_2)"
    icon: "mdi:alert-box" 

# generic event messages from panel
# panel event id code = evt
  - platform: template
    id_code: evt  
    name: "event (evt)"
    icon: "mdi:alert-box" 
  
# partition beeps
# beeps id code = bp_ + partition number
  - platform: template
    id_code: bp_1  
    name: "beeps (bp_1)"
    icon: "mdi:alert-box" 

  - platform: template
    id_code: bp_2  
    name: "partition 2 beeps (bp_2)"
    icon: "mdi:alert-box"   

 # panel trouble messages  
 # panel msg id code = tr_msg
  - platform: template
    id_code: tr_msg  
    name: "Trouble Msg (tr_msg)" 
    icon: "mdi:alert-box"

# this sensor below is optional - example use of pin d8 as a zone trigger pin for the emulated zone expander  
# this emulates the hardware connection for a pc5108 board. Use a pull down/pull up resistor.  Adjust logic accordingly for the correct logic output. ie invert
 # - platform: gpio  
 #   pin: D8
 #   device_class: window
 #   on_press:       #pin high=on(open), pin low=off(closed)
 #     - lambda: |-
 #         dsc.setZoneFault(17,1);  #set zone 17 as open
 #   on_release:
 #     - lambda: |-
 #         dsc.setZoneFault(17,0);  #set zone 17 as closed
 


 # end of panel sensor setup - no need to edit anything below.
##########################################################################################
switch:
    #shows status of connection status to panel.  You can disconnect before upload using the switch.
  - platform: template
    name: "Connection"
    id: connection_status_switch
    lambda: |-
      return dsc.keybusConnected;
    icon: "mdi:shield-link-variant"
    turn_on_action:
      - switch.toggle: restart_switch
    turn_off_action:
      - lambda: |-
          disconnectKeybus();

  - platform: restart
    id: restart_switch
    
  - platform: safe_mode
    name: "Safe Mode"