Class Device

Hierarchy

BaseDevice
- Device

Index

Constructors

Properties

connectionMonitorInterval id name organizationId realtimeListeners remoteDevicePeerId rtcClient tags? createDevice disableDevice getDevicesData patchDevice prefixed queryDevicesData

Methods

addInterventionResponse addListener addRealtimeListener assertNotCancelled changeStreamAudioType createCaptureStream createCustomBinaryRequestDataChannel createCustomDataChannel createCustomRequestDataChannel createInterventionRequest createShareLink disableRealtimeTelemetryPriorityIngestion emit enableRealtimeTelemetryPriorityIngestion eventNames eventsCounter getAgentVersion getAnnotationCount getAnnotationCountByIntervals getAvailableCommands getCommand getConfiguration getFileUrl getLatestTelemetry getRealtimeAudioStreams getRealtimeManipulators getRealtimePing getRealtimeStatus getRealtimeVideoStreams getRemoteDevicePeerId getRemotePeer getTelemetry getTelemetryStreams handleMessage initConnectionMonitoring isInRealtimeSession listenerCount listeners off on once queryEvents removeAllListeners removeListener removeRealtimeListener sendCommand sendRealtimeMessage startListeningToRealtimeDataStream startListeningToRealtimeVideo startRealtimeConnection stopConnectionMonitoring stopListeningToRealtimeDataStream stopListeningToRealtimeVideo stopRealtimeConnection

Constructors

constructor

new Device(id, name, organizationId, tags?): Device
Parameters
- id: string
- name: string
- organizationId: string
- Optional tags: ITags
Returns Device
Overrides BaseDevice.constructor
- Defined in data-sdk/src/devices/Device.ts:41

Properties

`Protected` connectionMonitorInterval

connectionMonitorInterval: undefined | Timer

id

id: string

name

name: string

`Private` organizationId

organizationId: string

`Protected` realtimeListeners

realtimeListeners: RealtimeListener[] = []

remoteDevicePeerId

remoteDevicePeerId: null | string = null

rtcClient

rtcClient: undefined | RtcClient

`Optional` tags

tags?: ITags

`Static` createDevice

createDevice: ((device) => Promise<IDevice>) = createDevice

Type declaration

- (device): Promise<IDevice>
- Parameters
  - device: IDevice
  Returns Promise<IDevice>

`Static` disableDevice

disableDevice: ((id) => Promise<IDevice[]>) = disableDevice

Type declaration

- (id): Promise<IDevice[]>
- Parameters
  - id: string
  Returns Promise<IDevice[]>

`Static` getDevicesData

getDevicesData: (() => Promise<IDevice[]>) = getDevicesData

Type declaration

- (): Promise<IDevice[]>
- Returns Promise<IDevice[]>

`Static` patchDevice

patchDevice: ((id, device) => Promise<IDevice>) = patchDevice

Type declaration

- (id, device): Promise<IDevice>
- Parameters
  - id: string
  - device: Partial<IDevice>
  Returns Promise<IDevice>

`Static` prefixed

prefixed: string | boolean

`Static` queryDevicesData

queryDevicesData: ((query) => Promise<IDevice[]>) = queryDevicesData

Type declaration

- (query): Promise<IDevice[]>
- Parameters
  - query: IDeviceQuery
  Returns Promise<IDevice[]>

Methods

addInterventionResponse

addInterventionResponse<T>(interventionId, interventionType, data): Promise<IInterventionResponse<keyof IInterventionTypeMap>>
Type Parameters
- T extends keyof IInterventionTypeMap
Parameters
- interventionId: string
- interventionType: keyof IInterventionTypeMap
- data: IInterventionTypeMap[T]["response"]
Returns Promise<IInterventionResponse<keyof IInterventionTypeMap>>
- Defined in data-sdk/src/devices/Device.ts:569

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
Returns this
Inherited from BaseDevice.addListener
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:45

addRealtimeListener

addRealtimeListener(listener): void
Parameters
- listener: RealtimeListener
Returns void
Inherited from BaseDevice.addRealtimeListener
- Defined in data-sdk/src/devices/BaseDevice.ts:84

`Protected` assertNotCancelled

assertNotCancelled(cancelled): void
Parameters
- cancelled: boolean
Returns void
Inherited from BaseDevice.assertNotCancelled
- Defined in data-sdk/src/devices/BaseDevice.ts:64

changeStreamAudioType

changeStreamAudioType(streamName, newFormat): Promise<void>
Parameters
- streamName: string
- newFormat: "wav" | "opus"
Returns Promise<void>
Inherited from BaseDevice.changeStreamAudioType
- Defined in data-sdk/src/devices/BaseDevice.ts:257

createCaptureStream

createCaptureStream(streamName): Promise<CaptureStream>
Parameters
- streamName: string
Returns Promise<CaptureStream>
- Defined in data-sdk/src/devices/Device.ts:451

