Naming Convention

Naming Convention

The connector uses the following naming convention for its entities:

Connector

A connector entity in the FastyBird IoT ecosystem refers to a entity which is holding basic configuration and is responsible for managing communication with Sonoff NS Panel devices and other FastyBird IoT ecosystem services.

Device

In this connector are used three types of devices.

Gateway

A gateway device type in the FastyBird IoT ecosystem refers to a entity which is holding configuration of Sonoff NS Panel device.

Sub-Device

A sub-device type in the FastyBird IoT ecosystem refers to a entity which is representing physical device that is connected to Sonoff NS Panel device via Zigbee network.

Note

Only Zigbee devices are now supported. In future will be supported other types. It depends on Sonoff developers team

Third-party device

A third-party device in the FastyBird IoT ecosystem refers to an entity that represents virtual device which is mapped to other device connected to FastyBird IoT and allow you to be controlled via Sonoff NS Panel interface.

Channel

A channel in the FastyBird IoT ecosystem refers to a entity which is mapping devices capabilities of connected sub-devices or third-party devices like button, relay state, light state.

Property

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 Property

Connector related properties are used to store configuration like communication mode. This configuration values are used to connect to Sonoff NS Panel devices.

Device Property

Device related properties are used to store configuration like ip address, communication port or to store basic device information like hardware model, manufacturer or access credential. 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 Property

Channel related properties are used for mapping devices capabilities attributes which are properties for storing device actual state. It could be a switch state or a light brightness. These values are read from device and stored in system.

Device Capability

A capability is an entity that refers to a specific functionality or feature that a device provides. For example, a thermostat device might provide a "temperature control" capability and a "humidity control" capability.

Device Capability Attribute

A attribute is an entity that refers to the individual attribute of a capability that can be queried or manipulated. Attribute represent specific data point that describe the state of a device or allow control over it. Examples of attribute include temperature, humidity, on/off status, and brightness level.

Device Mode

There are three devices modes supported by this connector.

The first mode is Gateway mode and in this mode are NS Panels used only as gateways. In this mode will be used only sub-devices. The second mode is Device mode and in this mode are NS Panels used only to use Third-party devices, so only mapped devices are connected to NS Panel. Last mode is Both mode and this mode is combining both previous modes, so all features are available.