Homie Node¶

class circuitpython_homie.HomieNode(name: str, node_type: str, node_id: str = None)[source]¶

A class to represent a Homie device’s individual node.

Parameters¶

name: str¶

The human friendly name of the node.

node_type: str¶

A description of the node’s type.

node_id: str = None¶

A unique identifying str to use in the generated MQTT topic. If this parameter is not specified, then the name parameter will be used (providing it conforms to Homie specifications - see validate_id()).

Warning

All attributes for this class should be considered read-only after calling HomieDevice.begin(). This is because the attributes published to the MQTT broker are not dynamically updated without calling HomieDevice.begin() after changing the attributes’ value.

name¶

The node’s human friendly name attribute.

node_id¶

The node’s ID as used in the generated MQTT topic.

properties : list[HomieProperty]¶

The node’s properties is a list of HomieProperty objects.

type¶

The node’s type attribute.