@neurodevs/node-lsl 12.0.4 → 12.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -38
- package/build/index.d.ts +5 -5
- package/build/index.js +5 -5
- package/build/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +5 -5
package/README.md
CHANGED
|
@@ -44,26 +44,20 @@ LSL is often used to stream EEG data over a network. For example, to instantiate
|
|
|
44
44
|
```typescript
|
|
45
45
|
import { LslStreamOutlet } from '@neurodevs/node-lsl'
|
|
46
46
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
maxBuffered: 360,
|
|
59
|
-
})
|
|
60
|
-
|
|
61
|
-
outlet.pushSample([1, 2, 3, 4, 5])
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
main().catch((error) => {
|
|
65
|
-
console.error('Error in main:', error)
|
|
47
|
+
const outlet = await LslStreamOutlet.Create({
|
|
48
|
+
name: 'Muse S (2nd gen)',
|
|
49
|
+
type: 'EEG',
|
|
50
|
+
channelNames: ['TP9', 'AF7', 'AF8', 'TP10', 'AUX'],
|
|
51
|
+
sampleRate: 256,
|
|
52
|
+
channelFormat: 'float32',
|
|
53
|
+
sourceId: 'muse-s-eeg',
|
|
54
|
+
manufacturer: 'Interaxon Inc.',
|
|
55
|
+
unit: 'microvolt',
|
|
56
|
+
chunkSize: 12,
|
|
57
|
+
maxBuffered: 360,
|
|
66
58
|
})
|
|
59
|
+
|
|
60
|
+
outlet.pushSample([1, 2, 3, 4, 5])
|
|
67
61
|
```
|
|
68
62
|
|
|
69
63
|
### LslEventMarkerOutlet
|
|
@@ -73,27 +67,21 @@ LSL is also often used to push event markers that mark different phases of an ex
|
|
|
73
67
|
```typescript
|
|
74
68
|
import { LslEventMarkerOutlet } from '@neurodevs/node-lsl'
|
|
75
69
|
|
|
76
|
-
|
|
77
|
-
const outlet = await LslEventMarkerOutlet.Create()
|
|
78
|
-
|
|
79
|
-
const markers = [
|
|
80
|
-
{ name: 'phase-1-begin', durationMs: 1000 },
|
|
81
|
-
{ name: 'phase-1-end', durationMs: 100 },
|
|
82
|
-
]
|
|
70
|
+
const outlet = await LslEventMarkerOutlet.Create()
|
|
83
71
|
|
|
84
|
-
|
|
85
|
-
|
|
72
|
+
const markers = [
|
|
73
|
+
{ name: 'phase-1-begin', durationMs: 1000 },
|
|
74
|
+
{ name: 'phase-1-end', durationMs: 100 },
|
|
75
|
+
]
|
|
86
76
|
|
|
87
|
-
|
|
88
|
-
|
|
77
|
+
// Hangs until complete
|
|
78
|
+
await outlet.pushMarkers(markers)
|
|
89
79
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
}
|
|
80
|
+
// Void promise, does not hang
|
|
81
|
+
void outlet.pushMarkers(markers)
|
|
93
82
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
})
|
|
83
|
+
// Interrupts the above pushMarkers process
|
|
84
|
+
outlet.stop()
|
|
97
85
|
```
|
|
98
86
|
|
|
99
87
|
## Test Doubles
|
|
@@ -107,8 +95,6 @@ import { LslEventMarkerOutlet, MockEventMarkerOutlet } from '@neurodevs/node-lsl
|
|
|
107
95
|
|
|
108
96
|
// In your tests / beforeEach
|
|
109
97
|
LslEventMarkerOutlet.Class = MockEventMarkerOutlet
|
|
110
|
-
|
|
111
|
-
// Must be in async
|
|
112
98
|
const mock = await LslEventMarkerOutlet.Create()
|
|
113
99
|
|
|
114
100
|
// Do something in your application that should start the outlet
|
package/build/index.d.ts
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
export * from './types.js';
|
|
2
|
-
export { default as
|
|
2
|
+
export { default as LslEventMarkerOutlet } from './impl/LslEventMarkerOutlet.js';
|
|
3
3
|
export * from './impl/LslEventMarkerOutlet.js';
|
|
4
|
-
export { default as
|
|
4
|
+
export { default as FakeEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/FakeEventMarkerOutlet.js';
|
|
5
5
|
export * from './testDoubles/EventMarkerOutlet/FakeEventMarkerOutlet.js';
|
|
6
|
-
export { default as
|
|
6
|
+
export { default as MockEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/MockEventMarkerOutlet.js';
|
|
7
7
|
export * from './testDoubles/EventMarkerOutlet/MockEventMarkerOutlet.js';
|
|
8
|
-
export { default as
|
|
8
|
+
export { default as SpyEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/SpyEventMarkerOutlet.js';
|
|
9
9
|
export * from './testDoubles/EventMarkerOutlet/SpyEventMarkerOutlet.js';
|
|
10
|
-
export { default as
|
|
10
|
+
export { default as ThrowingEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/ThrowingEventMarkerOutlet.js';
|
|
11
11
|
export * from './testDoubles/EventMarkerOutlet/ThrowingEventMarkerOutlet.js';
|
|
12
12
|
export { default as LiblslAdapter } from './impl/LiblslAdapter.js';
|
|
13
13
|
export * from './impl/LiblslAdapter.js';
|
package/build/index.js
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
export * from './types.js';
|
|
2
2
|
// EventMarkerOutlet
|
|
3
|
-
export { default as
|
|
3
|
+
export { default as LslEventMarkerOutlet } from './impl/LslEventMarkerOutlet.js';
|
|
4
4
|
export * from './impl/LslEventMarkerOutlet.js';
|
|
5
|
-
export { default as
|
|
5
|
+
export { default as FakeEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/FakeEventMarkerOutlet.js';
|
|
6
6
|
export * from './testDoubles/EventMarkerOutlet/FakeEventMarkerOutlet.js';
|
|
7
|
-
export { default as
|
|
7
|
+
export { default as MockEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/MockEventMarkerOutlet.js';
|
|
8
8
|
export * from './testDoubles/EventMarkerOutlet/MockEventMarkerOutlet.js';
|
|
9
|
-
export { default as
|
|
9
|
+
export { default as SpyEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/SpyEventMarkerOutlet.js';
|
|
10
10
|
export * from './testDoubles/EventMarkerOutlet/SpyEventMarkerOutlet.js';
|
|
11
|
-
export { default as
|
|
11
|
+
export { default as ThrowingEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/ThrowingEventMarkerOutlet.js';
|
|
12
12
|
export * from './testDoubles/EventMarkerOutlet/ThrowingEventMarkerOutlet.js';
|
|
13
13
|
// Liblsl
|
|
14
14
|
export { default as LiblslAdapter } from './impl/LiblslAdapter.js';
|
package/build/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAE1B,oBAAoB;AAEpB,OAAO,EAAE,OAAO,IAAI,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAE1B,oBAAoB;AAEpB,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AAChF,cAAc,gCAAgC,CAAA;AAE9C,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,0DAA0D,CAAA;AAC3G,cAAc,0DAA0D,CAAA;AAExE,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,0DAA0D,CAAA;AAC3G,cAAc,0DAA0D,CAAA;AAExE,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,yDAAyD,CAAA;AACzG,cAAc,yDAAyD,CAAA;AAEvE,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,8DAA8D,CAAA;AACnH,cAAc,8DAA8D,CAAA;AAE5E,SAAS;AAET,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAClE,cAAc,yBAAyB,CAAA;AAEvC,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,oCAAoC,CAAA;AAC1E,cAAc,oCAAoC,CAAA;AAElD,aAAa;AAEb,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAClE,cAAc,yBAAyB,CAAA;AAEvC,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,2CAA2C,CAAA;AACpF,cAAc,2CAA2C,CAAA;AAEzD,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,4CAA4C,CAAA;AACtF,cAAc,4CAA4C,CAAA;AAE1D,cAAc;AAEd,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,0BAA0B,CAAA;AACpE,cAAc,0BAA0B,CAAA;AAExC,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,8CAA8C,CAAA;AACzF,cAAc,8CAA8C,CAAA;AAE5D,eAAe;AAEf,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,2BAA2B,CAAA;AACtE,cAAc,2BAA2B,CAAA;AAEzC,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,gDAAgD,CAAA;AAC5F,cAAc,gDAAgD,CAAA;AAE9D,wBAAwB;AAExB,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,8BAA8B,CAAA;AAC5E,cAAc,8BAA8B,CAAA;AAE5C,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,kEAAkE,CAAA;AACvH,cAAc,kEAAkE,CAAA;AAEhF,QAAQ;AAER,OAAO,EAAE,OAAO,IAAI,2BAA2B,EAAE,MAAM,8CAA8C,CAAA"}
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -2,19 +2,19 @@ export * from './types.js'
|
|
|
2
2
|
|
|
3
3
|
// EventMarkerOutlet
|
|
4
4
|
|
|
5
|
-
export { default as
|
|
5
|
+
export { default as LslEventMarkerOutlet } from './impl/LslEventMarkerOutlet.js'
|
|
6
6
|
export * from './impl/LslEventMarkerOutlet.js'
|
|
7
7
|
|
|
8
|
-
export { default as
|
|
8
|
+
export { default as FakeEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/FakeEventMarkerOutlet.js'
|
|
9
9
|
export * from './testDoubles/EventMarkerOutlet/FakeEventMarkerOutlet.js'
|
|
10
10
|
|
|
11
|
-
export { default as
|
|
11
|
+
export { default as MockEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/MockEventMarkerOutlet.js'
|
|
12
12
|
export * from './testDoubles/EventMarkerOutlet/MockEventMarkerOutlet.js'
|
|
13
13
|
|
|
14
|
-
export { default as
|
|
14
|
+
export { default as SpyEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/SpyEventMarkerOutlet.js'
|
|
15
15
|
export * from './testDoubles/EventMarkerOutlet/SpyEventMarkerOutlet.js'
|
|
16
16
|
|
|
17
|
-
export { default as
|
|
17
|
+
export { default as ThrowingEventMarkerOutlet } from './testDoubles/EventMarkerOutlet/ThrowingEventMarkerOutlet.js'
|
|
18
18
|
export * from './testDoubles/EventMarkerOutlet/ThrowingEventMarkerOutlet.js'
|
|
19
19
|
|
|
20
20
|
// Liblsl
|