createCustomBinaryRequestDataChannel

createCustomBinaryRequestDataChannel(channelName, timeout?): BinaryRequestDataChannel
Parameters
- channelName: string
- timeout: number = 3000
Returns BinaryRequestDataChannel
Inherited from BaseDevice.createCustomBinaryRequestDataChannel
- Defined in data-sdk/src/devices/BaseDevice.ts:168

createCustomDataChannel

createCustomDataChannel(channelName, rtcConfig?): Promise<DataChannel>
Parameters
- channelName: string
- Optional rtcConfig: RTCDataChannelInit
Returns Promise<DataChannel>
Inherited from BaseDevice.createCustomDataChannel
- Defined in data-sdk/src/devices/BaseDevice.ts:270

createCustomRequestDataChannel

createCustomRequestDataChannel(channelName, timeout?): TextRequestDataChannel
Parameters
- channelName: string
- timeout: number = 3000
Returns TextRequestDataChannel
Inherited from BaseDevice.createCustomRequestDataChannel
- Defined in data-sdk/src/devices/BaseDevice.ts:161

createInterventionRequest

createInterventionRequest<T>(message, interventionType, interventionRequest, tags?): Promise<((id) => IInterventionTypeMap[T]["response"])>
Type Parameters
- T extends keyof IInterventionTypeMap
Parameters
- message: string
- interventionType: keyof IInterventionTypeMap
- interventionRequest: IInterventionTypeMap[T]["request"]
- Optional tags: {}
Returns Promise<((id) => IInterventionTypeMap[T]["response"])>
- Defined in data-sdk/src/devices/Device.ts:539

createShareLink

createShareLink(share, view): Promise<null | string>
Parameters
- share: IShare
- view: string
Returns Promise<null | string>
- Defined in data-sdk/src/devices/Device.ts:622

disableRealtimeTelemetryPriorityIngestion

disableRealtimeTelemetryPriorityIngestion(streamName): Promise<void>
Parameters
- streamName: string
Returns Promise<void>
Inherited from BaseDevice.disableRealtimeTelemetryPriorityIngestion
- Defined in data-sdk/src/devices/BaseDevice.ts:243

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Rest ...args: any[]
Returns boolean
Inherited from BaseDevice.emit
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:32

enableRealtimeTelemetryPriorityIngestion

enableRealtimeTelemetryPriorityIngestion(streamName): Promise<void>
Parameters
- streamName: string
Returns Promise<void>
Inherited from BaseDevice.enableRealtimeTelemetryPriorityIngestion
- Defined in data-sdk/src/devices/BaseDevice.ts:229

eventNames

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

Returns (string | symbol)[]
Inherited from BaseDevice.eventNames
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:15

eventsCounter

eventsCounter(eventTypes, timeFrame, range, time, query?): Promise<{
date: string;
events: IEvent[];
}[]>
Parameters
- eventTypes: ("custom" | "annotation" | "triggered-event" | "datapoint-event" | "device-online" | "device-offline" | "intervention-request" | "teleop-session-record" | "port-forwarding-session-record" | "command-request" | "command-response" | "command-delivery" | "intervention-response" | "comment" | "system" | "task-summary" | "stateful")[]
- timeFrame: AggregateLevel
- range: number
- time: number
- Optional query: IEventQuery
Returns Promise<{
date: string;
events: IEvent[];
}[]>
- Defined in data-sdk/src/devices/Device.ts:609

getAgentVersion

getAgentVersion(): Promise<undefined | null | string>
Asynchronously retrieves the device's agent version string

Returns Promise<undefined | null | string>
A promise that resolves to the agent version

Throws
Throws an error if the device info cannot be fetched
- Defined in data-sdk/src/devices/Device.ts:123

getAnnotationCount

getAnnotationCount(query, tagKey): Promise<{
[key: string]: number;
}>
Parameters
- query: IEventQuery
- tagKey: string
Returns Promise<{
[key: string]: number;
}>
- Defined in data-sdk/src/devices/Device.ts:593

getAnnotationCountByIntervals

getAnnotationCountByIntervals(query, tagKey, aggregate): Promise<{
    annotations: {
        [key: string]: number;
    };
    date: string;
}[]>
Parameters
- query: IEventQuery
- tagKey: string
- aggregate: AggregateLevel
Returns Promise<{
    annotations: {
        [key: string]: number;
    };
    date: string;
}[]>
- Defined in data-sdk/src/devices/Device.ts:597

getAvailableCommands

getAvailableCommands(): Promise<Command[]>
Returns Promise<Command[]>
- Defined in data-sdk/src/devices/Device.ts:365

getCommand

getCommand(id): Promise<Response>
Parameters
- id: string
Returns Promise<Response>
- Defined in data-sdk/src/devices/Device.ts:440

