SmartSwarm 300 Series
:
63
Name
name
A description of the register function e.g. Energy Meter
The Name field is not used for any algorithmic purpose within
the Device: it will become part of the enrichment-data
published for this Register.
Alias
alias
An alternate name for the register e.g. Power Usage
The Alias field is not used for any algorithmic purpose within
the Device: it will become part of the enrichment-data
published for this Register.
Data Type
datatype
Dropdown list of data types.
See section “Data Types”.
Width
length
Register data width.
For 16 and 32-bit data types this cannot be changed. For other
types the width can be from 1 to 32.
For Enum types this is used in conjunction with Bit Offset.
Width specifies the bit-width (e.g. “4” specifies a bit-width of
4 bits) within the register;
Bit Offset specifies the starting position of those 4 bits within
the register.
Zero Value
zero_value
Zero calibration value for this register.
This is an important value in converting from the Modbus
Register Value to a context-aware Enriched Value.
The equation used to enrich the Modbus data is:
Enriched_Value = (Modbus_Register_Value
/ Scaling) + Zero_Value
See examples given below.
Max
max
The expected Maximum Enriched value for this register.
E.g. If we know that the register value represents temperature
with a maximum value of 100 degrees Celsius, the value
entered here would be “100”.
This Max field value is not used for any algorithmic purpose
within the Device. It will become part of the enrichment-data
published for this register.
It should be used as an indicator of what the maximum
enriched value is expected to be.
Exception to this rule
: For
Counter
Data Type, Max is the
rollover value of the register.
