IOTileAdapter | iotile-device

Hierarchy

AbstractIOTileAdapter
- IOTileAdapter

Index

Constructors

constructor

Constructors

constructor

new IOTileAdapter(Config: any, notificationService: AbstractNotificationService, platform: Platform): IOTileAdapter

- Defined in device/iotile-serv.ts:109
Parameters
- Config: any
- notificationService: AbstractNotificationService
- platform: Platform
Returns IOTileAdapter

Properties

adParser

adParser: IOTileAdvertisementService

Private adapterEventNames

adapterEventNames: object

Type declaration

[key: number]: string

catAdapter

catAdapter: Category

Private charManagers

charManagers: object

Type declaration

[key: number]: CharacteristicManager

Private characteristicNames

characteristicNames: object

Type declaration

[key: number]: string

Private config

config: any

connectedDevice

connectedDevice: IOTileDevice | null

Private connectionHooks

connectionHooks: ConnectionHookCallback[]

connectionMessages

connectionMessages: any[]

interactive

interactive: boolean

lastScanResults

lastScanResults: IOTileAdvertisement[]

mockBLEService

mockBLEService: any

notification

notification: AbstractNotificationService

Private platform

platform: Platform

Private supportsFastWrites

supportsFastWrites: boolean

Private tracingInterface

tracingInterface: IOTileTracingInterface

Private tracingOpen

tracingOpen: boolean

Methods

addNotificationListener

addNotificationListener(char: IOTileCharacteristic, callback: NotificationCallback): Promise<function>

- Defined in device/iotile-serv.ts:831
ngdoc

method

name

iotile.device.service:IOTileAdapter#addNotificationListener

methodof

iotile.device.service:IOTileAdapter

description

Listen for notifications on a specific BLE characteristic known to IOTileAdapter.

This is an async method!

If this is the first call to addNotificationListener on this characteristic, the BLE stack is called to enable notifications. However, if this is a subsequent call, it will complete immediately since nofications have already been enabled. The listener will just be added to an internal table of notification listeners for that characteristic

Parameters
- char: IOTileCharacteristic
  
  A numerical identifier for the characteristic that we want notifications about.
- callback: NotificationCallback
  
  The callback with signature (ArrayBuffer) => void
Returns Promise<function>

Asynchronously returns a function that takes no arguments and removes this notification listener when called. The signature of the function returned is () => Promise

Private checkFastWriteSupport

checkFastWriteSupport(peripheral: BLEPeripheral): boolean

- Defined in device/iotile-serv.ts:1111
Parameters
- peripheral: BLEPeripheral
Returns boolean

Private checkProperty

checkProperty(char: BLECharacteristic, propToFind: string): boolean

- Defined in device/iotile-serv.ts:1137
Parameters
- char: BLECharacteristic
- propToFind: string
Returns boolean

clearTrace

clearTrace(): void

- Defined in device/iotile-serv.ts:616
Returns void

Private closeInterface

closeInterface(iface: Interface): Promise<void>

- Defined in device/iotile-serv.ts:969
Parameters
- iface: Interface
Returns Promise<void>

connect

connect(advert: IOTileAdvertisement, options: ConnectionOptions): Promise<IOTileDevice>

- Defined in device/iotile-serv.ts:465
ngdoc

method

name

iotile.device.service:IOTileAdapter#connect

methodof

iotile.device.service:IOTileAdapter

description

Connect to an IOTileDevice.

This is an async method

This method connects to an IOTile device over bluetooth. If there is already an IOTile device connected, it throws an error.

example
```
var foundAdverts = await IOTileAdapter.scan(1.0);
if (foundAdverts.length > 0) {
  var device = await IOTileAdapter.connect(foundAdverts[0]);
}
```
Parameters
- advert: IOTileAdvertisement
  
  The IOTileDevice object that we should connect to. This device should been returned from a previous call to IOTileAdapter.scan.
- options: ConnectionOptions
  
  (optional) Configure what checks and and actions are performed automatically on connection without any required interaction. By default, the RPC interface is opened and streaming is started.
Returns Promise<IOTileDevice>

Private connectInternal

connectInternal(advert: IOTileAdvertisement): Promise<IOTileDevice>

- Defined in device/iotile-serv.ts:1086
Connect to a device using the internal cordova BLE plugin

This function is a bit complicated because of the plugin's API. There are two callbacks provided to the plugin: onConnected and onDisconnected