getConfiguration

getConfiguration(getDesiredConfigurationVersion?): Promise<ConfigurationDocument>
Asynchronously retrieves the configuration document for a device.
Parameters
- getDesiredConfigurationVersion: boolean = false
  Whether to retrieve the desired configuration version
Returns Promise<ConfigurationDocument>
A promise that resolves to the configuration document

Throws
Throws an error if the device has no configuration or has never been turned on
Overrides BaseDevice.getConfiguration
- Defined in data-sdk/src/devices/Device.ts:82

getFileUrl

getFileUrl(fileId): Promise<string[]>
Parameters
- fileId: string
Returns Promise<string[]>
- Defined in data-sdk/src/devices/Device.ts:136

getLatestTelemetry

getLatestTelemetry(): Promise<any>
Returns Promise<any>
- Defined in data-sdk/src/devices/Device.ts:56

getRealtimeAudioStreams

getRealtimeAudioStreams(): Promise<RealtimeAudioStream[]>
Returns Promise<RealtimeAudioStream[]>
Inherited from BaseDevice.getRealtimeAudioStreams
- Defined in data-sdk/src/devices/BaseDevice.ts:314

getRealtimeManipulators

getRealtimeManipulators(): Promise<Manipulator[]>
Returns Promise<Manipulator[]>
Inherited from BaseDevice.getRealtimeManipulators
- Defined in data-sdk/src/devices/BaseDevice.ts:96

getRealtimePing

getRealtimePing(): undefined | number
Returns undefined | number
Inherited from BaseDevice.getRealtimePing
- Defined in data-sdk/src/devices/BaseDevice.ts:76

getRealtimeStatus

getRealtimeStatus(): "connected" | "connecting" | "disconnected"
Returns "connected" | "connecting" | "disconnected"
Inherited from BaseDevice.getRealtimeStatus
- Defined in data-sdk/src/devices/BaseDevice.ts:68

getRealtimeVideoStreams

getRealtimeVideoStreams(): Promise<RealtimeVideoStream[]>
Returns Promise<RealtimeVideoStream[]>
Inherited from BaseDevice.getRealtimeVideoStreams
- Defined in data-sdk/src/devices/BaseDevice.ts:124

`Private` getRemoteDevicePeerId

getRemoteDevicePeerId(rtcClient): Promise<string>
Parameters
- rtcClient: RtcClient
Returns Promise<string>
- Defined in data-sdk/src/devices/Device.ts:270

getRemotePeer

getRemotePeer(): Promise<IRtcPeer>
Returns Promise<IRtcPeer>
Overrides BaseDevice.getRemotePeer
- Defined in data-sdk/src/devices/Device.ts:315

getTelemetry

getTelemetry(streamNameOrStreamNames, start, end, tags?, limit?, offset?, latestOnly?): Promise<TelemetryResult[]>
Parameters
- streamNameOrStreamNames: string | string[]
- start: Date
- end: Date
- Optional tags: {}
- Optional limit: number
- Optional offset: number
- Optional latestOnly: boolean
Returns Promise<TelemetryResult[]>
Overrides BaseDevice.getTelemetry
- Defined in data-sdk/src/devices/Device.ts:468

getTelemetryStreams

getTelemetryStreams(): Promise<TelemetryStream[]>
Returns Promise<TelemetryStream[]>
- Defined in data-sdk/src/devices/Device.ts:501

`Protected` handleMessage

handleMessage(peerId, message): void
Parameters
- peerId: string
- message: any
Returns void
Inherited from BaseDevice.handleMessage
- Defined in data-sdk/src/devices/BaseDevice.ts:55

`Private` initConnectionMonitoring

initConnectionMonitoring(): void
Returns void
- Defined in data-sdk/src/devices/Device.ts:284

isInRealtimeSession

isInRealtimeSession(): Promise<boolean>
Returns Promise<boolean>
- Defined in data-sdk/src/devices/Device.ts:355

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from BaseDevice.listenerCount
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from BaseDevice.listeners
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from BaseDevice.off
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
Returns this
Inherited from BaseDevice.on
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
Returns this
Inherited from BaseDevice.once
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:54

queryEvents

queryEvents(query): Promise<IEvent[]>
Parameters
- query: IEventQuery
Returns Promise<IEvent[]>
Overrides BaseDevice.queryEvents
- Defined in data-sdk/src/devices/Device.ts:491

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns this
Inherited from BaseDevice.removeAllListeners
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from BaseDevice.removeListener
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:63

removeRealtimeListener

removeRealtimeListener(listener): void
Parameters
- listener: RealtimeListener
Returns void
Inherited from BaseDevice.removeRealtimeListener
- Defined in data-sdk/src/devices/BaseDevice.ts:88

sendCommand

