BasicControllerTile | iotile-device

Hierarchy

VirtualTile
- BasicControllerTile

Indexable

[key: string]: any

Index

Constructors

constructor

Properties

Constructors

constructor

new BasicControllerTile(iotileID: number, versionInfo: VersionInfo, firmwareVersion?: string, hwTag?: string): BasicControllerTile

Overrides VirtualTile.constructor
- Defined in mocks/tiles/basic-controller.ts:47
Parameters
- iotileID: number
- versionInfo: VersionInfo
- Default value firmwareVersion: string = "2.11.4"
- Default value hwTag: string = "btc1_v3"
Returns BasicControllerTile

Properties

address

address: number | undefined

Protected appInfo

appInfo: number

Protected downloadStreamState

downloadStreamState: DownloadStreamState | null

Protected firmwareVersion

firmwareVersion: string

highestUniqueID

highestUniqueID: number

Protected hwTag

hwTag: string

Protected iotileID

iotileID: number

Protected name

name: string

notificationCallback

notificationCallback: NotificationCallback | null

Protected osInfo

osInfo: number

prestreamingHook

prestreamingHook: PrestreamingHook | null

queuedReports

queuedReports: ArrayBuffer[] | SharedArrayBuffer[] | any[]

realtimeStreamers

realtimeStreamers: RealtimeStreamerState[]

Protected rpcTable

rpcTable: object

Type declaration

[key: number]: object
- [key: number]: RPCDescriptor

streamerAcks

streamerAcks: object

Type declaration

[key: number]: number

streams

streams: object

Type declaration

[key: number]: StreamValue[]

Methods

acknowledgeStreamer

acknowledgeStreamer(streamer: number, force: boolean, value: number): RPCResponse

- Defined in mocks/tiles/basic-controller.ts:296
Parameters
- streamer: number
- force: boolean
- value: number
Returns RPCResponse

Protected addRPC

addRPC(address: number, rpcID: number, argFormat: string, respFormat: string, handler: function, thisObject: object): void

Inherited from BaseRPCDispatcher.addRPC
- Defined in mocks/virtual-device.ts:89
Add an RPC to this RPCDispatcher.

The RPC handler is stored for later use and can be called using the public method rpc(address, rpcID, packedArguments: ArrayBuffer)

Parameters
- address: number
  
  The address of the tile where we want to add this RPC
- rpcID: number
  
  The 16-bit RPC id of the RPC, something like 0x8000
- argFormat: string
  
  A format string compatible with unpackArrayBuffer to unpack arguments
- respFormat: string
  
  A format string compatbile with packArrayBuffer to pack the return value
- handler: function
  
  A handler function that is called with bind(this, handler)
  - - (...args: any[]): RPCResponse
    - Parameters
      - Rest ...args: any[]
      Returns RPCResponse
- thisObject: object
  
  The object that should be used for the this parameter to handler
Returns void

addRealtimeStreamer

addRealtimeStreamer(stream: number, intervalMS: number): void

- Defined in mocks/tiles/basic-controller.ts:89
Parameters
- stream: number
- intervalMS: number
Returns void

beginDownloadStream

beginDownloadStream(stream: number): number[]

- Defined in mocks/tiles/basic-controller.ts:200
Parameters
- stream: number
Returns number[]

Private combineVersion

combineVersion(tag: number, version: string): number

- Defined in mocks/tiles/basic-controller.ts:68
Parameters
- tag: number
- version: string
Returns number

disableStreaming

disableStreaming(): void

- Defined in mocks/tiles/basic-controller.ts:142
Returns void

downloadReading

downloadReading(stream: number): number[]

- Defined in mocks/tiles/basic-controller.ts:215
Parameters
- stream: number
Returns number[]

enableStreaming

enableStreaming(callback: NotificationCallback): void

- Defined in mocks/tiles/basic-controller.ts:124
Parameters
- callback: NotificationCallback
Returns void

Protected findRPCHandlers

findRPCHandlers(obj: object): void

Inherited from BaseRPCDispatcher.findRPCHandlers
- Defined in mocks/virtual-device.ts:135
Parameters
- obj: object
Returns void

getCurrentDeviceTime

getCurrentDeviceTime(): RPCResponse

- Defined in mocks/tiles/basic-controller.ts:170
Returns RPCResponse

getDeviceInfo

getDeviceInfo(): RPCResponse

- Defined in mocks/tiles/basic-controller.ts:176
Returns RPCResponse

getHardwareTag

getHardwareTag(): RPCResponse

- Defined in mocks/tiles/basic-controller.ts:165
Returns RPCResponse

Protected handleRealtimeStreamer

handleRealtimeStreamer(state: RealtimeStreamerState): void

- Defined in mocks/tiles/basic-controller.ts:103
Parameters
- state: RealtimeStreamerState
Returns void

hasRPC

hasRPC(address: number, rpcID: number): boolean

Inherited from BaseRPCDispatcher.hasRPC
- Defined in mocks/virtual-device.ts:127
Parameters
- address: number
- rpcID: number
Returns boolean

inspectVirtualStream

inspectVirtualStream(stream: number): number[]

- Defined in mocks/tiles/basic-controller.ts:276
Parameters
- stream: number
Returns number[]

Private isBufferedStream

isBufferedStream(stream: number): boolean

- Defined in mocks/tiles/basic-controller.ts:80
Parameters
- stream: number
Returns boolean

isStreamingEnabled

isStreamingEnabled(): boolean

- Defined in mocks/tiles/basic-controller.ts:120
Returns boolean

pushReading

pushReading(value: number, stream: number): number[]

- Defined in mocks/tiles/basic-controller.ts:181
Parameters
- value: number
- stream: number
Returns number[]

queryStreamer

queryStreamer(streamer: number): RPCResponse

- Defined in mocks/tiles/basic-controller.ts:239
Parameters
- streamer: number
Returns RPCResponse

rpc

rpc(address: number, rpcID: number, args?: ArrayBuffer): Promise<ArrayBuffer>

Inherited from BaseRPCDispatcher.rpc
- Defined in mocks/virtual-device.ts:106
Parameters
- address: number
- rpcID: number
- Optional args: ArrayBuffer
Returns Promise<ArrayBuffer>

tile_status

tile_status(): RPCResponse

Inherited from VirtualTile.tile_status
- Defined in mocks/virtual-device.ts:181
Returns RPCResponse

triggerStreamer

triggerStreamer(streamer: number): RPCResponse

- Defined in mocks/tiles/basic-controller.ts:232
Parameters
- streamer: number
Returns RPCResponse

Generated using TypeDoc