Class TelemetryUniverseData

Hierarchy (view full)

BasicUniverseDataConnector
- TelemetryUniverseData

Implements

IUniverseData

Index

Constructors

Properties

lastQueriedHistoricTime liveIntervalHandle mapRealtimeConnections queryStore subscriberDistributorsLoaders subscriberLoaders subscriberSources time timeChangeListeners timeFinders videoCache

Methods

addFinder addInteraction addInteractionListener addInteractionsChangedListener addRemovableTelemetrySubscription createH264Drawer createRealtimeConnection fetchImage findDataForTime getDeviceContextName getDeviceContexts getHardwareStreams getInteractions getLatestLocations getLatestTransformTrees getNearestPoint getRealtimeButtons getStatistics getTelemetryStreamType getTelemetryStreams getTeleopRosStreams getTime getTimeMs getUrdfs onTimeChange removeFinder removeInteraction sendCommand sendRealtimeBitset sendRealtimeBoolean sendRealtimePose sendRtcMessage setTime subscribeDataSourceStateChange subscribeTelemetry subscribeToBitset subscribeToGeometry subscribeToGridMap subscribeToImage subscribeToJointState subscribeToJson subscribeToLocation subscribeToNumeric subscribeToNumericSet subscribeToOdometry subscribeToPath subscribeToPointCloud subscribeToPose subscribeToText subscribeToTransformTree subscribeToVideo

Constructors

constructor

new TelemetryUniverseData(): TelemetryUniverseData
Returns TelemetryUniverseData
Overrides BasicUniverseDataConnector.constructor
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:40

Properties

lastQueriedHistoricTime

lastQueriedHistoricTime: undefined | Date

liveIntervalHandle

liveIntervalHandle: undefined | number

mapRealtimeConnections

mapRealtimeConnections: Map<string, "loading" | Device | PeerDevice> = ...

queryStore

queryStore: QueryStore = ...

subscriberDistributorsLoaders

subscriberDistributorsLoaders: Map<string, Map<string, ((data) => void)[]>> = ...

subscriberLoaders

subscriberLoaders: Map<string, Map<string, ((data) => Promise<DataResult<any>>)>> = ...

subscriberSources

subscriberSources: Map<string, Map<string, UniverseDataSource>> = ...

time

time: Date | "live"

timeChangeListeners

timeChangeListeners: ((time) => void)[] = []

Type declaration

- (time): void
- Parameters
  - time: Date | "live"
  Returns void

timeFinders

timeFinders: ((time) => void)[] = []

Type declaration

- (time): void
- Parameters
  - time: Date
  Returns void

videoCache

videoCache: StoreCache<string, HTMLVideoElement> = ...

Methods

addFinder

addFinder<T>(callback, deviceId, name, dataType, latestOnly): ((time) => void)
Type Parameters
- T extends keyof IStreamTypeMap
Parameters
- callback: ((f) => Promise<void>)
  - - (f): Promise<void>
    - Parameters
      f: undefined | "too much data" | IDataPoint<T>[]
      Returns Promise<void>
- deviceId: string
- name: string
- dataType: T
- latestOnly: boolean
Returns ((time) => void)
- - (time): void
  - Parameters
    - time: Date
    Returns void
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:151

addInteraction

addInteraction(_interaction): void
Parameters
- _interaction: Interaction
Returns void
Implementation of IUniverseData.addInteraction
Inherited from BasicUniverseDataConnector.addInteraction
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:369

addInteractionListener

addInteractionListener(_callback): (() => void)
Parameters
- _callback: ((interaction) => void)
  - - (interaction): void
    - Parameters
      interaction: Interaction
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.addInteractionListener
Inherited from BasicUniverseDataConnector.addInteractionListener
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:387

addInteractionsChangedListener

addInteractionsChangedListener(_callback): (() => void)
Parameters
- _callback: ((interactions) => void)
  - - (interactions): void
    - Parameters
      interactions: Interaction[]
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.addInteractionsChangedListener
Inherited from BasicUniverseDataConnector.addInteractionsChangedListener
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:381

`Protected` addRemovableTelemetrySubscription

