Skip to content
akadlec edited this page Jan 8, 2024 · 10 revisions

FastyBird

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 FastyBird IoT Tuya Connector is an extension for the FastyBird IoT ecosystem that enables seamless integration with Tuya devices. It allows users to easily connect and control Tuya devices from within the FastyBird IoT ecosystem, providing a simple and user-friendly interface for managing and monitoring your devices.

About Connector

This connector has some services divided into namespaces. All services are preconfigured and imported into application container automatically.

\FastyBird\Connector\Tuya
  \API - Services and helpers related to API - for managing data exchange validation and data parsing
  \Clients - Services which handle communication with Tuya devices or clouds
  \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
  \Services - Communication services factories
  \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.

Using Connector

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:tuya-connector:install: is used for connector installation and configuration. With interactive menu you could manage connector and devices.
  • fb:tuya-connector:discover: is used for direct devices discover. This command will trigger actions which are responsible for devices discovery.
  • fb:tuya-connector:execute: is used for connector execution. It is simple command that will trigger all services which are related to communication with Tuya devices and services with 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:tuya-connector:install

Note

The path to the console command may vary depending on your FastyBird application distribution. For more information, refer to the FastyBird documentation.

Known Issues and Limitations

Mapping DPS to Properties

When using local network mode for device discovery, the connector may not always be able to accurately detect the data types of each device's DPS (data points). In such cases, it may be necessary to manually edit the device's properties and correct their configurations.