onConnected is called with no arguments after we succesfully connect onDisconnected is called in two circumstances:
- if we did not connect successfully, in which case we reject the promise
- if we subsequently get disconnected from the BLE device, in which case the promise is gone and we instead notify that we were disconnected by calling disconnectCallback.
Parameters
- advert: IOTileAdvertisement
Returns Promise<IOTileDevice>

connectTo

connectTo(slug: string, options: ConnectionOptions): Promise<IOTileDevice>

- Defined in device/iotile-serv.ts:408
ngdoc

method

name

iotile.device.service:IOTileAdapter#connectTo

methodof

iotile.device.service:IOTileAdapter

description

Connect to an IOTileDevice that has previously been scanned given its slug.

This is an async method

This method connects to an IOTile device over bluetooth. If there is already an IOTile device connected, it throws an error.

Raises a ConnectionError if the device slug cannot be found in previously scanned devices.

Parameters
- slug: string
  
  The slug of the device that we want to connect to
- options: ConnectionOptions
  
  (optional) Configure what checks and and actions are performed automatically on connection without any required interaction. By default, the RPC interface is opened and streaming is started.
Returns Promise<IOTileDevice>

Private createChannel

createChannel(): BLEChannel

- Defined in device/iotile-serv.ts:919
Create a channel object that can write and subscribe to characteristics over BLE. Channels are passed to the subinterfaces inside this IOTileAdapter in order to give them the ability to actually talk to the IOTile device without creating a public API for low level writes and notifications.

The BLEChannel interface is intended to be minimalist and only all the required operations.

Returns BLEChannel

Private createIOTileAdvertisement

createIOTileAdvertisement(peripheral: any): IOTileAdvertisement | null

- Defined in device/iotile-serv.ts:1008
Parameters
- peripheral: any
Returns IOTileAdvertisement | null

disconnect

disconnect(): Promise<void>

- Defined in device/iotile-serv.ts:757
ngdoc

method

name

iotile.device.service:IOTileAdapter#disconnect

methodof

iotile.device.service:IOTileAdapter

description

Disconnect from any currently connected IOTile Device.

This is an async method!

This method can never fail. After the method returns, the IOTile adapter will be in an Idle state and able to scan for or connect to other IOTile devices.

Returns Promise<void>

Private disconnectCallback

disconnectCallback(reason: any): void

- Defined in device/iotile-serv.ts:1162
Callback provided to ble plugin that is called whenever a device gets disconnected or if the connection attempt fails.

Parameters
- reason: any
Returns void

Private disconnectInternal

disconnectInternal(deviceID: any): Promise<void>

- Defined in device/iotile-serv.ts:1152
Internally in BLE central plugin, the possible responses are:
- in Android, there is no way for disconnect to fail. The disconnect attempt is scheduled and then resolve is called.
Parameters
- deviceID: any
Returns Promise<void>

enableTracing

enableTracing(): Promise<void>

- Defined in device/iotile-serv.ts:961
Open the tracing interface so that we can receive tracing data.

Returns Promise<void>

enabled

enabled(): Promise<boolean>

- Defined in device/iotile-serv.ts:307
ngdoc

method

name

iotile.device.service:IOTileAdapter#enabled

methodof

iotile.device.service:IOTileAdapter

description

Return is BLE is enabled on the device.

This is an async method!

Returns Promise<boolean>

Whether or not BLE is enabled on the device

Private ensureConnected

ensureConnected(action: string, userMessage?: undefined | string): void

- Defined in device/iotile-serv.ts:997
Parameters
- action: string
- Optional userMessage: undefined | string
Returns void

Private ensureIdle

ensureIdle(action: string): void

- Defined in device/iotile-serv.ts:991
Ensure the Adapter is in an idle state before proceeding

Parameters
- action: string
Returns void

errorHandlingRPC

errorHandlingRPC(address: number, rpcID: number, callFormat: string, respFormat: string, args: (string | number | ArrayBuffer)[], timeout?: undefined | number): Promise<any[]>

Overrides AbstractIOTileAdapter.errorHandlingRPC
- Defined in device/iotile-serv.ts:726
ngdoc

method

name

iotile.device.service:IOTileAdapter#errorHandlingRPC

methodof

iotile.device.service:IOTileAdapter

description

Type converting wrapper around rpc() that throws if the first argument of response is nonzero

This is an async method!

