@formant/data-sdk 0.0.90 → 0.0.93
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.
- package/dist/data-sdk.es.js +8 -9
- package/dist/data-sdk.umd.js +1 -1
- package/dist/types/common/defined.d.ts +3 -0
- package/dist/types/common/delay.d.ts +1 -0
- package/dist/types/data-sdk/src/App.d.ts +104 -0
- package/dist/types/data-sdk/src/Authentication.d.ts +28 -0
- package/dist/types/data-sdk/src/CaptureStream.d.ts +18 -0
- package/dist/types/data-sdk/src/DataChannel.d.ts +18 -0
- package/dist/types/data-sdk/src/Device.d.ts +112 -0
- package/dist/types/data-sdk/src/Fleet.d.ts +40 -0
- package/dist/types/data-sdk/src/KeyValue.d.ts +4 -0
- package/dist/types/data-sdk/src/Manipulator.d.ts +20 -0
- package/dist/types/data-sdk/src/PeerDevice.d.ts +37 -0
- package/dist/types/data-sdk/src/RequestDataChannel.d.ts +23 -0
- package/dist/types/data-sdk/src/config.d.ts +1 -0
- package/dist/types/data-sdk/src/main.d.ts +105 -0
- package/dist/types/data-sdk/src/model/AccessLevel.d.ts +5 -0
- package/dist/types/data-sdk/src/model/AggregateLevel.d.ts +1 -0
- package/dist/types/data-sdk/src/model/AnnotationAreaType.d.ts +2 -0
- package/dist/types/data-sdk/src/model/AnnotationType.d.ts +2 -0
- package/dist/types/data-sdk/src/model/EventSortableColumn.d.ts +1 -0
- package/dist/types/data-sdk/src/model/EventType.d.ts +2 -0
- package/dist/types/data-sdk/src/model/HealthStatus.d.ts +2 -0
- package/dist/types/data-sdk/src/model/HexRgbColor.d.ts +1 -0
- package/dist/types/data-sdk/src/model/IAnnotation.d.ts +13 -0
- package/dist/types/data-sdk/src/model/IAnnotationAreaTypeMap.d.ts +4 -0
- package/dist/types/data-sdk/src/model/IBaseEntity.d.ts +7 -0
- package/dist/types/data-sdk/src/model/IBaseEvent.d.ts +19 -0
- package/dist/types/data-sdk/src/model/IBattery.d.ts +6 -0
- package/dist/types/data-sdk/src/model/IBitset.d.ts +4 -0
- package/dist/types/data-sdk/src/model/IBoundingBox.d.ts +6 -0
- package/dist/types/data-sdk/src/model/ICommandDeliveryEvent.d.ts +3 -0
- package/dist/types/data-sdk/src/model/ICommandEventBase.d.ts +5 -0
- package/dist/types/data-sdk/src/model/ICommandParameter.d.ts +9 -0
- package/dist/types/data-sdk/src/model/ICommandRequest.d.ts +9 -0
- package/dist/types/data-sdk/src/model/ICommandRequestEvent.d.ts +5 -0
- package/dist/types/data-sdk/src/model/ICommandResponse.d.ts +13 -0
- package/dist/types/data-sdk/src/model/ICommandResponseEvent.d.ts +3 -0
- package/dist/types/data-sdk/src/model/IComment.d.ts +7 -0
- package/dist/types/data-sdk/src/model/IConfigurationMap.d.ts +3 -0
- package/dist/types/data-sdk/src/model/ICustomEvent.d.ts +5 -0
- package/dist/types/data-sdk/src/model/IDataPoint.d.ts +7 -0
- package/dist/types/data-sdk/src/model/IEvent.d.ts +12 -0
- package/dist/types/data-sdk/src/model/IEventFilter.d.ts +19 -0
- package/dist/types/data-sdk/src/model/IEventQuery.d.ts +7 -0
- package/dist/types/data-sdk/src/model/IEventSort.d.ts +6 -0
- package/dist/types/data-sdk/src/model/IFieldParametersTypeMap.d.ts +8 -0
- package/dist/types/data-sdk/src/model/IFile.d.ts +6 -0
- package/dist/types/data-sdk/src/model/IFileInfo.d.ts +6 -0
- package/dist/types/data-sdk/src/model/IFilter.d.ts +10 -0
- package/dist/types/data-sdk/src/model/IGoal.d.ts +5 -0
- package/dist/types/data-sdk/src/model/IGoalID.d.ts +3 -0
- package/dist/types/data-sdk/src/model/IHealth.d.ts +4 -0
- package/dist/types/data-sdk/src/model/IImage.d.ts +6 -0
- package/dist/types/data-sdk/src/model/IImageAnnotation.d.ts +9 -0
- package/dist/types/data-sdk/src/model/IInterventionRequest.d.ts +9 -0
- package/dist/types/data-sdk/src/model/IInterventionResponse.d.ts +10 -0
- package/dist/types/data-sdk/src/model/IInterventionTypeMap.d.ts +20 -0
- package/dist/types/data-sdk/src/model/ILabel.d.ts +4 -0
- package/dist/types/data-sdk/src/model/ILabeledPolygon.d.ts +4 -0
- package/dist/types/data-sdk/src/model/ILabelingRequestData.d.ts +8 -0
- package/dist/types/data-sdk/src/model/ILabelingResponseData.d.ts +4 -0
- package/dist/types/data-sdk/src/model/ILocalization.d.ts +12 -0
- package/dist/types/data-sdk/src/model/ILocation.d.ts +6 -0
- package/dist/types/data-sdk/src/model/IMap.d.ts +10 -0
- package/dist/types/data-sdk/src/model/INumericSetEntry.d.ts +5 -0
- package/dist/types/data-sdk/src/model/IOdometry.d.ts +7 -0
- package/dist/types/data-sdk/src/model/IPath.d.ts +5 -0
- package/dist/types/data-sdk/src/model/IPointCloud.d.ts +6 -0
- package/dist/types/data-sdk/src/model/IPortForwardingSessionRecord.d.ts +3 -0
- package/dist/types/data-sdk/src/model/IQuaternion.d.ts +6 -0
- package/dist/types/data-sdk/src/model/IQuery.d.ts +9 -0
- package/dist/types/data-sdk/src/model/IRtcSessionRecord.d.ts +9 -0
- package/dist/types/data-sdk/src/model/ISelectionRequestData.d.ts +6 -0
- package/dist/types/data-sdk/src/model/ISelectionResponseData.d.ts +3 -0
- package/dist/types/data-sdk/src/model/ISheetParameters.d.ts +5 -0
- package/dist/types/data-sdk/src/model/ISpreadsheetIdRange.d.ts +4 -0
- package/dist/types/data-sdk/src/model/IStreamCurrentValue.d.ts +13 -0
- package/dist/types/data-sdk/src/model/IStreamData.d.ts +11 -0
- package/dist/types/data-sdk/src/model/IStreamTypeMap.d.ts +27 -0
- package/dist/types/data-sdk/src/model/ISystemEvent.d.ts +3 -0
- package/dist/types/data-sdk/src/model/ITagParameters.d.ts +3 -0
- package/dist/types/data-sdk/src/model/ITagSets.d.ts +3 -0
- package/dist/types/data-sdk/src/model/ITaggedUsers.d.ts +4 -0
- package/dist/types/data-sdk/src/model/ITags.d.ts +3 -0
- package/dist/types/data-sdk/src/model/ITeleopRequestData.d.ts +3 -0
- package/dist/types/data-sdk/src/model/ITeleopResponseData.d.ts +4 -0
- package/dist/types/data-sdk/src/model/ITeleopSessionRecord.d.ts +3 -0
- package/dist/types/data-sdk/src/model/ITransform.d.ts +6 -0
- package/dist/types/data-sdk/src/model/ITransformNode.d.ts +7 -0
- package/dist/types/data-sdk/src/model/ITriggeredEvent.d.ts +10 -0
- package/dist/types/data-sdk/src/model/ITwist.d.ts +5 -0
- package/dist/types/data-sdk/src/model/IUserParameters.d.ts +4 -0
- package/dist/types/data-sdk/src/model/IVector3.d.ts +5 -0
- package/dist/types/data-sdk/src/model/IVideo.d.ts +7 -0
- package/dist/types/data-sdk/src/model/InterventionType.d.ts +2 -0
- package/dist/types/data-sdk/src/model/IsoDate.d.ts +1 -0
- package/dist/types/data-sdk/src/model/Severity.d.ts +2 -0
- package/dist/types/data-sdk/src/model/SortOrder.d.ts +1 -0
- package/dist/types/data-sdk/src/model/StreamType.d.ts +2 -0
- package/dist/types/data-sdk/src/model/Timestamp.d.ts +1 -0
- package/dist/types/data-sdk/src/model/Uuid.d.ts +1 -0
- package/dist/types/data-sdk/src/model/VideoMimeType.d.ts +2 -0
- package/dist/types/data-sdk/src/model/accessLevels.d.ts +1 -0
- package/dist/types/data-sdk/src/model/aggregateLevels.d.ts +2 -0
- package/dist/types/data-sdk/src/model/annotationTypes.d.ts +1 -0
- package/dist/types/data-sdk/src/model/eventTypes.d.ts +1 -0
- package/dist/types/data-sdk/src/model/healthStatuses.d.ts +1 -0
- package/dist/types/data-sdk/src/model/interventionTypes.d.ts +1 -0
- package/dist/types/data-sdk/src/model/severities.d.ts +1 -0
- package/dist/types/data-sdk/src/model/videoMimeTypes.d.ts +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export interface User {
|
|
2
|
+
firstName: string;
|
|
3
|
+
lastName: string;
|
|
4
|
+
email: string;
|
|
5
|
+
organizationId: string;
|
|
6
|
+
id: string;
|
|
7
|
+
}
|
|
8
|
+
export interface IAuthentication {
|
|
9
|
+
accessToken: string;
|
|
10
|
+
organizationId: string;
|
|
11
|
+
refreshToken: string;
|
|
12
|
+
userId: string;
|
|
13
|
+
}
|
|
14
|
+
export declare class Authentication {
|
|
15
|
+
static token: string | undefined;
|
|
16
|
+
static refreshToken: string | undefined;
|
|
17
|
+
static currentUser: User | undefined;
|
|
18
|
+
static currentOrganization: string | undefined;
|
|
19
|
+
static isShareToken: boolean;
|
|
20
|
+
static defaultDeviceId: string | undefined;
|
|
21
|
+
static waitingForAuth: ((result: boolean) => void)[];
|
|
22
|
+
static login(email: string, password: string): Promise<IAuthentication | Error>;
|
|
23
|
+
static loginWithToken(token: string, refreshToken?: string): Promise<void>;
|
|
24
|
+
static isAuthenticated(): boolean;
|
|
25
|
+
static getCurrentUser(): User | undefined;
|
|
26
|
+
static waitTilAuthenticated(): Promise<boolean>;
|
|
27
|
+
static listenForRefresh(): Promise<void>;
|
|
28
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export interface CaptureSession {
|
|
2
|
+
deviceId: string;
|
|
3
|
+
streamName: string;
|
|
4
|
+
tags: {};
|
|
5
|
+
expiration: string;
|
|
6
|
+
organizationId: string;
|
|
7
|
+
userId: string;
|
|
8
|
+
code: string;
|
|
9
|
+
id: string;
|
|
10
|
+
createdAt: string;
|
|
11
|
+
updatedAt: string;
|
|
12
|
+
}
|
|
13
|
+
export declare class CaptureStream {
|
|
14
|
+
captureSession: CaptureSession;
|
|
15
|
+
token: string | undefined;
|
|
16
|
+
constructor(captureSession: CaptureSession);
|
|
17
|
+
ingestJSON(value: {}): Promise<void>;
|
|
18
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export declare type DataChannelStringListener = (message: string) => void;
|
|
2
|
+
export declare type DataChannelBinaryListener = (message: Uint8Array) => void;
|
|
3
|
+
export declare class DataChannel {
|
|
4
|
+
private dataChannel;
|
|
5
|
+
ready: boolean;
|
|
6
|
+
listeners: DataChannelStringListener[];
|
|
7
|
+
binaryListeners: DataChannelBinaryListener[];
|
|
8
|
+
error: string | undefined;
|
|
9
|
+
decoder: TextDecoder;
|
|
10
|
+
constructor(dataChannel: RTCDataChannel);
|
|
11
|
+
waitTilReady(): Promise<boolean>;
|
|
12
|
+
send(data: string): void;
|
|
13
|
+
sendBinary(data: Uint8Array): void;
|
|
14
|
+
addListener(listener: DataChannelStringListener): void;
|
|
15
|
+
removeListener(listener: DataChannelStringListener): void;
|
|
16
|
+
addBinaryListener(listener: DataChannelBinaryListener): void;
|
|
17
|
+
removeBinaryListener(listener: DataChannelBinaryListener): void;
|
|
18
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { IRtcConnectConfiguration, RtcClient } from "@formant/realtime-sdk";
|
|
2
|
+
import { DataChannel } from "./DataChannel";
|
|
3
|
+
import { CaptureStream } from "./CaptureStream";
|
|
4
|
+
import { Manipulator } from "./Manipulator";
|
|
5
|
+
import { TextRequestDataChannel, BinaryRequestDataChannel } from "./RequestDataChannel";
|
|
6
|
+
import { InterventionType } from "./main";
|
|
7
|
+
import { IInterventionTypeMap } from "./main";
|
|
8
|
+
import { IInterventionResponse } from "./main";
|
|
9
|
+
export interface ConfigurationDocument {
|
|
10
|
+
urdfFiles: string[];
|
|
11
|
+
telemetry?: {
|
|
12
|
+
streams?: {
|
|
13
|
+
name: string;
|
|
14
|
+
disabled?: boolean;
|
|
15
|
+
onDemand?: boolean;
|
|
16
|
+
}[];
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
export interface Command {
|
|
20
|
+
id: string;
|
|
21
|
+
name: string;
|
|
22
|
+
command: string;
|
|
23
|
+
description: string;
|
|
24
|
+
parameterEnabled: true;
|
|
25
|
+
parameterValue: string | null;
|
|
26
|
+
parameterMeta?: {
|
|
27
|
+
topic?: string;
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
export interface IJointState {
|
|
31
|
+
name: string[];
|
|
32
|
+
position: number[];
|
|
33
|
+
velocity?: number[];
|
|
34
|
+
effort?: number[];
|
|
35
|
+
}
|
|
36
|
+
export interface TelemetryStream {
|
|
37
|
+
name: string;
|
|
38
|
+
onDemand: boolean;
|
|
39
|
+
}
|
|
40
|
+
export declare type RealtimeMessage = {
|
|
41
|
+
header: {
|
|
42
|
+
created: number;
|
|
43
|
+
stream: {
|
|
44
|
+
entityId: string;
|
|
45
|
+
streamName: string;
|
|
46
|
+
streamType: string;
|
|
47
|
+
};
|
|
48
|
+
};
|
|
49
|
+
payload: any;
|
|
50
|
+
};
|
|
51
|
+
export declare type RealtimeListener = (peerId: string, message: RealtimeMessage) => void;
|
|
52
|
+
export declare type RealtimeVideoStream = {
|
|
53
|
+
name: string;
|
|
54
|
+
};
|
|
55
|
+
export declare type RealtimeDataStream = {
|
|
56
|
+
name: string;
|
|
57
|
+
};
|
|
58
|
+
export declare const SessionType: {
|
|
59
|
+
Teleop: number;
|
|
60
|
+
Observe: number;
|
|
61
|
+
};
|
|
62
|
+
export interface IRealtimeDevice {
|
|
63
|
+
startRealtimeConnection(config?: IRtcConnectConfiguration): 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 {
|
|
71
|
+
id: string;
|
|
72
|
+
name: string;
|
|
73
|
+
private organizationId;
|
|
74
|
+
rtcClient: RtcClient | undefined;
|
|
75
|
+
remoteDevicePeerId: string | undefined;
|
|
76
|
+
realtimeListeners: RealtimeListener[];
|
|
77
|
+
constructor(id: string, name: string, organizationId: string);
|
|
78
|
+
getLatestTelemetry(): Promise<any>;
|
|
79
|
+
getConfiguration(): Promise<ConfigurationDocument>;
|
|
80
|
+
getFileUrl(fileId: string): Promise<string[]>;
|
|
81
|
+
private handleMessage;
|
|
82
|
+
getRealtimeStatus(): "disconnected" | "connecting" | "connected";
|
|
83
|
+
getRealtimePing(): number | undefined;
|
|
84
|
+
startRealtimeConnection(config?: IRtcConnectConfiguration): Promise<void>;
|
|
85
|
+
addRealtimeListener(listener: RealtimeListener): void;
|
|
86
|
+
removeRealtimeListener(listener: RealtimeListener): void;
|
|
87
|
+
getRealtimeVideoStreams(): Promise<RealtimeVideoStream[]>;
|
|
88
|
+
getRealtimeManipulators(): Promise<Manipulator[]>;
|
|
89
|
+
startListeningToRealtimeVideo(stream: RealtimeVideoStream): Promise<void>;
|
|
90
|
+
stopListeningToRealtimeVideo(stream: RealtimeVideoStream): Promise<void>;
|
|
91
|
+
startListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
|
|
92
|
+
stopListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
|
|
93
|
+
enableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>;
|
|
94
|
+
disableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>;
|
|
95
|
+
getRemotePeer(): Promise<import("@formant/realtime-sdk/dist/model/IRtcPeer").IRtcPeer>;
|
|
96
|
+
stopRealtimeConnection(): Promise<void>;
|
|
97
|
+
isInRealtimeSession(): Promise<boolean>;
|
|
98
|
+
getAvailableCommands(): Promise<Command[]>;
|
|
99
|
+
sendCommand(name: string, data?: string, time?: Date, metadata?: {}): Promise<any>;
|
|
100
|
+
createCustomDataChannel(channelName: string, rtcConfig?: RTCDataChannelInit): Promise<DataChannel>;
|
|
101
|
+
createCustomRequestDataChannel(channelName: string, timeout?: number): TextRequestDataChannel;
|
|
102
|
+
createCustomBinaryRequestDataChannel(channelName: string, timeout?: number): BinaryRequestDataChannel;
|
|
103
|
+
createCaptureStream(streamName: string): Promise<CaptureStream>;
|
|
104
|
+
getTelemetry(streamNameOrStreamNames: string | string[], start: Date, end: Date, tags?: {
|
|
105
|
+
[key in string]: string[];
|
|
106
|
+
}): Promise<import("./Fleet").TelemetryResult[]>;
|
|
107
|
+
getTelemetryStreams(): Promise<TelemetryStream[]>;
|
|
108
|
+
createInterventionRequest<T extends InterventionType>(message: string, interventionType: InterventionType, interventionRequest: IInterventionTypeMap[T]["request"], tags?: {
|
|
109
|
+
[key in string]: string[];
|
|
110
|
+
}): Promise<(id: string) => IInterventionTypeMap[T]["response"]>;
|
|
111
|
+
addInterventionResponse<T extends InterventionType>(interventionId: string, interventionType: InterventionType, data: IInterventionTypeMap[T]["response"]): Promise<IInterventionResponse>;
|
|
112
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { Device } from "./Device";
|
|
2
|
+
import { IRtcPeer } from "@formant/realtime-sdk/dist/model/IRtcPeer";
|
|
3
|
+
import { IEventQuery } from "./model/IEventQuery";
|
|
4
|
+
import { IEvent } from "./model/IEvent";
|
|
5
|
+
import { IQuery } from "./model/IQuery";
|
|
6
|
+
import { IStreamData } from "./model/IStreamData";
|
|
7
|
+
import { PeerDevice } from "./PeerDevice";
|
|
8
|
+
export interface TelemetryResult {
|
|
9
|
+
deviceId: string;
|
|
10
|
+
name: string;
|
|
11
|
+
points: [number, any][];
|
|
12
|
+
tags: {
|
|
13
|
+
[key in string]: string | number;
|
|
14
|
+
};
|
|
15
|
+
type: string;
|
|
16
|
+
}
|
|
17
|
+
export declare class Fleet {
|
|
18
|
+
static defaultDeviceId: string | undefined;
|
|
19
|
+
static knownContext: WeakRef<Device>[];
|
|
20
|
+
static setDefaultDevice(deviceId: string): Promise<void>;
|
|
21
|
+
static getCurrentDevice(): Promise<Device>;
|
|
22
|
+
static getPeerDevice(url: string): Promise<PeerDevice>;
|
|
23
|
+
static getDevice(deviceId: string): Promise<Device>;
|
|
24
|
+
static getDevices(): Promise<Device[]>;
|
|
25
|
+
static getOnlineDevices(): Promise<Device[]>;
|
|
26
|
+
static getPeers(): Promise<IRtcPeer[]>;
|
|
27
|
+
static getRealtimeSessions(): Promise<{
|
|
28
|
+
[key in string]: string[];
|
|
29
|
+
}>;
|
|
30
|
+
static getRealtimeDevices(): Promise<Device[]>;
|
|
31
|
+
static getLatestTelemetry(deviceIdOrDeviceIds?: string | string[]): Promise<any>;
|
|
32
|
+
static getTelemetry(deviceIdOrDeviceIds: string | string[], streamNameOrStreamNames: string | string[], start: Date, end: Date, tags?: {
|
|
33
|
+
[key in string]: string[];
|
|
34
|
+
}): Promise<TelemetryResult[]>;
|
|
35
|
+
static getFileUrl(uuid: string): Promise<string>;
|
|
36
|
+
static queryTelemetry(query: IQuery): Promise<IStreamData<keyof import("./main").IStreamTypeMap>[]>;
|
|
37
|
+
static queryEvents(query: IEventQuery): Promise<IEvent[]>;
|
|
38
|
+
static getEvent(uuid: string): Promise<IEvent>;
|
|
39
|
+
static getInterventions(): Promise<IEvent[]>;
|
|
40
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { RealtimeDataStream, IJointState, RealtimeMessage, IRealtimeDevice } from "./Device";
|
|
2
|
+
export declare type RealtimeManipulatorConfig = {
|
|
3
|
+
currentJointStateStream: RealtimeDataStream;
|
|
4
|
+
plannedJointStateStream?: RealtimeDataStream;
|
|
5
|
+
planValidStream?: RealtimeDataStream;
|
|
6
|
+
endEffectorStream?: RealtimeDataStream;
|
|
7
|
+
endEffectorLinkName?: string;
|
|
8
|
+
baseReferenceFrame?: string;
|
|
9
|
+
localFrame?: string;
|
|
10
|
+
};
|
|
11
|
+
export declare class Manipulator {
|
|
12
|
+
private device;
|
|
13
|
+
private config;
|
|
14
|
+
currentListeners: ((js: IJointState) => void)[];
|
|
15
|
+
constructor(device: IRealtimeDevice, config: RealtimeManipulatorConfig);
|
|
16
|
+
synchronize(): Promise<void>;
|
|
17
|
+
desynchronize(): Promise<void>;
|
|
18
|
+
onRealtimeMessage: (_peerId: string, message: RealtimeMessage) => void;
|
|
19
|
+
addCurrentJointStateListener(listener: (js: IJointState) => void): Promise<void>;
|
|
20
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { IRtcConnectConfiguration, 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 } from "./Device";
|
|
6
|
+
import { IStreamCurrentValue } from "./model/IStreamCurrentValue";
|
|
7
|
+
import { IRtcPeer } from "@formant/realtime-sdk/dist/model/IRtcPeer";
|
|
8
|
+
export declare class PeerDevice implements IRealtimeDevice {
|
|
9
|
+
peerUrl: string;
|
|
10
|
+
rtcClient: RtcClient | undefined;
|
|
11
|
+
remoteDevicePeerId: string | undefined;
|
|
12
|
+
realtimeListeners: RealtimeListener[];
|
|
13
|
+
id: string;
|
|
14
|
+
constructor(peerUrl: string);
|
|
15
|
+
getLatestTelemetry(): Promise<IStreamCurrentValue[]>;
|
|
16
|
+
getDeviceId(): Promise<string>;
|
|
17
|
+
getConfiguration(): Promise<ConfigurationDocument>;
|
|
18
|
+
private handleMessage;
|
|
19
|
+
getRealtimeStatus(): "disconnected" | "connecting" | "connected";
|
|
20
|
+
getRealtimePing(): number | undefined;
|
|
21
|
+
startRealtimeConnection(_config?: IRtcConnectConfiguration): Promise<void>;
|
|
22
|
+
addRealtimeListener(listener: RealtimeListener): void;
|
|
23
|
+
removeRealtimeListener(listener: RealtimeListener): void;
|
|
24
|
+
getRealtimeVideoStreams(): Promise<RealtimeVideoStream[]>;
|
|
25
|
+
getRealtimeManipulators(): Promise<Manipulator[]>;
|
|
26
|
+
startListeningToRealtimeVideo(stream: RealtimeVideoStream): Promise<void>;
|
|
27
|
+
stopListeningToRealtimeVideo(stream: RealtimeVideoStream): Promise<void>;
|
|
28
|
+
startListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
|
|
29
|
+
stopListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
|
|
30
|
+
enableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>;
|
|
31
|
+
disableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>;
|
|
32
|
+
getRemotePeer(): Promise<IRtcPeer>;
|
|
33
|
+
stopRealtimeConnection(): Promise<void>;
|
|
34
|
+
createCustomDataChannel(channelName: string, rtcConfig?: RTCDataChannelInit): Promise<DataChannel>;
|
|
35
|
+
createCustomRequestDataChannel(channelName: string, timeout?: number): TextRequestDataChannel;
|
|
36
|
+
createCustomBinaryRequestDataChannel(channelName: string, timeout?: number): BinaryRequestDataChannel;
|
|
37
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { DataChannel } from "./main";
|
|
2
|
+
import { IRealtimeDevice } from "./Device";
|
|
3
|
+
declare abstract class RequestDataChannel {
|
|
4
|
+
protected device: IRealtimeDevice;
|
|
5
|
+
protected channel_name: string;
|
|
6
|
+
protected timeout: number;
|
|
7
|
+
protected channel: undefined | DataChannel;
|
|
8
|
+
protected requestIdToResponseMap: Map<string, any>;
|
|
9
|
+
constructor(device: IRealtimeDevice, channel_name: string, timeout: number);
|
|
10
|
+
}
|
|
11
|
+
export declare class BinaryRequestDataChannel extends RequestDataChannel {
|
|
12
|
+
private RESPONSE_SUCCESS_BYTE;
|
|
13
|
+
private decoder;
|
|
14
|
+
generateBinaryId(): Uint8Array;
|
|
15
|
+
initialize(): Promise<void>;
|
|
16
|
+
request(data: Uint8Array): Promise<any>;
|
|
17
|
+
}
|
|
18
|
+
export declare class TextRequestDataChannel extends RequestDataChannel {
|
|
19
|
+
generateTextId(): string;
|
|
20
|
+
initialize(): Promise<void>;
|
|
21
|
+
request(data: string): Promise<any>;
|
|
22
|
+
}
|
|
23
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare let FORMANT_API_URL: string;
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
export * from "./Fleet";
|
|
2
|
+
export * from "./Authentication";
|
|
3
|
+
export * from "./Device";
|
|
4
|
+
export * from "./PeerDevice";
|
|
5
|
+
export * from "./DataChannel";
|
|
6
|
+
export * from "./CaptureStream";
|
|
7
|
+
export * from "./Manipulator";
|
|
8
|
+
export * from "./RequestDataChannel";
|
|
9
|
+
export * from "./App";
|
|
10
|
+
export * from "./KeyValue";
|
|
11
|
+
export * from "./model/accessLevels";
|
|
12
|
+
export * from "./model/AccessLevel";
|
|
13
|
+
export * from "./model/aggregateLevels";
|
|
14
|
+
export * from "./model/AggregateLevel";
|
|
15
|
+
export * from "./model/AnnotationAreaType";
|
|
16
|
+
export * from "./model/annotationTypes";
|
|
17
|
+
export * from "./model/AnnotationType";
|
|
18
|
+
export * from "./model/EventSortableColumn";
|
|
19
|
+
export * from "./model/eventTypes";
|
|
20
|
+
export * from "./model/EventType";
|
|
21
|
+
export * from "./model/healthStatuses";
|
|
22
|
+
export * from "./model/HealthStatus";
|
|
23
|
+
export * from "./model/HexRgbColor";
|
|
24
|
+
export * from "./model/IAnnotationAreaTypeMap";
|
|
25
|
+
export * from "./model/IAnnotation";
|
|
26
|
+
export * from "./model/IBaseEntity";
|
|
27
|
+
export * from "./model/IBaseEvent";
|
|
28
|
+
export * from "./model/IBattery";
|
|
29
|
+
export * from "./model/IBitset";
|
|
30
|
+
export * from "./model/IBoundingBox";
|
|
31
|
+
export * from "./model/ICommandDeliveryEvent";
|
|
32
|
+
export * from "./model/ICommandEventBase";
|
|
33
|
+
export * from "./model/ICommandParameter";
|
|
34
|
+
export * from "./model/ICommandRequestEvent";
|
|
35
|
+
export * from "./model/ICommandRequest";
|
|
36
|
+
export * from "./model/ICommandResponseEvent";
|
|
37
|
+
export * from "./model/ICommandResponse";
|
|
38
|
+
export * from "./model/IComment";
|
|
39
|
+
export * from "./model/IConfigurationMap";
|
|
40
|
+
export * from "./model/ICustomEvent";
|
|
41
|
+
export * from "./model/IDataPoint";
|
|
42
|
+
export * from "./model/IEventFilter";
|
|
43
|
+
export * from "./model/IEventQuery";
|
|
44
|
+
export * from "./model/IEventSort";
|
|
45
|
+
export * from "./model/IEvent";
|
|
46
|
+
export * from "./model/IFieldParametersTypeMap";
|
|
47
|
+
export * from "./model/IFileInfo";
|
|
48
|
+
export * from "./model/IFile";
|
|
49
|
+
export * from "./model/IFilter";
|
|
50
|
+
export * from "./model/IGoalID";
|
|
51
|
+
export * from "./model/IGoal";
|
|
52
|
+
export * from "./model/IHealth";
|
|
53
|
+
export * from "./model/IImageAnnotation";
|
|
54
|
+
export * from "./model/IImage";
|
|
55
|
+
export * from "./model/IInterventionRequest";
|
|
56
|
+
export * from "./model/IInterventionResponse";
|
|
57
|
+
export * from "./model/IInterventionTypeMap";
|
|
58
|
+
export * from "./model/ILabeledPolygon";
|
|
59
|
+
export * from "./model/ILabelingRequestData";
|
|
60
|
+
export * from "./model/ILabelingResponseData";
|
|
61
|
+
export * from "./model/ILabel";
|
|
62
|
+
export * from "./model/ILocalization";
|
|
63
|
+
export * from "./model/ILocation";
|
|
64
|
+
export * from "./model/IMap";
|
|
65
|
+
export * from "./model/interventionTypes";
|
|
66
|
+
export * from "./model/InterventionType";
|
|
67
|
+
export * from "./model/INumericSetEntry";
|
|
68
|
+
export * from "./model/IOdometry";
|
|
69
|
+
export * from "./model/IPath";
|
|
70
|
+
export * from "./model/IPointCloud";
|
|
71
|
+
export * from "./model/IPortForwardingSessionRecord";
|
|
72
|
+
export * from "./model/IQuaternion";
|
|
73
|
+
export * from "./model/IQuery";
|
|
74
|
+
export * from "./model/IRtcSessionRecord";
|
|
75
|
+
export * from "./model/ISelectionRequestData";
|
|
76
|
+
export * from "./model/ISelectionResponseData";
|
|
77
|
+
export * from "./model/ISheetParameters";
|
|
78
|
+
export * from "./model/IsoDate";
|
|
79
|
+
export * from "./model/ISpreadsheetIdRange";
|
|
80
|
+
export * from "./model/IStreamData";
|
|
81
|
+
export * from "./model/IStreamTypeMap";
|
|
82
|
+
export * from "./model/IStreamCurrentValue";
|
|
83
|
+
export * from "./model/ISystemEvent";
|
|
84
|
+
export * from "./model/ITaggedUsers";
|
|
85
|
+
export * from "./model/ITagParameters";
|
|
86
|
+
export * from "./model/ITagSets";
|
|
87
|
+
export * from "./model/ITags";
|
|
88
|
+
export * from "./model/ITeleopRequestData";
|
|
89
|
+
export * from "./model/ITeleopResponseData";
|
|
90
|
+
export * from "./model/ITeleopSessionRecord";
|
|
91
|
+
export * from "./model/ITransformNode";
|
|
92
|
+
export * from "./model/ITransform";
|
|
93
|
+
export * from "./model/ITriggeredEvent";
|
|
94
|
+
export * from "./model/ITwist";
|
|
95
|
+
export * from "./model/IUserParameters";
|
|
96
|
+
export * from "./model/IVector3";
|
|
97
|
+
export * from "./model/IVideo";
|
|
98
|
+
export * from "./model/severities";
|
|
99
|
+
export * from "./model/Severity";
|
|
100
|
+
export * from "./model/SortOrder";
|
|
101
|
+
export * from "./model/StreamType";
|
|
102
|
+
export * from "./model/Timestamp";
|
|
103
|
+
export * from "./model/Uuid";
|
|
104
|
+
export * from "./model/videoMimeTypes";
|
|
105
|
+
export * from "./model/VideoMimeType";
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { accessLevels } from "./accessLevels";
|
|
2
|
+
export declare type AccessLevel = typeof accessLevels[number];
|
|
3
|
+
export declare const viewer: "viewer" | "operator" | "administrator";
|
|
4
|
+
export declare const operator: "viewer" | "operator" | "administrator";
|
|
5
|
+
export declare const administrator: "viewer" | "operator" | "administrator";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare type AggregateLevel = "year" | "month" | "week" | "day" | "hour" | "minute" | "second";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare type EventSortableColumn = "device.name" | "time";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare type HexRgbColor = string;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { IBaseEvent } from "./IBaseEvent";
|
|
2
|
+
import { IsoDate } from "./IsoDate";
|
|
3
|
+
import { ISpreadsheetIdRange } from "./ISpreadsheetIdRange";
|
|
4
|
+
import { ITaggedUsers } from "./ITaggedUsers";
|
|
5
|
+
import { Uuid } from "./Uuid";
|
|
6
|
+
export interface IAnnotation extends IBaseEvent<"annotation"> {
|
|
7
|
+
editedAt?: IsoDate;
|
|
8
|
+
userId: Uuid;
|
|
9
|
+
annotationTemplateId: Uuid;
|
|
10
|
+
taggedUsers?: ITaggedUsers | null;
|
|
11
|
+
publishedTo?: ISpreadsheetIdRange;
|
|
12
|
+
note?: string | null;
|
|
13
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { EventType } from "./EventType";
|
|
2
|
+
import { IBaseEntity } from "./IBaseEntity";
|
|
3
|
+
import { IsoDate } from "./IsoDate";
|
|
4
|
+
import { ITags } from "./ITags";
|
|
5
|
+
import { StreamType } from "./StreamType";
|
|
6
|
+
import { Uuid } from "./Uuid";
|
|
7
|
+
export interface IBaseEvent<T extends EventType = EventType> extends IBaseEntity {
|
|
8
|
+
type?: T;
|
|
9
|
+
organizationId?: Uuid;
|
|
10
|
+
time: IsoDate;
|
|
11
|
+
endTime?: IsoDate | null;
|
|
12
|
+
message: string;
|
|
13
|
+
viewed?: boolean;
|
|
14
|
+
deviceId?: Uuid;
|
|
15
|
+
streamName?: string;
|
|
16
|
+
streamType?: StreamType;
|
|
17
|
+
tags?: ITags;
|
|
18
|
+
notificationEnabled?: boolean;
|
|
19
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { IConfigurationMap } from "./IConfigurationMap";
|
|
2
|
+
import { IFileInfo } from "./IFileInfo";
|
|
3
|
+
import { IsoDate } from "./IsoDate";
|
|
4
|
+
export interface ICommandParameter {
|
|
5
|
+
value?: string;
|
|
6
|
+
meta?: IConfigurationMap;
|
|
7
|
+
scrubberTime: IsoDate;
|
|
8
|
+
files?: IFileInfo[];
|
|
9
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { IsoDate } from "./IsoDate";
|
|
2
|
+
import { ITags } from "./ITags";
|
|
3
|
+
import { StreamType } from "./StreamType";
|
|
4
|
+
import { Uuid } from "./Uuid";
|
|
5
|
+
export interface ICommandResponse {
|
|
6
|
+
time: IsoDate;
|
|
7
|
+
message: string;
|
|
8
|
+
success: boolean;
|
|
9
|
+
replyToCommandRequestId: Uuid;
|
|
10
|
+
streamName?: string;
|
|
11
|
+
streamType?: StreamType;
|
|
12
|
+
tags?: ITags;
|
|
13
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { IAnnotation } from "./IAnnotation";
|
|
2
|
+
import { ICommandDeliveryEvent } from "./ICommandDeliveryEvent";
|
|
3
|
+
import { ICommandRequestEvent } from "./ICommandRequestEvent";
|
|
4
|
+
import { ICommandResponseEvent } from "./ICommandResponseEvent";
|
|
5
|
+
import { IComment } from "./IComment";
|
|
6
|
+
import { ICustomEvent } from "./ICustomEvent";
|
|
7
|
+
import { IInterventionRequest } from "./IInterventionRequest";
|
|
8
|
+
import { IPortForwardingSessionRecord } from "./IPortForwardingSessionRecord";
|
|
9
|
+
import { ISystemEvent } from "./ISystemEvent";
|
|
10
|
+
import { ITeleopSessionRecord } from "./ITeleopSessionRecord";
|
|
11
|
+
import { ITriggeredEvent } from "./ITriggeredEvent";
|
|
12
|
+
export declare type IEvent = ITriggeredEvent | IInterventionRequest | ITeleopSessionRecord | IPortForwardingSessionRecord | ICommandRequestEvent | ICommandResponseEvent | ICommandDeliveryEvent | ICustomEvent | IComment | ISystemEvent | IAnnotation;
|