System Events


Button Monitor

Monitors state changes to the Aurora's main push-button.

Name Id Mask (hex)
btn-monitor 16 0x00010000

Flags

State changes are specified as a mask, as the system originally supported button events that could potentially be combined and emitted within the same event occurence. This will likely change in the future however until it does, profiles and 3rd party software should account for event emissions that contain a mask of 1 or more of the below button states.

Flags / Mask Meaning
1 Button pressed.
2 Button released.
4 Button held short (750ms-3s)
8 Button held medium (3s-7s)
16 Button held long (>7s)
32 Button released and inactive for ~3s

SD Card Monitor

Monitors state changes to the Aurora's SD card system.

Name Id Mask (hex)
sd-monitor 17 0x00020000

Flags

Specifies the current SD card system state based on the table below:

Flags / Mask Meaning
0 SD card disconnected / system disabled.
1 SD card system connecting / mounting.
2 SD card connected and ready.
3 SD card system pausing.
4 SD card system paused.
5 SD card system disconnecting.

USB Monitor

Monitors state changes to the Aurora's USB system.

Name Id Mask (hex)
usb-monitor 18 0x00040000

Flags

Specifies the current USB system state based on the table below:

Flags / Mask Meaning
0 USB cable disconnected / system disabled.
1 USB system transitioning to idle.
2 USB system idle. (i.e. cable connected without host connection)
3 USB system connecting to host via virtual COM port.
4 USB VCOM host connected.
5 USB system connecting to host as a Mass Storage Device.
6 USB connected to host in Storage Mode.
7 USB system disconnecting from host as a Mass Storage Device.
8 USB system disconnected from host as a Mass Storage Device.
9 USB system transitioning to disconnected state.

Battery Monitor

Monitors changes to the current battery level. Emitted only when at least a 5% change in battery level is detected, at most once every 5 seconds.

Name Id Mask (hex)
batt-monitor 19 0x00080000

Flags

Specifies the current battery level as a percentage in 5% intervals.

Examples

Flags Meaning
5 Battery level at 5%. (critically low)
25 Battery level at 25%. (low)
100 Battery fully charge.

Profile Monitor

Monitors when profiles are loading/loaded and unloading/unloaded.

Name Id Mask (hex)
prof-monitor 22 0x00400000

Flags

Specifies the current profile state based on the table below:

Flags / Mask Meaning
0 Profile is loading.
1 Profile loaded.
2 Profile is unloading.
3 Profile unloaded.

Clock Alarm Fire

Emitted when a configured system alarm is fired. See clock-alarm-set for information on how to configure an alarm.

Name Id Mask (hex)
clock-alarm-fire 27 0x08000000

Flags

Specifies the alarm id that has fired as a mask. A mask is used since potentially more than one alarm could be configured to go off at the same time.

Flags / Mask Meaning
1 Alarm 0 fired
2 Alarm 1 fired

Clock Timer0 Fire

Emitted when Timer0 fires. See clock-timer-set for information on how to configure a system timer.

Name Id Mask (hex)
clock-timer0-fire 28 0x10000000

Flags

Specifies the number of times timer0 has fired since it was set.


Clock Timer1 Fire

Emitted when Timer1 fires. See clock-timer-set for information on how to configure a system timer.

Name Id Mask (hex)
clock-timer1-fire 29 0x20000000

Flags

Specifies the number of times timer1 has fired since it was set.


Clock Timer2 Fire

Emitted when Timer2 fires. See clock-timer-set for information on how to configure a system timer.

Name Id Mask (hex)
clock-timer2-fire 30 0x40000000

Flags

Specifies the number of times timer2 has fired since it was set.


Clock Timer Fire

Emitted when any timer (0-2) fires. See clock-timer-set for information on how to configure a system timer.

Name Id Mask (hex)
clock-timer-fire 31 0x80000000

Flags

Specifies the timer id that has fired as a mask. A mask is used since potentially more than one timer could be configured to go off at a the same time.

Flags / Mask Meaning
1 Timer0 fired.
2 Timer1 fired.
4 Timer2 fired.

results matching ""

    No results matching ""