device-20CB.yaml

# viessmann devices specification
# version 0.1 : format may vari in futur.

# links : 
#  - https://openv.wikispaces.com/Ger%C3%A4te (devices lists with device-id)
#  - https://github.com/openv/openv -> new address for OpenV forum and code (wikispaces.com will shutdown shortly
#  - https://github.com/openv/openv/wiki/Adressen    (devices addresses)
#  - 0x20CB : https://sourceforge.net/p/vcontrold/code/HEAD/tree/branches/vcontrold_fn_ipv6/xml-32/xml_p300/vito.xml
# TODO : 
# - support multiple device description, or includes.
# - add ro and rw mode for addresses

device:
  device_id:	0x20CB
  product_id:   ScotHO1
  controler:	Vitodens200

config:

  # supported types
  types: [byte, short, int4, bool, percent, addr, systime, enum]


# fields description :
# name: a name which is ruby identifyer compatible
#  - addr : field address
#  - type : type, one of : byte, short, int4, bool, percent, addr, systime, enum
#  - enum : list of textual values for type=enum ; may be different for reading and writing
#  - range : supported ranges ; may be important for user input
#  - unit
#  - cat : categories (unless now)
#  - mult : multiplier (default =1)
#  - path : path for MQTT subscribe and publish.
#  - description : textual description, in english

addr:
  norm_room_temp:
    addr:	0x2306
    type:	[byte,rw]
    range: [3, 37]
    unit:	'°'
    path:	"/settings/temp/room/normal"
    cat:	[temp, setting]
    # mult:	1   (default to 1)
    description: indoor temperature setting

  reduce_room_temp:
    addr:	0x2307
    type:	[byte,rw]
    range: [3, 37]
    unit:	'°'
    path:	"/settings/temp/room/low"
    cat:	[temp, setting]
    description: indoor temperature setting for the night and holidays

  mode:
    addr:	0x2323
    type:	[enum, rw]
    description:  active mode
    range: [0, 4]
    path:	"/settings/power/mode"
    cat:	[setting, mode]

    enums: [
     'standby',         # 0: standby mode
     'hot water',       # 1: hot water only (DHW)
     'mixte',           # 2: central heating + hot water
     'perm_reduced',    # 3: external program is displayed on controler with moon
     'perm_normal'      # 4: external program + sun
     # 'fixme',         # 5: hot water and heating
     ]

  # eco mode and party_mode lasts only 12 hours
  eco_mode:
    addr:	0x2330
    type:	[bool, rw]
    range:  [0, 1]
    cat:	[setting, mode]
    path:	"/settings/eco-mode"
    description:  economic mode

  party_mode:
    addr:	0x2331
    type:	[bool,rw]
    range:  [0, 1]
    cat:	[setting, mode]
    path:	"/settings/party-mode"
    description:  party mode 

  indoor_temp:
    addr:	0x0800
    type:	[short,ro]
    mult:	10
    unit:	'°'
    cat:	[temp, info]
    path:	"/temp/indoor"
    description:  indoor temperature

  outdoor_temp:
    addr:	0x0896
    type:	[short,ro]
    range:  [-60, 60]
    mult:	10
    unit:	'°'
    path:	"/temp/outoor"
    cat:	[temp, info]
    description:  outdoor temperature

  boiler_temp:
    addr:	0x0802
    type:	[short,ro]
    range:  [0, 150]
    mult:	10
    unit:	'°'
    path:	"/temp/boiler"
    cat:	[temp, info]
    description:  boiler temperature
  
  device_id:
    addr:	0x00F8
    type:	[addr,ro]
    cat:	[info, system]
    path:	"/sys/device-id"
    description:  device ID

  starts:
    addr:	0x088A
    type:	[int4,ro]
    range:  [0, 1150000]
    cat:	[info, system]
    path:	"/stats/sys/starts"
    description:  number of starts

  runtime:
    addr:	0x08A7
    type:	[int4,ro]
    range:  [0, 1150000]
    cat:	[info, system]
    unit:	's'
    path:	"/stats/sys/runtime"
    description:  working time in seconds

  power:
    addr:	0xA38F
    type:	[percent,ro]
    range:  [0, 100]
    mult:	2
    unit:	'%'
    path:	"/stats/heater-power"
    cat:	[info, system]
    description:  heating power in percent

  power_pump:
    addr:	0x0A3C
    type:	[percent,ro]
    range:  [0, 100]
    mult:	2
    unit:	'%'
    path:	"/stats/pump-power"
    cat:	[info, system]
    description:  pump power in percent

  hot_water_temp:
    addr:	0x0804
    type:	[short,ro]
    range:  [0, 150]
    mult:	10
    unit:	'°'
    path:	"/temp/hot-water"
    cat:	[temp, info]
    description:  hot water temperature

  hot_water_temp_set:
    addr:	0x2544
    type:	[short,ro]
    range:  [0, 150]
    mult:	10
    unit:	'°'
    path:	"/settings/temp/hot-water"
    cat:	[temp, info, fixme]
    description:  hot water temperature (fixme:addr)

  flow_temp:
    addr:	0x080C
    type:	[short,ro]
    range:  [0, 150]
    mult:	10
    unit:	'°'
    path:	"/temp/flow"
    cat:	[temp, info]
    description:  water flow temperature

  return_temp:
    addr:	0x080A
    type:	[short,ro]
    range:  [0, 150]
    mult:	10
    unit:	'°'
    path:	"/temp/return"
    cat:	[temp, info]
    description:  return water temperature

  circuit_flow_temp:
    addr:	0x080A
    type:	[short,ro]
    range:  [0, 150]
    mult:	10
    unit:	'°'
    path:	"/temp/circuit-flow"
    cat:	[temp, info, fixme]
    description:  return water temperature (fixme:addr idem hot_water_temp_set)

  flow:
    addr:	0x0C24
    type:	[short,ro]
    range:  [0, 150]
    unit:	'°'
    path:	"/temp/return"
    cat:	[temp, info]
    description:  water flow in 1/h

  exhaust_gaz_temp:
    addr:	0x0808
    type:	[short,ro]
    range:  [0, 150]
    mult:	10
    unit:	'°'
    path:	"/temp/exhaut-gaz"
    cat:	[temp, info]
    description:  exhaut gaz temperature

  boiler_output:
    addr:	0x0305
    type:	[percent,ro]
    range:  [0, 100]
    mult:	2
    unit:	'%'
    path:	"/stats/boiler-output"
    cat:	[info, system]
    description:  boiler output in %

  frost_alarm:
    addr:	0x2510
    type:	[bool, ro]
    range:  [0, 1]
    path:	"/info/alarm/frost"
    cat:	[info, system, alarm, temp]
    description:  frost alarm (danger)

  switching_valve:
    addr:	0x0A10
    type:	[byte, ro]
    range:  [0, 3]
    enum:	['undefined', 'heating', 'middle position', 'hot water']
    path:	"/info/valve/switching"
    cat:	[info, system, valve]
    description:  switching valve position

  curve_level:
    addr:	0x27D4
    type:	[short, rw]
    range:  [-13, 40]
    unit:	K
    path:	"/setting/curve/level"
    cat:	[setting, system]
    description:  heating curve level

  curve_slope:
    addr:	0x27D3
    type:	[short, rw]
    range:  [0.2, 3.5]
    mult:	10
    path:	"/setting/curve/slope"
    cat:	[setting, system]
    description:  heating curve slope

  system_time:
    addr:	0x088E
    type:	[systime, rw]
    path:	"/setting/sys/time"
    cat:	[setting, system, time]
    description:  boiler system time