This function sends a single RPC to an IOTile device and waits for it to finish before returning. Internally it calls IOTileAdapter.rpc() to make the actual RPC call but this function builds the payload ArrayBuffer from a list of integers and a format code. Similarly, it decodes the response into a list of numbers as well.

If an error occurs calling the RPC, an exception is thrown indicating what went wrong. If the error is unrecoverable, further RPCs to the device will not be allowed without disconnecting and reconnecting.

The RPC called must return a uint32_t as the first 4 bytes of its response and this value is checked to ensure it is zero. If it is nonzero, an exception is thrown rather saying there was an error executing the RPC.

The list of values returned does not include the error code since it will always be zero.

Parameters
- address: number
  
  The address of the tile that we want to send the RPC to
- rpcID: number
  
  The 16 bit id of the RPC that we would like to call
- callFormat: string
  
  A format code passed to packArrayBuffer to convert a list of numbers into an ArrayBuffer. Examples would be "LH" to pack an unsigned 32 bit integer followed by a 16 bit integer.
- respFormat: string
  
  A format code passed to unpackArrayBuffer to convert the response Callback into a list of numbers that are returned.
- args: (string | number | ArrayBuffer)[]
  
  An array of arguments that should match the format of callFormat and is used to construct the payload for this RPC. The first item (the error code) is shifted off and not returned.
- Optional timeout: undefined | number
  
  The maximum amount of time that we would like to wait for this RPC to finish.
Returns Promise<any[]>

The decoded list of numbers that were returned from the RPC (excluding the error code).

Private findCharacteristic

findCharacteristic(peripheral: BLEPeripheral, service: string, charName: string): BLECharacteristic | null

- Defined in device/iotile-serv.ts:1122
Parameters
- peripheral: BLEPeripheral
- service: string
- charName: string
Returns BLECharacteristic | null

getConnectedDevice

getConnectedDevice(): IOTileDevice | null

- Defined in device/iotile-serv.ts:230
ngdoc

method

name

iotile.device.service:IOTileAdapter#getConnectedDevice

methodof

iotile.device.service:IOTileAdapter

description

Get the currently connected device. If there is no device currently connected, returns null.

Returns IOTileDevice | null

{IOTileDevice} The currently connected device or null if no device is connected currently.

Private notify

notify(event: AdapterEvent, args: any): void

- Defined in device/iotile-serv.ts:1003
Parameters
- event: AdapterEvent
- args: any
Returns void

Private openInterface

openInterface(iface: Interface): Promise<void>

- Defined in device/iotile-serv.ts:936
Parameters
- iface: Interface
Returns Promise<void>

pause

pause(): void

- Defined in device/iotile-serv.ts:287
Returns void

registerConnectionHook

registerConnectionHook(hook: ConnectionHookCallback): void

- Defined in device/iotile-serv.ts:253
ngdoc

method

name

iotile.device.service:IOTileAdapter#registerConnectionHook

methodof

iotile.device.service:IOTileAdapter

description

Register a function to be called everytime someone connects to a device

The function should be asynchronous and throw an exception if there is an error inside the hook that means the device should not be connected to. If any hook throws an exception, the device is disconnected from and that error is thrown to whomever tried to connect to the device.

The signature of the method should be (IOTileDevice, IOTileAdapter) => Promise

Parameters
- hook: ConnectionHookCallback
  
  The function that should be called every time we connect to a device.
Returns void

registerPreconnectionHook

registerPreconnectionHook(hook: PreconnectionHookCallback): void

- Defined in device/iotile-serv.ts:275
ngdoc

method

name

iotile.device.service:IOTileAdapter#registerPreconnectionHook

methodof

iotile.device.service:IOTileAdapter

description

Register a function to be called before someone connects to a device

The function should be asynchronous and return a boolean. If the function returns true, we can proceed with the connection. If the function returns false, the connection attempt will be stopped.

The signature of the method should be (IOTileDevice, IOTileAdapter) => Promise

Parameters
- hook: PreconnectionHookCallback
  
  The function that should be called every time we connect to a device.
Returns void

Private removeNotificationListener

removeNotificationListener(char: IOTileCharacteristic, handlerID: number): Promise<void>

- Defined in device/iotile-serv.ts:892
ngdoc

method

name

iotile.device.service:IOTileAdapter#removeNotificationListener

methodof

iotile.device.service:IOTileAdapter

description

Remove a previously installed notification listener.

This is an async method!

This will deregister a callback that was listening for notified data on a characteristic. If this is the last callback registered on that characteristic, notifications will also be stopped.

