Home > @ibloat/homie-ts

homie-ts package

Classes

Class	Description
ColorHSV	(BETA) Wraps HSV colors for PropertyType.COLOR property values
ColorRGB	(BETA) Wraps RGB colors for PropertyType.COLOR property values
Device	A Homie Device It holds the Nodes and is generally responsible for interactions with the broker
Node	A Device node It contains Property instances
Property	Node properties The attributes affect how the property gets advertised.

Interfaces

Interface	Description
DeviceAttributes	Device attributes
DeviceOptions	(BETA) Options for Device creation
NodeAttributes	Mandatory attributes for Nodes
NodeOptions	(BETA) Options for Node creation
PropertyOptions	(BETA) Options for Property creation

Functions

Function	Returns	Description
defaultPayload	any	(BETA) Return a default value for the supplied PropertyType
encodePayload	string	(BETA) Encodes a payload to be set as a property value on the Property topic
parsePayload	any	(BETA) Parses a payload received from MQTT
validFormat	boolean | "" | undefined	(BETA) Checks if a given format is valid for the property type

Enumerations

Enumeration	Description
Lifecycle	Valid values of a Device’s DeviceAttributes.state attribute.
PropertyType	Property types as specified by the Homie Convention
Unit	Units specified in the Homie Convention. They are not binding and the user is free to set PropertyBase.datatype to whatever they like.