addRemovableTelemetrySubscription<T>(deviceId, source, loader, distribute): (() => void)
Type Parameters
- T
Parameters
- deviceId: string
- source: UniverseDataSource
- loader: ((data) => Promise<DataResult<T>>)
  - - (data): Promise<DataResult<T>>
    - Parameters
      data: IStreamData<keyof IStreamTypeMap>[]
      Returns Promise<DataResult<T>>
- distribute: ((data) => void)
  - - (data): void
    - Parameters
      data: T
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Inherited from BasicUniverseDataConnector.addRemovableTelemetrySubscription
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:209

`Protected` createH264Drawer

createH264Drawer(): H264BytestreamCanvasDrawer
Returns H264BytestreamCanvasDrawer
Inherited from BasicUniverseDataConnector.createH264Drawer
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:266

`Protected` createRealtimeConnection

createRealtimeConnection(deviceId, sessionType?): Promise<void>
Parameters
- deviceId: string
- sessionType: number = SessionType.TELEOP
Returns Promise<void>
Inherited from BasicUniverseDataConnector.createRealtimeConnection
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:170

fetchImage

fetchImage(url): Promise<HTMLImageElement>
Parameters
- url: string
Returns Promise<HTMLImageElement>
Inherited from BasicUniverseDataConnector.fetchImage
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:453

findDataForTime

findDataForTime(time): void
Parameters
- time: Date
Returns void
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:143

getDeviceContextName

getDeviceContextName(_deviceId): Promise<undefined | string>
Parameters
- _deviceId: string
Returns Promise<undefined | string>
Implementation of IUniverseData.getDeviceContextName
Inherited from BasicUniverseDataConnector.getDeviceContextName
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:428

getDeviceContexts

getDeviceContexts(): Promise<{
deviceId: string;
deviceName: string;
}[]>
Returns Promise<{
deviceId: string;
deviceName: string;
}[]>
Implementation of IUniverseData.getDeviceContexts
Inherited from BasicUniverseDataConnector.getDeviceContexts
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:422

getHardwareStreams

getHardwareStreams(_deviceId): Promise<IRealtimeStream[]>
Parameters
- _deviceId: string
Returns Promise<IRealtimeStream[]>
Implementation of IUniverseData.getHardwareStreams
Inherited from BasicUniverseDataConnector.getHardwareStreams
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:365

getInteractions

getInteractions(): Interaction[]
Returns Interaction[]
Implementation of IUniverseData.getInteractions
Inherited from BasicUniverseDataConnector.getInteractions
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:377

getLatestLocations

getLatestLocations(): Promise<{
location: ILocation;
streamName: string;
}[]>
Returns Promise<{
location: ILocation;
streamName: string;
}[]>
Implementation of IUniverseData.getLatestLocations
Inherited from BasicUniverseDataConnector.getLatestLocations
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:405

getLatestTransformTrees

getLatestTransformTrees(_deviceId): Promise<{
streamName: string;
transformTree: ITransformNode;
}[]>
Parameters
- _deviceId: string
Returns Promise<{
streamName: string;
transformTree: ITransformNode;
}[]>
Implementation of IUniverseData.getLatestTransformTrees
Inherited from BasicUniverseDataConnector.getLatestTransformTrees
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:399

getTelemetryStreamType

getTelemetryStreamType(_deviceId, _streamName): Promise<undefined | string>
Parameters
- _deviceId: string
- _streamName: string
Returns Promise<undefined | string>
Implementation of IUniverseData.getTelemetryStreamType
Inherited from BasicUniverseDataConnector.getTelemetryStreamType
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:432

getTelemetryStreams

getTelemetryStreams(_deviceId): Promise<ITelemetryStream[]>
Parameters
- _deviceId: string
Returns Promise<ITelemetryStream[]>
Implementation of IUniverseData.getTelemetryStreams
Inherited from BasicUniverseDataConnector.getTelemetryStreams
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:357

getTeleopRosStreams

