Home
Important
This documentation is meant to be used by developers or users which has basic programming skills. If you are regular user please use FastyBird IoT documentation which is available on docs.fastybird.com.
The Zigbee2MQTT Connector is an addition to the FastyBird IoT ecosystem that facilitates integration with devices using the Zigbee wireless network through the Zigbee2MQTT service. This connector enables users to effortlessly connect and control their devices using the Zigbee2MQTT service within the FastyBird IoT ecosystem, providing a convenient and intuitive interface for managing and monitoring their devices.
This connector has some services divided into namespaces. All services are preconfigured and imported into application container automatically.
\FastyBird\Connector\Zigbee2Mqtt
\API - Services and helpers related to API - for validation and data parsing
\Clients - Services which handle communication with Zigbee2MQTT service
\Commands - Services used for user console interface
\Entities - All entities used by connector
\Helpers - Useful helpers for reading values, bulding entities etc.
\Queue - Services related to connector internal communication
\Schemas - {JSON:API} schemas mapping for API requests
\Translations - Connector translations
\Writers - Services for handling request from other services
All services, helpers, etc. are written to be self-descriptive 😉.
Tip
To better understand what some parts of the connector meant to be used for, please refer to the Naming Convention page.
Tip
Physical devices needs to be mapped to FastyBird IoT ecosystem. This is done automatically during discovery process. If you need more info of how it is done, check Exposes page.
The connector is ready to be used as is. Has configured all services in application container and there is no need to develop some other services or bridges.
Tip
Find fundamental details regarding the installation and configuration of this connector on the Configuration page.
Tip
The connector features a built-in physical device discovery capability, and you can find detailed information about device discovery on the dedicated Discovery page.
This connector is equipped with interactive console. With this console commands you could manage almost all connector features.
- fb:zigbee2mqtt-connector:install: is used for connector installation and configuration. With interactive menu you could manage connector, bridges and device.
- fb:zigbee2mqtt-connector:discover: is used for direct devices discover. This command will trigger actions which are responsible for devices discovery.
- fb:zigbee2mqtt-connector:execute: is used for connector execution. It is simple command that will trigger all services which are related to communication with Zigbee2MQTT services and other FastyBird IoT ecosystem services like state storage, or user interface communication.
Each console command could be triggered like this 🤓
php bin/fb-console fb:zigbee2mqtt-connector:installNote
The path to the console command may vary depending on your FastyBird application distribution. For more information, refer to the FastyBird documentation.
The connector will attempt to map Zigbee2MQTT devices and their capabilities to the correct data types according to received exposed configuration, but there may be cases where incorrect data type is set. These issues can be corrected through the FastyBird IoT user interface.
Some of the Zigbee2MQTT devices could expose List type capability, but this capability is now not supported by this connector. If you find any device which is using this type of capability, feel free to open a feature request