-
-
Notifications
You must be signed in to change notification settings - Fork 0
Naming Convention
The connector uses the following naming convention for its entities:
A connector entity in the FastyBird IoT ecosystem refers to a entity which is holding basic configuration and is responsible for managing communication with devices using the FastyBird MQTT Convention.
A device in the FastyBird IoT ecosystem refers to a physical device that adheres to the FastyBird MQTT Convention.
Devices can have multiple separate components, referred to as channels. For instance, a light device might have separate channels for the switch, color, and light temperature. These channels are logically distinct from each other and can be managed independently.
A property in the FastyBird IoT ecosystem refers to a entity which is holding configuration values or device actual state. Connector, Device and Channel entity has own Property entities.
Connector related properties are used to store configuration like server address, port or credentials. This configuration
values are used to connect to MQTT broker.
Device related properties are used to store device state or to store basic device information
like hardware model or manufacturer. Some of them have to be configured to be able to use this connector or to communicate
with device. In case some of the mandatory property is missing, connector will log and error.
Channel properties are used for storing device channels states. Each device is exposing at least one channel.
Property entity is then holding physical device state value eg: state: on or off
A MQTT broker is a service which is used to handle communication between devices and FastyBird IoT connectors. You could use self-hosted applications like Mosquitto and also services provided by other vendors like HideMQ or CloudMQTT
Tip
If you find incorrect or missing information, feel free to notify us. You could use the issue tracker or mail or X network for any idea that can improve the project. Thank you for testing, reporting and contributing.
Homepage https://www.fastybird.com and repository https://github.com/fastybird/fb-mqtt-connector.