Sign in

v1

latestOpenAPI 3.0.32026-07-171140286.6 KB
Api\SensorDefinitionController

api/sensordefinition POST Store a newly created sensordefinition

post/api/sensordefinition

Headers

Authorizationstring
Content-Typestring
Acceptstring
Accept-languagestring

Request body

namestring

Name of the sensorinstance (e.g. temperature frame 1)

insideboolean

True is measured inside, false if measured outside

offsetnumber

Measurement value that defines 0

multipliernumber

Amount of units (calibration figure) per delta Measurement value to multiply withy (value - offset)

input_measurement_idinteger

Measurement that represents the input Measurement value (e.g. 5, 3).

input_measurement_abbreviationstring

Abbreviation of the Measurement that represents the input value (e.g. w_v, or t_i).

output_measurement_idinteger

Measurement that represents the output Measurement value (e.g. 6, 3).

output_measurement_abbreviationstring

Abbreviation of the Measurement that represents the output (calculated with (raw_value - offset) * multiplier) value (e.g. weight_kg, or t_i),

device_idinteger

Device ID that the Sensordefinition belongs to. Required if hardware_id, and device_hardware_id are not set.

hardware_idstring

Device hardware ID that the Sensordefinition belongs to. Required if device_id, and device_hardware_id are not set.

device_hardware_idstring

Device hardware ID that the Sensordefinition belongs to. Required if hardware_id, and device_id are not set.

Example request

{
  "name": "nihil",
  "offset": 4.8005514,
  "multiplier": 77.910918,
  "input_measurement_id": 5,
  "input_measurement_abbreviation": "w_v",
  "output_measurement_id": 6,
  "output_measurement_abbreviation": "t_i",
  "device_id": 9,
  "hardware_id": "deleniti",
  "device_hardware_id": "eius"
}