Event Reporting
ReferenceAudience: API consumerUse: look up the members, types, defaults, and limits of a configuration object
Event Configuration
cfgEventPayload
The eventConfiguration object of config_events, and of an endpoint configuration. Every flag is a boolean. A flag marked reserved is accepted, stored, and returned in read-backs, but has no effect. The support status is as the API developer states it; the contract does not mark it.
| Field | Type | Firmware support |
|---|---|---|
antenna | boolean | reserved |
terminalConnection | boolean | supported |
firmwareUpdate | boolean | supported |
gpi | boolean | reserved |
network | boolean | supported |
exceptions | boolean | reserved |
ntp | boolean | reserved |
userApp | boolean | reserved |
heartbeat | boolean | supported |
power | boolean | supported |
battery | boolean | supported |
temperature | boolean | reserved |
fileDownload | boolean | supported |
cpuUsage | boolean | reserved |
flashUsage | boolean | reserved |
ramUsage | boolean | reserved |
heartbeatConfiguration | object (heartbeatConfiguration) | |
cpuThreshold | integer | reserved |
ramThreshold | integer | reserved |
flashThreshold | integer | reserved |
temperatureThreshold | integer | reserved |
No member is required.
Changes take effect after the reader reboots. Which configuration wins when config_events and an endpoint's eventConfiguration disagree is not specified in the available sources.
heartbeatConfiguration
| Field | Type | Required | Default | Limits | Meaning |
|---|---|---|---|---|---|
interval | integer | No | max 65535 | Seconds between heartbeats | |
inventoryStatus | boolean | No | Include inventory status in each heartbeat | ||
batteryStatus | boolean | No | Include battery status in each heartbeat | ||
userApps | boolean | No | Include user-application status in each heartbeat. Not supported: no heartbeat carries it. |
alertThresholds
The four threshold members of cfgEventPayload.
| Field | Type | Required | Default | Limits | Meaning |
|---|---|---|---|---|---|
cpuThreshold | integer | No | CPU usage percentage above which an alert is raised. Reserved: accepted but has no effect. | ||
ramThreshold | integer | No | RAM usage percentage above which an alert is raised. Reserved: accepted but has no effect. | ||
flashThreshold | integer | No | Flash usage percentage above which an alert is raised. Reserved: accepted but has no effect. | ||
temperatureThreshold | integer | No | Temperature above which an alert is raised. Reserved: accepted but has no effect. |
Related: 📕 config_endpoint · 📕 config_events · 📕 Connection Parameters · 📕 Topics and Channels