Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

3.1 Data sets and general request scheme

...

  • Use the wizard to create a configuration template for a LIBERO Gx

    • Select the correct type of LIBERO Gx (first three numbers of the serial number are of importance)

    • Fill in the wizard forms until the summary page is reached

    • Alt+Click on the “Buy and Start Sensor” button

      • A file download fill will appear

      • Save the file with a fitting name (e.g. LIBERO_GH_longlive_freezer.json)

  • Use the POST /api/v1/Templates endpoint to upload the contents of the saved configuration JSON file

    • Important: The configuration has to be jsonJSON-escaped. Do this programatically programmatically or use an online tool

    • The request object is described in the swagger uiUI

  • Optional: Use the GET /api/v1/Templates endpoint to list all available templates

...

  • Use the PUT /api/v1/Device/{deviceSerialNumber} endpoint to configure the devices

    • One call per device. Use , use a script to automate this process

    • Three possible payloads, as denoted by $type

      • Check the swagger ui UI for more information on the specific objects

      • DeviceConfigurationRequestByTemplateId and DeviceConfigurationRequestByTemplateName can be used to configure a device

        • Optional: provide metadata, see swagger ui UI for more information on placeholders

      • DeviceConfigurationRequestClearPending can be used to clear a pending configuration for devices that have not been paired to the organization yet

3.3 Version of the REST-

...

API

For the REST-API a versioning mechanism is implemented.

...

Fieldname

Type

Description

sensorId

Int64

Id for the sensor data representing a data sink.

deviceId

String

Identifier of the device

value

Decimal

Numeric value of the measure

 

timeStamp

DateTimeOffset

DateTime of measure as timezone utc

error

String

Error message of respective sensor

status

Decimal

Status of respective sensor

unit

String

Unit Token

Possible Values:

K,°C,°F, %

unitType

String

Type of unit as text:

  • temperature

    • relative_humidity

tiltAngle

Decimal

Numeric value of the tilt angle from the device

4.3.1.1 Example Measurements

...

Code Block
languagejson
{
    "type": "eapi_measurement_new",
    "data": {
	    "sensorId": "5368"
		"deviceId": "951FF00000340",
        "timeStamp": "2022-10-11T16:21:27+00:00",
		"error":        "value"Short Circuit",
		"status": 24.60,
        "unit": "°C",
        		"unitType": “temperature",
        "deviceId		"value": "951FF00000340",
        "sensorId": "5368"  24.6,
		"tiltAngle": 2.4,
    }
}

4.3.2 GeoData

Fieldname

Type

Description

sensorId

Int64

Id for the sensor data representing a data sink.

deviceId

String

Identifier of the device

latitude

Double

Latitude with 8 digits precision

longitude

Double

Longitude with 8 digits precision

timestamp

DateTimeOffset

datetime in timezone utc

accuracy

Decimal

Accuracy in meters

...