# holiday/start
# $rg 0x2309 8
# 25;112;1;1;4;0;0;0;
# holiday/end
# $rg 0x2311 8
# 25;112;1;1;4;0;0;0;
#     2309, 8 bytes, (YMDxhms)
#     2311, 8 bytes, (YMDxhms)

# FIXME : to be done
#   holiday_start_time
#     addr:	0x2309
#     type:	[datetime, rw]
#     path:	"/setting/holliday/start"
#     cat:	[setting, system, time]
#     description:  holliday start date-time / heater running in eco mode
# 
#   holiday_end_time
#     addr:	0x2311
#     type:	[datetime, rw]
#     path:	"/setting/holliday/start"
#     cat:	[setting, system, time]
#     description:  holliday start date-time / heater running in eco mode
    

# link : https://gist.github.com/mqu/9519e39ccc474f111ffb
# 			:outdoor_temp_lp     => Command.new(0x5525, 2, 10, '°C', :ro, :short, 'outdoor_temp_lp',     'Outdoor temperature low-pass'),
# 			:outdoor_temp_smooth => Command.new(0x5527, 2, 10, '°C', :ro, :short, 'outdoor_temp_smooth', 'Outdoor temperature smooth (attenuated)'),
# 			:boiler_temp_lp      => Command.new(0x0810, 2, 10, '°C', :ro, :short, 'boiler_temp_lp',        'Boiler temperature low-pass'),
# 			:boiler_temp_set     => Command.new(0x555a, 2, 10, '°C', :ro, :short, 'boiler_temp_set',       'Boiler temperature setpoint'),
# 			:hot_water_temp     => Command.new(0x0804, 2, 10, '°C',  :ro, :short, 'hot_water_temp',      'Hot water temperature'),
# 			:hot_water_temp_lp  => Command.new(0x0812, 2, 10, '°C',  :ro, :short, 'hot_water_temp_lp',   'Hot water temperature low-pass'),
# 
# 			:circuit_flow_temp   => Command.new(0x2544, 2,  10, '°C', :ro, :short, 'circuit_flow_temp',  'Circuit flow temperature'),
# 			# :storage_charge_pump => Command.new(0x0845, 1,  nil,  '',  :ro, :byte, 'storage_charge_pump',  'storage charge pump'),
# 			# :circulation_pump    => Command.new(0x0846, 1,  nil,  '',  :ro, :byte, 'circulation_pump',     'circulation pump'),
# 			# :mixer_position      => Command.new(0x254C, 1,    2,  '%', :ro, :byte, 'mixer_position',      'mixer position'),
# #