iotile-device
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • LoggingBase
    • IOTileDevice

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

adapter

adapter: AbstractIOTileAdapter

advertisement

advertisement: IOTileAdvertisement

connectionID

connectionID: any

deviceID

deviceID: number

Private downloadLock

downloadLock: any

mqttBridgeConfig

mqttBridgeConfig: MQTTBridgeConfig

networkConfig

networkConfig: NetworkConfig

slug

slug: string

Methods

acknowledgeStreamerRPC

  • acknowledgeStreamerRPC(streamer: number, highestID: number, force: boolean): Promise<void>

Protected buildLogMessage

  • buildLogMessage(msg: string, extraArgs?: __type | any[]): MessageType

  • Parameters

    • msg: string
    • Optional extraArgs: __type | any[]

    Returns MessageType

clearAllReadings

  • clearAllReadings(): Promise<void>

  • Clear all stored readings in the device.

    This removes all buffered and output stream data stored in the device.

    Returns Promise<void>

config

controllerHWVersionRPC

  • controllerHWVersionRPC(): Promise<string>

  • IOTile controllers have an embedded 10 character long hardware id tag that uniquely determines what hardware type they are. This is important information to know when seeing what kind of script or firmware update to apply since different hardware versions may require different scripts or different firmware.

    The value is padded out with null characters to exactly 10 bytes so make sure to strip those out.

    Returns Promise<string>

controllerVersionRPC

  • controllerVersionRPC(): Promise<string>

Private convertEncodedVersion

  • convertEncodedVersion(encVersion: number): string

currentTime

  • currentTime(synchronizationSlopSeconds?: number): Promise<DeviceTime>

downloadStream

  • downloadStream(streamName: string, progress?: any): Promise<RawReading[]>

getDeviceInfo

graphInput

  • graphInput(stream: string | number, value: number): Promise<void>

highestUniqueIDRPC

  • highestUniqueIDRPC(): Promise<any>

inspectVirtualStream

  • inspectVirtualStream(stream: string | number): Promise<number>

Protected logDebug

  • logDebug(msg: string, extraArgs?: __type | any[]): void

  • Parameters

    • msg: string
    • Optional extraArgs: __type | any[]

    Returns void

Protected logError

  • logError(msg: string, extraArgs?: __type | any[]): void

  • Parameters

    • msg: string
    • Optional extraArgs: __type | any[]

    Returns void

Protected logException

  • logException(msg: string, error: ErrorType, extraArgs?: undefined | __type): void

  • Parameters

    • msg: string
    • error: ErrorType
    • Optional extraArgs: undefined | __type

    Returns void

Protected logInfo

  • logInfo(msg: string, extraArgs?: __type | any[]): void

  • Parameters

    • msg: string
    • Optional extraArgs: __type | any[]

    Returns void

Protected logTrace

  • logTrace(msg: string, extraArgs?: __type | any[]): void

  • Parameters

    • msg: string
    • Optional extraArgs: __type | any[]

    Returns void

Protected logWarning

  • logWarning(msg: string, extraArgs?: __type | any[]): void

  • Parameters

    • msg: string
    • Optional extraArgs: __type | any[]

    Returns void

queryBLEConnectionInfo

queryStreamerRPC

receiveReports

remoteBridge

Protected setLogLevel

  • setLogLevel(level: LogLevel, applyChildren?: undefined | true | false): void
  • description

    WARNING: This will override the entire category configuration, not just the LogLevel. DO NOT use in production.

    todo

    Keep current config settings and only update LogLevel. It is not apparent how to do this and may require a PR for https://github.com/mreuvers/typescript-logging

    Parameters

    • level: LogLevel
    • Optional applyChildren: undefined | true | false

      default: fase. If set to true then the level will be set for all child categories.

    Returns void

synchronizeTime

  • synchronizeTime(forcedTime?: Date): Promise<number>

tileVersionRPC

  • tileVersionRPC(address: number): Promise<string>

triggerStreamer

  • triggerStreamer(streamer: number): Promise<any>

updateBLEParams

  • updateBLEParams(minIntervalMS: number, maxIntervalMS: number, timeoutMS: number): Promise<number>

  • Parameters

    • minIntervalMS: number
    • maxIntervalMS: number
    • timeoutMS: number

    Returns Promise<number>

Private waitReports

  • waitReports(notifier: ProgressNotifier, streamers: number[] | object): Promise<WaitReportsResult>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc