Notion

@neurosity/notion › Notion

Example

import { Notion } from "@neurosity/notion";

const notion = new Notion({
  deviceId: "..."
});

Hierarchy

  • Notion

Index

Constructors

Accessors

Methods

Constructors

constructor

+ new Notion(options: NotionOptions): Notion

Defined in Notion.ts:75

Creates new instance of Notion

const notion = new Notion({
  deviceId: "..."
});

Parameters:

NameTypeDescription
optionsNotionOptions

Returns: Notion

Accessors

training

• get training(): Training

Defined in Notion.ts:622

notion.training.record({
  metric: "kinesis",
  label: "push"
});

notion.training.stop({
  metric: "kinesis",
  label: "push"
});

Returns: Training

Training methods

Methods

addMarker

▸ addMarker(label: string): void

Defined in Notion.ts:353

Injects an EEG marker to data stream

notion.addMarker("eyes-closed");

// later...

notion.addMarker("eyes-open");

Parameters:

NameTypeDescription
labelstringName the label to inject

Returns: void

brainwaves

▸ brainwaves(label: BrainwavesLabel, ...otherLabels: BrainwavesLabel[]): Observable‹Epoch | PowerByBand | PSD›

Defined in Notion.ts:411

Example

notion.brainwaves("raw").subscribe(brainwaves => {
  console.log(brainwaves);
});

Example

notion.brainwaves("powerByBand").subscribe(brainwaves => {
  console.log(brainwaves);
});

Example

notion.brainwaves("psd").subscribe(brainwaves => {
  console.log(brainwaves);
});

Parameters:

NameType
labelBrainwavesLabel
...otherLabelsBrainwavesLabel[]

Returns: Observable‹Epoch | PowerByBand | PSD›

Observable of brainwaves metric events

calm

▸ calm(): Observable‹Calm›

Defined in Notion.ts:438

Example

notion.calm().subscribe(calm => {
  console.log(calm.probability);
});

// 0.45
// 0.47
// 0.53
// 0.51
// ...

Returns: Observable‹Calm›

Observable of calm events - awareness/calm alias

disconnect

▸ disconnect(): Promise‹void›

Defined in Notion.ts:232

Ends database connection

await notion.disconnect();

Returns: Promise‹void›

enableLocalMode

▸ enableLocalMode(shouldEnable: boolean): Promise‹boolean›

Defined in Notion.ts:191

Enables/disables local mode

With local mode, device metrics like brainwaves, calm, focus, etc will stream via your local WiFi network and not the default cloud server.

Local Mode is disabled by default, to enable it:

await notion.enableLocalMode(true);

To disable it:

await notion.enableLocalMode(false);

Keep in mind:

  • Activity Logging will not work while this setting is enabled.
  • Your Notion must be connected to the same WiFi network as this device to establish communication.
  • An internet connection is still needed to authenticate, get device status and add metric subscriptions.
  • This setting is not global and needs to be set for every Notion app you wish to affect.

Parameters:

NameType
shouldEnableboolean

Returns: Promise‹boolean›

focus

▸ focus(): Observable‹Focus›

Defined in Notion.ts:527

Example

notion.focus().subscribe(focus => {
  console.log(focus.probability);
});

// 0.56
// 0.46
// 0.31
// 0.39
// ...

Returns: Observable‹Focus›

Observable of focus events - awareness/focus alias

getInfo

▸ getInfo(): Promise‹DeviceInfo›

Defined in Notion.ts:150

const info = await notion.getInfo();

Returns: Promise‹DeviceInfo›

isLocalMode

▸ isLocalMode(): Observable‹boolean›

Defined in Notion.ts:163

Observes Local Mode changes

notion.isLocalMode().subscribe(isLocalMode => {
 console.log(isLocalMode);
});

Returns: Observable‹boolean›

kinesis

▸ kinesis(label: string, ...otherLabels: string[]): Observable‹Kinesis›

Defined in Notion.ts:535

Parameters:

NameType
labelstring
...otherLabelsstring[]

Returns: Observable‹Kinesis›

Observable of kinesis metric events

login

▸ login(credentials: Credentials): Promise‹void›

Defined in Notion.ts:112

Starts user session

await notion.login({
  email: "...",
  password: "..."
});

Parameters:

NameTypeDescription
credentialsCredentials

Returns: Promise‹void›

logout

▸ logout(): Promise‹void›

Defined in Notion.ts:125

Ends user session

await notion.logout();
// session has ended

Returns: Promise‹void›

predictions

▸ predictions(label: string, ...otherLabels: string[]): Observable‹any›

Defined in Notion.ts:550

Parameters:

NameType
labelstring
...otherLabelsstring[]

Returns: Observable‹any›

Observable of predictions metric events

settings

▸ settings(): Observable‹Settings›

Defined in Notion.ts:497

Observes last state of settings and all subsequent settings changes

notion.settings().subscribe(settings => {
  console.log(settings.lsl);
});

// true
// ...

Returns: Observable‹Settings›

Observable of settings metric events

signalQuality

▸ signalQuality(): Observable‹SignalQuality›

Defined in Notion.ts:457

Observes signal quality data where each property is the name of the channel and the value includes the standard deviation and a status set by the device

notion.signalQuality().subscribe(signalQuality => {
  console.log(signalQuality);
});

// { FC6: { standardDeviation: 3.5, status: "good" }, C3: {...}, ... }

Returns: Observable‹SignalQuality›

Observable of signalQuality metric events

status

▸ status(): Observable‹DeviceStatus›

Defined in Notion.ts:575

Observes last state of status and all subsequent status changes

notion.status().subscribe(status => {
  console.log(status.state);
});

// "online"
// ...

Returns: Observable‹DeviceStatus›

Observable of status metric events

← GlobalsCalm →