Skip to content
This repository has been archived by the owner on Sep 8, 2024. It is now read-only.

Latest commit

 

History

History
122 lines (118 loc) · 7.52 KB

config_json.md

File metadata and controls

122 lines (118 loc) · 7.52 KB
Raw

config.json schema documentation

Properties

  • thermostats required
    • List of controlled thermostats
    • Type: array
    • path: #config.schema.json/properties/thermostats
  • mqtt
    • MQTT Server settings
    • Type: object
    • path: #config.schema.json/properties/mqtt
    • Default: [object Object]
    • Properties
      • server
        • MQTT server name
        • Type: string
        • path: #config.schema.json/properties/mqtt/properties/server
        • Default: "localhost"
      • port
        • MQTT server port
        • Type: integer
        • path: #config.schema.json/properties/mqtt/properties/port
        • Default: 1883
        • Range: between 1 and 65534
      • user
        • user name required to connect
        • Type: string
        • path: #config.schema.json/properties/mqtt/properties/user
      • password
        • password required to connect
        • Type: string
        • path: #config.schema.json/properties/mqtt/properties/password
      • base_topic
        • base MQTT topic for all thermostats
        • Type: string
        • path: #config.schema.json/properties/mqtt/properties/base_topic
        • Default: "etrv"
      • autodiscovery
        • Enable MQTT autodiscovery for Homeassistant and OpenHab
        • Type: boolean
        • path: #config.schema.json/properties/mqtt/properties/autodiscovery
        • Default: true
      • autodiscovery_topic
        • Base autodiscovery topic name
        • Type: string
        • path: #config.schema.json/properties/mqtt/properties/autodiscovery_topic
        • Default: "homeassistant"
      • autodiscovery_retain
        • Set retain bit on autodiscovery related messages
        • Type: boolean
        • path: #config.schema.json/properties/mqtt/properties/autodiscovery_retain
        • Default: true
      • hass_birth_topic
        • Home assistant birth message (program started) topic
        • Type: string
        • path: #config.schema.json/properties/mqtt/properties/hass_birth_topic
        • Default: "hass/status"
      • hass_birth_payload
        • Home assistant birth message (program started) payload
        • Type: string
        • path: #config.schema.json/properties/mqtt/properties/hass_birth_payload
        • Default: "online"
  • options
    • Options common for all thermostats
    • Type: object
    • path: #config.schema.json/properties/options
    • Default: [object Object]
    • Properties
      • poll_interval
        • Interval between thermostat data readouts in seconds
        • Type: integer
        • path: #config.schema.json/properties/options/properties/poll_interval
        • Default: 3600
        • Range: ≥ 1
      • retry_limit
        • Limit of BLE connect attempts
        • Type: integer
        • path: #config.schema.json/properties/options/properties/retry_limit
        • Default: 5
        • Range: ≥ 0
      • stay_connected
        • Set to true in order to leave BLE connection running after polling thermostat data or setting temperature. May drain battery.
        • Type: boolean
        • path: #config.schema.json/properties/options/properties/stay_connected
        • Default: false
      • report_room_temperature
        • Set to false to disable reporting current room temperature as a separate Home Assistant sensor in MQTT auto discovery
        • Type: boolean
        • path: #config.schema.json/properties/options/properties/report_room_temperature
        • Default: true
      • setpoint_debounce_time
        • Delay in seconds between getting setpoint value over MQTT and applying it to the thermostat. Used for debouncing Home Assistant climate control behaviour.
        • Type: integer
        • path: #config.schema.json/properties/options/properties/setpoint_debounce_time
        • Default: 3
        • Range: ≥ 1

definitions

  • Type: object
  • path: #config.schema.json/definitions/thermostat
  • Properties
    • topic required
      • MQTT topic name to control this thermostat
      • Type: string
      • path: #config.schema.json/definitions/thermostat/properties/topic
      • Length: ≥ 1
    • address required
      • BLE MAC address of the thermostat in 00:00:00:00:00:00 format
      • Type: string
      • path: #config.schema.json/definitions/thermostat/properties/address
      • Length: between 17 and 17
    • secret_key required
      • Secret pairing key of the thermostat as hex string, 16 bytes, 32 hex chars
      • Type: string
      • path: #config.schema.json/definitions/thermostat/properties/secret_key
      • Length: between 32 and 32

Generated with json-schema-md-doc