Channel attributes

Abstract

Channels can have the following attributes. Not each channel have all, only if the attribute makes sense.

Name ^(required)

• Type : string

Unique channel name, will be shown in tree definition overview and charts definition view.

Description

• Type : string

Long description, will be shown in tree definition overview and charts definition view.

Serial

• Type : string

Unique sensor serial number, if supported or required by channel type.

Channel

• Type : string

Channel name for multi sensors.

Resolution

• required
• Type : numeric
• Default : 1

On data readout the stored/calculated reading will multiplied with this factor.

Unit

• Type : string

Channel unit, will be shown in tree definition overview and charts definition view.

Decimals

• Type : integer
• Default : 2

Decimals for value output and charting.

The API will always return raw data, not rounded!

Meter

• Type : numeric (boolean)
• Default : 0

Meter channels stores raising values.

This attribute must be defined manually only for a few channels, most channel types pre-define this.

Numeric

• Type : numeric (boolean)
• Default : 1

Channels can have numeric or alphanumeric data.

Offset

• Type : numeric

This offset will be applied during readout to the reading values to correct them.

Adjust

• Type : numeric (boolean)
• Default : 0

Adjust channel offset (for meter channels only) automatic, if the actual reading value is lower than last reading but <> 0.

Use this, if your measuring equipment sometimes looses/resets its counter.

Cost

• Type : numeric

Cost per unit, for meter channels only.

Threshold

• Type : numeric

A reading is only accepted, if the value is ± threshold from last reading, only relevant for writable channels.

Valid from

• Type : numeric

Readings are only valid if they are greater or equal this limit.

For writable channels invalid values skipped on saving, for calculated channels they will be skipped on readout.

Valid to

• Type : numeric

Readings are only valid if they are lower or equal this limit.

For writable channels invalid values skipped on saving, for calculated channels they will be skipped on readout.

Public

• Type : numeric (boolean)
• Default : 1

Non public channels are not accessible for not logged in visitors or without API key.

Comment

• Type : text

Internal comment, not visible anywhere else.

Dasboard channels use this for special settings.