Endpoints
A device can have multiple sensors, functions, or channels. For example, a dimmer capable of controlling four light circuits can be said to have four distinct functions or "channels". When a user interacts with the device, they are actually interacting with one of those channels, not the entire device.
Each of these functions or channels, in Gear Studio terminology, is called an "endpoint". Endpoints have the following characteristics:
- They have a unique identifier within the device.
- They have a sensor type (temperature sensor, light, energy, volume, etc.)
- They have a description used in Gear to identify the endpoint more easily.
- They have an associated sector, indicating where they are installed or where they operate (their location within the facility).
- Depending on the sensor type, they may have other specific characteristics.
Below are some examples of endpoints in commonly used devices.
| Device | Endpoints |
|---|---|
| Temperature and humidity sensor | Endpoint 1: temperatureEndpoint 2: humidity |
| 2-channel dimmer | Endpoint 1: dimmer channel 1Endpoint 2: dimmer channel 2 |
| Electrical consumption meter | Endpoint 1: active and reactive energy meterEndpoint 2: voltage meterEndpoint 3: current meterEndpoint 4: active power meterEndpoint 5: power factor meter |
| 5-in-1 sensor (example: HPA-4416) | Endpoint 1: temperature sensorEndpoint 2: humidity sensorEndpoint 3: light sensorEndpoint 4: motion detectorEndpoint 5: door/window opening detector |
More information
For more information about device and endpoint management, see the following tutorials:
Device Control
Gear Studio allows controlling devices that support actuation, such as appliances, dimmers, thermostats, curtain controllers, and much more.
Create an endpoint
IMPORTANT: as a general rule, endpoints can only be created on devices that correspond to user-defined device models. This is because when creating devices that correspond to models built into Gear Studio, the platform automatically creates all necessary endpoints.