getTeleopRosStreams(_deviceId): Promise<ITelemetryRosStream[]>
Parameters
- _deviceId: string
Returns Promise<ITelemetryRosStream[]>
Implementation of IUniverseData.getTeleopRosStreams
Inherited from BasicUniverseDataConnector.getTeleopRosStreams
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:361

getTime

getTime(): Date | "live"
Returns Date | "live"
Implementation of IUniverseData.getTime
Inherited from BasicUniverseDataConnector.getTime
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:79

getTimeMs

getTimeMs(): number
Returns number
Implementation of IUniverseData.getTimeMs
Inherited from BasicUniverseDataConnector.getTimeMs
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:83

getUrdfs

getUrdfs(deviceId): Promise<string[]>
Parameters
- deviceId: string
Returns Promise<string[]>
Implementation of IUniverseData.getUrdfs
Inherited from BasicUniverseDataConnector.getUrdfs
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:347

onTimeChange

onTimeChange(time): void
Parameters
- time: Date | "live"
Returns void
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:130

removeFinder

removeFinder(fn): void
Parameters
- fn: ((time) => void)
  - - (time): void
    - Parameters
      time: Date
      Returns void
Returns void
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:238

removeInteraction

removeInteraction(_id): void
Parameters
- _id: string
Returns void
Implementation of IUniverseData.removeInteraction
Inherited from BasicUniverseDataConnector.removeInteraction
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:373

sendCommand

sendCommand(deviceId, name, data?): Promise<void>
Parameters
- deviceId: string
- name: string
- Optional data: string
Returns Promise<void>
Implementation of IUniverseData.sendCommand
Inherited from BasicUniverseDataConnector.sendCommand
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:275

sendRealtimeBitset

sendRealtimeBitset(deviceId, streamName, bitset): Promise<void>
Parameters
- deviceId: string
- streamName: string
- bitset: IBitset
Returns Promise<void>
Implementation of IUniverseData.sendRealtimeBitset
Inherited from BasicUniverseDataConnector.sendRealtimeBitset
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:324

sendRealtimeBoolean

sendRealtimeBoolean(deviceId, streamName, value): Promise<void>
Parameters
- deviceId: string
- streamName: string
- value: boolean
Returns Promise<void>
Implementation of IUniverseData.sendRealtimeBoolean
Inherited from BasicUniverseDataConnector.sendRealtimeBoolean
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:306

sendRealtimePose

sendRealtimePose(deviceId, streamName, pose): Promise<void>
Parameters
- deviceId: string
- streamName: string
- pose: ITransform
Returns Promise<void>
Implementation of IUniverseData.sendRealtimePose
Inherited from BasicUniverseDataConnector.sendRealtimePose
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:287

`Protected` sendRtcMessage

sendRtcMessage(deviceId, msg): Promise<void>
Parameters
- deviceId: string
- msg: IRtcStreamMessage
Returns Promise<void>
Inherited from BasicUniverseDataConnector.sendRtcMessage
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:160

setTime

setTime(time): void
Parameters
- time: Date | "live"
Returns void
Implementation of IUniverseData.setTime
Inherited from BasicUniverseDataConnector.setTime
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:72

subscribeDataSourceStateChange

subscribeDataSourceStateChange(_deviceId, _source, _onDataSourceStateChange?): CloseSubscription
Parameters
- _deviceId: string
- _source: UniverseDataSource
- Optional _onDataSourceStateChange: ((state) => void)
  - - (state): void
    - Parameters
      state: DataSourceState
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeDataSourceStateChange
Inherited from BasicUniverseDataConnector.subscribeDataSourceStateChange
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:445

subscribeTelemetry

subscribeTelemetry<T>(deviceId, source, type, callback): CloseSubscription
Type Parameters
- T extends keyof IStreamTypeMap
Parameters
- deviceId: string
- source: UniverseDataSource
- type: T
- callback: ((f) => Promise<void>)
  - - (f): Promise<void>
    - Parameters
      f: undefined | "too much data" | IDataPoint<T>[]
      Returns Promise<void>
Returns CloseSubscription
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:242

subscribeToBitset

subscribeToBitset(_deviceId, _source, _callback): CloseSubscription
Parameters
- _deviceId: string
- _source: UniverseDataSource
- _callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | IBitset
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToBitset
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:46

