new BLE(runtime, extensionId, peripheralOptions, connectCallback, resetCallback)
A BLE peripheral socket object. It handles connecting, over web sockets, to BLE peripherals, and reading and writing data to them.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
runtime |
Runtime | the Runtime for sending/receiving GUI update events. |
|
extensionId |
string | the id of the extension using this socket. |
|
peripheralOptions |
object | the list of options for peripheral discovery. |
|
connectCallback |
object | a callback for connection. |
|
resetCallback |
object |
null
|
a callback for resetting extension state. |
Methods
connectPeripheral(id)
Try connecting to the input peripheral id, and then call the connect callback if connection is successful.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
number | the id of the peripheral to connect to |
didReceiveCall(method, params) → {object}
Handle a received call from the socket.
Parameters:
| Name | Type | Description |
|---|---|---|
method |
string | a received method label. |
params |
object | a received list of parameters. |
Returns:
- optional return value.
- Type
- object
disconnect()
Close the websocket.
handleDisconnectError()
Handle an error resulting from losing connection to a peripheral.
This could be due to:
- battery depletion
- going out of bluetooth range
- being powered down
Disconnect the socket, and if the extension using this socket has a reset callback, call it. Finally, emit an error to the runtime.
isConnected() → {bool}
Returns:
whether the peripheral is connected.
- Type
- bool
read(serviceId, characteristicId, optStartNotifications, onCharacteristicChanged) → {Promise}
Read from the specified ble service.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
serviceId |
number | the ble service to read. |
|
characteristicId |
number | the ble characteristic to read. |
|
optStartNotifications |
boolean |
false
|
whether to start receiving characteristic change notifications. |
onCharacteristicChanged |
object |
null
|
callback for characteristic change notifications. |
Returns:
- a promise from the remote read request.
- Type
- Promise
requestPeripheral()
Request connection to the peripheral. If the web socket is not yet open, request when the socket promise resolves.
startNotifications(serviceId, characteristicId, onCharacteristicChanged) → {Promise}
Start receiving notifications from the specified ble service.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
serviceId |
number | the ble service to read. |
|
characteristicId |
number | the ble characteristic to get notifications from. |
|
onCharacteristicChanged |
object |
null
|
callback for characteristic change notifications. |
Returns:
- a promise from the remote startNotifications request.
- Type
- Promise
write(serviceId, characteristicId, message, encoding, withResponse) → {Promise}
Write data to the specified ble service.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
serviceId |
number | the ble service to write. |
|
characteristicId |
number | the ble characteristic to write. |
|
message |
string | the message to send. |
|
encoding |
string |
null
|
the message encoding type. |
withResponse |
boolean |
null
|
if true, resolve after peripheral's response. |
Returns:
- a promise from the remote send request.
- Type
- Promise