Name | Description | Type | Additional information |
---|---|---|---|
Index |
Field index. This is used for the original 1..12 index Api (not the sen-ml). |
integer |
None. |
Channel |
The device channel the field descriptor applies to. Typically this would be 0. A device may be composed of numerous sub-components/sensors, each of these can be allocated a channel so that the measurements can be grouped by sub-component and the fieldnames can stay unique. |
integer |
None. |
Name |
Field Name. NB: This is NOT case sensitive. |
string |
None. |
Label |
Label to be used for the field. |
string |
None. |
Unit |
Field unit |
string |
None. |
Visible |
If the field should be shown. |
boolean |
None. |
IncludeOnChart |
If this field should be included on the chart for the device page. |
boolean |
None. |
Rounding |
Rounding for the field value. Number of decimal places. |
integer |
None. |
WorkingRange |
The range that normal measurements is expected to be within. |
FieldRangeDto |
None. |
AcceptableRange |
Acceptable range. |
FieldRangeDto |
None. |
Calibration |
Calibration for the field. Transforms the raw value using y=mx + c to replace the value set. Where: x is the measured value m is slope c is the offset. y is the resultant value that is stored. Stored calibrated values are NOT recalculated if the calibration is changed. |
FieldCalibrationDto |
None. |
Tags |
Tags for the field (e.g. "Humidity" where the sensor name has to be something other than Humidity. Allows grouping of field data by tag rather than device/name/label. NB: not fully implemented at this time |
Collection of string |
None. |
UseSecondAxis |
When plotting with other fields in the device fields, use the secondary Y axis. |
boolean |
None. |
YAxis |
The Y-axis to plot this field on. |
ChartAxisOption |
None. |
Links |
HyperMedia Links. ReadOnly. |
Collection of LinkDto |
None. |
IsPrimary |
If this is the primary field for the device. |
boolean |
None. |
DefaultChartType |
When showing just this field, use this chart type. |
ChartType |
None. |
StartDate |
The date of the earliest measurement for this field. |
date |
None. |
SetDeviceState |
Set the devices state (metatag) with the value from this field |
boolean |
None. |
OrderPosition |
Note: Not yet on membership. User defined position in ordered list. Default null. Fields are ordered by order position first, then additional fields by label if order position is not set. |
integer |
None. |