Node State Time Alert generator plugin

This plugin allows to monitor the time a node stays in a defined state and to notify the user, through an event, if the node exceeds the configurable permanence time in the defined state.

To add a new aler rule press on Add rule and a new configuration row will appear. Here the user has to set:

Network address - if only one network is configured in MeshCube Any network can be left, otherwise make sure to select the right network on which to configure the alert rule.
Node class - the possible choices are:
- Any class
- FA
- FB
- FC
- FE
- FF
Node address - this parameter is useful when the user is interested in monitoring one particular node. Otherwise Any node address can be selected.
State - select the operation state to monitor the node in.
Time - maximum permanence time of the node in the defined state to generate an event.
Since the minimum timeout for any state is 60 sec, the minimum configurable time is 60sec

More than one alert rule can be configured simultaneously.

After the Alert rules have been defined, save the configuration by pressing Save .
When the Alert condition is met, the system then generates an event, described below.

State alert Settings

Generated event

The event generated by this plugin is meshNodeStateTimeAlert

{
  "from_cache": `boolean`,
  "id": `string`,
  "address": `number`,
  "network_id": `number`,
  "alias": `string`,
  "device": `object`,
  "version": `string`,
  "node_class": `string`,
  "operation_mode": `string`,
  "alarm": `string`,
  "state": `string`,
  "state_time": `number`,
  "role": `string`,
  "low_latency": `boolean`,
  "autorole": `boolean`,
  "max_buffer_usage": `number`,
  "avg_buffer_usage": `number`,
  "routers_in_neighborhood": `number`,
  "scans": `number`,
  "battery": `number`,
  "nodes": {
    "timestamp": `number`,
    "travel_time": `number`,
    "count": `number`,
    "items": [
      {
        "role": `string`,
        "id": `string`,
        "network_id": `number`,
        "address": `number`,
        "rssi": `number`
      }
    ]
  },
  "routing": `object`,
  "boot_count": `number`,
  "stack_version": `string`,
  "app_version": `string`,
  "scratchpad_stored_sequence": `number`,
  "scratchpad_processed_sequence": `number`,
  "is_otap_enabled": `boolean`,
  "has_configuration": `boolean`,
  "configuration_status": `string`,
  "last_update": `number`,
  "last_update_time": `number`,
  "last_update_elapsed": `object`,
  "status": `string`
}

Event fields description

`from_cache`

The node was loaded from the system cache and no update was received by the system from last restart.

A node can be from_cache only after a system reboot.

`id`

The node unique identifier, composed by:

The node type prefix: S Sink, R Router node, N Non Router node.
The node address
The network address

`address`

The node address

`network_id`

The node network identifier

`alias`

Alias assigned to the node.

The system does not check whether this value is not unique across the same network.

`device`

Object containing the description of the node, composed by:

model: model number
name: model name
serial: serial number

`node_class`

Field specifying the class of the node:

F9: default Anchor class
FA: default Asset Tag class
FB: default Personal Tag class

`operation_mode`

Field defining the operational mode of the tag. The possible modes are:

For Tags:
- NRLS mode: the tag is in sleep mode between consecutive updates of the tag
- Autoscan mode: the tag is continuously connected to the network
For Anchors:
- Opportunistic mode: the anchor is continuously connected to the network

`alarm`

Field specifying the type of alarm active on the device.

`state`

Field specofying the state of the tag. The possible states are:

sleep
default
motion
alarm

For full description of Mesh Tags states refer to the manual relative to Wirepas Firmware v.3.x on the support center.

`state_time`

Reports for how long the node has been in that given state.

`role`

Defines the role of the tag:

Sink node
Router node
Non router node

`nodes`

Object containing the number an the list of nodes that detect the device that generated the event. For each node is specified:

node_role: sink or router node
id: id of the node
network_id
address
rssi: measured rssi between the node and the device

`routing`

Object containing information about the routing of the signal from the device to the sink.

`has_configuration`

Field with booleann response specifying whether the tag has a configuration set.

`configuration_status`

Field specifying is the configuration set on the network matches the one that is present on the device.

`status`

Field specifying the status of the node, that can be:

online
offline