6.3 Home Assistant support

Introduction

Home Assistant support can be globally activated on the configuration web page.

• Once Home Assistant support is activated there will be the followed MQTT topics created under homeassistant.
• A running Home Assistant instance should create new entities in Home Assistant if MQTT autodiscovery is enabled.

Table of used fields / components

• X...Used
• O...Optional
• R...Required
• N...Documented, but not used

Used	Field	Type	Default	Sensor	Binary Sensor	Switch	Number	Select
	availability	list		O	O	O	O	O
	- payload_available	string	online	O	O	O	O	O
	- payload_not_available	string	offline	O	O	O	O	O
	- topic	string		O	O	O	O	O
	- value_template	template		O	O	O		O
	availability_mode	string	latest	O	O	O	O	O
	availability_template	template		O	O	O		O
X	availability_topic	string		O	O	O	O	O
X	command_template	template				O	O	O
X	command_topic	string				O	O	O
	default_entity_id	string		O	O	O	O	O
X	device	map		O	O	O	O	O
X	- configuration_url	string		O	O	O	O	O
	- connections	list		O	O	O	O	O
X	- hw_version	string		O	O	O	O	O
X	- identifiers	list | string		O	O	O	O	O
X	- manufacturer	string		O	O	O	O	O
X	- model	string		O	O	O	O	O
X	- model_id	string		O	O	O	O	O
X	- name	string		O	O	O	O	O
X	- serial_number	string		O	O	O	O	O
	- suggested_area	string		O	O	O	O	O
X	- sw_version	string		O	O	O	O	O
	- via_device	string		O	O	O	O	O
X	device_class	string		O	O	O	O
	enabled_by_default	boolean	true	O	O	O	O	O
	encoding	string	Utf-8	O	O	O	O	O
X	entity_category	string		O	O	O	O	O
	entity_picture	string		O	O	O	O	O
	expire_after	integer	0	O	O
	force_update	boolean	false	O	O
	icon	icon		O	O	O	O	O
	json_attributes_template	template		O	O	O	O	O
	json_attributes_topic	string		O	O	O	O	O
	last_reset_value_template	template		O
X	min	float	1				O
X	max	float	100				O
X	mode	string	auto				O
X	name	string		O	O	O	O	O
	off_delay	integer			O
	optimistic	boolean	true			O	O	O
X	options	list		N				R
	payload_available	string	online	O	O	O
	payload_not_available	string	offline	O	O	O
X	payload_off	string	OFF		O	O
X	payload_on	string	ON		O	O
	payload_reset	string	None				O
	platform	string		R	R	R	R	R
	retain	boolean	false			O	O	O
	suggested_display_precision	integer		O
	qos	integer	0	O	O	O	O	O
X	state_class	string		O
X	step	float	1				O
	state_off	string				O
	state_on	string				O
X	state_topic	string		R	R	O	O	O
X	unique_id	string		O	O	O	O	O
X	unit_of_measurement	string		O			O
X	value_template	template		O	O	O	O	O

The following entries should be displayed below MQTT Device

• Diagnostic - Uptime of device (DD HH:MM:SS)
• Diagnostic - Free Heap
• Diagnostic - Loop Duration
• Configuration - Restart button

MQTT Device - Sensors

• When a command is loaded with ha (true), an MQTT topic is automatically created under homeassistant.
• A running Home Assistant instance should create a new entity in Home Assistant if MQTT autodiscovery is enabled.
• According to the above data it should look like the following example.

topic: homeassistant/sensor/ebus8406ac/outdoor_temperature/config
payload:
{
  "unique_id": "ebus8406ac_01",
  "name": "outdoor temperature",
  "availability_topic": "ebus/8406ac/state/available",
  "device_class": "temperature",
  "state_topic": "ebus/8406ac/values/outdoor_temperature",
  "unit_of_measurement": "°C",
  "value_template": "{{value_json.value}}",
  "device": {
    "identifiers": "ebus8406ac"
  }
}