@formant/data-sdk 0.0.74 → 0.0.77

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -79,7 +79,7 @@ export interface StreamData {
79
79
  export declare type DataPoint = [number, any];
80
80
  export declare class App {
81
81
  private static sendAppMessage;
82
- private static getCurrentModuleContext;
82
+ static getCurrentModuleContext(): string | null;
83
83
  static isModule(): boolean;
84
84
  static goToTime(date: Date): void;
85
85
  static showMessage(message: string): void;
@@ -59,7 +59,15 @@ export declare enum SessionType {
59
59
  Teleop = 1,
60
60
  Observe = 3
61
61
  }
62
- export declare class Device {
62
+ export interface IRealtimeDevice {
63
+ startRealtimeConnection(sessionType?: SessionType): Promise<void>;
64
+ startListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
65
+ stopListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
66
+ addRealtimeListener(listener: RealtimeListener): void;
67
+ removeRealtimeListener(listener: RealtimeListener): void;
68
+ createCustomDataChannel(channelName: string, rtcConfig?: RTCDataChannelInit): Promise<DataChannel>;
69
+ }
70
+ export declare class Device implements IRealtimeDevice {
63
71
  id: string;
64
72
  name: string;
65
73
  private organizationId;
@@ -73,7 +81,7 @@ export declare class Device {
73
81
  private handleMessage;
74
82
  getRealtimeStatus(): "disconnected" | "connecting" | "connected";
75
83
  getRealtimePing(): number | undefined;
76
- startRealtimeConnection(): Promise<void>;
84
+ startRealtimeConnection(sessionType?: SessionType): Promise<void>;
77
85
  addRealtimeListener(listener: RealtimeListener): void;
78
86
  removeRealtimeListener(listener: RealtimeListener): void;
79
87
  getRealtimeVideoStreams(): Promise<RealtimeVideoStream[]>;
@@ -4,6 +4,7 @@ import { IEventQuery } from "./model/IEventQuery";
4
4
  import { IEvent } from "./model/IEvent";
5
5
  import { IQuery } from "./model/IQuery";
6
6
  import { IStreamData } from "./model/IStreamData";
7
+ import { PeerDevice } from "./PeerDevice";
7
8
  export interface TelemetryResult {
8
9
  deviceId: string;
9
10
  name: string;
@@ -18,6 +19,7 @@ export declare class Fleet {
18
19
  static knownContext: WeakRef<Device>[];
19
20
  static setDefaultDevice(deviceId: string): Promise<void>;
20
21
  static getCurrentDevice(): Promise<Device>;
22
+ static getPeerDevice(url: string): Promise<PeerDevice>;
21
23
  static getDevice(deviceId: string): Promise<Device>;
22
24
  static getDevices(): Promise<Device[]>;
23
25
  static getOnlineDevices(): Promise<Device[]>;
@@ -1,4 +1,4 @@
1
- import { Device, RealtimeDataStream, IJointState, RealtimeMessage } from "./Device";
1
+ import { RealtimeDataStream, IJointState, RealtimeMessage, IRealtimeDevice } from "./Device";
2
2
  export declare type RealtimeManipulatorConfig = {
3
3
  currentJointStateStream: RealtimeDataStream;
4
4
  plannedJointStateStream?: RealtimeDataStream;
@@ -12,7 +12,7 @@ export declare class Manipulator {
12
12
  private device;
13
13
  private config;
14
14
  currentListeners: ((js: IJointState) => void)[];
15
- constructor(device: Device, config: RealtimeManipulatorConfig);
15
+ constructor(device: IRealtimeDevice, config: RealtimeManipulatorConfig);
16
16
  synchronize(): Promise<void>;
17
17
  desynchronize(): Promise<void>;
18
18
  onRealtimeMessage: (_peerId: string, message: RealtimeMessage) => void;
@@ -0,0 +1,36 @@
1
+ import { RtcClient } from "@formant/realtime-sdk";
2
+ import { DataChannel } from "./DataChannel";
3
+ import { Manipulator } from "./Manipulator";
4
+ import { TextRequestDataChannel, BinaryRequestDataChannel } from "./RequestDataChannel";
5
+ import { ConfigurationDocument, IRealtimeDevice, RealtimeDataStream, RealtimeListener, RealtimeVideoStream, SessionType } from "./Device";
6
+ import { IStreamCurrentValue } from "./model/IStreamCurrentValue";
7
+ export declare class PeerDevice implements IRealtimeDevice {
8
+ peer_url: string;
9
+ rtcClient: RtcClient | undefined;
10
+ remoteDevicePeerId: string | undefined;
11
+ realtimeListeners: RealtimeListener[];
12
+ id: string;
13
+ constructor(peer_url: string);
14
+ getLatestTelemetry(): Promise<IStreamCurrentValue[]>;
15
+ getDeviceId(): Promise<string>;
16
+ getConfiguration(): Promise<ConfigurationDocument>;
17
+ private handleMessage;
18
+ getRealtimeStatus(): "disconnected" | "connecting" | "connected";
19
+ getRealtimePing(): number | undefined;
20
+ startRealtimeConnection(sessionType?: SessionType): Promise<void>;
21
+ addRealtimeListener(listener: RealtimeListener): void;
22
+ removeRealtimeListener(listener: RealtimeListener): void;
23
+ getRealtimeVideoStreams(): Promise<RealtimeVideoStream[]>;
24
+ getRealtimeManipulators(): Promise<Manipulator[]>;
25
+ startListeningToRealtimeVideo(stream: RealtimeVideoStream): Promise<void>;
26
+ stopListeningToRealtimeVideo(stream: RealtimeVideoStream): Promise<void>;
27
+ startListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
28
+ stopListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
29
+ enableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>;
30
+ disableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>;
31
+ getRemotePeer(): Promise<import("@formant/realtime-sdk/dist/model/IRtcPeer").IRtcPeer>;
32
+ stopRealtimeConnection(): Promise<void>;
33
+ createCustomDataChannel(channelName: string, rtcConfig?: RTCDataChannelInit): Promise<DataChannel>;
34
+ createCustomRequestDataChannel(channelName: string, timeout?: number): TextRequestDataChannel;
35
+ createCustomBinaryRequestDataChannel(channelName: string, timeout?: number): BinaryRequestDataChannel;
36
+ }
@@ -1,11 +1,12 @@
1
- import { Device, DataChannel } from "./main";
1
+ import { DataChannel } from "./main";
2
+ import { IRealtimeDevice } from "./Device";
2
3
  declare abstract class RequestDataChannel {
3
- protected device: Device;
4
+ protected device: IRealtimeDevice;
4
5
  protected channel_name: string;
5
6
  protected timeout: number;
6
7
  protected channel: undefined | DataChannel;
7
8
  protected requestIdToResponseMap: Map<string, any>;
8
- constructor(device: Device, channel_name: string, timeout: number);
9
+ constructor(device: IRealtimeDevice, channel_name: string, timeout: number);
9
10
  }
10
11
  export declare class BinaryRequestDataChannel extends RequestDataChannel {
11
12
  private RESPONSE_SUCCESS_BYTE;
@@ -1,6 +1,7 @@
1
1
  export * from "./Fleet";
2
2
  export * from "./Authentication";
3
3
  export * from "./Device";
4
+ export * from "./PeerDevice";
4
5
  export * from "./DataChannel";
5
6
  export * from "./CaptureStream";
6
7
  export * from "./Manipulator";
@@ -78,6 +79,7 @@ export * from "./model/IsoDate";
78
79
  export * from "./model/ISpreadsheetIdRange";
79
80
  export * from "./model/IStreamData";
80
81
  export * from "./model/IStreamTypeMap";
82
+ export * from "./model/IStreamCurrentValue";
81
83
  export * from "./model/ISystemEvent";
82
84
  export * from "./model/ITaggedUsers";
83
85
  export * from "./model/ITagParameters";
@@ -0,0 +1,13 @@
1
+ import { IsoDate } from "./IsoDate";
2
+ import { IStreamTypeMap } from "./IStreamTypeMap";
3
+ import { ITags } from "./ITags";
4
+ import { StreamType } from "./StreamType";
5
+ import { Uuid } from "./Uuid";
6
+ export interface IStreamCurrentValue<T extends StreamType = any> {
7
+ deviceId: Uuid;
8
+ streamName: string;
9
+ streamType: StreamType;
10
+ tags: ITags;
11
+ currentValue: IStreamTypeMap[T];
12
+ currentValueTime: IsoDate;
13
+ }
package/package.json CHANGED
@@ -18,7 +18,7 @@
18
18
  "require": "./dist/data-sdk.umd.js"
19
19
  }
20
20
  },
21
- "version": "0.0.74",
21
+ "version": "0.0.77",
22
22
  "scripts": {
23
23
  "dev": "vite --port 9146",
24
24
  "build": "tsc && vite build",
@@ -32,7 +32,7 @@
32
32
  },
33
33
  "types": "./dist/types/data-sdk/src/main.d.ts",
34
34
  "dependencies": {
35
- "@formant/realtime-sdk": "0.0.7",
35
+ "@formant/realtime-sdk": "0.0.8",
36
36
  "@types/google-protobuf": "^3.15.5",
37
37
  "typedoc": "^0.22.13"
38
38
  }