Sleep Events


Signal Monitor

Monitors whether an EEG signal is present and for how long.

Name Id Mask (hex)
signal-monitor 0 0x00000001

Flags

Specifies the number of minutes the signal has been present or not present. When an even number, flags indicates the number of minutes the signal has been disconnected, using the formula:

minutes disconnected = flags / 2

When odd, flags indicates the number of minutes the signal has been present, using the formula:

minutes connected = (flags - 1) / 2

Examples

Flags Meaning
0 Signal disconnected
1 Signal detected
2 Signal not present for 1 minute.
3 Signal present for 1 minute
120 Signal not present for 1 hour.
121 Signal present for 1 hour.

Sleep Tracker/Monitor

Monitors the current sleep stage, emitting an event each time a change is detected. This event is emitted by the Sleep Tracker Stream, which needs to be enabled separately in order to generate this event.

Name Id Mask (hex)
st-monitor 1 0x00000002

Flags

Specifies the current sleep stage based on the table below:

Examples

Flags Meaning
0 No Signal
1 Awake
2 Light Sleep
3 Deep Sleep
4 REM Sleep

Movement Monitor

Monitors overt movements picked up by Aurora's accelerometer/gyroscope. This event is emitted by the Sleep Features Stream, which needs to be enabled separately in order to generate this event.

Name Id Mask (hex)
movement-monitor 2 0x00000004

Flags

Specifies the amount of movement detected since the last time the [Sleep Features Stream](/streams/derived.md#sleep-features produced an output. Movement below a certain threshold will not generate any events.

Flags Meaning
1 Minor Movement
2 Moderate Movement
3 Significant Movement

REM Stim

Emitted whenever REM Stimulation is triggered by the Sleep Tracker Stream. Consequently, the Sleep Tracker Stream must be configured and enabled before this event will be generated.

Name Id Mask (hex)
stim-presented 3 0x00000008

Flags

Specifies the number of times REM stimulation has been triggered during the current REM stage. If the current stage changes to something other than REM, this count gets reset. See the Sleep Tracker Stream for configuration options controlling stimulation delays and repeat intervals.

Flags Meaning
1 First time stimulation was triggered in the current REM stage.
4 The 4th time in a row stimulation was triggered in the current REM stage.

Awakening

Emitted whenever an awakening is detected by the Sleep Tracker Stream. Consequently, the Sleep Tracker Stream must be configured and enabled before this event will be generated.

Name Id Mask (hex)
awakening 4 0x00000010

Flags

The flags payload has no special meaning for this event and will always be set to 1.


Auto-Shutdown

This event gets emmitted immediately before the Aurora shuts down automatically, either because of a critically low battery, or because no signal has been detected. Shutdowns caused by a user action (such as removing the USB cable while in charge mode) do not generate an event.

Name Id Mask (hex)
auto-shutdown 5 0x00000020

Flags

Specifies the reason for the shutdown.

Flags Meaning
1 No signal for 5 minutes in Standalone Mode
2 No signal for 2 hours
3 Battery critically low (<= 5%)

Smart Alarm

Emitted when the configured alarm time occurs or potentially earlier if the Sleep Tracker Stream detects an opportune time to trigger the alarm based on the current configuration.

Name Id Mask (hex)
smart-alarm 6 0x00000040

Flags

The flags payload has no special meaning for this event and will always be set to 1.


results matching ""

    No results matching ""