IoT Export
...
IoT Core Data Model
Simple IoT Core

Values

20min
channel and parameter values the channel and parameter data always contain the current value, which is encapsulated in a container object there are the following internal data types for values data type description number long 64 bit integer with sign number double 64 bit floating point number with double precision and sign text string with a maximum length of 2 147 483 647 characters state representation of a state as a string color color information as a string a more detailed description with value ranges and unit is contained in the value description (descriptionid) container data all containers contain the following fields; in addition, each data type container has specific fields field data type description type string the internal data type of the value info string optional information of the channel descriptionid string the id of the value description changeable boolean flag whether the value is changeable number long simpleiotcorenumberlongvaluedto field data type description value number 64 bit integer with sign code examples simpleiotcorenumberlongvaluedto { "type" "number long", "info" "dimmer", "descriptionid" "28fe2f5c44b7eed19be6ae35d8386bce", "changeable" true, "value" 120 } number double simpleiotcorenumberdoublevaluedto field data type description value number 64 bit floating point number with double precision and sign code examples simpleiotcorenumberdoublevaluedto { "type" "number double", "info" "batteryvoltage", "descriptionid" "9dd8b5f7bc9be573a8da87e284f71afa", "changeable" true, "value" 4 2 } text simpleiotcoretextvaluedto field data type description value string string with a maximum length of 2 147 483 647 characters code examples simpleiotcoretextvaluedto { "type" "text", "info" "notes", "descriptionid" "2d6b4d84700ecd2e29b00b8482eda29c", "changeable" false, "value" "this is an example string value" } state simpleiotcorestatevaluedto field data type description value string representation of a state as a string code examples simpleiotcorestatevaluedto { "type" "state", "info" "window", "descriptionid" "5c731d9c9025dc1a943cfe8ca22103dc", "changeable" false, "value" "opened" } color simpleiotcorecolorvaluedto field data type description value string color information as hexadecimal value code examples simpleiotcorecolorvaluedto { "type" "color", "info" "dimmer", "descriptionid" "4036cbe644b0e2b0c1b689c7b6d7583c", "changeable" false, "value" "ffffff" } value description description containers are used to provide a detailed specification of how values are to be interpreted or which ranges are possible there is a description container for each internal data type in order to fulfil the specific requirements each container has its own id, which can also be used by several channels at the same time the id is the same across all systems, but may differ between software versions each container contains the following fields, and each description container also has specific fields field data type description type string the internal data type for which the description applies descriptionid string the id of the value description number long simpleiotcorenumberlongdescriptiondto field data type description minvalue number minimum value maxvalue number maximum value stepsize number optional step size when setting the value default 1 measuringunit string optional measuring unit of the value code examples simpleiotcorenumberlongdescriptiondto { "type" "number long", "descriptionid" "28fe2f5c44b7eed19be6ae35d8386bce", "measuringunit" "%", "minvalue" 0, "maxvalue" 100, "stepsize" 1 } number double simpleiotcorenumberdoubledescriptiondto field data type description minvalue number minimum value maxvalue number maximum value stepsize number optional step size when setting the value default 1 0 decimalpartdigits number optional decimal places of the value default 2 0 measuringunit string optional measuring unit of the value code examples simpleiotcorenumberdoubledescriptiondto { "type" "number double", "descriptionid" "9dd8b5f7bc9be573a8da87e284f71afa", "measuringunit" "v", "minvalue" 0 0, "maxvalue" 5 0, "stepsize" 0 1, "decimalpartdigits" 1 } text simpleiotcoretextdescriptiondto field datatype description minlength number minimum number of characters maxlength number maximum number of characters code examples simpleiotcoretextdescriptiondto { "type" "text", "descriptionid" "72cce1e3aa4eefd44f89519cf01a2b1d", "minlength" 0, "maxlength" 255 } state simpleiotcorestatedescriptiondto field data type description possiblestates array an array of strings with the possible states code examples simpleiotcorestatedescriptiondto { "type" "state", "descriptionid" "f4a95060064eaf3304240300b3a42c10", "possiblestates" \[ "opened", "closed" ] } color simpleiotcorehexcolordescriptiondto field data type description colortype string information on how the value is to be interpreted the following values are possible in the colortype field type description html hex hexadecimal color value (rrggbb) without leading hash code examples simpleiotcorehexcolordescriptiondto { "type" "color", "descriptionid" "4afc44d3b5f76bfe5c71693d861fb058", "colortype" "html hex" }