Frame Parameters - Novus LogBox Wi-Fi Instruction Manual

Error Type
NOT_AUTHORIZED_ERROR
HIGH_RANGE_ERROR
LOW RANGE ERROR
INVALID_VALUE_ERROR
ALARM_DISABLED_ERROR
CHANNEL_DISABLED_ERROR
EVENT_CHANNEL_ERROR
INVALID_STRING_ERROR
PARSE_ERROR
7.3

FRAME PARAMETERS

The following is a list of permissible parameters within each frame:
PARAMETER
alarm_high
alarm_low
battery
buzzer_state
channels_enabled
config_received
event_type
error_type
firmware_version
frame_format
gmt
hash
ip
lqi
mac
model
millisecond
n_channels
parameter
serial
sp_alarm_low
sp_alarm_high
tag_channels
tag_units
NOVUS AUTOMATION
Unauthorized parameter for writing.
Error in the setpoint value of the upper alarm of a channel.
Error in the value of the lower alarm setpoint of a channel.
Error for values outside parameter range.
Error resulting from attempting to change the setpoint of an alarm disabled.
Error resulting from attempting to change the alarm setpoint of a disabled channel.
Error resulting from attempting to change the setpoint on the digital channel when it is set to "Event Log".
Error resulting from attempting to place an invalid key in the parameter.
Error in the JSON frame parse.
Table 06 – Error type
Informs which channels are in alarm. See the
information on how boolean variables work.
Informs which channels are in the upper alarm. See the
information on how boolean variables work.
Informs the current voltage of the battery in volts and with two decimal places.
Informs whether or not the buzzer is in alarm. See the
information on how boolean variables work.
Reports the number of active channels on the device.
If it is active or configured as static, the digital channel in "Pulse Count" mode will always be the first item
in the array. The array order of the channels is: Digital channel, analog channel 1, analog channel 2 and
analog channel 3.
See the Boolean Format section of this chapter for more information on how boolean variables work.
Informs if the configuration was successfully sent or if there was an error during the process.
Informs the event counting edge: Rising edge, Rising edge, or both edges.
Permissible only for the digital channel and configurable through the NXperience software (see the
chapter Configuration Software).
Reports the type of error encountered during the attempt to execute the command. See Table 06 in this
chapter for more information on error types.
Informs the firmware version of the device.
Informs the type of JSON format defined for the frame. See the
for more information on frame formats.
Informs GMT in minutes.
Informs the generated key by setting or changing any device parameters. It acts as a kind of
configuration password applied to the device and is widely used in validated systems.
Informs the IP device.
Informs the quality of your Wi-Fi connection.
Informs the MAC address of the device.
Informs the device model.
Informs in how many milliseconds the log event happened. You can supplement the timestamp
parameter.
Informs the numbers of the device channels.
Informs the parameter in which was change according to the sent topic.
Informs the device's serial number.
Informs the lower alarm setpoint.
Informs the upper alarm setpoint.
Informs the defined tag for each channel through NXperience software. See the
chapter for more information on how to set the tag for each channel.
Informs the unit tag defined for each channel using the NXperience software: Celsius (°C) or Fahrenheit
Description
DESCRIPTION
Boolean Format section of this chapter for more
Boolean Format section of this chapter for more
Boolean Format section of this chapter for more
JSON Format section from the chapter
Configuration Software
21/53