Class Device

Hierarchy

Device

Properties

connected

connected: boolean

deviceDirName

deviceDirName: string

deviceRoot

deviceRoot: string

Private eventTimerCancellationToken

eventTimerCancellationToken: Timer

Private pendingEventRequests

pendingEventRequests: EventNotificationRequest[]

Private sysClassDir

sysClassDir: string

Static Private eventTimerInterval

eventTimerInterval: number

Static overrideSysClassDir

overrideSysClassDir: string

Methods

connect

connect(driverName: string, nameConvention?: string, propertyConstraints?: object): void

- Defined in io.ts:102
Parameters
- driverName: string
- Optional nameConvention: string
- Optional propertyConstraints: object
  - [propertyName: string]: any
Returns void

Protected constructPropertyPath

constructPropertyPath(property: string, deviceRoot?: string): string

- Defined in io.ts:150
Parameters
- property: string
- Optional deviceRoot: string
Returns string

readNumber

readNumber(property: string, deviceRoot?: string): number

- Defined in io.ts:154
Parameters
- property: string
- Optional deviceRoot: string
Returns number

readProperty

readProperty(property: string, deviceRoot?: string): any

- Defined in io.ts:193
Parameters
- property: string
- Optional deviceRoot: string
Returns any

readString

readString(property: string, deviceRoot?: string): string

- Defined in io.ts:163
Parameters
- property: string
- Optional deviceRoot: string
Returns string

readStringArray

readStringArray(property: string, deviceRoot?: string): string[]

- Defined in io.ts:172
Parameters
- property: string
- Optional deviceRoot: string
Returns string[]

readStringArrayAsType

readStringArrayAsType<T>(property: string, deviceRoot?: string): T[]

- Defined in io.ts:178
Type parameters
- T
Parameters
- property: string
- Optional deviceRoot: string
Returns T[]

readStringAsType

readStringAsType<T>(property: string, deviceRoot?: string): T

- Defined in io.ts:168
Type parameters
- T
Parameters
- property: string
- Optional deviceRoot: string
Returns T

readStringSelector

readStringSelector(property: string, deviceRoot?: string): string

- Defined in io.ts:182
Parameters
- property: string
- Optional deviceRoot: string
Returns string

registerEventCallback

registerEventCallback(callbackFunction: function, eventPredicate: function, firstTriggerOnly?: boolean, userCallbackData?: any): void

- Defined in io.ts:262
Parameters
- callbackFunction: function
  - - (err?: Error, userData?: any): void
    - Parameters
      - Optional err: Error
      - Optional userData: any
      Returns void
- eventPredicate: function
  - - (userData?: any): boolean
    - Parameters
      - Optional userData: any
      Returns boolean
- Default value firstTriggerOnly: boolean = false
- Optional userCallbackData: any
Returns void

registerEventPromise

registerEventPromise(eventPredicate: function, userCallbackData?: any): Promise<any>

- Defined in io.ts:277
Parameters
- eventPredicate: function
  - - (userData?: any): boolean
    - Parameters
      - Optional userData: any
      Returns boolean
- Optional userCallbackData: any
Returns Promise<any>

set

set(propertyDefs: any): void

- Defined in io.ts:238
Parameters
- propertyDefs: any
Returns void

setNumber

setNumber(property: string, value: number): void

- Defined in io.ts:230
Parameters
- property: string
- value: number
Returns void

setProperty

setProperty(property: string, value: any): any

- Defined in io.ts:216
Parameters
- property: string
- value: any
Returns any

setString

setString(property: string, value: string): void

- Defined in io.ts:234
Parameters
- property: string
- value: string
Returns void

Private updateEventTimerState

updateEventTimerState(): void

- Defined in io.ts:252
Returns void

Private updatePendingEventRequests

updatePendingEventRequests(): void

- Defined in io.ts:244
Returns void

Generated using TypeDoc