Class BasicUniverseDataConnector

Hierarchy (view full)

BasicUniverseDataConnector
- LiveUniverseData
- TelemetryUniverseData

Constructors

constructor

new BasicUniverseDataConnector(): BasicUniverseDataConnector
Returns BasicUniverseDataConnector
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:87

Properties

lastQueriedHistoricTime

lastQueriedHistoricTime: undefined | Date

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

Methods

addInteraction

addInteraction(_interaction): void
Parameters
- _interaction: Interaction
Returns void
- 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
- 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
- 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
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:209

`Protected` createH264Drawer

createH264Drawer(): H264BytestreamCanvasDrawer
Returns H264BytestreamCanvasDrawer
- 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>
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:170

fetchImage

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

`Private` generateTelemetryFilter

generateTelemetryFilter(): IQuery
Returns IQuery
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:138

getDeviceContextName

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

getDeviceContexts

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

getHardwareStreams

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

getInteractions

getInteractions(): Interaction[]
Returns Interaction[]
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:377

getLatestLocations

getLatestLocations(): Promise<{
location: ILocation;
streamName: string;
}[]>
Returns Promise<{
location: ILocation;
streamName: string;
}[]>
- 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;
}[]>
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:399

getRealtimeButtons

getRealtimeButtons(_deviceId): Promise<RealtimeButtonConfiguration[]>
Parameters
- _deviceId: string
Returns Promise<RealtimeButtonConfiguration[]>
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:393

getStatistics

getStatistics(): Promise<IUniverseStatistics>
Returns Promise<IUniverseStatistics>
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:439

getTelemetryStreamType

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

getTelemetryStreams

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

getTeleopRosStreams

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

getTime

getTime(): Date | "live"
Returns Date | "live"
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:79

getTimeMs

getTimeMs(): number
Returns number
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:83

getUrdfs

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

removeInteraction

removeInteraction(_id): void
Parameters
- _id: string
Returns void
- 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>
- 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>
- 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>
- 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>
- 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>
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:160

setTime

setTime(time): void
Parameters
- time: Date | "live"
Returns void
- 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
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:445

Class BasicUniverseDataConnector

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BasicUniverseDataConnector

Properties

lastQueriedHistoricTime

mapRealtimeConnections

queryStore

subscriberDistributorsLoaders

subscriberLoaders

subscriberSources

time

timeChangeListeners

Type declaration

Parameters

Returns void

Methods

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>

Private generateTelemetryFilter

Returns IQuery

getDeviceContextName

Parameters

Returns Promise<undefined | string>

getDeviceContexts

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

getHardwareStreams

Parameters

Returns Promise<IRealtimeStream[]>

getInteractions

Returns Interaction[]

getLatestLocations

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

getLatestTransformTrees

Parameters

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

getRealtimeButtons

Parameters

Returns Promise<RealtimeButtonConfiguration[]>

getStatistics

Returns Promise<IUniverseStatistics>

getTelemetryStreamType

Parameters

Returns Promise<undefined | string>

getTelemetryStreams

`Protected` addRemovableTelemetrySubscription

`Protected` createH264Drawer

`Protected` createRealtimeConnection

`Private` generateTelemetryFilter

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

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

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

`Protected` sendRtcMessage