Parameters
- char: IOTileCharacteristic
  
  A numerical identifier for the characteristic that we want notifications about.
- handlerID: number
  
  the ID of the callback that should be removed, which is returned from the call to addNotificationListener.
Returns Promise<void>

A promise that is fullfilled when the listener has been removed

resetStreaming

resetStreaming(): void

Overrides AbstractIOTileAdapter.resetStreaming
- Defined in device/iotile-serv.ts:573
Utility method to forcibly reset the streaming interface in case it has received corrupted data.

Returns void

resume

resume(): void

- Defined in device/iotile-serv.ts:291
Returns void

rpc

rpc(address: number, rpcID: number, payload: ArrayBuffer, timeout?: undefined | number): Promise<ArrayBuffer>

Overrides AbstractIOTileAdapter.rpc
- Defined in device/iotile-serv.ts:603
ngdoc

method

name

iotile.device.service:IOTileAdapter#rpc

methodof

iotile.device.service:IOTileAdapter

description

Send an RPC to a connected IOTile device

This is an async method!

This function sends a single RPC to an IOTile device and waits for it to finish before returning. Internally the RPC is queued so that multiple users calling this function from different places simultaneously will properly be synchronized.

This is provisional API that will change.

Parameters
- address: number
  
  The address of the tile that we want to send the RPC to
- rpcID: number
  
  The 16 bit id of the RPC that we would like to call
- payload: ArrayBuffer
  
  The payload that we would like to send
- Optional timeout: undefined | number
  
  The maximum amount of time that we would like to wait for this RPC to finish.
Returns Promise<ArrayBuffer>

scan

scan(scanPeriod: number): Promise<IOTileAdvertisement[]>

- Defined in device/iotile-serv.ts:344
ngdoc

method

name

iotile.device.service:IOTileAdapter#scan

methodof

iotile.device.service:IOTileAdapter

description
Scan for devices for a fixed period of time.

This is an async method!

Returns a list of IOTileAdvertisement objects for the IOTile devices that were found.

Side Effects:
- Notifies on AdapterEvent.ScanStarted when scanning has been started
- Notifies on AdapterEvent.ScanFinished when scanning has finished.
AdapterEvent.ScanFinished has one argument with a count property that contains the number of IOTile devices that were found. See the ScanFinishedArgs interface.
example
```
//Scan for 1 second and return the devices seen
var foundDevices = await IOTileAdapter.scan(1.0);
console.log("Found " + foundDevices.length + " IOTile devices!");
```
Parameters
- scanPeriod: number
  
  The number of seconds to scan
Returns Promise<IOTileAdvertisement[]>

A list of the IOTile devices seen during the scan

sendScript

sendScript(script: ArrayBuffer, notifier: any): Promise<void>

- Defined in device/iotile-serv.ts:610
Parameters
- script: ArrayBuffer
- notifier: any
Returns Promise<void>

Private setReportSize

setReportSize(device: IOTileDevice, adapter: AbstractIOTileAdapter): Promise<any>

- Defined in device/iotile-serv.ts:198
Parameters
- device: IOTileDevice
- adapter: AbstractIOTileAdapter
Returns Promise<any>

stopScan

stopScan(): Promise<void>

- Defined in device/iotile-serv.ts:1015
Wrapper around cordova ble plugin with a Promise based interface

Returns Promise<void>

subscribe(event: AdapterEvent, callback: function): any

Overrides AbstractIOTileAdapter.subscribe
- Defined in device/iotile-serv.ts:803
ngdoc

method

name

iotile.device.service:IOTileAdapter#subscribe

methodof

iotile.device.service:IOTileAdapter

description

Subscribe to notifications on IOTileDevice related events.

Currently supports scan started and scan finished events. The notifications proceed using the angular event system. You may pass a scope object and all notifications you register will be automatically removed when your scope is destroyed. If you are calling this method from a service, you can pass null for the scope to not automatically deregister the handler on scope destruction.

Parameters
- event: AdapterEvent
  
  The event that you want to subscribe to, must be an event in IOTileAdapterModule.AdapterEvent.
- callback: function
  
  The function that will be called when the event happens. callback must have the signature callback(object) => void.
  - - (string: string, any: any): void
    - Parameters
      - string: string
      - any: any
      Returns void
Returns any

A function that will deregister this handler before the scope is destroyed if necessary.

typedRPC

