Class JDDevice

A Jacdac device hosting services.

Hierarchy

JDNode
- JDDevice

JDOM

`Readonly` bus

bus: JDBus

Gets the bus this device belongs to

`Readonly` eventStats

eventStats: Record<string, number> = {}

Gets a counter of event emit calls.

newListenerStats

newListenerStats: Record<string, number> = undefined

Gets a counter map from events to new listener counts

`Readonly` nodeId

nodeId: number = ...

Gets an internal unique node identifier, mostly used for debugging.

changeId

get changeId(): number
Gets a counter for the CHANGE event.

Returns number
Inherited from JDNode.changeId
- Defined in src/jdom/eventsource.ts:325

children

get children(): JDNode[]
Gets the list of child services.

Returns JDNode[]
Overrides JDNode.children
- Defined in src/jdom/device.ts:705

friendlyName

get friendlyName(): string
Gets the device short name

Returns string
Overrides JDNode.friendlyName
- Defined in src/jdom/device.ts:359

id

get id(): string
Gets a unique identifier for this device in the bus

Returns string
Overrides JDNode.id
- Defined in src/jdom/device.ts:305

name

get name(): string
Gets the short id of the device

Returns string
Overrides JDNode.name
- Defined in src/jdom/device.ts:313

nodeData

get nodeData(): Record<string, unknown>
Gets a databag to store custom information

Returns Record<string, unknown>
Inherited from JDNode.nodeData
- Defined in src/jdom/node.ts:63

nodeKind

get nodeKind(): string
Identifies node as a device

Returns string
Overrides JDNode.nodeKind
- Defined in src/jdom/device.ts:321

parent

get parent(): JDNode
Gets the bus instance hosting this device.

Returns JDNode
Overrides JDNode.parent
- Defined in src/jdom/device.ts:435

qualifiedName

get qualifiedName(): string
Gets the device short name

Returns string
Overrides JDNode.qualifiedName
- Defined in src/jdom/device.ts:367

shortId

get shortId(): string
Gets the device short identifier

Returns string
- Defined in src/jdom/device.ts:425

emit

emit(eventName, ...args): boolean
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Parameters
- eventName: string
- Rest ...args: unknown[]
Returns boolean
Inherited from JDNode.emit
- Defined in src/jdom/eventsource.ts:237

emitPropagated

emitPropagated(event, arg?): void
Emit event in current node and parent nodes
Parameters
- event: string
  
  event to emit
- Optional arg: any
  
  event arguments
Returns void
Inherited from JDNode.emitPropagated
- Defined in src/jdom/node.ts:74

eventNames

eventNames(): string[]
Returns an array listing the events for which the emitter has registered listeners.

Returns string[]
Inherited from JDNode.eventNames
- Defined in src/jdom/eventsource.ts:294

listenerCount

listenerCount(eventName): number
Gets the number of listeners for a given event
Parameters
- eventName: string
  
  name of the event
Returns number
number of registered handlers
Inherited from JDNode.listenerCount
- Defined in src/jdom/eventsource.ts:273

listenerStackTraces

listenerStackTraces(eventName): string[]
Gets the list stack trace where an event was registered. Only enabled if Flags.debug is true.
Parameters
- eventName: string
  
  name of the event
Returns string[]
stack traces where a listener was added
Inherited from JDNode.listenerStackTraces
- Defined in src/jdom/eventsource.ts:285

observe

observe<T>(eventName): Observable<T>
Creates an observable from the given event
Type Parameters
- T
Parameters
- eventName: string | string[]
Returns Observable<T>
Inherited from JDNode.observe
- Defined in src/jdom/eventsource.ts:303

off

off(eventName, handler): JDDevice
Unregisters a handler for one or more events
Parameters
- eventName: string | string[]
  
  name or names of the events to subscribe
- handler: EventHandler
  
  handler to unregister
Returns JDDevice
current object instance
Inherited from JDNode.off
- Defined in src/jdom/eventsource.ts:137

on

on(eventName, handler): JDDevice
Registers a handler for one or more events
Parameters
- eventName: string | string[]
  
  name or names of the events to subscribe
- handler: EventHandler
  
  handler to register
Returns JDDevice
current object instance
Inherited from JDNode.on
- Defined in src/jdom/eventsource.ts:122

once

once(eventName, handler): JDDevice
Registers a handler for one or more events to run only once.
Parameters
- eventName: string | string[]
  
  name or names of the events to subscribe
- handler: EventHandler
  
  handler to execute
Returns JDDevice
current object instance
Inherited from JDNode.once
- Defined in src/jdom/eventsource.ts:151