subscribeToGeometry

subscribeToGeometry(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | IMarker3DArray
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToGeometry
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:482

subscribeToGridMap

subscribeToGridMap(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | IUniverseGridMap
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToGridMap
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:530

subscribeToImage

subscribeToImage(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((image) => void)
  - - (image): void
    - Parameters
      image: Symbol | HTMLCanvasElement
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToImage
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:763

subscribeToJointState

subscribeToJointState(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | IJointState
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToJointState
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:522

subscribeToJson

subscribeToJson<T>(deviceId, source, callback): CloseSubscription
Type Parameters
- T
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | T
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToJson
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:685

subscribeToLocation

subscribeToLocation(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | ILocation
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToLocation
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:652

subscribeToNumeric

subscribeToNumeric(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((num) => void)
  - - (num): void
    - Parameters
      num: Symbol | [number, number][]
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToNumeric
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:724

subscribeToNumericSet

subscribeToNumericSet(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((entry) => void)
  - - (entry): void
    - Parameters
      entry: Symbol | [number, INumericSetEntry[]][]
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToNumericSet
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:741

subscribeToOdometry

subscribeToOdometry(deviceId, source, callback, trail?): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | IUniverseOdometry
      Returns void
- trail: number = 0
Returns CloseSubscription
Implementation of IUniverseData.subscribeToOdometry
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:354

subscribeToPath

subscribeToPath(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | IUniversePath
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToPath
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:54

subscribeToPointCloud

subscribeToPointCloud(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | IUniversePointCloud
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToPointCloud
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:265

subscribeToPose

subscribeToPose(_deviceId, _source, _callback): CloseSubscription
Parameters
- _deviceId: string
- _source: UniverseDataSource
- _callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | IPose
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToPose
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:474

subscribeToText

subscribeToText(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((text) => void)
  - - (text): void
    - Parameters
      text: string | Symbol
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToText
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:707

subscribeToTransformTree

subscribeToTransformTree(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | ITransformNode
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToTransformTree
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:630

subscribeToVideo

subscribeToVideo(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((frame) => void)
  - - (frame): void
    - Parameters
      frame: Symbol | HTMLCanvasElement
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToVideo
- Defined in data-sdk/src/connector/data/TelemetryUniverseData.ts:592

Class TelemetryUniverseData

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns TelemetryUniverseData

Properties

lastQueriedHistoricTime

liveIntervalHandle

mapRealtimeConnections

queryStore

subscriberDistributorsLoaders

subscriberLoaders

subscriberSources

time

timeChangeListeners

Type declaration

Parameters

Returns void

timeFinders

Type declaration

Parameters

Returns void

videoCache

Methods

addFinder

Type Parameters

Parameters

Parameters

Returns Promise<void>

Returns ((time) => void)

Parameters

Returns void

addInteraction

Parameters

Returns void

addInteractionListener

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

addInteractionsChangedListener

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

Protected addRemovableTelemetrySubscription

Type Parameters

Parameters

Parameters

Returns Promise<DataResult<T>>

Parameters

Returns void

Returns (() => void)

Returns void

Protected createH264Drawer

Returns H264BytestreamCanvasDrawer

Protected createRealtimeConnection

Parameters

Returns Promise<void>

fetchImage

Parameters

Returns Promise<HTMLImageElement>

findDataForTime

Parameters

Returns void

getDeviceContextName

Parameters

Returns Promise<undefined | string>

getDeviceContexts

Returns Promise<{ deviceId: string; deviceName: string; }[]>

getHardwareStreams

Parameters

Returns Promise<IRealtimeStream[]>

`Protected` addRemovableTelemetrySubscription

`Protected` createH264Drawer

`Protected` createRealtimeConnection

Returns Promise<{
deviceId: string;
deviceName: string;
}[]>

Returns Promise<{
location: ILocation;
streamName: string;
}[]>

Returns Promise<{
streamName: string;
transformTree: ITransformNode;
}[]>

`Private` getNearestPoint

`Protected` sendRtcMessage