The term session is used to describe a period of time during which Aurora is actively monitoring (and possibly recording) data streams. The CLI command stream-session can be used to begin/end a session, which is generally the first command most profiles execute upon loading and unloading.
Whenever a session begins, a new folder of the form
YYYY-MM-DD@HHMM is created within the top-level
Within this subfolder a
session.txt file is created which stores information about the current system
configuration. Whenever a stream is enabled/disabled, information about it's current configuration along with timestamps for
when it began/ended are also saved within this
session.txt file. If these streams have file output enabled, those data
files will also be saved within the session's subfolder. Additionally, events can be configured to write to the
file when they occur during an active session. See the CLI command event-output-enable
for details about how to configure events to be output to the
Below is a short annotated
session.txt file to serve as an example:
version: 20500 # Current application firmware version date: 2018-05-19 00:44:37.145 # Timestamp when session began debug: 0 # Whether stream debugging is enabled profile.name: default.prof # Currently running profile. (Omitted if there isn't one) profile.id: F367G2 # Id of running profile streams.0.id: 1 # First enabled stream's id streams.0.file: eeg.csv # Name of the stream's data file streams.0.type: 6 # Enabled stream's data type streams.0.sample_type: 0 # Enabled stream's sample rate type streams.0.sample_rate: 128 # Enabled stream's configured sample rate value streams.0.time: 427 # Relative time (in ms) when the stream was enabled. events.0.id: 2 # Id of the first emitted event. events.0.time: 2432 # Relative time (in ms) when this event was emitted. events.0.flags: 1 # The emitted event's flags value events.1.id: 0 # Id of the second emitted event. events.1.time: 18427 # Relative time (in ms) when this event was emitted. events.1.flags: 1 # The emitted event's flags value streams.0.duration: 26186397 # How long the first enabled stream was enabled (in ms). duration: 26186695 # Total duration of the session (in ms).
session.txt file is one of the things the Aurora mobile and desktop apps transmit to our servers during a "sync" and
is required to be present if compatibility with Aurora apps is desired. This file carries the data required to graph sleep
stage changes and other important events such as when the Aurora's button was pressed or when a REM stimulation occurred.
The profiles section contains additional information about the specific events required to have
output enabled to be compatible with the official Aurora apps.