Skip to main content

System

System events relate to the running system of the device.

Device Events#

These events apply depending on which peripherals are installed inside the dongle.

TagDescriptionFields
system/device/ec2x/gnss/assist_data_updatedGNSS assist data of the installed EC2X compatible device has been updated.-
system/device/ec2x/powered_offInstalled EC2X compatible device was powered off. Automatic power on is expected immediately after.reason

FIELD DEFINITIONS

NameTypeDescriptionExample
reasonTextThe explanatory cause for the event.-

Minion Events#

TagDescriptionFields
system/minion/readyThe Minion is started up and ready.-
system/minion/onlineThe Minion is connected to the hub.-
system/minion/offlineThe Minion is not connected to the hub.-
system/minion/restartingThe Minion is restarting because of the specified reason.reason

FIELD DEFINITIONS

NameTypeDescriptionExample
reasonTextThe explanatory cause for the event.-

Network Events#

TagDescriptionFields
system/network/wwan0/onlineThe network interface wwan0 has gone online.-
system/network/wwan0/offlineThe network interface wwan0 has gone offline.reason

FIELD DEFINITIONS

NameTypeDescriptionExample
reasonTextThe explanatory cause for the event.-

Power Events#

TagDescriptionFields
system/power/_bootingThe prefixed underscore indicates that this is a private event and should only be used for debugging purposes. The event describes the internal state of the SPM subsystem. This event may be discarded in the future.awaken, trigger
system/power/onTriggered when it is confirmed that the SPM subsystem is in on state.awaken, trigger
system/power/last_offInforms during start-up the last known timestamp where the device was last powered off. The actual timestamp is retrieved from the syslog and should only be used for debugging purposes.timestamp
system/power/recoverInforms during start-up if the device has recovered from an error condition handled by the SPM subsystem.trigger
system/power/sleepDevice went into sleep because of specifed reason.delay, interval, reason, uptime
system/power/hibernateDevice went into hibernation because of specifed reason.delay, interval, reason, uptime
system/power/3v3/restartedThe 3V3 power supply has been restarted.reason
system/power/config_failedOne or more configuration parameters of the SPM subsystem could not be loaded and have therefore been restored to default. This event only applies to SPM version 3.params

FIELD DEFINITIONS

NameTypeDescriptionExample
awakenTextThe state from which the device awakens.off, sleeping, hibernating
delayNumberDelay in seconds before execution.10
intervalNumberPlanned duration in seconds before expiration.300
reasonTextThe explanatory cause for the event.-
timestampTimestampTime to be reported.2019-03-13T11:10:14
triggerTextUnderlying cause of the event reported by the SPM subsystem.acc, boot_timeout, heartbeat_timeout, modem, rpi, spm, stn, timer
uptimeNumberSystem uptime in seconds.3745
paramsListList of parameter names.-

Release Events#

TagDescriptionFields
system/release/pendingInstalling latest release.id
system/release/forcingForce installing latest release.id
system/release/retryingRetrying installation of latest release.id
system/release/failedInstallation of latest release failed.id
system/release/updatedInstallation of latest release succeeded.id

FIELD DEFINITIONS

NameTypeDescriptionExample
idUUIDID of the concerned release.8ff5526a3dafe2fc0e80675f32755578ddaf3962

STN Events#

TagDescriptionFields
system/stn/not_connectedNot connected to STN11XX interface.-
system/stn/interface_connectedConnected to STN11XX interface.-
system/stn/bus_connectedConnected to bus using specified protocol.protocol, autodetected
system/stn/bus_disconnectedWas connected to a bus but is now disconnected.-

FIELD DEFINITIONS

NameTypeDescriptionExample
protocolTextID of the protocol.6
autodetectedBooleanHas the protocol been autodetected or not?true

Time Events#

TagDescriptionFields
system/time/syncedThe system clock was synchronized with the specifed source.new, old, source
system/time/uncertainThe system clock is not synchronized.-

FIELD DEFINITIONS

NameTypeDescriptionExample
newTimestampThe new time after synchronization.19-03-13 10:08:19
oldTimestampThe old time before synchronization.2019-03-13 10:08:30
sourceTextThe source that was synchronized against.network, ntp, rtc

RFID Events#

TagDescriptionFields
system/rfid/<rfid_token>/readA new RFID token has been read by the reader.-
system/rfid/<rfid_token>/rejectedA token that was read was rejected.-
system/rfid/<rfid_token>/authenticatedA token that was read was authenticated.valid_from, valid_for

FIELD DEFINITIONS

NameTypeDescriptionExample
valid_fromTimestampFrom what time is the token valid. The timestamp is in UTC.2019-03-13 10:08:30
valid_forNumberFor how long (in seconds) is the token valid for.7200

Short Message Service (SMS) Events#

TagDescriptionFields
system/sms/receivedA new SMS message was received.sender, timestamp, text

FIELD DEFINITIONS

NameTypeDescriptionExample
senderTextThe phone number of whoever sent the message, including country code.+4501020304
timestampTimestampThe timestamp that the message was received on. Timestamp is in UTC.2019-03-13 10:08:30
textTextThe text contained in the mesage.'An example text message.'

Hotspot Events#

TagDescriptionFields
system/hotspot/client/<mac>/connectedA client with MAC accress <mac> has connected to the device's hotspot.-
system/hotspot/client/<mac>/disconnectedA client with MAC accress <mac> has disconnected from the device's hotspot.-
system/hotspot/client/<mac>/not_connectedA client with MAC accress <mac> hasn't connected to the device's hotspot. This is only available with the custom handler hostapd.expect_allow_list_handler.-

FIELD DEFINITIONS

NameTypeDescriptionExample
macTextA Media Access Control address.2C-54-91-88-C9-E3

USB Device Events#

TagDescriptionFields
system/usb/<vendor_id>/<product_id>/connectedA USB device was connected to the AutoPi. Run usbutil.devices to get a list of currently connected devices.bus, device, name
system/usb/<vendor_id>/<product_id>/disconnectedA USB device has disconnected from the AutoPi.bus, device, name
system/usb/<vendor_id>/<product_id>/not_connectedA device with <vendor_id> and <product_id> has been specified as expected, but was not found to be connected when the device was started.-

FIELD DEFINITIONS

NameTypeDescriptionExample
busTextThe (linux) bus number the device is connected on.001
deviceTextThe device number the system has assigned to the device.001
vendorTextThe vendor hexadecimal number/ID of the device.1d6d
productTextThe product's hexadecimal number/ID of the device.0002
nameTextThe device's name.Linux Foundation 2.0 root hub

Docker Events#

We pass through the following docker events from the docker instance event stream.

  • start
  • stop
  • die
  • pull

See more information about the events here: https://docs.docker.com/engine/reference/commandline/events/

TagDescriptionFields
system/docker/container/<name>/startA container was started. This event will occur every time the device starts.release_hash, image, name, project, id, release
system/docker/container/<name>/stopA container was stopped.release_hash, image, name, project, id, release
system/docker/container/<name>/dieA container stopped unexpectedly.release_hash, image, name, project, id, release
system/docker/image/<name>/pullAn image was pulledtag, release_hash, image, name, project, id, release

FIELD DEFINITIONS

NameTypeDescriptionExample
release_hashTextThe version of the docker releasee205220a
imageTextThe name of the imageredis:bullseye
nameTextUnique name of the containerproject_name-container_name-pretty_version
projectTextProject namemy_project
idTextID of docker object40d7a9a7d6bb3c085149a45fc1874de8b4541bac7a28a46f60f734e34f52989b
releaseTextPretty version of the release1.2.3