Document toolboxDocument toolbox

Sensors API

This guide provides information about how to get information about your sensors connected to twinzo platfrom.

Configuration

To connect sensors with twinzo digital twin, visit the course page and find out, how to set up a sensors:

The main information about how to use twinzo´s REST API and how to authorize your access:

Swagger Sensors Section

The Swagger Sensors section provides a detailed description of the API for the sensors . We can use /sensors or /sensors/{id} for specific sensors to get information about sensors.

image-20240821-063937.png

/sensors

  • use for getting a list of sensors from branche

/sensors/{id}

  • get specific sensor’s information according to the id

Example

There are examples for both /sensors and /sensors/{id} calls below. First is the response you get and then the image with the parameters you have to call for the correct answer. The whole request URL: https://api.twinzo.eu/v3.0/sensors / https://api.twinzo.eu/v3.0/sensors/1052

/sensors

[ { "Id": 4, "Title": "Enviro S01", "Mac": "00:00:00:00:00:00", "Note": "gfsdgfdg", "SectorId": 14, "SensorData": [ ], "AreaId": 2 }, { "Id": 955, "Title": "Office3_temperature", "Mac": "00:00:00:00:00:00", "SectorId": 14, "SensorData": [ ], "AreaId": 6 }, { "Id": 1052, "Title": "off4-2", "SensorData": [ ] } ]

 

image-20240821-065333.png

/sensors/{id} (/sensors/1052)

{ "Id": 1052, "Title": "Off4-2", "SensorData": [ ] }

 

 

Data Properties

Data payload JSON object has five properties:

Id

Sensor ID

Title

Sensor´s title

MAC

MAC address of the sensor

Note

Internal note for the sensor

SectorId

Sector ID where the sensors is connected

SensorData

Data required via OData

AreaId

Area ID where the sensors is connected

If you encounter any issues or need assistance with using this product, please do not hesitate to reach out for support. Our team is here to help you resolve any problems and answer any questions you may have.
To create a support ticket, visit our support portal at https://partner.twinzo.eu/helpdesk/customer-care-1