-
-
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 Apple HomeKit system and other FastyBird IoT ecosystem services.
A device entity in the FastyBird IoT ecosystem refers to a entity which is an entity that represents a virtual Apple HomeKit device mapped to other device connector to FastyBird IoT ecosystem.
A channel in the FastyBird IoT ecosystem refers to a entity which is mapping physical devices attributes to a virtual Apple HomeKit devices services.
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 communication port, pin code or setup id. This configuration values are used
to build Apple HomeKit gateway which is then connected to Apple HomeKit home application.
Device related properties are used to store configuration like category or type. 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 related properties are used for mapping devices attributes to virtual devices characteristics.
A service 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" service and a "humidity control" service.
A characteristic is an entity that refers to the individual attribute of a service that can be queried or manipulated. Characteristic represent specific data point that describe the state of a device or allow control over it. Examples of characteristic include temperature, humidity, on/off status, and brightness level.
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/homekit-connector.