BluetoothClient
@neurosity/sdk / BluetoothClient
Class: BluetoothClient
Defined in: api/bluetooth/BluetoothClient.ts:37
Constructors
Constructor
new BluetoothClient(
options):BluetoothClient
Defined in: api/bluetooth/BluetoothClient.ts:59
Parameters
options
Options
Returns
BluetoothClient
Properties
_accelerometer$
_accelerometer$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:47
_brainwavesPowerByBand$
_brainwavesPowerByBand$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:51
_brainwavesPSD$
_brainwavesPSD$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:50
_brainwavesRaw$
_brainwavesRaw$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:48
_brainwavesRawUnfiltered$
_brainwavesRawUnfiltered$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:49
_calm$
_calm$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:45
_focus$
_focus$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:44
_kinesis$
_kinesis$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:46
_settings$
_settings$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:55
_signalQuality$
_signalQuality$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:52
_signalQualityV2$
_signalQualityV2$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:53
_status$
_status$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:54
_wifiConnections$
_wifiConnections$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:57
_wifiNearbyNetworks$
_wifiNearbyNetworks$:
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:56
deviceInfo
deviceInfo:
DeviceInfo
Defined in: api/bluetooth/BluetoothClient.ts:39
isAuthenticated$
isAuthenticated$:
ReplaySubject<boolean>
Defined in: api/bluetooth/BluetoothClient.ts:42
osHasBluetoothSupport$
osHasBluetoothSupport$:
ReplaySubject<boolean>
Defined in: api/bluetooth/BluetoothClient.ts:41
selectedDevice$
selectedDevice$:
ReplaySubject<DeviceInfo>
Defined in: api/bluetooth/BluetoothClient.ts:40
transport
transport:
BluetoothTransport
Defined in: api/bluetooth/BluetoothClient.ts:38
Accessors
wifi
Get Signature
get wifi():
object
Defined in: api/bluetooth/BluetoothClient.ts:430
Returns
object
connect()
connect: (
ssid,password?) =>Promise<any>
Parameters
ssid
string
password?
string
Returns
Promise<any>
connections()
connections: () =>
Observable<any>
Returns
Observable<any>
forgetConnection()
forgetConnection: (
ssid) =>Promise<any>
Parameters
ssid
string
Returns
Promise<any>
nearbyNetworks()
nearbyNetworks: () =>
Observable<any>
Returns
Observable<any>
reset()
reset: () =>
Promise<any>
Returns
Promise<any>
speedTest()
speedTest: () =>
Promise<any>
Returns
Promise<any>
Methods
_autoAuthenticate()
_autoAuthenticate(
createBluetoothToken):Observable<IsAuthenticatedResponse>
Defined in: api/bluetooth/BluetoothClient.ts:144
Parameters
createBluetoothToken
CreateBluetoothToken
Returns
Observable<IsAuthenticatedResponse>
_hasBluetoothSupport()
_hasBluetoothSupport():
Promise<boolean>
Defined in: api/bluetooth/BluetoothClient.ts:177
Returns
Promise<boolean>
_subscribeWhileAuthenticated()
_subscribeWhileAuthenticated(
characteristicName,skipJSONDecoding):Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:287
Parameters
characteristicName
string
skipJSONDecoding
boolean = false
Returns
Observable<any>
_withAuthentication()
_withAuthentication<
T>(getter):Promise<T>
Defined in: api/bluetooth/BluetoothClient.ts:268
Type Parameters
T
T
Parameters
getter
() => Promise<T>
Returns
Promise<T>
accelerometer()
accelerometer():
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:342
Returns
Observable<any>
addMarker()
addMarker(
label):Promise<void>
Defined in: api/bluetooth/BluetoothClient.ts:379
Parameters
label
string
Returns
Promise<void>
authenticate()
authenticate(
token):Promise<IsAuthenticatedResponse>
Defined in: api/bluetooth/BluetoothClient.ts:181
Parameters
token
string
Returns
Promise<IsAuthenticatedResponse>
brainwaves()
brainwaves(
label):Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:346
Parameters
label
string
Returns
Observable<any>
calm()
calm():
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:312
Returns
Observable<any>
connect()
connect(
deviceNicknameORPeripheral?):Promise<void>
Defined in: api/bluetooth/BluetoothClient.ts:239
Parameters
deviceNicknameORPeripheral?
DeviceNicknameOrPeripheral
Returns
Promise<void>
connection()
connection():
Observable<BLUETOOTH_CONNECTION>
Defined in: api/bluetooth/BluetoothClient.ts:255
Returns
Observable<BLUETOOTH_CONNECTION>
disconnect()
disconnect():
Promise<void>
Defined in: api/bluetooth/BluetoothClient.ts:251
Returns
Promise<void>
dispatchAction()
dispatchAction(
action):Promise<any>
Defined in: api/bluetooth/BluetoothClient.ts:404
Parameters
action
Action
Returns
Promise<any>
enableAutoConnect()
enableAutoConnect(
autoConnect):void
Defined in: api/bluetooth/BluetoothClient.ts:173
Parameters
autoConnect
boolean
Returns
void
focus()
focus():
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:308
Returns
Observable<any>
getDeviceId()
getDeviceId():
Promise<string>
Defined in: api/bluetooth/BluetoothClient.ts:263
Returns
Promise<string>
getInfo()
getInfo():
Promise<DeviceInfo>
Defined in: api/bluetooth/BluetoothClient.ts:390
Returns
Promise<DeviceInfo>
haptics()
haptics(
effects):Promise<any>
Defined in: api/bluetooth/BluetoothClient.ts:417
Parameters
effects
any
Returns
Promise<any>
isAuthenticated()
isAuthenticated():
Promise<IsAuthenticatedResponse>
Defined in: api/bluetooth/BluetoothClient.ts:204
Returns
Promise<IsAuthenticatedResponse>
kinesis()
kinesis(
label?):Observable<Kinesis>
Defined in: api/bluetooth/BluetoothClient.ts:329
Observes kinesis classification events streamed over BLE.
The firmware emits JSON events of shape
{ metric: "kinesis", label: string, probability: number, timestamp: number }
on the kinesis characteristic. When a label is provided, the stream is
filtered to only emit events matching that label, mirroring the cloud
kinesis(label) semantics.
Parameters
label?
string
Optional kinesis label to filter by (e.g. "leftHandPinch").
When omitted, all kinesis events are emitted.
Returns
Observable<Kinesis>
Observable of Kinesis events.
logs()
logs():
Observable<string>
Defined in: api/bluetooth/BluetoothClient.ts:259
Returns
Observable<string>
scan()
scan(
options?):Observable<Peripheral[]>
Defined in: api/bluetooth/BluetoothClient.ts:224
Parameters
options?
any
Returns
Observable<Peripheral[]>
settings()
settings():
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:413
Returns
Observable<any>
signalQuality()
signalQuality():
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:371
Returns
Observable<any>
signalQualityV2()
signalQualityV2():
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:375
Returns
Observable<any>
status()
status():
Observable<any>
Defined in: api/bluetooth/BluetoothClient.ts:400
Returns
Observable<any>