subscribe<T>(eventName, next): (() => void)
Subscribes to an event and returns the unsubscription handler
Type Parameters
- T
Parameters
- eventName: string | string[]
- next: ((value) => void)
  - - (value): void
    - Parameters
      
      value: T
      
      Returns void
Returns (() => void)
- - (): void
  - Subscribes to an event and returns the unsubscription handler
    
    Returns void
    
    Category
    JDOM
Inherited from JDNode.subscribe
- Defined in src/jdom/eventsource.ts:313

Control

`Readonly` deviceId

deviceId: string

Gets the device identifier

announceFlags

get announceFlags(): ControlAnnounceFlags
Gets the control announce flag from the annouce packet.

Returns ControlAnnounceFlags
- Defined in src/jdom/device.ts:384

firmwareVersion

get firmwareVersion(): string
Returns the firmware version synchronously. If needed, tries to refresh the value in the background.

Returns string
- Defined in src/jdom/device.ts:993

isClient

get isClient(): boolean
Indicates if the device is announced as a client

Returns boolean
- Defined in src/jdom/device.ts:408

packetCount

get packetCount(): number
Gets the number of packets sent since the last announce packet, as read from the announce packet.

Returns number
- Defined in src/jdom/device.ts:417

productIdentifier

get productIdentifier(): number
Returns the product identifier synchronously. If needed, tries to refresh the value in the background.

Returns number
- Defined in src/jdom/device.ts:952

restartCounter

get restartCounter(): number
Gets the restart counter from the announce packet.

Returns number
- Defined in src/jdom/device.ts:392

statusLight

get statusLight(): LEDController
Gets a controller for the status light. Returns undefined if the device does not support a status light.

Returns LEDController
- Defined in src/jdom/device.ts:872

statusLightFlags

get statusLightFlags(): ControlAnnounceFlags
Gets the status light announce flags from the announce packet.

Returns ControlAnnounceFlags
- Defined in src/jdom/device.ts:400

uptime

get uptime(): number
Gets the elapsed time since boot in milli-seconds

Returns number
- Defined in src/jdom/device.ts:963

resolveFirmwareVersion

resolveFirmwareVersion(retry?): Promise<string>
Tries to retrive the firmware version from the device
Parameters
- retry: number = 0
  
  number of attempts
Returns Promise<string>
promise that returns firmware if received
- Defined in src/jdom/device.ts:981

resolveProductIdentifier

resolveProductIdentifier(retry?): Promise<number>
Tries to retrive the product identifier from the device
Parameters
- retry: number = 0
  
  number of attempts
Returns Promise<number>
promise that returns product identifier if received
- Defined in src/jdom/device.ts:939

Diagnostics

`Readonly` stats

stats: DeviceStatsMonitor = ...

Quality of service statistics for this device

describe

describe(): string
Gets a description of the device.

Returns string
a descriptive string for this device
- Defined in src/jdom/device.ts:283

Firmware

firmwareInfo

get firmwareInfo(): FirmwareInfo
Gets the firmware information if any.

Returns FirmwareInfo
- Defined in src/jdom/device.ts:443

firmwareUpdater

get firmwareUpdater(): FirmwareUpdater
Firmware updater, defined if a firmware update is in progress

Returns FirmwareUpdater
- Defined in src/jdom/device.ts:526
set firmwareUpdater(value): void
Sets the flashing sequence state
Parameters
- value: FirmwareUpdater
Returns void
- Defined in src/jdom/device.ts:534

Lifecycle

connected

connected: boolean

Indicates if the device is connected to a bus

lastSeen

lastSeen: number

Timestamp of the last packet received from the device

lastServiceUpdate

lastServiceUpdate: number

Timestamp of the last service update packet received from the device

announced

get announced(): boolean
Indicates if service information is available. This happens after a announce packet has been received.

Returns boolean
- Defined in src/jdom/device.ts:376

eventCounter

get eventCounter(): number
Gets the number of events received by the service clients in this device

Returns number
- Defined in src/jdom/device.ts:555

identifying

get identifying(): boolean
Indicates the device should be identifying.

Returns boolean
- Defined in src/jdom/device.ts:913

lost

get lost(): boolean
Indicates if no packet from this device has been observed in a while.

Returns boolean
- Defined in src/jdom/device.ts:497

identify

identify(): Promise<void>
Sends an identify command to the device

Returns Promise<void>
- Defined in src/jdom/device.ts:888

reset

reset(): Promise<void>
Sends a reset command to the device

