Notion

@neurosity/notion › Notion

Example

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

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

Hierarchy

• Notion

Index

Constructors

• constructor

Accessors

• training

Methods

• addMarker
• brainwaves
• calm
• disconnect
• focus
• getInfo
• kinesis
• login
• logout
• predictions
• settings
• signalQuality
• status

Constructors

constructor

+ new Notion(options: NotionOptions): Notion

Defined in Notion.ts:60

Creates new instance of Notion

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

Parameters:

Name	Type	Description
options	NotionOptions

Returns: Notion

Accessors

training

• get training(): Training

Defined in Notion.ts:490

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:221

Injects an EEG marker to data stream

notion.addMarker("eyes-closed");

// later...

notion.addMarker("eyes-open");

Parameters:

Name	Type	Description
label	string	Name the label to inject

Returns: void

---

brainwaves

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

Defined in Notion.ts:279

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:

Name	Type
label	BrainwavesLabel
...otherLabels	BrainwavesLabel[]

Returns: Observable‹Epoch | PowerByBand | PSD›

Observable of brainwaves metric events

---

calm

▸ calm(): Observable‹Calm›

Defined in Notion.ts:306

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:143

Ends database connection

await notion.disconnect();

Returns: Promise‹void›

---

focus

▸ focus(): Observable‹Focus›

Defined in Notion.ts:395

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:132

const info = await notion.getInfo();

Returns: Promise‹DeviceInfo›

---

kinesis

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

Defined in Notion.ts:403

Parameters:

Name	Type
label	string
...otherLabels	string[]

Returns: Observable‹Kinesis›

Observable of kinesis metric events

---

login

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

Defined in Notion.ts:94

Starts user session

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

Parameters:

Name	Type	Description
credentials	Credentials

Returns: Promise‹void›

---

logout

▸ logout(): Promise‹void›

Defined in Notion.ts:107

Ends user session

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

Returns: Promise‹void›

---

predictions

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

Defined in Notion.ts:418

Parameters:

Name	Type
label	string
...otherLabels	string[]

Returns: Observable‹any›

Observable of predictions metric events

---

settings

▸ settings(): Observable‹Settings›

Defined in Notion.ts:365

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:325

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:443

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