sendCommand(name, data?, time?, metadata?): Promise<Response>
Parameters
- name: string
- Optional data: string
- Optional time: Date
- Optional metadata: {}
Returns Promise<Response>
- Defined in data-sdk/src/devices/Device.ts:390

sendRealtimeMessage

sendRealtimeMessage(message, config?): Promise<void>
Parameters
- message: IRtcStreamMessage
- config: IRtcSendConfiguration = ...
Returns Promise<void>
Inherited from BaseDevice.sendRealtimeMessage
- Defined in data-sdk/src/devices/BaseDevice.ts:299

startListeningToRealtimeDataStream

startListeningToRealtimeDataStream(stream): Promise<void>
Parameters
- stream: RealtimeDataStream
Returns Promise<void>
Inherited from BaseDevice.startListeningToRealtimeDataStream
- Defined in data-sdk/src/devices/BaseDevice.ts:202

startListeningToRealtimeVideo

startListeningToRealtimeVideo(stream): Promise<void>
Parameters
- stream: RealtimeVideoStream
Returns Promise<void>
Inherited from BaseDevice.startListeningToRealtimeVideo
- Defined in data-sdk/src/devices/BaseDevice.ts:175

startRealtimeConnection

startRealtimeConnection(options?): Promise<void>
Starts a real-time connection with the remote device using WebRTC.
Parameters
- Optional options: SessionType | IStartRealtimeConnectionOptions = {}
  Optional session type to be used for the connection.
Returns Promise<void>
Throws
Error If the connection could not be established or if a connection already exists.
Overrides BaseDevice.startRealtimeConnection
- Defined in data-sdk/src/devices/Device.ts:157

`Protected` stopConnectionMonitoring

stopConnectionMonitoring(): void
Returns void
Inherited from BaseDevice.stopConnectionMonitoring
- Defined in data-sdk/src/devices/BaseDevice.ts:59

stopListeningToRealtimeDataStream

stopListeningToRealtimeDataStream(stream): Promise<void>
Parameters
- stream: RealtimeDataStream
Returns Promise<void>
Inherited from BaseDevice.stopListeningToRealtimeDataStream
- Defined in data-sdk/src/devices/BaseDevice.ts:216

stopListeningToRealtimeVideo

stopListeningToRealtimeVideo(stream): Promise<void>
Parameters
- stream: RealtimeVideoStream
Returns Promise<void>
Inherited from BaseDevice.stopListeningToRealtimeVideo
- Defined in data-sdk/src/devices/BaseDevice.ts:189

stopRealtimeConnection

stopRealtimeConnection(): Promise<void>
Returns Promise<void>
- Defined in data-sdk/src/devices/Device.ts:330

Class Device

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Device

Properties

Protected connectionMonitorInterval

id

name

Private organizationId

Protected realtimeListeners

remoteDevicePeerId

rtcClient

Optional tags

Static createDevice

Type declaration

Parameters

Returns Promise<IDevice>

Static disableDevice

Type declaration

Parameters

Returns Promise<IDevice[]>

Static getDevicesData

Type declaration

Returns Promise<IDevice[]>

Static patchDevice

Type declaration

Parameters

Returns Promise<IDevice>

Static prefixed

Static queryDevicesData

Type declaration

Parameters

Returns Promise<IDevice[]>

Methods

addInterventionResponse

Type Parameters

Parameters

Returns Promise<IInterventionResponse<keyof IInterventionTypeMap>>

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

addRealtimeListener

Parameters

Returns void

Protected assertNotCancelled

Parameters

Returns void

changeStreamAudioType

Parameters

Returns Promise<void>

createCaptureStream

Parameters

Returns Promise<CaptureStream>

createCustomBinaryRequestDataChannel

Parameters

Returns BinaryRequestDataChannel

createCustomDataChannel

Parameters

Returns Promise<DataChannel>

createCustomRequestDataChannel

Parameters

Returns TextRequestDataChannel

createInterventionRequest

Type Parameters

Parameters

Returns Promise<((id) => IInterventionTypeMap[T]["response"])>

createShareLink

Parameters

Returns Promise<null | string>

disableRealtimeTelemetryPriorityIngestion

Parameters

`Protected` connectionMonitorInterval

`Private` organizationId

`Protected` realtimeListeners

`Optional` tags

`Static` createDevice

`Static` disableDevice

`Static` getDevicesData

`Static` patchDevice

`Static` prefixed

`Static` queryDevicesData

`Protected` assertNotCancelled

Returns Promise<{
date: string;
events: IEvent[];
}[]>

Returns Promise<{
[key: string]: number;
}>

Returns Promise<{
annotations: {
[key: string]: number;
};
date: string;
}[]>

`Private` getRemoteDevicePeerId

`Protected` handleMessage

`Private` initConnectionMonitoring