Returns Promise<void>
- Defined in src/jdom/device.ts:921

Other

`Readonly` created

created: number

Timestamp when the device was first seen

anonymizedDeviceId

get anonymizedDeviceId(): string
Gets a random device id for the lifetime of this object.

Returns string
- Defined in src/jdom/device.ts:251

brain

get brain(): boolean
Indicates if the device is a unique brain

Returns boolean
- Defined in src/jdom/device.ts:1010

proxy

get proxy(): boolean
Indicates if the device is in proxy mode

Returns boolean
- Defined in src/jdom/device.ts:1003

awaitOnce

awaitOnce(eventName, token?): Promise<void>
Awaits an event with a timeout. Throws JacdacError with timeout if operation does not return.
Parameters
- eventName: string | string[]
- Optional token: JDCancellationToken
Returns Promise<void>
Inherited from JDNode.awaitOnce
- Defined in src/jdom/eventsource.ts:163

ping

ping(): Promise<boolean>
Check if the device is still there

Returns Promise<boolean>
true if the device is there, undefined on timeout
- Defined in src/jdom/device.ts:783

startProxy

startProxy(): Promise<void>
Send command to enter proxy/dongle mode

Returns Promise<void>
- Defined in src/jdom/device.ts:929

Services

bootloader

get bootloader(): boolean
Indicates if the service is in bootloader mode

Returns boolean
- Defined in src/jdom/device.ts:602

serviceClasses

get serviceClasses(): number[]
Gets the list of service classes

Returns number[]
- Defined in src/jdom/device.ts:634

serviceLength

get serviceLength(): number
Gets the number of services hosted by the device

Returns number
- Defined in src/jdom/device.ts:610

hasService

hasService(serviceClass): boolean
Indicates if the device contains at least one service matching the service class
Parameters
- serviceClass: number
  
  service class to match
Returns boolean
true if at least one service present
- Defined in src/jdom/device.ts:572

port

port(id): PipeInfo
Gets or allocates a pipe port
Parameters
- id: number
  
  identifier of the port
Returns PipeInfo
a pipe port
- Defined in src/jdom/device.ts:590

service

service(serviceIndex): JDService
Gets the service client at the given service index
Parameters
- serviceIndex: number
  
  index of the service client
Returns JDService
service client
- Defined in src/jdom/device.ts:662

serviceClassAt

serviceClassAt(index): number
Gets the service class at a given index
Parameters
- index: number
  
  index of the service
Returns number
service class
- Defined in src/jdom/device.ts:621

services

services(options?): JDService[]
Gets a filtered list of service clients.
Parameters
- Optional options: ServiceFilter
  
  filters for services
Returns JDService[]
services matching the filter
- Defined in src/jdom/device.ts:675

Transport

isPhysical

get isPhysical(): boolean
Indicates if the devices is a physical device, not emulated.

Returns boolean
- Defined in src/jdom/device.ts:329

replay

get replay(): boolean
Indicates if the device is part of a trace replay

Returns boolean
- Defined in src/jdom/device.ts:351

source

get source(): string
Indicates the source of packets

Returns string
- Defined in src/jdom/device.ts:343

Class JDDevice

Hierarchy

Index

JDOM

Control

Diagnostics

Firmware

Lifecycle

Other

Services

Transport

JDOM

Readonly bus

Readonly eventStats

newListenerStats

Readonly nodeId

changeId

Returns number

children

Returns JDNode[]

friendlyName

Returns string

id

Returns string

name

Returns string

nodeData

Returns Record<string, unknown>

nodeKind

Returns string

parent

Returns JDNode

qualifiedName

Returns string

shortId

Returns string

emit

Parameters

eventName: string

Rest ...args: unknown[]

Returns boolean

emitPropagated

Parameters

event: string

Optional arg: any

Returns void

eventNames

Returns string[]

listenerCount

Parameters

eventName: string

Returns number

listenerStackTraces

Parameters

eventName: string

Returns string[]

observe

Type Parameters

T

Parameters

eventName: string | string[]

Returns Observable<T>

off

Parameters

eventName: string | string[]

handler: EventHandler

Returns JDDevice

on

Parameters

eventName: string | string[]

handler: EventHandler

Returns JDDevice

once

Parameters

eventName: string | string[]

handler: EventHandler

Returns JDDevice

subscribe

Type Parameters

T

`Readonly` bus

`Readonly` eventStats

`Readonly` nodeId

`Rest` ...args: unknown[]

`Optional` arg: any

`Readonly` deviceId

`Readonly` stats

`Readonly` created