Device Events
When a significant event occurs on an OSS device, it is registered (e.g., EVENT_UPGRADE_COMPLETE). These events are reported to Azure and can be viewed in the "Raw data" tab of the OSS-connected IoT Central application.
An example of an event in the "Raw data" tab:
Below are all of the events you may encounter when using your OSS devices.
Password Management
EVENT_PASSWORD_REMOVAL_REQ
Message: NFC password removal requested!
Meaning: An NFC password removal request was initiated through the OSS Companion app, Azure, or by pressing the "MD" button three times.
Note: The "MD" button is a physical button on the OSS device's sub-assembly, and its use should be limited to developers or for password removal in the event that the associated mobile phone is unavailable, the password is forgotten, or there is no cloud connection.
EVENT_PASSWORD_REMOVAL_SUCC
Message: NFC password removed!
Note: NFC password removal will not be complete until a mobile phone makes NFC contact with the OSS device because the OSS device's NFC chip, where the NFC password is stored, is not powered by the OSS device itself but by the user's mobile phone.
Firmware Upgrade
EVENT_UPGRADE_START
Message: Over-the-air firmware download started!
EVENT_UPGRADE_FAIL
Message: Firmware download failed! Retrying.
Meaning: The checksum verification failed after all firmware chunks were downloaded. The download will restart from the first chunk.
EVENT_UPGRADE_PART_DOWNLOAD
Message: [part_num]/[total_chunks] of firmware downloaded!
Meaning: A chunk of firmware has been downloaded and appended to the firmware file.
EVENT_UPGRADE_FULL_DOWNLOAD
Message: Firmware download complete! Flashing firmware…
EVENT_UPGRADE_COMPLETE
Message: Upgrade successful! New firmware version: [app_version]
EVENT_SUPERVISOR_UPGRADE_FAIL
Message: Supervisor MCU’s firmware upgrade failed! Version mismatch detected!
Note: The Supervisor MCU acts as a controller for handling the NFC interface, powering OSS and battery management.
EVENT_SUPERVISOR_UPGRADE_SUCC
Message: The supervisor firmware MCU was upgraded successfully!
Sensor
EVENT_SENSOR_INVALID_VALUE
Message: [parameter] value out of range! [parameter]: [value]
Meaning: A sensor reading was outside the predefined range.
Defined ranges:
- Temperature: -40 to 85°C
- Humidity: 0% to 100%
- CO2: 1 to 10,001 ppm
EVENT_SENSOR_TIMEOUT
Message: Unable to read sensor parameters!
Meaning: The system made three failed attempts to read sensor data.
EVENT_SENSOR_NOT_FOUND
Message: Unable to detect the sensor pod or the sensor pod did not boot!
EVENT_SENSOR_UPGRADE_FAIL
Message: Sensor pod’s firmware upgrade failed! Version mismatch detected!
Meaning: The sensor pod firmware version does not match the expected value.
Device Migration
EVENT_MIGRATE_START
Message: Device migration started! Destination device ID: [device_id]
Meaning: The device migration process has started.
EVENT_MIGRATE_SUCC
Message: Device migrated! Destination device ID: [device_id]
Meaning: The device migration was successfully completed.
EVENT_MIGRATE_FAIL
Message: Device migration failed!
Meaning: Device migration failed, and reverted to the original IoT Central device entity.
EVENT_MIGRATE_INVALID_KEY
Message: Invalid primary key! Device migration will not start!
Meaning: The "Device Migrate" command failed due to an invalid primary key, and the device reverted to the original IoT Central device entity.
Advanced Command
EVENT_ADVANCED_ACCEPTED_CMD
Message: "Advanced" command “([command])” accepted!
Meaning: A valid "Advanced" command was received and executed successfully.
Note: "Advanced" commands allow extra functionality, such as calibrating CO2 levels.
EVENT_ADVANCED_REJECTED_CMD
Message: "Advanced" command “([command])” rejected!
Meaning: An invalid "Advanced" command was rejected. This could be due to typos or an unsupported command.