typedRPC(address: number, rpcID: number, callFormat: string, respFormat: string, args: (string | number | ArrayBuffer)[], timeout?: undefined | number): Promise<any[]>

Overrides AbstractIOTileAdapter.typedRPC
- Defined in device/iotile-serv.ts:679
ngdoc

method

name

iotile.device.service:IOTileAdapter#typedRPC

methodof

iotile.device.service:IOTileAdapter

description

Type converting wrapper around rpc()

This is an async method!

This function sends a single RPC to an IOTile device and waits for it to finish before returning. Internally it calls IOTileAdapter.rpc() to make the actual RPC call but this function builds the payload ArrayBuffer from a list of integers and a format code. Similarly, it decodes the response into a list of numbers as well.

If an error occurs calling the RPC, an exception is thrown indicating what went wrong. If the error is unrecoverable, further RPCs to the device will not be allowed without disconnecting and reconnecting.

Parameters
- address: number
  
  The address of the tile that we want to send the RPC to
- rpcID: number
  
  The 16 bit id of the RPC that we would like to call
- callFormat: string
  
  A format code passed to packArrayBuffer to convert a list of numbers into an ArrayBuffer. Examples would be "LH" to pack an unsigned 32 bit integer followed by a 16 bit integer.
- respFormat: string
  
  A format code passed to unpackArrayBuffer to convert the response Callback into a list of numbers that are returned.
- args: (string | number | ArrayBuffer)[]
  
  An array of arguments that should match the format of callFormat and is used to construct the payload for this RPC.
- Optional timeout: undefined | number
  
  The maximum amount of time that we would like to wait for this RPC to finish.
Returns Promise<any[]>

The decoded list of numbers that were returned from the RPC.

waitForTracingData

waitForTracingData(numBytes: number, timeout?: number): Promise<ArrayBuffer>

- Defined in device/iotile-serv.ts:643
Wait for a given number of bytes to be received on the tracing interface.

If no data has been received in more than 1 second after calling this function, the promise returned will be rejected by the tracing interface watchdog timer, making sure that the interface cannot stall. The recommended way to use this function is to trigger some event that sends data via the tracing interface (after making sure the interface is open...) and then calling:
```
let data: ArrayBuffer = await adapter.waitForTracingData(numBytes);
```
That is all that is required to synchronously receive that number of bytes from the tracing interface.
Parameters
- numBytes: number
  
  The number of bytes to wait for. This exact number of bytes will be returned to you when the Promise is resolved.
- Default value timeout: number = 1000
  
  The number of milliseconds to wait before receiving another chunk of tracing data before we give up and abort the wait (rejecting the promise). This defaults to 1000 ms if not passed.
Returns Promise<ArrayBuffer>

Private write

write(char: IOTileCharacteristic, value: ArrayBuffer): Promise<void>

- Defined in device/iotile-serv.ts:1021
Parameters
- char: IOTileCharacteristic
- value: ArrayBuffer
Returns Promise<void>

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Config: any

notificationService: AbstractNotificationService

platform: Platform

Returns IOTileAdapter

Properties

adParser

Private adapterEventNames

Type declaration

[key: number]: string

catAdapter

Private charManagers

Type declaration

[key: number]: CharacteristicManager

Private characteristicNames

Type declaration

[key: number]: string

Private config

connectedDevice

Private connectionHooks

connectionMessages

interactive

lastScanResults

mockBLEService

notification

Private platform

Private preconnectionHooks

rpcInterface

Private scriptInterface

state

Private streamingInterface

Private supportsFastWrites

Private tracingInterface

Private tracingOpen

Methods

addNotificationListener

Parameters

char: IOTileCharacteristic

callback: NotificationCallback

Returns Promise<function>

Private checkFastWriteSupport

Parameters

peripheral: BLEPeripheral

Returns boolean

Private checkProperty

Parameters

char: BLECharacteristic

propToFind: string

Returns boolean

clearTrace

Returns void

Private closeInterface

Parameters

iface: Interface

Returns Promise<void>

connect

Parameters

advert: IOTileAdvertisement

options: ConnectionOptions

Returns Promise<IOTileDevice>

Private connectInternal

Parameters

advert: IOTileAdvertisement

Returns Promise<IOTileDevice>

connectTo

Parameters

slug: string

options: ConnectionOptions

Returns Promise<IOTileDevice>

Private createChannel

Returns BLEChannel

Private createIOTileAdvertisement

Parameters