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 FastyBird IoT Shelly Connector is an extension for the FastyBird IoT ecosystem that enables seamless integration with Shelly devices. It allows users to easily connect and control Shelly 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\Shelly
  \API - Services and helpers related to API - for managing data exchange validation and data parsing
  \Clients - Services which handle communication with Shelly 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:shelly-connector:install: is used for connector installation and configuration. With interactive menu you could manage connector and devices.
• fb:shelly-connector:discover: is used for direct devices discover. This command will trigger actions which are responsible for devices discovery.
• fb:shelly-connector:execute: is used for connector execution. It is simple command that will trigger all services which are related to communication with Shelly 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:shelly-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.

Troubleshooting

Discovery Issues

In some cases, Shelly devices may not be discovered. This is usually due to issues with mDNS service. Each Shelly device sends out multicast information, but some routers or other network components may block this communication. To resolve this issue, refer to your router's configuration and check if there are any blocks or configurations that may be blocking mDNS service.

Incorrect Mapping

The connector will attempt to map Shelly devices to the correct channels and device properties, but there may be cases where naming issues or incorrect data types occur. These issues can be corrected through the FastyBird IoT user interface.

Known Issues and Limitations

Battery-powered devices are a special type of device and must be woken up (e.g. by pressing a button) in order for them to be discovered by the connector.

Currently, generation 2 battery devices are not supported, but we are working to add support for them in the future.