glp/0/{SID}/fb/dev/{Edge_Protocol_ID}/{Handle}/sts

Device status information is available in the feedback channel. The device’s status object reports various properties including the current state, whether some action is in progress, what the last error or alarm was, etc.

Device Status Objects

Field Name

Type

Notes

action

string

The name of the pending action, or null if none.

Multiple actions can be triggered in rapid succession. The processor queues the actions and executes them in the order received, or in parallel where this is possible.

Tools write to the action object to the request channel. Feedback is provided with the device’s status object through the feedback channel, and with error or warning diagnostics in the event channel if necessary.

addr

any

Contains protocol-specific addressing data. While not used by IAP, this can be useful for troubleshooting. The format of the address provided is specific to the processor.

cat

string

There are three fundamental device categories that represent a wide range of devices and applications:

i/o	Most devices are classified as input or output devices ("i/o") even if they do not serve physical actuators or sensors.
infrastructure	Infrastructure devices are those that enable the network but do not themselves provide input or output functionality and do not directly contribute to the distributed network algorithm. Examples for infrastructure devices include routers or gateway devices.
segment	The segment device category includes edge servers.

health

string

A device’s health is reported as one of these:

normal	Indicates no known problem.
suspect	Indicates that the device is under investigation, reports occasional transient problems. It is not good (normal) and neither is it outright bad (down).
down	Indicates severe problems communicating with the device. Logged events should reveal more detail.
nascent	Indicates that the device can still be reached, but not in the way intended. This typically means that the device can still be reached with its physical address but no longer responds with its logical address.

An ill health does not automatically affect the device’s state. For example, the device might still be provisioned (a state) but difficult to reach (suspect health).

interfaceType

string

Either “static”, “dynamic”. Dynamic interfaces support creation or deletion of interface blocks, properties and datapoints.

The property is optional and defaults to “static” when not present.

manufacturer

string

(Can be null) Device manufacturer’s name, where available.

product

string

(Can be null) Alphanumeric product name, where available.

routing

any

(Can be null) routing is used to help restore a network following an edge server or edge device replacement.

See the description of routing in Create Action Properties.

state

string

The state property describes the known state as provisioned, unprovisioned, or unknown.

Example: "provisioned"

type

string

A device type indicator, interpreted based on the edge protocol.
The device type indicator follows a standard program ID format.

Example: “80000112345604”

unid

string

The device’s unique identifier within its edge protocol within the segment that contains it, typically a physical address such as a MAC ID.

Example: "050301C0D0B0"

usage

string

A device application usage indicator. Possible values depend on the cat field (described above).

cat value	possible usage values
"i/o"	“controller,” “sensor”, or “mixed”
“infrastructure”	“router”, “gateway” or “other”

version

string

Application version information in the format: M.NN.BBB

Example: “1.23.031”

glp/0/17qehie/fb/sts
{
    "health":null,
    "state":"provisioned",
    "lon": {
        "ni": {
            "local": {
                "channelType":"internal"
            },
            "lon0": {
                "channelType":"TP_FT-10"
            }
        }
    },
    "mru":"2023-07-11 13:56:59.289 UTC"
}