@wandelbots/nova-js 3.12.0 → 3.13.0-pr.307.07b1ea2
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/experimental/nats/index.cjs +115 -0
- package/dist/experimental/nats/index.cjs.map +1 -0
- package/dist/experimental/nats/index.d.cts +2227 -0
- package/dist/experimental/nats/index.d.cts.map +1 -0
- package/dist/experimental/nats/index.d.mts +2227 -0
- package/dist/experimental/nats/index.d.mts.map +1 -0
- package/dist/experimental/nats/index.mjs +114 -0
- package/dist/experimental/nats/index.mjs.map +1 -0
- package/package.json +11 -2
- package/src/asyncapi.yaml +3593 -0
- package/src/experimental/nats/index.ts +16 -0
- package/src/lib/experimental/nats/NovaNatsClient.ts +116 -0
- package/src/lib/experimental/nats/buildSubject.ts +68 -0
- package/src/lib/experimental/nats/generated/operations.ts +203 -0
- package/src/lib/experimental/nats/generated/types.ts +2325 -0
|
@@ -0,0 +1,2227 @@
|
|
|
1
|
+
import { ConnectionOptions, Msg, NatsConnection } from "@nats-io/nats-core";
|
|
2
|
+
|
|
3
|
+
//#region src/lib/experimental/nats/generated/types.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* A description of the cell.
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
9
|
+
* via the `definition` "CellDescription".
|
|
10
|
+
*/
|
|
11
|
+
type CellDescription = string;
|
|
12
|
+
/**
|
|
13
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
14
|
+
* via the `definition` "Manufacturer".
|
|
15
|
+
*/
|
|
16
|
+
type Manufacturer = "abb" | "fanuc" | "kuka" | "staubli" | "universalrobots" | "yaskawa";
|
|
17
|
+
/**
|
|
18
|
+
* Identifies a single motion group model.
|
|
19
|
+
* See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
|
|
20
|
+
*
|
|
21
|
+
*
|
|
22
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
23
|
+
* via the `definition` "MotionGroupModel".
|
|
24
|
+
*/
|
|
25
|
+
type MotionGroupModel = string;
|
|
26
|
+
/**
|
|
27
|
+
* Request body wrapper for `addVirtualControllerMotionGroup`.
|
|
28
|
+
* Allow either referencing a predefined motion group model or
|
|
29
|
+
* uploading a JSON configuration that the backend converts into a
|
|
30
|
+
* motion group description.
|
|
31
|
+
*
|
|
32
|
+
*
|
|
33
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
34
|
+
* via the `definition` "AddVirtualControllerMotionGroupRequest".
|
|
35
|
+
*/
|
|
36
|
+
type AddVirtualControllerMotionGroupRequest = MotionGroupFromModel | MotionGroupFromJSON;
|
|
37
|
+
/**
|
|
38
|
+
* A list of environment variables with name and their value.
|
|
39
|
+
* These can be used to configure the containerized application, and turn features on or off.
|
|
40
|
+
*
|
|
41
|
+
*
|
|
42
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
43
|
+
* via the `definition` "ContainerEnvironment".
|
|
44
|
+
*/
|
|
45
|
+
type ContainerEnvironment = {
|
|
46
|
+
name: string;
|
|
47
|
+
value: string;
|
|
48
|
+
}[];
|
|
49
|
+
/**
|
|
50
|
+
* State of the program run.
|
|
51
|
+
*/
|
|
52
|
+
type ProgramRunState1 = "PREPARING" | "RUNNING" | "COMPLETED" | "FAILED" | "STOPPED";
|
|
53
|
+
/**
|
|
54
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
55
|
+
* via the `definition` "ServiceGroup".
|
|
56
|
+
*/
|
|
57
|
+
type ServiceGroup = "SystemService" | "CellService" | "RobotController" | "App";
|
|
58
|
+
/**
|
|
59
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
60
|
+
* via the `definition` "ServiceStatusSeverity".
|
|
61
|
+
*/
|
|
62
|
+
type ServiceStatusSeverity = "INFO" | "WARNING" | "ERROR";
|
|
63
|
+
/**
|
|
64
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
65
|
+
* via the `definition` "ServiceStatusPhase".
|
|
66
|
+
*/
|
|
67
|
+
type ServiceStatusPhase = "Terminating" | "Initialized" | "Running" | "NoReady" | "Completed" | "ContainerCreating" | "PodInitializing" | "Unknown" | "CrashLoopBackOff" | "Error" | "ImagePullBackOff" | "OOMKilled" | "Pending" | "Evicted";
|
|
68
|
+
/**
|
|
69
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
70
|
+
* via the `definition` "ServiceStatusList".
|
|
71
|
+
*/
|
|
72
|
+
type ServiceStatusList = ServiceStatus[];
|
|
73
|
+
/**
|
|
74
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
75
|
+
*
|
|
76
|
+
*
|
|
77
|
+
* @minItems 3
|
|
78
|
+
* @maxItems 3
|
|
79
|
+
*
|
|
80
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
81
|
+
* via the `definition` "Vector3d".
|
|
82
|
+
*/
|
|
83
|
+
type Vector3D = [number, number, number];
|
|
84
|
+
/**
|
|
85
|
+
* Defines a rotation in 3D space.
|
|
86
|
+
* A three-dimensional Vector [rx, ry, rz] with double precision.
|
|
87
|
+
* Rotation is applied around the vector.
|
|
88
|
+
* The angle of rotation equals the length of the vector.
|
|
89
|
+
*
|
|
90
|
+
*
|
|
91
|
+
* @minItems 3
|
|
92
|
+
* @maxItems 3
|
|
93
|
+
*
|
|
94
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
95
|
+
* via the `definition` "RotationVector".
|
|
96
|
+
*/
|
|
97
|
+
type RotationVector = [number, number, number];
|
|
98
|
+
/**
|
|
99
|
+
* The shape of the motion groups links to validate against colliders.
|
|
100
|
+
* Indexed along the kinematic chain, starting with a static base shape before first joint.
|
|
101
|
+
* The base of the motion group is not checked for collision against the environment.
|
|
102
|
+
*
|
|
103
|
+
*/
|
|
104
|
+
type LinkChain1 = CollisionMotionGroupLink[];
|
|
105
|
+
/**
|
|
106
|
+
* Current state of the BUS input/output service.
|
|
107
|
+
*
|
|
108
|
+
*
|
|
109
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
110
|
+
* via the `definition` "BusIOsStateEnum".
|
|
111
|
+
*/
|
|
112
|
+
type BusIOsStateEnum = "BUS_IOS_STATE_UNKNOWN" | "BUS_IOS_STATE_INITIALIZING" | "BUS_IOS_STATE_CONNECTED" | "BUS_IOS_STATE_DISCONNECTED";
|
|
113
|
+
/**
|
|
114
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
115
|
+
* via the `definition` "IOValue".
|
|
116
|
+
*/
|
|
117
|
+
type IOValue = IOBooleanValue | IOIntegerValue | IOFloatValue;
|
|
118
|
+
/**
|
|
119
|
+
* Array of input/output values.
|
|
120
|
+
*
|
|
121
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
122
|
+
* via the `definition` "ListIOValuesResponse".
|
|
123
|
+
*/
|
|
124
|
+
type ListIOValuesResponse = IOValue[];
|
|
125
|
+
/**
|
|
126
|
+
* Current operation mode of the configured robot controller.
|
|
127
|
+
* Operation modes in which the attached motion groups can be moved are:
|
|
128
|
+
* - OPERATION_MODE_MANUAL (if enabling switch is pressed)
|
|
129
|
+
* - OPERATION_MODE_MANUAL_T1 (if enabling switch is pressed)
|
|
130
|
+
* - OPERATION_MODE_MANUAL_T2 (if enabling switch is pressed)
|
|
131
|
+
* - OPERATION_MODE_AUTO (without needing to press enabling switch)
|
|
132
|
+
* All other modes are considered as non-operational.
|
|
133
|
+
*
|
|
134
|
+
*
|
|
135
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
136
|
+
* via the `definition` "OperationMode".
|
|
137
|
+
*/
|
|
138
|
+
type OperationMode = "OPERATION_MODE_UNKNOWN" | "OPERATION_MODE_NO_CONTROLLER" | "OPERATION_MODE_DISCONNECTED" | "OPERATION_MODE_POWER_ON" | "OPERATION_MODE_PENDING" | "OPERATION_MODE_MANUAL" | "OPERATION_MODE_MANUAL_T1" | "OPERATION_MODE_MANUAL_T2" | "OPERATION_MODE_AUTO" | "OPERATION_MODE_RECOVERY";
|
|
139
|
+
/**
|
|
140
|
+
* Current safety state of the configured robot controller.
|
|
141
|
+
* Operation modes in which the attached motion groups can be moved are:
|
|
142
|
+
* - SAFETY_STATE_NORMAL
|
|
143
|
+
* - SAFETY_STATE_REDUCED
|
|
144
|
+
* All other modes are considered as non-operational.
|
|
145
|
+
*
|
|
146
|
+
*
|
|
147
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
148
|
+
* via the `definition` "SafetyStateType".
|
|
149
|
+
*/
|
|
150
|
+
type SafetyStateType = "SAFETY_STATE_UNKNOWN" | "SAFETY_STATE_FAULT" | "SAFETY_STATE_NORMAL" | "SAFETY_STATE_MASTERING" | "SAFETY_STATE_CONFIRM_SAFETY" | "SAFETY_STATE_OPERATOR_SAFETY" | "SAFETY_STATE_PROTECTIVE_STOP" | "SAFETY_STATE_REDUCED" | "SAFETY_STATE_STOP" | "SAFETY_STATE_STOP_0" | "SAFETY_STATE_STOP_1" | "SAFETY_STATE_STOP_2" | "SAFETY_STATE_RECOVERY" | "SAFETY_STATE_DEVICE_EMERGENCY_STOP" | "SAFETY_STATE_ROBOT_EMERGENCY_STOP" | "SAFETY_STATE_VIOLATION";
|
|
151
|
+
/**
|
|
152
|
+
* Current joint position of each joint.
|
|
153
|
+
* The unit depends on the type of joint: For revolute joints, the angle is given in [rad]; for prismatic joints, the displacement is given in [mm].
|
|
154
|
+
*
|
|
155
|
+
*/
|
|
156
|
+
type Joints1 = number[];
|
|
157
|
+
/**
|
|
158
|
+
* Current joint torque of each joint in [Nm].
|
|
159
|
+
* Is only available if the robot controller supports it, e.g., available for UR controllers.
|
|
160
|
+
*
|
|
161
|
+
*/
|
|
162
|
+
type Joints2 = number[];
|
|
163
|
+
/**
|
|
164
|
+
* Current at TCP in [A].
|
|
165
|
+
* Is only available if the robot controller supports it, e.g., available for UR controllers.
|
|
166
|
+
*
|
|
167
|
+
*/
|
|
168
|
+
type Joints3 = number[];
|
|
169
|
+
/**
|
|
170
|
+
* State of indicated motion groups.
|
|
171
|
+
* In case of state request via controller all configured motion groups are returned.
|
|
172
|
+
* In case of executing a motion only the affected motion groups are returned.
|
|
173
|
+
*
|
|
174
|
+
*/
|
|
175
|
+
type MotionGroupState1 = MotionGroupState[];
|
|
176
|
+
/**
|
|
177
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
178
|
+
*
|
|
179
|
+
*
|
|
180
|
+
* @minItems 3
|
|
181
|
+
* @maxItems 3
|
|
182
|
+
*/
|
|
183
|
+
type Vector3D1 = [number, number, number];
|
|
184
|
+
/**
|
|
185
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
186
|
+
*
|
|
187
|
+
*
|
|
188
|
+
* @minItems 3
|
|
189
|
+
* @maxItems 3
|
|
190
|
+
*/
|
|
191
|
+
type Vector3D2 = [number, number, number];
|
|
192
|
+
/**
|
|
193
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
194
|
+
* via the `definition` "JointTypeEnum".
|
|
195
|
+
*/
|
|
196
|
+
type JointTypeEnum = "REVOLUTE_JOINT" | "PRISMATIC_JOINT";
|
|
197
|
+
/**
|
|
198
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
199
|
+
* via the `definition` "SystemUpdateStartedEvent".
|
|
200
|
+
*/
|
|
201
|
+
type SystemUpdateStartedEvent = CloudEvent & {
|
|
202
|
+
type?: "nova.v2.events.system.update.started";
|
|
203
|
+
source?: "/nova/service-manager";
|
|
204
|
+
/**
|
|
205
|
+
* Unique identifier for this update process
|
|
206
|
+
*/
|
|
207
|
+
id: {
|
|
208
|
+
[k: string]: unknown;
|
|
209
|
+
};
|
|
210
|
+
/**
|
|
211
|
+
* Timestamp when the update process started (RFC3339)
|
|
212
|
+
*/
|
|
213
|
+
time: {
|
|
214
|
+
[k: string]: unknown;
|
|
215
|
+
};
|
|
216
|
+
/**
|
|
217
|
+
* System update started event payload
|
|
218
|
+
*/
|
|
219
|
+
data: {
|
|
220
|
+
/**
|
|
221
|
+
* New system version being installed
|
|
222
|
+
*/
|
|
223
|
+
newVersion: string;
|
|
224
|
+
/**
|
|
225
|
+
* Previous system version, if available
|
|
226
|
+
*/
|
|
227
|
+
oldVersion?: string;
|
|
228
|
+
};
|
|
229
|
+
};
|
|
230
|
+
/**
|
|
231
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
232
|
+
* via the `definition` "SystemUpdateCompletedEvent".
|
|
233
|
+
*/
|
|
234
|
+
type SystemUpdateCompletedEvent = CloudEvent & {
|
|
235
|
+
type?: "nova.v2.events.system.update.completed";
|
|
236
|
+
source?: "/nova/service-manager";
|
|
237
|
+
/**
|
|
238
|
+
* Same unique identifier from the started event for correlation
|
|
239
|
+
*/
|
|
240
|
+
id: {
|
|
241
|
+
[k: string]: unknown;
|
|
242
|
+
};
|
|
243
|
+
/**
|
|
244
|
+
* Timestamp when the update process completed (RFC3339)
|
|
245
|
+
*/
|
|
246
|
+
time: {
|
|
247
|
+
[k: string]: unknown;
|
|
248
|
+
};
|
|
249
|
+
/**
|
|
250
|
+
* System update completed event payload
|
|
251
|
+
*/
|
|
252
|
+
data: {
|
|
253
|
+
/**
|
|
254
|
+
* New system version that was installed
|
|
255
|
+
*/
|
|
256
|
+
newVersion: string;
|
|
257
|
+
/**
|
|
258
|
+
* Error message if update failed
|
|
259
|
+
*/
|
|
260
|
+
error?: string;
|
|
261
|
+
};
|
|
262
|
+
};
|
|
263
|
+
/**
|
|
264
|
+
* The operating state.
|
|
265
|
+
*
|
|
266
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
267
|
+
* via the `definition` "OperatingState".
|
|
268
|
+
*/
|
|
269
|
+
type OperatingState = "ACTIVE" | "INACTIVE";
|
|
270
|
+
/**
|
|
271
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
272
|
+
* via the `definition` "CellCreatedEvent".
|
|
273
|
+
*/
|
|
274
|
+
type CellCreatedEvent = {
|
|
275
|
+
type?: "nova.v2.events.cells.{cell}.created";
|
|
276
|
+
source?: "/nova/service-manager";
|
|
277
|
+
/**
|
|
278
|
+
* Unique identifier for this cell created event.
|
|
279
|
+
*/
|
|
280
|
+
id: {
|
|
281
|
+
[k: string]: unknown;
|
|
282
|
+
};
|
|
283
|
+
/**
|
|
284
|
+
* Timestamp when the cell foundation release was created.
|
|
285
|
+
*/
|
|
286
|
+
time: {
|
|
287
|
+
[k: string]: unknown;
|
|
288
|
+
};
|
|
289
|
+
data: CellEventData;
|
|
290
|
+
} & CloudEvent;
|
|
291
|
+
/**
|
|
292
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
293
|
+
* via the `definition` "CellUpdatedEvent".
|
|
294
|
+
*/
|
|
295
|
+
type CellUpdatedEvent = {
|
|
296
|
+
type?: "nova.v2.events.cells.{cell}.updated";
|
|
297
|
+
source?: "/nova/service-manager";
|
|
298
|
+
/**
|
|
299
|
+
* Unique identifier for this cell updated event.
|
|
300
|
+
*/
|
|
301
|
+
id: {
|
|
302
|
+
[k: string]: unknown;
|
|
303
|
+
};
|
|
304
|
+
/**
|
|
305
|
+
* Timestamp when the cell foundation release was updated.
|
|
306
|
+
*/
|
|
307
|
+
time: {
|
|
308
|
+
[k: string]: unknown;
|
|
309
|
+
};
|
|
310
|
+
data: CellEventData;
|
|
311
|
+
} & CloudEvent;
|
|
312
|
+
/**
|
|
313
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
314
|
+
* via the `definition` "CellDeletedEvent".
|
|
315
|
+
*/
|
|
316
|
+
type CellDeletedEvent = {
|
|
317
|
+
type?: "nova.v2.events.cells.{cell}.deleted";
|
|
318
|
+
source?: "/nova/service-manager";
|
|
319
|
+
/**
|
|
320
|
+
* Unique identifier for this cell deleted event.
|
|
321
|
+
*/
|
|
322
|
+
id: {
|
|
323
|
+
[k: string]: unknown;
|
|
324
|
+
};
|
|
325
|
+
/**
|
|
326
|
+
* Timestamp when the cell foundation release was deleted.
|
|
327
|
+
*/
|
|
328
|
+
time: {
|
|
329
|
+
[k: string]: unknown;
|
|
330
|
+
};
|
|
331
|
+
data: CellEventData;
|
|
332
|
+
} & CloudEvent;
|
|
333
|
+
/**
|
|
334
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
335
|
+
* via the `definition` "AppCreatedEvent".
|
|
336
|
+
*/
|
|
337
|
+
type AppCreatedEvent = {
|
|
338
|
+
type?: "nova.v2.events.cells.{cell}.apps.{app}.created";
|
|
339
|
+
source?: "/nova/service-manager";
|
|
340
|
+
/**
|
|
341
|
+
* Unique identifier for this app created event.
|
|
342
|
+
*/
|
|
343
|
+
id: {
|
|
344
|
+
[k: string]: unknown;
|
|
345
|
+
};
|
|
346
|
+
/**
|
|
347
|
+
* Timestamp when the app release was created.
|
|
348
|
+
*/
|
|
349
|
+
time: {
|
|
350
|
+
[k: string]: unknown;
|
|
351
|
+
};
|
|
352
|
+
data: AppEventData;
|
|
353
|
+
} & CloudEvent;
|
|
354
|
+
/**
|
|
355
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
356
|
+
* via the `definition` "AppUpdatedEvent".
|
|
357
|
+
*/
|
|
358
|
+
type AppUpdatedEvent = {
|
|
359
|
+
type?: "nova.v2.events.cells.{cell}.apps.{app}.updated";
|
|
360
|
+
source?: "/nova/service-manager";
|
|
361
|
+
/**
|
|
362
|
+
* Unique identifier for this app updated event.
|
|
363
|
+
*/
|
|
364
|
+
id: {
|
|
365
|
+
[k: string]: unknown;
|
|
366
|
+
};
|
|
367
|
+
/**
|
|
368
|
+
* Timestamp when the app release was updated.
|
|
369
|
+
*/
|
|
370
|
+
time: {
|
|
371
|
+
[k: string]: unknown;
|
|
372
|
+
};
|
|
373
|
+
data: AppEventData;
|
|
374
|
+
} & CloudEvent;
|
|
375
|
+
/**
|
|
376
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
377
|
+
* via the `definition` "AppDeletedEvent".
|
|
378
|
+
*/
|
|
379
|
+
type AppDeletedEvent = {
|
|
380
|
+
type?: "nova.v2.events.cells.{cell}.apps.{app}.deleted";
|
|
381
|
+
source?: "/nova/service-manager";
|
|
382
|
+
/**
|
|
383
|
+
* Unique identifier for this app deleted event.
|
|
384
|
+
*/
|
|
385
|
+
id: {
|
|
386
|
+
[k: string]: unknown;
|
|
387
|
+
};
|
|
388
|
+
/**
|
|
389
|
+
* Timestamp when the app release was deleted.
|
|
390
|
+
*/
|
|
391
|
+
time: {
|
|
392
|
+
[k: string]: unknown;
|
|
393
|
+
};
|
|
394
|
+
data: AppEventData;
|
|
395
|
+
} & CloudEvent;
|
|
396
|
+
/**
|
|
397
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
398
|
+
* via the `definition` "RobotControllerCreatedEvent".
|
|
399
|
+
*/
|
|
400
|
+
type RobotControllerCreatedEvent = {
|
|
401
|
+
type?: "nova.v2.events.cells.{cell}.controllers.{controller}.created";
|
|
402
|
+
source?: "/nova/service-manager";
|
|
403
|
+
/**
|
|
404
|
+
* Unique identifier for this robot controller created event.
|
|
405
|
+
*/
|
|
406
|
+
id: {
|
|
407
|
+
[k: string]: unknown;
|
|
408
|
+
};
|
|
409
|
+
/**
|
|
410
|
+
* Timestamp when the robot controller release was created.
|
|
411
|
+
*/
|
|
412
|
+
time: {
|
|
413
|
+
[k: string]: unknown;
|
|
414
|
+
};
|
|
415
|
+
data: RobotControllerEventData;
|
|
416
|
+
} & CloudEvent;
|
|
417
|
+
/**
|
|
418
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
419
|
+
* via the `definition` "RobotControllerUpdatedEvent".
|
|
420
|
+
*/
|
|
421
|
+
type RobotControllerUpdatedEvent = {
|
|
422
|
+
type?: "nova.v2.events.cells.{cell}.controllers.{controller}.updated";
|
|
423
|
+
source?: "/nova/service-manager";
|
|
424
|
+
/**
|
|
425
|
+
* Unique identifier for this robot controller updated event.
|
|
426
|
+
*/
|
|
427
|
+
id: {
|
|
428
|
+
[k: string]: unknown;
|
|
429
|
+
};
|
|
430
|
+
/**
|
|
431
|
+
* Timestamp when the robot controller release was updated.
|
|
432
|
+
*/
|
|
433
|
+
time: {
|
|
434
|
+
[k: string]: unknown;
|
|
435
|
+
};
|
|
436
|
+
data: RobotControllerEventData;
|
|
437
|
+
} & CloudEvent;
|
|
438
|
+
/**
|
|
439
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
440
|
+
* via the `definition` "RobotControllerDeletedEvent".
|
|
441
|
+
*/
|
|
442
|
+
type RobotControllerDeletedEvent = {
|
|
443
|
+
type?: "nova.v2.events.cells.{cell}.controllers.{controller}.deleted";
|
|
444
|
+
source?: "/nova/service-manager";
|
|
445
|
+
/**
|
|
446
|
+
* Unique identifier for this robot controller deleted event.
|
|
447
|
+
*/
|
|
448
|
+
id: {
|
|
449
|
+
[k: string]: unknown;
|
|
450
|
+
};
|
|
451
|
+
/**
|
|
452
|
+
* Timestamp when the robot controller release was deleted.
|
|
453
|
+
*/
|
|
454
|
+
time: {
|
|
455
|
+
[k: string]: unknown;
|
|
456
|
+
};
|
|
457
|
+
data: RobotControllerEventData;
|
|
458
|
+
} & CloudEvent;
|
|
459
|
+
interface AbbController {
|
|
460
|
+
kind: "AbbController";
|
|
461
|
+
controller_ip: string;
|
|
462
|
+
/**
|
|
463
|
+
* Default values: 80, 443. If custom value is set, field is required.
|
|
464
|
+
*
|
|
465
|
+
*/
|
|
466
|
+
controller_port: number;
|
|
467
|
+
/**
|
|
468
|
+
* The EGM server runs inside of the cell, thus its IP must be in the same network as the 'controller_ip'
|
|
469
|
+
*/
|
|
470
|
+
egm_server: {
|
|
471
|
+
ip: string;
|
|
472
|
+
port: number;
|
|
473
|
+
};
|
|
474
|
+
}
|
|
475
|
+
/**
|
|
476
|
+
* Optional dedicated network interface for a physical robot controller.
|
|
477
|
+
*
|
|
478
|
+
* When set, the controller is given its own network interface on the selected
|
|
479
|
+
* physical network port (`pf`) with the given `address`, so it can reach the
|
|
480
|
+
* robot network directly.
|
|
481
|
+
*
|
|
482
|
+
*
|
|
483
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
484
|
+
* via the `definition` "ControllerNetworkInterface".
|
|
485
|
+
*/
|
|
486
|
+
interface ControllerNetworkInterface {
|
|
487
|
+
/**
|
|
488
|
+
* IPv4 address in CIDR notation to assign to the controller's network
|
|
489
|
+
* interface, for example `192.168.1.10/24`. The value must be a valid IPv4
|
|
490
|
+
* address followed by a prefix length between 0 and 32.
|
|
491
|
+
*
|
|
492
|
+
*/
|
|
493
|
+
address: string;
|
|
494
|
+
/**
|
|
495
|
+
* Name of the node's physical network port that connects to the robot
|
|
496
|
+
* network, for example `enp10s0f0`. The controller's interface is provided
|
|
497
|
+
* from this port.
|
|
498
|
+
*
|
|
499
|
+
*/
|
|
500
|
+
pf: string;
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* The configuration of a physical FANUC robot controller has to contain IP address of the controller.
|
|
504
|
+
*
|
|
505
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
506
|
+
* via the `definition` "FanucController".
|
|
507
|
+
*/
|
|
508
|
+
interface FanucController {
|
|
509
|
+
kind: "FanucController";
|
|
510
|
+
controller_ip: string;
|
|
511
|
+
network_interface?: ControllerNetworkInterface;
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* The configuration of a physical KUKA robot controller has to contain an IP address.
|
|
515
|
+
* Additionally an RSI server configuration has to be specified in order to control the robot.
|
|
516
|
+
* Deploying the server is a functionality of this API.
|
|
517
|
+
*
|
|
518
|
+
*
|
|
519
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
520
|
+
* via the `definition` "KukaController".
|
|
521
|
+
*/
|
|
522
|
+
interface KukaController {
|
|
523
|
+
kind: "KukaController";
|
|
524
|
+
controller_ip: string;
|
|
525
|
+
controller_port: number;
|
|
526
|
+
/**
|
|
527
|
+
* The RSI server runs inside of the cell.
|
|
528
|
+
*/
|
|
529
|
+
rsi_server: {
|
|
530
|
+
ip: string;
|
|
531
|
+
port: number;
|
|
532
|
+
};
|
|
533
|
+
/**
|
|
534
|
+
* If true, uses slower cycle time of 12ms instead of 4ms.
|
|
535
|
+
*
|
|
536
|
+
*/
|
|
537
|
+
slow_cycle_rate?: boolean;
|
|
538
|
+
}
|
|
539
|
+
/**
|
|
540
|
+
* The configuration of a physical Universal Robots controller has to contain IP address of the controller.
|
|
541
|
+
*
|
|
542
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
543
|
+
* via the `definition` "UniversalrobotsController".
|
|
544
|
+
*/
|
|
545
|
+
interface UniversalrobotsController {
|
|
546
|
+
kind: "UniversalrobotsController";
|
|
547
|
+
controller_ip: string;
|
|
548
|
+
}
|
|
549
|
+
/**
|
|
550
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
551
|
+
* via the `definition` "MotionGroupFromType".
|
|
552
|
+
*/
|
|
553
|
+
interface MotionGroupFromModel {
|
|
554
|
+
/**
|
|
555
|
+
* Unique identifier for the motion group to be added.
|
|
556
|
+
*/
|
|
557
|
+
motion_group: string;
|
|
558
|
+
motion_group_model: MotionGroupModel;
|
|
559
|
+
/**
|
|
560
|
+
* Initial joint position of the added motion group.
|
|
561
|
+
* Provides the joint position as a JSON array of float values in radians. The array length
|
|
562
|
+
* must match the robot's degrees of freedom, e.g., `"[0, 0, 0, 0, 0, 0]"` for a 6-DOF robot.
|
|
563
|
+
* If the provided array length does not match the robot's DOF, the array will be adjusted; if it is longer, extra values will be truncated;
|
|
564
|
+
* if it is shorter, missing values will be filled with zeros.
|
|
565
|
+
*
|
|
566
|
+
*/
|
|
567
|
+
initial_joint_position?: string;
|
|
568
|
+
}
|
|
569
|
+
/**
|
|
570
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
571
|
+
* via the `definition` "MotionGroupFromJson".
|
|
572
|
+
*/
|
|
573
|
+
interface MotionGroupFromJSON {
|
|
574
|
+
/**
|
|
575
|
+
* Unique identifier for the motion group to be added.
|
|
576
|
+
*/
|
|
577
|
+
motion_group: string;
|
|
578
|
+
/**
|
|
579
|
+
* JSON configuration of the virtual robot controller, can be obtained from the physical controller's configuration
|
|
580
|
+
* via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration).
|
|
581
|
+
*
|
|
582
|
+
*/
|
|
583
|
+
json_data: string;
|
|
584
|
+
/**
|
|
585
|
+
* The identifier of the motion group that needs to be extracted from the provided JSON configuration.
|
|
586
|
+
*
|
|
587
|
+
*/
|
|
588
|
+
extracted_motion_group_id: string;
|
|
589
|
+
/**
|
|
590
|
+
* Initial joint position of the added motion group.
|
|
591
|
+
* Provides the joint position as a JSON array of float values in radians. The array length
|
|
592
|
+
* must match the robot's degrees of freedom, e.g., `"[0, 0, 0, 0, 0, 0]"` for a 6-DOF robot.
|
|
593
|
+
* If the provided array length does not match the robot's DOF, the array will be adjusted: if it is longer, extra values will be truncated;
|
|
594
|
+
* if it is shorter, missing values will be filled with zeros.
|
|
595
|
+
*
|
|
596
|
+
*/
|
|
597
|
+
initial_joint_position?: string;
|
|
598
|
+
}
|
|
599
|
+
/**
|
|
600
|
+
* The configuration of a virtual robot controller has to contain the manufacturer string,
|
|
601
|
+
* an optional joint position string array, and either a preset `type` **or** the complete JSON configuration.
|
|
602
|
+
*
|
|
603
|
+
*
|
|
604
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
605
|
+
* via the `definition` "VirtualController".
|
|
606
|
+
*/
|
|
607
|
+
interface VirtualController {
|
|
608
|
+
kind: "VirtualController";
|
|
609
|
+
manufacturer: Manufacturer;
|
|
610
|
+
/**
|
|
611
|
+
* Preset type of the virtual robot controller.
|
|
612
|
+
* See [getRobotConfigurations](#/operations/getRobotConfigurations) for supported types.
|
|
613
|
+
*
|
|
614
|
+
*/
|
|
615
|
+
type?: string;
|
|
616
|
+
/**
|
|
617
|
+
* Complete JSON configuration of the virtual robot controller.
|
|
618
|
+
* Can be obtained from the physical controller's configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration).
|
|
619
|
+
* If provided, the `type` field should not be used.
|
|
620
|
+
*
|
|
621
|
+
*/
|
|
622
|
+
json?: string;
|
|
623
|
+
/**
|
|
624
|
+
* Initial joint position of the first motion group from the virtual robot controller.
|
|
625
|
+
* Provides the joint position as a JSON array of float values in radians. The array length
|
|
626
|
+
* must match the robot's degrees of freedom, e.g., `"[0, 0, 0, 0, 0, 0]"` for a 6-DOF robot.
|
|
627
|
+
* If the provided array length does not match the robot's DOF, the array will be adjusted: if it is longer, extra values will be truncated;
|
|
628
|
+
* if it is shorter, missing values will be filled with zeros.
|
|
629
|
+
*
|
|
630
|
+
*/
|
|
631
|
+
initial_joint_position?: string;
|
|
632
|
+
/**
|
|
633
|
+
* Adds a motion group configuration for the virtual robot controller.
|
|
634
|
+
*
|
|
635
|
+
* > **NOTE**
|
|
636
|
+
* >
|
|
637
|
+
* > Set only one of the two options, **motion_group_model**, or **json_data**
|
|
638
|
+
*
|
|
639
|
+
* - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types
|
|
640
|
+
* - **json_data**: JSON configuration of the virtual robot controller, can be obtained from the physical controller's configuration
|
|
641
|
+
* via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration)
|
|
642
|
+
* - **extracted_motion_group_id**: Motion group identifier to extract from the provided JSON configuration, required when using json_data
|
|
643
|
+
* - **motion_group**: Unique identifier for the motion group
|
|
644
|
+
* - **initial_joint_position**: Specifies the initial joint position for the added motion group
|
|
645
|
+
*
|
|
646
|
+
*
|
|
647
|
+
* @maxItems 10
|
|
648
|
+
*/
|
|
649
|
+
motion_groups?: [] | [AddVirtualControllerMotionGroupRequest] | [AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest] | [AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest] | [AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest] | [AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest] | [AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest] | [AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest] | [AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest] | [AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest] | [AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest, AddVirtualControllerMotionGroupRequest];
|
|
650
|
+
}
|
|
651
|
+
/**
|
|
652
|
+
* The configuration of a physical Yaskawa robot controller has to contain IP address of the controller.
|
|
653
|
+
*
|
|
654
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
655
|
+
* via the `definition` "YaskawaController".
|
|
656
|
+
*/
|
|
657
|
+
interface YaskawaController {
|
|
658
|
+
kind: "YaskawaController";
|
|
659
|
+
controller_ip: string;
|
|
660
|
+
}
|
|
661
|
+
/**
|
|
662
|
+
* The configuration of a physical or virtual robot controller.
|
|
663
|
+
*
|
|
664
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
665
|
+
* via the `definition` "RobotController".
|
|
666
|
+
*/
|
|
667
|
+
interface RobotController {
|
|
668
|
+
/**
|
|
669
|
+
* Unique name of controller within the cell.
|
|
670
|
+
* It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
|
|
671
|
+
*
|
|
672
|
+
*/
|
|
673
|
+
name: string;
|
|
674
|
+
configuration: AbbController | FanucController | KukaController | UniversalrobotsController | VirtualController | YaskawaController;
|
|
675
|
+
}
|
|
676
|
+
/**
|
|
677
|
+
* User provided credentials for creating a secret to pull an image from a registry.
|
|
678
|
+
*
|
|
679
|
+
*
|
|
680
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
681
|
+
* via the `definition` "ImageCredentials".
|
|
682
|
+
*/
|
|
683
|
+
interface ImageCredentials {
|
|
684
|
+
registry: string;
|
|
685
|
+
user: string;
|
|
686
|
+
password: string;
|
|
687
|
+
}
|
|
688
|
+
/**
|
|
689
|
+
* A user provided, custom container image and the required credentials to pull it from a registry.
|
|
690
|
+
*
|
|
691
|
+
*
|
|
692
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
693
|
+
* via the `definition` "ContainerImage".
|
|
694
|
+
*/
|
|
695
|
+
interface ContainerImage {
|
|
696
|
+
/**
|
|
697
|
+
* The location of a container image in the form of `<registry>/<image>:<tag>`.
|
|
698
|
+
*/
|
|
699
|
+
image: string;
|
|
700
|
+
credentials?: ImageCredentials;
|
|
701
|
+
/**
|
|
702
|
+
* Known secrets for authentication with the container registry.
|
|
703
|
+
*/
|
|
704
|
+
secrets?: {
|
|
705
|
+
name: string;
|
|
706
|
+
}[];
|
|
707
|
+
}
|
|
708
|
+
/**
|
|
709
|
+
* The path and capacity of a volume that retains data across application restarts.
|
|
710
|
+
* The maximal requestable capacity is 300Mi.
|
|
711
|
+
* If you need more capacity consider using [storeObject](#/operations/storeObject).
|
|
712
|
+
*
|
|
713
|
+
*
|
|
714
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
715
|
+
* via the `definition` "ContainerStorage".
|
|
716
|
+
*/
|
|
717
|
+
interface ContainerStorage {
|
|
718
|
+
mount_path: string;
|
|
719
|
+
/**
|
|
720
|
+
* The amount of local storage available for the application.
|
|
721
|
+
*
|
|
722
|
+
* **NOTE:** The capacity can NEVER be reduced!
|
|
723
|
+
*
|
|
724
|
+
*/
|
|
725
|
+
capacity: string;
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* Additional resources that the application requires.
|
|
729
|
+
*
|
|
730
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
731
|
+
* via the `definition` "ContainerResources".
|
|
732
|
+
*/
|
|
733
|
+
interface ContainerResources {
|
|
734
|
+
/**
|
|
735
|
+
* Number of GPUs the application requires.
|
|
736
|
+
*/
|
|
737
|
+
intel_gpu?: number;
|
|
738
|
+
/**
|
|
739
|
+
* The maximum memory allocated to this application.
|
|
740
|
+
*/
|
|
741
|
+
memory_limit?: string;
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
* An App is defined by a webserver, packed inside a container, serving a web-application.
|
|
745
|
+
*
|
|
746
|
+
*
|
|
747
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
748
|
+
* via the `definition` "App".
|
|
749
|
+
*/
|
|
750
|
+
interface App {
|
|
751
|
+
/**
|
|
752
|
+
* The name of the provided application.
|
|
753
|
+
* The name must be unique within the cell and is used as an identifier for addressing the application in all API calls
|
|
754
|
+
* , e.g., when updating the application.
|
|
755
|
+
*
|
|
756
|
+
* It also defines where the application is reachable (/$cell/$name).
|
|
757
|
+
*
|
|
758
|
+
* It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
|
|
759
|
+
*
|
|
760
|
+
*/
|
|
761
|
+
name: string;
|
|
762
|
+
/**
|
|
763
|
+
* The path of the icon for the App (/$cell/$name/$app_icon).
|
|
764
|
+
*/
|
|
765
|
+
app_icon: string;
|
|
766
|
+
container_image: ContainerImage;
|
|
767
|
+
/**
|
|
768
|
+
* The port the containerized webserver is listening on.
|
|
769
|
+
*/
|
|
770
|
+
port?: number;
|
|
771
|
+
environment?: ContainerEnvironment;
|
|
772
|
+
storage?: ContainerStorage;
|
|
773
|
+
resources?: ContainerResources;
|
|
774
|
+
/**
|
|
775
|
+
* Defines the URL path suffix used to check the application's health status. The complete health check URL
|
|
776
|
+
* is constructed as `/$cell/$name/$health_path`. When the application is working as expected,
|
|
777
|
+
* the endpoint returns an HTTP 200 status code.
|
|
778
|
+
*
|
|
779
|
+
* If not specified, the system will default to using the application icon path suffix
|
|
780
|
+
* (the value of `app_icon`) as the health check endpoint, resulting in `/$cell/$name/$app_icon`.
|
|
781
|
+
*
|
|
782
|
+
* If the health check fails (no response or non-200 status code), the system will
|
|
783
|
+
* automatically restart the application container to restore service.
|
|
784
|
+
*
|
|
785
|
+
*/
|
|
786
|
+
health_path?: string;
|
|
787
|
+
/**
|
|
788
|
+
* Defines the URL path suffix used to provide an endpoint for diagnosis data collection.
|
|
789
|
+
* The complete diagnosis check URL is constructed as `/$cell/$name/$diagnosis_path`.
|
|
790
|
+
*
|
|
791
|
+
* The endpoint is called when a diagnosis package is requested via the diagnosis API.
|
|
792
|
+
* The endpoint needs to return the data within a zip file `application/zip` response.
|
|
793
|
+
*
|
|
794
|
+
*/
|
|
795
|
+
diagnosis_path?: string;
|
|
796
|
+
}
|
|
797
|
+
/**
|
|
798
|
+
* To create a robot cell, only a valid name is required.
|
|
799
|
+
* Once created, a robot cell provides access to the Wandelbots NOVA foundation services.
|
|
800
|
+
* The configuration can be customized, e.g., robot controllers, also within apps.
|
|
801
|
+
*
|
|
802
|
+
*
|
|
803
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
804
|
+
* via the `definition` "Cell".
|
|
805
|
+
*/
|
|
806
|
+
interface Cell {
|
|
807
|
+
/**
|
|
808
|
+
* A unique name for the cell used as an identifier for addressing the cell in all API calls.
|
|
809
|
+
* It must be a valid k8s label name as defined by [RFC 1123](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names).
|
|
810
|
+
*
|
|
811
|
+
*/
|
|
812
|
+
name: string;
|
|
813
|
+
/**
|
|
814
|
+
* Wandelbots NOVA version of the cell.
|
|
815
|
+
* This version must not exceed the current system version.
|
|
816
|
+
*
|
|
817
|
+
*/
|
|
818
|
+
version?: string;
|
|
819
|
+
description?: CellDescription;
|
|
820
|
+
controllers?: RobotController[];
|
|
821
|
+
apps?: App[];
|
|
822
|
+
[k: string]: unknown;
|
|
823
|
+
}
|
|
824
|
+
/**
|
|
825
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
826
|
+
* via the `definition` "ProgramStatus".
|
|
827
|
+
*/
|
|
828
|
+
interface ProgramStatus {
|
|
829
|
+
/**
|
|
830
|
+
* The app name where the program is hosted.
|
|
831
|
+
*/
|
|
832
|
+
app: string;
|
|
833
|
+
/**
|
|
834
|
+
* Unique identifier of the program.
|
|
835
|
+
*/
|
|
836
|
+
program: string;
|
|
837
|
+
/**
|
|
838
|
+
* Unique identifier of the program run.
|
|
839
|
+
*/
|
|
840
|
+
run: string;
|
|
841
|
+
state: ProgramRunState1;
|
|
842
|
+
/**
|
|
843
|
+
* Error message if the program run failed.
|
|
844
|
+
*/
|
|
845
|
+
error?: string;
|
|
846
|
+
/**
|
|
847
|
+
* RFC3339 timestamp when the program run started.
|
|
848
|
+
*/
|
|
849
|
+
start_time?: string;
|
|
850
|
+
/**
|
|
851
|
+
* RFC3339 timestamp when the program run ended.
|
|
852
|
+
*/
|
|
853
|
+
end_time?: string;
|
|
854
|
+
/**
|
|
855
|
+
* RFC3339 timestamp when the program run ended.
|
|
856
|
+
*/
|
|
857
|
+
timestamp: string;
|
|
858
|
+
}
|
|
859
|
+
/**
|
|
860
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
861
|
+
* via the `definition` "ServiceStatus".
|
|
862
|
+
*/
|
|
863
|
+
interface ServiceStatus {
|
|
864
|
+
service: string;
|
|
865
|
+
group: ServiceGroup;
|
|
866
|
+
status: {
|
|
867
|
+
severity: ServiceStatusSeverity;
|
|
868
|
+
code: ServiceStatusPhase;
|
|
869
|
+
reason?: string;
|
|
870
|
+
};
|
|
871
|
+
}
|
|
872
|
+
/**
|
|
873
|
+
* Lifecycle event for a cell cycle.
|
|
874
|
+
*
|
|
875
|
+
*
|
|
876
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
877
|
+
* via the `definition` "CellCycleEvent".
|
|
878
|
+
*/
|
|
879
|
+
interface CellCycleEvent {
|
|
880
|
+
/**
|
|
881
|
+
* Type of the cycle event.
|
|
882
|
+
*/
|
|
883
|
+
event_type: "cycle_started" | "cycle_finished" | "cycle_failed";
|
|
884
|
+
/**
|
|
885
|
+
* Unique identifier of this cycle event.
|
|
886
|
+
*/
|
|
887
|
+
id: string;
|
|
888
|
+
/**
|
|
889
|
+
* Unique identifier of the cycle this event belongs to.
|
|
890
|
+
*/
|
|
891
|
+
cycle_id: string;
|
|
892
|
+
/**
|
|
893
|
+
* Timestamp when the cycle event occurred, in ISO 8601 format.
|
|
894
|
+
*/
|
|
895
|
+
timestamp: string;
|
|
896
|
+
/**
|
|
897
|
+
* Unique identifier of the cell the event belongs to.
|
|
898
|
+
*/
|
|
899
|
+
cell: string;
|
|
900
|
+
/**
|
|
901
|
+
* Additional event-specific data. May be empty.
|
|
902
|
+
*/
|
|
903
|
+
extra?: {
|
|
904
|
+
[k: string]: unknown;
|
|
905
|
+
};
|
|
906
|
+
/**
|
|
907
|
+
* Duration of the cycle in milliseconds.
|
|
908
|
+
*/
|
|
909
|
+
duration_ms?: number;
|
|
910
|
+
/**
|
|
911
|
+
* Reason for cycle failure.
|
|
912
|
+
*/
|
|
913
|
+
reason?: string;
|
|
914
|
+
}
|
|
915
|
+
/**
|
|
916
|
+
* Defines a spherical shape centred around the origin.
|
|
917
|
+
*
|
|
918
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
919
|
+
* via the `definition` "Sphere".
|
|
920
|
+
*/
|
|
921
|
+
interface Sphere {
|
|
922
|
+
shape_type: "sphere";
|
|
923
|
+
/**
|
|
924
|
+
* The radius of the sphere in [mm].
|
|
925
|
+
*/
|
|
926
|
+
radius: number;
|
|
927
|
+
}
|
|
928
|
+
/**
|
|
929
|
+
* Defines a cuboid shape centred around an origin.
|
|
930
|
+
*
|
|
931
|
+
* If a margin is applied to the box type full, it is added to all size values. The shape will keep its edges.
|
|
932
|
+
* The hollow box type consists of thin boxes that make up its walls.
|
|
933
|
+
* If a margin is applied to the box type hollow, its size values are reduced by the margin.
|
|
934
|
+
*
|
|
935
|
+
*
|
|
936
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
937
|
+
* via the `definition` "Box".
|
|
938
|
+
*/
|
|
939
|
+
interface Box {
|
|
940
|
+
shape_type: "box";
|
|
941
|
+
/**
|
|
942
|
+
* The dimension in x-direction in [mm].
|
|
943
|
+
*/
|
|
944
|
+
size_x: number;
|
|
945
|
+
/**
|
|
946
|
+
* The dimension in y-direction in [mm].
|
|
947
|
+
*/
|
|
948
|
+
size_y: number;
|
|
949
|
+
/**
|
|
950
|
+
* The dimension in z-direction in [mm].
|
|
951
|
+
*/
|
|
952
|
+
size_z: number;
|
|
953
|
+
/**
|
|
954
|
+
* The box type defines if the box is hollow or full.
|
|
955
|
+
*/
|
|
956
|
+
box_type: "HOLLOW" | "FULL";
|
|
957
|
+
}
|
|
958
|
+
/**
|
|
959
|
+
* Defines an x/y-plane with finite size. Centred around the z-axis.
|
|
960
|
+
*
|
|
961
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
962
|
+
* via the `definition` "Rectangle".
|
|
963
|
+
*/
|
|
964
|
+
interface Rectangle {
|
|
965
|
+
shape_type: "rectangle";
|
|
966
|
+
/**
|
|
967
|
+
* The dimension in x-direction in [mm].
|
|
968
|
+
*/
|
|
969
|
+
size_x: number;
|
|
970
|
+
/**
|
|
971
|
+
* The dimension in y-direction in [mm].
|
|
972
|
+
*/
|
|
973
|
+
size_y: number;
|
|
974
|
+
}
|
|
975
|
+
/**
|
|
976
|
+
* Defines an x/y-plane with infinite size.
|
|
977
|
+
*
|
|
978
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
979
|
+
* via the `definition` "Plane".
|
|
980
|
+
*/
|
|
981
|
+
interface Plane {
|
|
982
|
+
shape_type: "plane";
|
|
983
|
+
}
|
|
984
|
+
/**
|
|
985
|
+
* Defines a cylindrical shape.
|
|
986
|
+
* Centred around origin, symmetric around z-axis.
|
|
987
|
+
*
|
|
988
|
+
* If a margin is applied, it is added to radius and height. The shape will keep its edges.
|
|
989
|
+
*
|
|
990
|
+
*
|
|
991
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
992
|
+
* via the `definition` "Cylinder".
|
|
993
|
+
*/
|
|
994
|
+
interface Cylinder {
|
|
995
|
+
shape_type: "cylinder";
|
|
996
|
+
/**
|
|
997
|
+
* The radius of the cylinder in [mm].
|
|
998
|
+
*/
|
|
999
|
+
radius: number;
|
|
1000
|
+
/**
|
|
1001
|
+
* The height of the cylinder in [mm].
|
|
1002
|
+
*/
|
|
1003
|
+
height: number;
|
|
1004
|
+
}
|
|
1005
|
+
/**
|
|
1006
|
+
* Defines a cylindrical shape with 2 semi-spheres on the top and bottom.
|
|
1007
|
+
* Centred around origin, symmetric around z-axis.
|
|
1008
|
+
*
|
|
1009
|
+
*
|
|
1010
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1011
|
+
* via the `definition` "Capsule".
|
|
1012
|
+
*/
|
|
1013
|
+
interface Capsule {
|
|
1014
|
+
shape_type: "capsule";
|
|
1015
|
+
/**
|
|
1016
|
+
* The radius of the cylinder and semi-spheres in [mm].
|
|
1017
|
+
*/
|
|
1018
|
+
radius: number;
|
|
1019
|
+
/**
|
|
1020
|
+
* The height of the inner cylinder in [mm].
|
|
1021
|
+
*/
|
|
1022
|
+
cylinder_height: number;
|
|
1023
|
+
}
|
|
1024
|
+
/**
|
|
1025
|
+
* Convex hull around four spheres. Sphere center points in x/y-plane, offset by either combination "+/- sizeX" or "+/- sizeY".
|
|
1026
|
+
*
|
|
1027
|
+
* Alternative description: Rectangle in x/y-plane with a 3D padding.
|
|
1028
|
+
*
|
|
1029
|
+
*
|
|
1030
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1031
|
+
* via the `definition` "RectangularCapsule".
|
|
1032
|
+
*/
|
|
1033
|
+
interface RectangularCapsule {
|
|
1034
|
+
shape_type: "rectangular_capsule";
|
|
1035
|
+
/**
|
|
1036
|
+
* The radius of the inner spheres in [mm].
|
|
1037
|
+
*/
|
|
1038
|
+
radius: number;
|
|
1039
|
+
/**
|
|
1040
|
+
* The distance of the sphere center in x-direction in [mm].
|
|
1041
|
+
*/
|
|
1042
|
+
sphere_center_distance_x: number;
|
|
1043
|
+
/**
|
|
1044
|
+
* The distance of the sphere center in y-direction in [mm].
|
|
1045
|
+
*/
|
|
1046
|
+
sphere_center_distance_y: number;
|
|
1047
|
+
}
|
|
1048
|
+
/**
|
|
1049
|
+
* Defines a convex hull encapsulating a set of vertices.
|
|
1050
|
+
*
|
|
1051
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1052
|
+
* via the `definition` "ConvexHull".
|
|
1053
|
+
*/
|
|
1054
|
+
interface ConvexHull {
|
|
1055
|
+
shape_type: "convex_hull";
|
|
1056
|
+
/**
|
|
1057
|
+
* The list of encapsulated points.
|
|
1058
|
+
*/
|
|
1059
|
+
vertices: Vector3D[];
|
|
1060
|
+
}
|
|
1061
|
+
/**
|
|
1062
|
+
* Defines a pose in 3D space.
|
|
1063
|
+
* A pose is a combination of a position and an orientation.
|
|
1064
|
+
* The position is applied before the orientation.
|
|
1065
|
+
*
|
|
1066
|
+
*
|
|
1067
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1068
|
+
* via the `definition` "Pose".
|
|
1069
|
+
*/
|
|
1070
|
+
interface Pose {
|
|
1071
|
+
position?: Vector3D;
|
|
1072
|
+
orientation?: RotationVector;
|
|
1073
|
+
}
|
|
1074
|
+
/**
|
|
1075
|
+
* Defines a collider with a single shape.
|
|
1076
|
+
*
|
|
1077
|
+
* A collider is an object that is used for collision detection.
|
|
1078
|
+
* It defines the `shape` that is attached with the offset of `pose` to a reference frame.
|
|
1079
|
+
*
|
|
1080
|
+
* Use colliders to:
|
|
1081
|
+
* - Define the shape of a workpiece. The reference frame is the scene origin.
|
|
1082
|
+
* - Define the shape of a link in a motion group. The reference frame is the link coordinate system.
|
|
1083
|
+
* - Define the shape of a tool. The reference frame is the flange coordinate system.
|
|
1084
|
+
*
|
|
1085
|
+
*
|
|
1086
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1087
|
+
* via the `definition` "Collider".
|
|
1088
|
+
*/
|
|
1089
|
+
interface Collider {
|
|
1090
|
+
shape: Sphere | Box | Rectangle | Plane | Cylinder | Capsule | RectangularCapsule | ConvexHull;
|
|
1091
|
+
pose?: Pose;
|
|
1092
|
+
/**
|
|
1093
|
+
* Increases the shape's size in all dimensions. Applied in [mm]. Can be used to keep a safe distance to the shape.
|
|
1094
|
+
*/
|
|
1095
|
+
margin?: number;
|
|
1096
|
+
}
|
|
1097
|
+
/**
|
|
1098
|
+
* A collection of identifiable colliders.
|
|
1099
|
+
*
|
|
1100
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1101
|
+
* via the `definition` "ColliderDictionary".
|
|
1102
|
+
*/
|
|
1103
|
+
interface ColliderDictionary {
|
|
1104
|
+
[k: string]: Collider;
|
|
1105
|
+
}
|
|
1106
|
+
/**
|
|
1107
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1108
|
+
* via the `definition` "Link".
|
|
1109
|
+
*/
|
|
1110
|
+
interface CollisionMotionGroupLink {
|
|
1111
|
+
[k: string]: Collider;
|
|
1112
|
+
}
|
|
1113
|
+
/**
|
|
1114
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1115
|
+
* via the `definition` "CollisionSetup".
|
|
1116
|
+
*/
|
|
1117
|
+
interface CollisionSetup {
|
|
1118
|
+
colliders?: ColliderDictionary1;
|
|
1119
|
+
link_chain?: LinkChain1;
|
|
1120
|
+
tool?: CollisionMotionGroupTool1;
|
|
1121
|
+
/**
|
|
1122
|
+
* If true, self-collision detection is enabled for the motion group.
|
|
1123
|
+
*
|
|
1124
|
+
* Self-collision detection checks if links in the kinematic chain of the motion group collide with each other.
|
|
1125
|
+
* Adjacent links in the kinematic chain of the motion group are not checked for mutual collision.
|
|
1126
|
+
* The tool is treated like a link at the end of the kinematic chain. It is checked against all links except the last one.
|
|
1127
|
+
*
|
|
1128
|
+
* Default is true.
|
|
1129
|
+
*
|
|
1130
|
+
*/
|
|
1131
|
+
self_collision_detection?: boolean;
|
|
1132
|
+
}
|
|
1133
|
+
/**
|
|
1134
|
+
* Colliders are checked against links and tool.
|
|
1135
|
+
*
|
|
1136
|
+
*/
|
|
1137
|
+
interface ColliderDictionary1 {
|
|
1138
|
+
[k: string]: Collider;
|
|
1139
|
+
}
|
|
1140
|
+
/**
|
|
1141
|
+
* Shape of the tool to validate against colliders.
|
|
1142
|
+
*
|
|
1143
|
+
*/
|
|
1144
|
+
interface CollisionMotionGroupTool1 {
|
|
1145
|
+
[k: string]: Collider;
|
|
1146
|
+
}
|
|
1147
|
+
/**
|
|
1148
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1149
|
+
* via the `definition` "BusIOsState".
|
|
1150
|
+
*/
|
|
1151
|
+
interface BusIOsState {
|
|
1152
|
+
state: BusIOsStateEnum;
|
|
1153
|
+
/**
|
|
1154
|
+
* A message providing additional information on the input/output service, e.g., BUS service status, encountered errors.
|
|
1155
|
+
* May be empty if no additional information is available.
|
|
1156
|
+
*
|
|
1157
|
+
*/
|
|
1158
|
+
message?: string;
|
|
1159
|
+
}
|
|
1160
|
+
/**
|
|
1161
|
+
* Input/Output boolean value representation.
|
|
1162
|
+
*
|
|
1163
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1164
|
+
* via the `definition` "IOBooleanValue".
|
|
1165
|
+
*/
|
|
1166
|
+
interface IOBooleanValue {
|
|
1167
|
+
/**
|
|
1168
|
+
* Unique identifier of the input/output.
|
|
1169
|
+
*/
|
|
1170
|
+
io: string;
|
|
1171
|
+
/**
|
|
1172
|
+
* Value of a digital input/output.
|
|
1173
|
+
*
|
|
1174
|
+
*/
|
|
1175
|
+
value: boolean;
|
|
1176
|
+
value_type: "boolean";
|
|
1177
|
+
}
|
|
1178
|
+
/**
|
|
1179
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1180
|
+
* via the `definition` "IOIntegerValue".
|
|
1181
|
+
*/
|
|
1182
|
+
interface IOIntegerValue {
|
|
1183
|
+
/**
|
|
1184
|
+
* Unique identifier of the input/output.
|
|
1185
|
+
*/
|
|
1186
|
+
io: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* Value of an input/output with integer representation.
|
|
1189
|
+
*
|
|
1190
|
+
* > The integral value is transmitted as a string to avoid precision loss during conversion to JSON.
|
|
1191
|
+
* > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers,
|
|
1192
|
+
* > JS bigint libraries can help you to parse the string into an integral value.
|
|
1193
|
+
*
|
|
1194
|
+
*/
|
|
1195
|
+
value: string;
|
|
1196
|
+
value_type: "integer";
|
|
1197
|
+
}
|
|
1198
|
+
/**
|
|
1199
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1200
|
+
* via the `definition` "IOFloatValue".
|
|
1201
|
+
*/
|
|
1202
|
+
interface IOFloatValue {
|
|
1203
|
+
/**
|
|
1204
|
+
* Unique identifier of the input/output.
|
|
1205
|
+
*/
|
|
1206
|
+
io: string;
|
|
1207
|
+
/**
|
|
1208
|
+
* Value of an analog input/output in floating number representation.
|
|
1209
|
+
*
|
|
1210
|
+
*/
|
|
1211
|
+
value: number;
|
|
1212
|
+
value_type: "float";
|
|
1213
|
+
}
|
|
1214
|
+
/**
|
|
1215
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1216
|
+
* via the `definition` "SelectIOs".
|
|
1217
|
+
*/
|
|
1218
|
+
interface SelectIOs {
|
|
1219
|
+
/**
|
|
1220
|
+
* Array of input/output identifiers to retrieve the values for.
|
|
1221
|
+
*/
|
|
1222
|
+
ios: string[];
|
|
1223
|
+
/**
|
|
1224
|
+
* Type of update.
|
|
1225
|
+
* - changes: Only send updates when the value changes.
|
|
1226
|
+
* - full: Send the full list of values at the update rate.
|
|
1227
|
+
*
|
|
1228
|
+
*/
|
|
1229
|
+
update_type?: "changes" | "full";
|
|
1230
|
+
}
|
|
1231
|
+
/**
|
|
1232
|
+
* Array of input/output values.
|
|
1233
|
+
*
|
|
1234
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1235
|
+
* via the `definition` "StreamIOValuesResponse".
|
|
1236
|
+
*/
|
|
1237
|
+
interface StreamIOValuesResponse {
|
|
1238
|
+
io_values: IOValue[];
|
|
1239
|
+
/**
|
|
1240
|
+
* Timestamp indicating when the represented information was received from the robot controller.
|
|
1241
|
+
*/
|
|
1242
|
+
timestamp: string;
|
|
1243
|
+
/**
|
|
1244
|
+
* Sequence number of the controller state. It starts with 0 upon establishing the connection with a physical controller.
|
|
1245
|
+
* The sequence number is reset when the connection to the physical controller is closed and re-established.
|
|
1246
|
+
*
|
|
1247
|
+
*/
|
|
1248
|
+
sequence_number: number;
|
|
1249
|
+
}
|
|
1250
|
+
/**
|
|
1251
|
+
* Jogging is active.
|
|
1252
|
+
*
|
|
1253
|
+
*
|
|
1254
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1255
|
+
* via the `definition` "JoggingRunning".
|
|
1256
|
+
*/
|
|
1257
|
+
interface JoggingRunning {
|
|
1258
|
+
kind: "RUNNING";
|
|
1259
|
+
}
|
|
1260
|
+
/**
|
|
1261
|
+
* User has paused jogging.
|
|
1262
|
+
*
|
|
1263
|
+
*
|
|
1264
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1265
|
+
* via the `definition` "JoggingPausedByUser".
|
|
1266
|
+
*/
|
|
1267
|
+
interface JoggingPausedByUser {
|
|
1268
|
+
kind: "PAUSED_BY_USER";
|
|
1269
|
+
}
|
|
1270
|
+
/**
|
|
1271
|
+
* Jogging was paused because of an I/O event.
|
|
1272
|
+
*
|
|
1273
|
+
*
|
|
1274
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1275
|
+
* via the `definition` "JoggingPausedOnIO".
|
|
1276
|
+
*/
|
|
1277
|
+
interface JoggingPausedOnIO {
|
|
1278
|
+
kind: "PAUSED_ON_IO";
|
|
1279
|
+
}
|
|
1280
|
+
/**
|
|
1281
|
+
* Jogging was paused because a joint is near its limit.
|
|
1282
|
+
*
|
|
1283
|
+
*
|
|
1284
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1285
|
+
* via the `definition` "JoggingPausedNearJointLimit".
|
|
1286
|
+
*/
|
|
1287
|
+
interface JoggingPausedNearJointLimit {
|
|
1288
|
+
kind: "PAUSED_NEAR_JOINT_LIMIT";
|
|
1289
|
+
joint_indices: number[];
|
|
1290
|
+
}
|
|
1291
|
+
/**
|
|
1292
|
+
* Jogging was paused because the motion group neared a collision.
|
|
1293
|
+
*
|
|
1294
|
+
*
|
|
1295
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1296
|
+
* via the `definition` "JoggingPausedNearCollision".
|
|
1297
|
+
*/
|
|
1298
|
+
interface JoggingPausedNearCollision {
|
|
1299
|
+
kind: "PAUSED_NEAR_COLLISION";
|
|
1300
|
+
description: string;
|
|
1301
|
+
}
|
|
1302
|
+
/**
|
|
1303
|
+
* Jogging was paused because the motion group neared a singularity or the workspace boundary.
|
|
1304
|
+
*
|
|
1305
|
+
*
|
|
1306
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1307
|
+
* via the `definition` "JoggingPausedNearSingularity".
|
|
1308
|
+
*/
|
|
1309
|
+
interface JoggingPausedNearSingularity {
|
|
1310
|
+
kind: "PAUSED_NEAR_SINGULARITY";
|
|
1311
|
+
description: string;
|
|
1312
|
+
}
|
|
1313
|
+
/**
|
|
1314
|
+
* State of jogging execution.
|
|
1315
|
+
* This state is sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate.
|
|
1316
|
+
* The jogging state can be one of the following:
|
|
1317
|
+
* - RUNNING: Jogging is active.
|
|
1318
|
+
* - PAUSED_BY_USER: User has paused jogging.
|
|
1319
|
+
* - PAUSED_NEAR_JOINT_LIMIT: Jogging was paused because a joint is near its limit.
|
|
1320
|
+
* - PAUSED_NEAR_COLLISION: Jogging was paused because the motion group neared a collision.
|
|
1321
|
+
* - PAUSED_NEAR_SINGULARITY: Jogging was paused because the motion group neared a singularity or the workspace boundary.
|
|
1322
|
+
* - PAUSED_ON_IO: Jogging was paused because of an I/O event.
|
|
1323
|
+
*
|
|
1324
|
+
*
|
|
1325
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1326
|
+
* via the `definition` "JoggingDetails".
|
|
1327
|
+
*/
|
|
1328
|
+
interface JoggingDetails {
|
|
1329
|
+
state: JoggingRunning | JoggingPausedByUser | JoggingPausedOnIO | JoggingPausedNearJointLimit | JoggingPausedNearCollision | JoggingPausedNearSingularity;
|
|
1330
|
+
/**
|
|
1331
|
+
* Timestamp of the current jogger session in milliseconds.
|
|
1332
|
+
* Only waypoint sessions are supported. Other sessions return 0.
|
|
1333
|
+
*
|
|
1334
|
+
* > **NOTE**
|
|
1335
|
+
* >
|
|
1336
|
+
* > This field is experimental and its behavior may change in future releases.
|
|
1337
|
+
*
|
|
1338
|
+
*/
|
|
1339
|
+
jogger_session_timestamp_ms?: number;
|
|
1340
|
+
kind: "JOGGING";
|
|
1341
|
+
}
|
|
1342
|
+
/**
|
|
1343
|
+
* Trajectory is being executed.
|
|
1344
|
+
*
|
|
1345
|
+
*
|
|
1346
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1347
|
+
* via the `definition` "TrajectoryRunning".
|
|
1348
|
+
*/
|
|
1349
|
+
interface TrajectoryRunning {
|
|
1350
|
+
kind: "RUNNING";
|
|
1351
|
+
/**
|
|
1352
|
+
* Remaining time in milliseconds (ms) to reach the end of the motion.
|
|
1353
|
+
*/
|
|
1354
|
+
time_to_end: number;
|
|
1355
|
+
}
|
|
1356
|
+
/**
|
|
1357
|
+
* User has paused execution.
|
|
1358
|
+
*
|
|
1359
|
+
*
|
|
1360
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1361
|
+
* via the `definition` "TrajectoryPausedByUser".
|
|
1362
|
+
*/
|
|
1363
|
+
interface TrajectoryPausedByUser {
|
|
1364
|
+
kind: "PAUSED_BY_USER";
|
|
1365
|
+
}
|
|
1366
|
+
/**
|
|
1367
|
+
* First or last sample (depending on direction) of trajectory has been sent.
|
|
1368
|
+
*
|
|
1369
|
+
*
|
|
1370
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1371
|
+
* via the `definition` "TrajectoryEnded".
|
|
1372
|
+
*/
|
|
1373
|
+
interface TrajectoryEnded {
|
|
1374
|
+
kind: "END_OF_TRAJECTORY";
|
|
1375
|
+
}
|
|
1376
|
+
/**
|
|
1377
|
+
* Waiting for an I/O event to start execution.
|
|
1378
|
+
*
|
|
1379
|
+
*
|
|
1380
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1381
|
+
* via the `definition` "TrajectoryWaitForIO".
|
|
1382
|
+
*/
|
|
1383
|
+
interface TrajectoryWaitForIO {
|
|
1384
|
+
kind: "WAIT_FOR_IO";
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
* Execution was paused because of an I/O event.
|
|
1388
|
+
*
|
|
1389
|
+
*
|
|
1390
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1391
|
+
* via the `definition` "TrajectoryPausedOnIO".
|
|
1392
|
+
*/
|
|
1393
|
+
interface TrajectoryPausedOnIO {
|
|
1394
|
+
kind: "PAUSED_ON_IO";
|
|
1395
|
+
}
|
|
1396
|
+
/**
|
|
1397
|
+
* State of trajectory execution.
|
|
1398
|
+
* This state is sent during trajectory movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate.
|
|
1399
|
+
* The trajectory state can be one of the following:
|
|
1400
|
+
* - RUNNING: Trajectory is being executed.
|
|
1401
|
+
* - PAUSED_BY_USER: User has paused execution.
|
|
1402
|
+
* - END_OF_TRAJECTORY: First or last sample (depending on direction) of trajectory has been sent.
|
|
1403
|
+
* - WAIT_FOR_IO: Waiting for an I/O event to start execution.
|
|
1404
|
+
* - PAUSED_ON_IO: Execution was paused because of an I/O event.
|
|
1405
|
+
*
|
|
1406
|
+
*
|
|
1407
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1408
|
+
* via the `definition` "TrajectoryDetails".
|
|
1409
|
+
*/
|
|
1410
|
+
interface TrajectoryDetails {
|
|
1411
|
+
/**
|
|
1412
|
+
* Unique identifier of the trajectory being executed.
|
|
1413
|
+
*
|
|
1414
|
+
*/
|
|
1415
|
+
trajectory: string;
|
|
1416
|
+
/**
|
|
1417
|
+
* Location of current joint position commmand on the trajectory being executed.
|
|
1418
|
+
*
|
|
1419
|
+
*/
|
|
1420
|
+
location: number;
|
|
1421
|
+
state: TrajectoryRunning | TrajectoryPausedByUser | TrajectoryEnded | TrajectoryWaitForIO | TrajectoryPausedOnIO;
|
|
1422
|
+
/**
|
|
1423
|
+
* Discriminator for OpenApi generators, which is always "TRAJECTORY" for this schema.
|
|
1424
|
+
*
|
|
1425
|
+
*/
|
|
1426
|
+
kind: "TRAJECTORY";
|
|
1427
|
+
}
|
|
1428
|
+
/**
|
|
1429
|
+
* Presents the current state of the motion group.
|
|
1430
|
+
*
|
|
1431
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1432
|
+
* via the `definition` "MotionGroupState".
|
|
1433
|
+
*/
|
|
1434
|
+
interface MotionGroupState {
|
|
1435
|
+
/**
|
|
1436
|
+
* Timestamp for when data was received from the robot controller.
|
|
1437
|
+
*/
|
|
1438
|
+
timestamp: string;
|
|
1439
|
+
/**
|
|
1440
|
+
* Sequence number of the controller state. It starts with 0 upon establishing the connection with a physical controller.
|
|
1441
|
+
* The sequence number is reset when the connection to the physical controller is closed and re-established.
|
|
1442
|
+
*
|
|
1443
|
+
*/
|
|
1444
|
+
sequence_number: number;
|
|
1445
|
+
/**
|
|
1446
|
+
* Identifier of the motion group.
|
|
1447
|
+
*/
|
|
1448
|
+
motion_group: string;
|
|
1449
|
+
/**
|
|
1450
|
+
* Convenience: Identifier of the robot controller the motion group is attached to.
|
|
1451
|
+
*/
|
|
1452
|
+
controller: string;
|
|
1453
|
+
joint_position: Joints1;
|
|
1454
|
+
joint_limit_reached: MotionGroupState_JointLimitReached1;
|
|
1455
|
+
joint_torque?: Joints2;
|
|
1456
|
+
joint_current?: Joints3;
|
|
1457
|
+
flange_pose?: Pose1;
|
|
1458
|
+
/**
|
|
1459
|
+
* Unique identifier addressing the active TCP.
|
|
1460
|
+
* Might not be returned for positioners as some do not support TCPs, depending on the model.
|
|
1461
|
+
*
|
|
1462
|
+
*/
|
|
1463
|
+
tcp?: string;
|
|
1464
|
+
tcp_pose?: Pose2;
|
|
1465
|
+
/**
|
|
1466
|
+
* Unique identifier addressing the reference coordinate system of the cartesian data.
|
|
1467
|
+
* Might not be returned for positioners as some do not support TCPs, depending on the model.
|
|
1468
|
+
* Default: world coordinate system of corresponding controller.
|
|
1469
|
+
*
|
|
1470
|
+
*/
|
|
1471
|
+
coordinate_system?: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* Unique identifier addressing the active payload.
|
|
1474
|
+
* Only fetchable via GET endpoint, not available in WebSocket.
|
|
1475
|
+
*
|
|
1476
|
+
*/
|
|
1477
|
+
payload?: string;
|
|
1478
|
+
/**
|
|
1479
|
+
* Indicates whether the motion group is in standstill.
|
|
1480
|
+
* Convenience: Signals that NOVA treats measured joint velocities as 0.
|
|
1481
|
+
*
|
|
1482
|
+
*/
|
|
1483
|
+
standstill: boolean;
|
|
1484
|
+
execute?: Execute1;
|
|
1485
|
+
/**
|
|
1486
|
+
* Revision number of the motion group description.
|
|
1487
|
+
* The revision is incremented whenever the motion group description changes due to a modification of the tools or the payloads in the robot configuration.
|
|
1488
|
+
* The robot controller is polled every 10 s during Monitoring Mode to detect those changes.
|
|
1489
|
+
* Use to trigger fetching based on robot configuration changes.
|
|
1490
|
+
*
|
|
1491
|
+
*/
|
|
1492
|
+
description_revision: number;
|
|
1493
|
+
}
|
|
1494
|
+
/**
|
|
1495
|
+
* Indicates whether the joint is in a limit for all joints of the motion group.
|
|
1496
|
+
*
|
|
1497
|
+
*/
|
|
1498
|
+
interface MotionGroupState_JointLimitReached1 {
|
|
1499
|
+
/**
|
|
1500
|
+
* If true, operational (soft) jointLimit is reached for specific joint.
|
|
1501
|
+
*/
|
|
1502
|
+
limit_reached: boolean[];
|
|
1503
|
+
}
|
|
1504
|
+
/**
|
|
1505
|
+
* Defines a pose in 3D space.
|
|
1506
|
+
* A pose is a combination of a position and an orientation.
|
|
1507
|
+
* The position is applied before the orientation.
|
|
1508
|
+
*
|
|
1509
|
+
*/
|
|
1510
|
+
interface Pose1 {
|
|
1511
|
+
position?: Vector3D;
|
|
1512
|
+
orientation?: RotationVector;
|
|
1513
|
+
}
|
|
1514
|
+
/**
|
|
1515
|
+
* Defines a pose in 3D space.
|
|
1516
|
+
* A pose is a combination of a position and an orientation.
|
|
1517
|
+
* The position is applied before the orientation.
|
|
1518
|
+
*
|
|
1519
|
+
*/
|
|
1520
|
+
interface Pose2 {
|
|
1521
|
+
position?: Vector3D;
|
|
1522
|
+
orientation?: RotationVector;
|
|
1523
|
+
}
|
|
1524
|
+
/**
|
|
1525
|
+
* Data that was commanded to the motion group. Includes additional data on NOVA's execution components for executing trajectories and jogging.
|
|
1526
|
+
* This is a convenience field to indicate the last command sent to the motion group.
|
|
1527
|
+
* It is not available in all cases, e.g., if the motion group is not moved by NOVA.
|
|
1528
|
+
*
|
|
1529
|
+
*/
|
|
1530
|
+
interface Execute1 {
|
|
1531
|
+
/**
|
|
1532
|
+
* Commanded joint position of each joint. This command was sent in the time step the corresponding state was received.
|
|
1533
|
+
* The unit depends on the type of joint: For revolute joints, the angle is given in [rad]; for prismatic joints, the displacement is given in [mm].
|
|
1534
|
+
*
|
|
1535
|
+
*/
|
|
1536
|
+
joint_position: number[];
|
|
1537
|
+
details?: JoggingDetails | TrajectoryDetails;
|
|
1538
|
+
}
|
|
1539
|
+
/**
|
|
1540
|
+
* Returns the whole current state of robot controller.
|
|
1541
|
+
*
|
|
1542
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1543
|
+
* via the `definition` "RobotControllerState".
|
|
1544
|
+
*/
|
|
1545
|
+
interface RobotControllerState {
|
|
1546
|
+
/**
|
|
1547
|
+
* Mode of communication and control between NOVA and the robot controller.
|
|
1548
|
+
*/
|
|
1549
|
+
mode: "MODE_CONTROLLER_NOT_CONFIGURED" | "MODE_INITIALIZING" | "MODE_MONITOR" | "MODE_CONTROL" | "MODE_FREE_DRIVE";
|
|
1550
|
+
/**
|
|
1551
|
+
* Last error stack encountered during initialization process or after a controller disconnect.
|
|
1552
|
+
* At this stage, it's unclear whether the error is fatal.
|
|
1553
|
+
*
|
|
1554
|
+
* Evaluate `last_error` to decide whether to remove the controller using `deleteController`.
|
|
1555
|
+
* Examples:
|
|
1556
|
+
* - Delete required: Host resolution fails repeatedly due to an incorrect IP.
|
|
1557
|
+
* - Delete not required: Temporary network delay caused a disconnect; the system will auto-reconnect.
|
|
1558
|
+
*
|
|
1559
|
+
*/
|
|
1560
|
+
last_error?: string[];
|
|
1561
|
+
/**
|
|
1562
|
+
* Timestamp indicating when the represented information was received from the robot controller.
|
|
1563
|
+
*/
|
|
1564
|
+
timestamp: string;
|
|
1565
|
+
/**
|
|
1566
|
+
* Sequence number of the controller state. It starts with 0 upon establishing the connection with a physical controller.
|
|
1567
|
+
* The sequence number is reset when the connection to the physical controller is closed and re-established.
|
|
1568
|
+
*
|
|
1569
|
+
*/
|
|
1570
|
+
sequence_number: number;
|
|
1571
|
+
/**
|
|
1572
|
+
* Identifier of the configured robot controller.
|
|
1573
|
+
*/
|
|
1574
|
+
controller: string;
|
|
1575
|
+
operation_mode: OperationMode;
|
|
1576
|
+
safety_state: SafetyStateType;
|
|
1577
|
+
/**
|
|
1578
|
+
* If made available by the robot controller, returns the current velocity override in
|
|
1579
|
+
* [percentage] for movements adjusted on robot control panel.
|
|
1580
|
+
* Valid value range: 1 - 100.
|
|
1581
|
+
*
|
|
1582
|
+
*/
|
|
1583
|
+
velocity_override?: number;
|
|
1584
|
+
motion_groups: MotionGroupState1;
|
|
1585
|
+
}
|
|
1586
|
+
/**
|
|
1587
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1588
|
+
* via the `definition` "TcpOffset".
|
|
1589
|
+
*/
|
|
1590
|
+
interface TcpOffset {
|
|
1591
|
+
/**
|
|
1592
|
+
* A readable and changeable name for frontend visualization.
|
|
1593
|
+
*/
|
|
1594
|
+
name: string;
|
|
1595
|
+
pose: Pose;
|
|
1596
|
+
}
|
|
1597
|
+
/**
|
|
1598
|
+
* The upper_limit must be greater then the lower_limit.
|
|
1599
|
+
*
|
|
1600
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1601
|
+
* via the `definition` "LimitRange".
|
|
1602
|
+
*/
|
|
1603
|
+
interface LimitRange {
|
|
1604
|
+
lower_limit?: number;
|
|
1605
|
+
upper_limit?: number;
|
|
1606
|
+
}
|
|
1607
|
+
/**
|
|
1608
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1609
|
+
* via the `definition` "JointLimits".
|
|
1610
|
+
*/
|
|
1611
|
+
interface JointLimits {
|
|
1612
|
+
position?: LimitRange;
|
|
1613
|
+
velocity?: number;
|
|
1614
|
+
acceleration?: number;
|
|
1615
|
+
/**
|
|
1616
|
+
* > **NOTE**
|
|
1617
|
+
* >
|
|
1618
|
+
* > This limit type is experimental and its behavior may change in future releases.
|
|
1619
|
+
*
|
|
1620
|
+
*/
|
|
1621
|
+
jerk?: number;
|
|
1622
|
+
torque?: number;
|
|
1623
|
+
}
|
|
1624
|
+
/**
|
|
1625
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1626
|
+
* via the `definition` "CartesianLimits".
|
|
1627
|
+
*/
|
|
1628
|
+
interface CartesianLimits {
|
|
1629
|
+
velocity?: number;
|
|
1630
|
+
acceleration?: number;
|
|
1631
|
+
/**
|
|
1632
|
+
* > **NOTE**
|
|
1633
|
+
* >
|
|
1634
|
+
* > This limit type is experimental and its behavior may change in future releases.
|
|
1635
|
+
*
|
|
1636
|
+
*/
|
|
1637
|
+
jerk?: number;
|
|
1638
|
+
orientation_velocity?: number;
|
|
1639
|
+
orientation_acceleration?: number;
|
|
1640
|
+
/**
|
|
1641
|
+
* > **NOTE**
|
|
1642
|
+
* >
|
|
1643
|
+
* > This limit type is experimental and its behavior may change in future releases.
|
|
1644
|
+
*
|
|
1645
|
+
*/
|
|
1646
|
+
orientation_jerk?: number;
|
|
1647
|
+
}
|
|
1648
|
+
/**
|
|
1649
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1650
|
+
* via the `definition` "LimitSet".
|
|
1651
|
+
*/
|
|
1652
|
+
interface LimitSet {
|
|
1653
|
+
joints?: JointLimits[];
|
|
1654
|
+
tcp?: CartesianLimits;
|
|
1655
|
+
elbow?: CartesianLimits;
|
|
1656
|
+
flange?: CartesianLimits;
|
|
1657
|
+
coupled_shoulder_elbow_joint?: JointLimits;
|
|
1658
|
+
}
|
|
1659
|
+
/**
|
|
1660
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1661
|
+
* via the `definition` "OperationLimits".
|
|
1662
|
+
*/
|
|
1663
|
+
interface OperationLimits {
|
|
1664
|
+
auto_limits?: LimitSet;
|
|
1665
|
+
manual_limits?: LimitSet;
|
|
1666
|
+
manual_t1_limits?: LimitSet;
|
|
1667
|
+
manual_t2_limits?: LimitSet;
|
|
1668
|
+
/**
|
|
1669
|
+
* Flag to indicate whether the TCP velocity limit is also applied for the elbow and flange in auto mode.
|
|
1670
|
+
*/
|
|
1671
|
+
safety_limit_elbow_flange_velocity_in_auto?: boolean;
|
|
1672
|
+
}
|
|
1673
|
+
/**
|
|
1674
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1675
|
+
* via the `definition` "Payload".
|
|
1676
|
+
*/
|
|
1677
|
+
interface Payload {
|
|
1678
|
+
name: string;
|
|
1679
|
+
/**
|
|
1680
|
+
* Mass of payload in [kg].
|
|
1681
|
+
*/
|
|
1682
|
+
payload: number;
|
|
1683
|
+
center_of_mass?: Vector3D1;
|
|
1684
|
+
moment_of_inertia?: Vector3D2;
|
|
1685
|
+
}
|
|
1686
|
+
/**
|
|
1687
|
+
* A single set of DH parameters.
|
|
1688
|
+
*
|
|
1689
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1690
|
+
* via the `definition` "DHParameter".
|
|
1691
|
+
*/
|
|
1692
|
+
interface DHParameter {
|
|
1693
|
+
/**
|
|
1694
|
+
* Angle about x-axis in [rad].
|
|
1695
|
+
*/
|
|
1696
|
+
alpha?: number;
|
|
1697
|
+
/**
|
|
1698
|
+
* Angle about z-axis in [rad].
|
|
1699
|
+
*/
|
|
1700
|
+
theta?: number;
|
|
1701
|
+
/**
|
|
1702
|
+
* Offset along x-axis in [mm].
|
|
1703
|
+
*/
|
|
1704
|
+
a?: number;
|
|
1705
|
+
/**
|
|
1706
|
+
* Offset along z-axis in [mm].
|
|
1707
|
+
*/
|
|
1708
|
+
d?: number;
|
|
1709
|
+
/**
|
|
1710
|
+
* True, if rotation direction of joint is reversed.
|
|
1711
|
+
*/
|
|
1712
|
+
reverse_rotation_direction?: boolean;
|
|
1713
|
+
type?: JointTypeEnum;
|
|
1714
|
+
}
|
|
1715
|
+
/**
|
|
1716
|
+
* The configuration of a motion-group used for motion planning.
|
|
1717
|
+
* The parameters `mounting`, `kinematic_chain_offset`, `dh_parameters`, `flange_offset` and `tcp_offset` are used to model the kinematic structure of the motion group.
|
|
1718
|
+
* They can be used to compute the coordinate transformations from world to tcp frame:
|
|
1719
|
+
* [world frame] -> mounting -> [base frame] -> kinematic chain offset + motion group kinematics (Denavit-Hartenberg parameters) -> [end of kinematic chain frame]
|
|
1720
|
+
* -> flange_offset -> [flange frame] -> tcp_offset -> [tcp frame].
|
|
1721
|
+
*
|
|
1722
|
+
*
|
|
1723
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1724
|
+
* via the `definition` "MotionGroupDescription".
|
|
1725
|
+
*/
|
|
1726
|
+
interface MotionGroupDescription {
|
|
1727
|
+
motion_group_model: MotionGroupModel;
|
|
1728
|
+
mounting?: Pose3;
|
|
1729
|
+
tcps?: TcpOffsetDictionary;
|
|
1730
|
+
safety_zones?: ColliderDictionary2;
|
|
1731
|
+
/**
|
|
1732
|
+
* The shape of the MotionGroups links to validate against safety zones.
|
|
1733
|
+
* Indexed along the kinematic chain, starting with a static base shape before first joint.
|
|
1734
|
+
*
|
|
1735
|
+
*/
|
|
1736
|
+
safety_link_colliders?: ColliderDictionary[];
|
|
1737
|
+
safety_tool_colliders?: SafetyToolColliders;
|
|
1738
|
+
operation_limits: OperationLimits;
|
|
1739
|
+
payloads?: PayloadDictionary;
|
|
1740
|
+
/**
|
|
1741
|
+
* [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
|
|
1742
|
+
*/
|
|
1743
|
+
cycle_time?: number;
|
|
1744
|
+
/**
|
|
1745
|
+
* The Denavit-Hartenberg parameters describing the motion group kinematics.
|
|
1746
|
+
*/
|
|
1747
|
+
dh_parameters?: DHParameter[];
|
|
1748
|
+
kinematic_chain_offset?: Pose4;
|
|
1749
|
+
flange_offset?: Pose5;
|
|
1750
|
+
/**
|
|
1751
|
+
* The serial number of the motion group, if available. If not available, the serial number of the robot controller. If not available, empty.
|
|
1752
|
+
*
|
|
1753
|
+
*/
|
|
1754
|
+
serial_number?: string;
|
|
1755
|
+
/**
|
|
1756
|
+
* Revision number of the motion group description.
|
|
1757
|
+
* The revision is incremented whenever the motion group description changes due to a modification of the tools or the payloads in the robot configuration.
|
|
1758
|
+
* The robot controller is polled every 10 s in Monitoring Mode to detect those changes.
|
|
1759
|
+
* Use to detect changes since the last retrieval.
|
|
1760
|
+
*
|
|
1761
|
+
*/
|
|
1762
|
+
description_revision?: number;
|
|
1763
|
+
}
|
|
1764
|
+
/**
|
|
1765
|
+
* Defines a pose in 3D space.
|
|
1766
|
+
* A pose is a combination of a position and an orientation.
|
|
1767
|
+
* The position is applied before the orientation.
|
|
1768
|
+
*
|
|
1769
|
+
*/
|
|
1770
|
+
interface Pose3 {
|
|
1771
|
+
position?: Vector3D;
|
|
1772
|
+
orientation?: RotationVector;
|
|
1773
|
+
}
|
|
1774
|
+
/**
|
|
1775
|
+
* Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier.
|
|
1776
|
+
* Values are TcpOffsets.
|
|
1777
|
+
*
|
|
1778
|
+
*/
|
|
1779
|
+
interface TcpOffsetDictionary {
|
|
1780
|
+
[k: string]: TcpOffset;
|
|
1781
|
+
}
|
|
1782
|
+
/**
|
|
1783
|
+
* SafetyZones are areas which cannot be entered or where certain limits apply.
|
|
1784
|
+
* SafetyZones are defined in the world coordinate system.
|
|
1785
|
+
*
|
|
1786
|
+
*/
|
|
1787
|
+
interface ColliderDictionary2 {
|
|
1788
|
+
[k: string]: Collider;
|
|
1789
|
+
}
|
|
1790
|
+
/**
|
|
1791
|
+
* Maps a TCP name to its tool collider. Key must be a TCP identifier.
|
|
1792
|
+
* Values are ColliderDictionaries that make up the shape of one tool to validate against safety zones.
|
|
1793
|
+
*
|
|
1794
|
+
*/
|
|
1795
|
+
interface SafetyToolColliders {
|
|
1796
|
+
[k: string]: ColliderDictionary;
|
|
1797
|
+
}
|
|
1798
|
+
/**
|
|
1799
|
+
* Maps a payload name to its configuration. Key must be a payload identifier.
|
|
1800
|
+
* Values are payload objects.
|
|
1801
|
+
*
|
|
1802
|
+
*/
|
|
1803
|
+
interface PayloadDictionary {
|
|
1804
|
+
[k: string]: Payload;
|
|
1805
|
+
}
|
|
1806
|
+
/**
|
|
1807
|
+
* Defines a pose in 3D space.
|
|
1808
|
+
* A pose is a combination of a position and an orientation.
|
|
1809
|
+
* The position is applied before the orientation.
|
|
1810
|
+
*
|
|
1811
|
+
*/
|
|
1812
|
+
interface Pose4 {
|
|
1813
|
+
position?: Vector3D;
|
|
1814
|
+
orientation?: RotationVector;
|
|
1815
|
+
}
|
|
1816
|
+
/**
|
|
1817
|
+
* Defines a pose in 3D space.
|
|
1818
|
+
* A pose is a combination of a position and an orientation.
|
|
1819
|
+
* The position is applied before the orientation.
|
|
1820
|
+
*
|
|
1821
|
+
*/
|
|
1822
|
+
interface Pose5 {
|
|
1823
|
+
position?: Vector3D;
|
|
1824
|
+
orientation?: RotationVector;
|
|
1825
|
+
}
|
|
1826
|
+
/**
|
|
1827
|
+
* CloudEvents specification v1.0.2 compliant event structure.
|
|
1828
|
+
* This schema defines the standardized format for event data across all NOVA services.
|
|
1829
|
+
*
|
|
1830
|
+
*
|
|
1831
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1832
|
+
* via the `definition` "CloudEvent".
|
|
1833
|
+
*/
|
|
1834
|
+
interface CloudEvent {
|
|
1835
|
+
/**
|
|
1836
|
+
* The version of the CloudEvents specification which the event uses
|
|
1837
|
+
*/
|
|
1838
|
+
specversion: "1.0";
|
|
1839
|
+
/**
|
|
1840
|
+
* Type of the event related to the source occurrence
|
|
1841
|
+
*/
|
|
1842
|
+
type: string;
|
|
1843
|
+
/**
|
|
1844
|
+
* Identifies the context in which an event happened
|
|
1845
|
+
*/
|
|
1846
|
+
source: string;
|
|
1847
|
+
/**
|
|
1848
|
+
* Unique identifier for the event
|
|
1849
|
+
*/
|
|
1850
|
+
id: string;
|
|
1851
|
+
/**
|
|
1852
|
+
* Timestamp of when the occurrence happened (RFC3339)
|
|
1853
|
+
*/
|
|
1854
|
+
time?: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* Content type of the data value
|
|
1857
|
+
*/
|
|
1858
|
+
datacontenttype?: string;
|
|
1859
|
+
/**
|
|
1860
|
+
* URI reference that identifies the schema that the data adheres to
|
|
1861
|
+
*/
|
|
1862
|
+
dataschema?: string;
|
|
1863
|
+
/**
|
|
1864
|
+
* Subject of the event in the context of the event producer
|
|
1865
|
+
*/
|
|
1866
|
+
subject?: string;
|
|
1867
|
+
/**
|
|
1868
|
+
* The event payload specific to the event type
|
|
1869
|
+
*/
|
|
1870
|
+
data?: {
|
|
1871
|
+
[k: string]: unknown;
|
|
1872
|
+
};
|
|
1873
|
+
}
|
|
1874
|
+
/**
|
|
1875
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1876
|
+
* via the `definition` "NetworkState".
|
|
1877
|
+
*/
|
|
1878
|
+
interface NetworkState {
|
|
1879
|
+
/**
|
|
1880
|
+
* Indicates whether the system is connected to the internet.
|
|
1881
|
+
*
|
|
1882
|
+
*/
|
|
1883
|
+
internet_connected: boolean;
|
|
1884
|
+
/**
|
|
1885
|
+
* Type of the active network link (e.g., ethernet, wifi, cellular, vpn, unknown).
|
|
1886
|
+
*
|
|
1887
|
+
*/
|
|
1888
|
+
connection_type?: "ethernet" | "wifi" | "cellular" | "vpn" | "unknown";
|
|
1889
|
+
/**
|
|
1890
|
+
* Received signal strength in dBm for wireless interfaces; negative values indicate weaker signals.
|
|
1891
|
+
*
|
|
1892
|
+
*/
|
|
1893
|
+
signal_strength?: number;
|
|
1894
|
+
/**
|
|
1895
|
+
* Normalized link quality metric from 0 (poor) to 1 (excellent) when provided by the interface.
|
|
1896
|
+
*
|
|
1897
|
+
*/
|
|
1898
|
+
link_quality?: number;
|
|
1899
|
+
/**
|
|
1900
|
+
* Round-trip latency to the probe endpoint measured in milliseconds.
|
|
1901
|
+
*
|
|
1902
|
+
*/
|
|
1903
|
+
latency_ms?: number;
|
|
1904
|
+
/**
|
|
1905
|
+
* Estimated downstream bandwidth in megabits per second based on the probe.
|
|
1906
|
+
*
|
|
1907
|
+
*/
|
|
1908
|
+
bandwidth_mbps?: number;
|
|
1909
|
+
}
|
|
1910
|
+
/**
|
|
1911
|
+
* CloudEvents v1.0 compliant event published when system network status changes.
|
|
1912
|
+
* This event wraps the NetworkState payload in a standard CloudEvents envelope.
|
|
1913
|
+
*
|
|
1914
|
+
*
|
|
1915
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1916
|
+
* via the `definition` "NetworkStatusChangedEvent".
|
|
1917
|
+
*/
|
|
1918
|
+
interface NetworkStatusChangedEvent {
|
|
1919
|
+
/**
|
|
1920
|
+
* The version of the CloudEvents specification which the event uses
|
|
1921
|
+
*/
|
|
1922
|
+
specversion: "1.0";
|
|
1923
|
+
/**
|
|
1924
|
+
* Type of the event related to the source occurrence
|
|
1925
|
+
*/
|
|
1926
|
+
type: "nova.v2.events.system.network.status.changed";
|
|
1927
|
+
/**
|
|
1928
|
+
* Identifies the context in which an event happened
|
|
1929
|
+
*/
|
|
1930
|
+
source: "/nova/system-info";
|
|
1931
|
+
/**
|
|
1932
|
+
* Unique identifier for this network status change event
|
|
1933
|
+
*/
|
|
1934
|
+
id: string;
|
|
1935
|
+
/**
|
|
1936
|
+
* Timestamp when the network status changed (RFC3339)
|
|
1937
|
+
*/
|
|
1938
|
+
time: string;
|
|
1939
|
+
/**
|
|
1940
|
+
* Content type of the data value
|
|
1941
|
+
*/
|
|
1942
|
+
datacontenttype?: string;
|
|
1943
|
+
data: NetworkState;
|
|
1944
|
+
}
|
|
1945
|
+
/**
|
|
1946
|
+
* Payload for a cell lifecycle event.
|
|
1947
|
+
*
|
|
1948
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1949
|
+
* via the `definition` "CellEventData".
|
|
1950
|
+
*/
|
|
1951
|
+
interface CellEventData {
|
|
1952
|
+
/**
|
|
1953
|
+
* Chart version of the cell foundation release.
|
|
1954
|
+
*/
|
|
1955
|
+
version: string;
|
|
1956
|
+
operating_state: OperatingState;
|
|
1957
|
+
}
|
|
1958
|
+
/**
|
|
1959
|
+
* Payload for an app lifecycle event.
|
|
1960
|
+
*
|
|
1961
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1962
|
+
* via the `definition` "AppEventData".
|
|
1963
|
+
*/
|
|
1964
|
+
interface AppEventData {
|
|
1965
|
+
/**
|
|
1966
|
+
* OCI image reference of the app release.
|
|
1967
|
+
*/
|
|
1968
|
+
image: string;
|
|
1969
|
+
operating_state: OperatingState;
|
|
1970
|
+
}
|
|
1971
|
+
/**
|
|
1972
|
+
* Payload for a robot controller lifecycle event.
|
|
1973
|
+
*
|
|
1974
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1975
|
+
* via the `definition` "RobotControllerEventData".
|
|
1976
|
+
*/
|
|
1977
|
+
interface RobotControllerEventData {
|
|
1978
|
+
manufacturer: Manufacturer;
|
|
1979
|
+
/**
|
|
1980
|
+
* Indicates whether the controller is virtual.
|
|
1981
|
+
*/
|
|
1982
|
+
virtual: boolean;
|
|
1983
|
+
operating_state: OperatingState;
|
|
1984
|
+
}
|
|
1985
|
+
/**
|
|
1986
|
+
* This interface was referenced by `GeneratedNatsPayloadsRoot`'s JSON-Schema
|
|
1987
|
+
* via the `definition` "NatsErrorPayload".
|
|
1988
|
+
*/
|
|
1989
|
+
interface NatsErrorPayload {
|
|
1990
|
+
code?: string;
|
|
1991
|
+
message: string;
|
|
1992
|
+
}
|
|
1993
|
+
//#endregion
|
|
1994
|
+
//#region src/lib/experimental/nats/generated/operations.d.ts
|
|
1995
|
+
/** Subject parameters required by each NATS subject, e.g. "nova.v2.cells.{cell}". */
|
|
1996
|
+
interface NatsOperationParams {
|
|
1997
|
+
/** publishCell */
|
|
1998
|
+
"nova.v2.cells.{cell}": {
|
|
1999
|
+
cell: string;
|
|
2000
|
+
};
|
|
2001
|
+
/** publishApp */
|
|
2002
|
+
"nova.v2.cells.{cell}.apps.{app}": {
|
|
2003
|
+
cell: string;
|
|
2004
|
+
app: string;
|
|
2005
|
+
};
|
|
2006
|
+
/** publishProgramStatus */
|
|
2007
|
+
"nova.v2.cells.{cell}.programs": {
|
|
2008
|
+
cell: string;
|
|
2009
|
+
};
|
|
2010
|
+
/** publishRobotController */
|
|
2011
|
+
"nova.v2.cells.{cell}.controllers.{controller}": {
|
|
2012
|
+
cell: string;
|
|
2013
|
+
controller: string;
|
|
2014
|
+
};
|
|
2015
|
+
/** publishCellStatus */
|
|
2016
|
+
"nova.v2.cells.{cell}.status": {
|
|
2017
|
+
cell: string;
|
|
2018
|
+
};
|
|
2019
|
+
/** publishCellCycle */
|
|
2020
|
+
"nova.v2.cells.{cell}.cycle": {
|
|
2021
|
+
cell: string;
|
|
2022
|
+
};
|
|
2023
|
+
/** publishSystemStatus */
|
|
2024
|
+
"nova.v2.system.status": Record<string, never>;
|
|
2025
|
+
/** publishCollisionSetup */
|
|
2026
|
+
"nova.v2.cells.{cell}.collision.setups.{setup}": {
|
|
2027
|
+
cell: string;
|
|
2028
|
+
setup: string;
|
|
2029
|
+
};
|
|
2030
|
+
/** publishBUSIOStatus */
|
|
2031
|
+
"nova.v2.cells.{cell}.bus-ios.status": {
|
|
2032
|
+
cell: string;
|
|
2033
|
+
};
|
|
2034
|
+
/** publishBUSIOsIOs */
|
|
2035
|
+
"nova.v2.cells.{cell}.bus-ios.ios": {
|
|
2036
|
+
cell: string;
|
|
2037
|
+
};
|
|
2038
|
+
/** setBUSIOsIOs */
|
|
2039
|
+
"nova.v2.cells.{cell}.bus-ios.ios.set": {
|
|
2040
|
+
cell: string;
|
|
2041
|
+
};
|
|
2042
|
+
/** selectRobotControllerIOs */
|
|
2043
|
+
"nova.v2.cells.{cell}.controllers.{controller}.ios.select": {
|
|
2044
|
+
cell: string;
|
|
2045
|
+
controller: string;
|
|
2046
|
+
};
|
|
2047
|
+
/** publishRobotControllerIOs */
|
|
2048
|
+
"nova.v2.cells.{cell}.controllers.{controller}.ios": {
|
|
2049
|
+
cell: string;
|
|
2050
|
+
controller: string;
|
|
2051
|
+
};
|
|
2052
|
+
/** publishRobotControllersState */
|
|
2053
|
+
"nova.v2.cells.{cell}.controllers.{controller}.state": {
|
|
2054
|
+
cell: string;
|
|
2055
|
+
controller: string;
|
|
2056
|
+
};
|
|
2057
|
+
/** publishMotionGroupDescription */
|
|
2058
|
+
"nova.v2.cells.{cell}.controllers.{controller}.motion-groups.{motion-group}.description": {
|
|
2059
|
+
cell: string;
|
|
2060
|
+
controller: string;
|
|
2061
|
+
"motion-group": string;
|
|
2062
|
+
};
|
|
2063
|
+
/** eventSystemUpdateStarted */
|
|
2064
|
+
"nova.v2.events.system.update.started": Record<string, never>;
|
|
2065
|
+
/** eventSystemUpdateCompleted */
|
|
2066
|
+
"nova.v2.events.system.update.completed": Record<string, never>;
|
|
2067
|
+
/** eventSystemNetworkStatusChanged */
|
|
2068
|
+
"nova.v2.events.system.network.status.changed": Record<string, never>;
|
|
2069
|
+
/** eventCellCreated */
|
|
2070
|
+
"nova.v2.events.cells.{cell}.created": {
|
|
2071
|
+
cell: string;
|
|
2072
|
+
};
|
|
2073
|
+
/** eventCellUpdated */
|
|
2074
|
+
"nova.v2.events.cells.{cell}.updated": {
|
|
2075
|
+
cell: string;
|
|
2076
|
+
};
|
|
2077
|
+
/** eventCellDeleted */
|
|
2078
|
+
"nova.v2.events.cells.{cell}.deleted": {
|
|
2079
|
+
cell: string;
|
|
2080
|
+
};
|
|
2081
|
+
/** eventAppCreated */
|
|
2082
|
+
"nova.v2.events.cells.{cell}.apps.{app}.created": {
|
|
2083
|
+
cell: string;
|
|
2084
|
+
app: string;
|
|
2085
|
+
};
|
|
2086
|
+
/** eventAppUpdated */
|
|
2087
|
+
"nova.v2.events.cells.{cell}.apps.{app}.updated": {
|
|
2088
|
+
cell: string;
|
|
2089
|
+
app: string;
|
|
2090
|
+
};
|
|
2091
|
+
/** eventAppDeleted */
|
|
2092
|
+
"nova.v2.events.cells.{cell}.apps.{app}.deleted": {
|
|
2093
|
+
cell: string;
|
|
2094
|
+
app: string;
|
|
2095
|
+
};
|
|
2096
|
+
/** eventRobotControllerCreated */
|
|
2097
|
+
"nova.v2.events.cells.{cell}.controllers.{controller}.created": {
|
|
2098
|
+
cell: string;
|
|
2099
|
+
controller: string;
|
|
2100
|
+
};
|
|
2101
|
+
/** eventRobotControllerUpdated */
|
|
2102
|
+
"nova.v2.events.cells.{cell}.controllers.{controller}.updated": {
|
|
2103
|
+
cell: string;
|
|
2104
|
+
controller: string;
|
|
2105
|
+
};
|
|
2106
|
+
/** eventRobotControllerDeleted */
|
|
2107
|
+
"nova.v2.events.cells.{cell}.controllers.{controller}.deleted": {
|
|
2108
|
+
cell: string;
|
|
2109
|
+
controller: string;
|
|
2110
|
+
};
|
|
2111
|
+
}
|
|
2112
|
+
/** Payload types for subjects the server publishes and the client subscribes to. */
|
|
2113
|
+
interface NatsSubscribePayloads {
|
|
2114
|
+
/** publishCell */
|
|
2115
|
+
"nova.v2.cells.{cell}": Cell;
|
|
2116
|
+
/** publishApp */
|
|
2117
|
+
"nova.v2.cells.{cell}.apps.{app}": App;
|
|
2118
|
+
/** publishProgramStatus */
|
|
2119
|
+
"nova.v2.cells.{cell}.programs": ProgramStatus;
|
|
2120
|
+
/** publishRobotController */
|
|
2121
|
+
"nova.v2.cells.{cell}.controllers.{controller}": RobotController;
|
|
2122
|
+
/** publishCellStatus */
|
|
2123
|
+
"nova.v2.cells.{cell}.status": ServiceStatusList;
|
|
2124
|
+
/** publishCellCycle */
|
|
2125
|
+
"nova.v2.cells.{cell}.cycle": CellCycleEvent;
|
|
2126
|
+
/** publishSystemStatus */
|
|
2127
|
+
"nova.v2.system.status": ServiceStatusList;
|
|
2128
|
+
/** publishCollisionSetup */
|
|
2129
|
+
"nova.v2.cells.{cell}.collision.setups.{setup}": CollisionSetup;
|
|
2130
|
+
/** publishBUSIOStatus */
|
|
2131
|
+
"nova.v2.cells.{cell}.bus-ios.status": BusIOsState;
|
|
2132
|
+
/** publishBUSIOsIOs */
|
|
2133
|
+
"nova.v2.cells.{cell}.bus-ios.ios": ListIOValuesResponse;
|
|
2134
|
+
/** publishRobotControllerIOs */
|
|
2135
|
+
"nova.v2.cells.{cell}.controllers.{controller}.ios": StreamIOValuesResponse;
|
|
2136
|
+
/** publishRobotControllersState */
|
|
2137
|
+
"nova.v2.cells.{cell}.controllers.{controller}.state": RobotControllerState;
|
|
2138
|
+
/** publishMotionGroupDescription */
|
|
2139
|
+
"nova.v2.cells.{cell}.controllers.{controller}.motion-groups.{motion-group}.description": MotionGroupDescription;
|
|
2140
|
+
/** eventSystemUpdateStarted */
|
|
2141
|
+
"nova.v2.events.system.update.started": SystemUpdateStartedEvent;
|
|
2142
|
+
/** eventSystemUpdateCompleted */
|
|
2143
|
+
"nova.v2.events.system.update.completed": SystemUpdateCompletedEvent;
|
|
2144
|
+
/** eventSystemNetworkStatusChanged */
|
|
2145
|
+
"nova.v2.events.system.network.status.changed": NetworkStatusChangedEvent;
|
|
2146
|
+
/** eventCellCreated */
|
|
2147
|
+
"nova.v2.events.cells.{cell}.created": CellCreatedEvent;
|
|
2148
|
+
/** eventCellUpdated */
|
|
2149
|
+
"nova.v2.events.cells.{cell}.updated": CellUpdatedEvent;
|
|
2150
|
+
/** eventCellDeleted */
|
|
2151
|
+
"nova.v2.events.cells.{cell}.deleted": CellDeletedEvent;
|
|
2152
|
+
/** eventAppCreated */
|
|
2153
|
+
"nova.v2.events.cells.{cell}.apps.{app}.created": AppCreatedEvent;
|
|
2154
|
+
/** eventAppUpdated */
|
|
2155
|
+
"nova.v2.events.cells.{cell}.apps.{app}.updated": AppUpdatedEvent;
|
|
2156
|
+
/** eventAppDeleted */
|
|
2157
|
+
"nova.v2.events.cells.{cell}.apps.{app}.deleted": AppDeletedEvent;
|
|
2158
|
+
/** eventRobotControllerCreated */
|
|
2159
|
+
"nova.v2.events.cells.{cell}.controllers.{controller}.created": RobotControllerCreatedEvent;
|
|
2160
|
+
/** eventRobotControllerUpdated */
|
|
2161
|
+
"nova.v2.events.cells.{cell}.controllers.{controller}.updated": RobotControllerUpdatedEvent;
|
|
2162
|
+
/** eventRobotControllerDeleted */
|
|
2163
|
+
"nova.v2.events.cells.{cell}.controllers.{controller}.deleted": RobotControllerDeletedEvent;
|
|
2164
|
+
}
|
|
2165
|
+
type NatsSubscribeSubject = keyof NatsSubscribePayloads;
|
|
2166
|
+
/** Request payload types for subjects the client sends requests to. */
|
|
2167
|
+
interface NatsRequestPayloads {
|
|
2168
|
+
/** setBUSIOsIOs */
|
|
2169
|
+
"nova.v2.cells.{cell}.bus-ios.ios.set": ListIOValuesResponse;
|
|
2170
|
+
/** selectRobotControllerIOs */
|
|
2171
|
+
"nova.v2.cells.{cell}.controllers.{controller}.ios.select": SelectIOs;
|
|
2172
|
+
}
|
|
2173
|
+
/** Reply payload types for request/reply subjects. */
|
|
2174
|
+
interface NatsReplyPayloads {
|
|
2175
|
+
/** setBUSIOsIOs */
|
|
2176
|
+
"nova.v2.cells.{cell}.bus-ios.ios.set": NatsErrorPayload;
|
|
2177
|
+
/** selectRobotControllerIOs */
|
|
2178
|
+
"nova.v2.cells.{cell}.controllers.{controller}.ios.select": NatsErrorPayload;
|
|
2179
|
+
}
|
|
2180
|
+
type NatsRequestSubject = keyof NatsRequestPayloads;
|
|
2181
|
+
//#endregion
|
|
2182
|
+
//#region src/lib/experimental/nats/NovaNatsClient.d.ts
|
|
2183
|
+
type NovaNatsClientConfig = ConnectionOptions;
|
|
2184
|
+
/**
|
|
2185
|
+
* Typed NATS client for the Wandelbots NOVA messaging API, generated from
|
|
2186
|
+
* src/asyncapi.yaml (see scripts/generate-nats-client.ts).
|
|
2187
|
+
*
|
|
2188
|
+
* Connects over WebSocket via `@nats-io/nats-core`'s `wsconnect`.
|
|
2189
|
+
*/
|
|
2190
|
+
declare class NovaNatsClient {
|
|
2191
|
+
readonly config: NovaNatsClientConfig;
|
|
2192
|
+
private connectionPromise;
|
|
2193
|
+
constructor(config: NovaNatsClientConfig);
|
|
2194
|
+
/**
|
|
2195
|
+
* Connects to NATS if not already connected or connecting, and returns the
|
|
2196
|
+
* connection. Safe to call concurrently: all callers share the same
|
|
2197
|
+
* in-flight connection attempt instead of each starting their own.
|
|
2198
|
+
*/
|
|
2199
|
+
connect(): Promise<NatsConnection>;
|
|
2200
|
+
/** Closes the underlying NATS connection, if open or connecting. */
|
|
2201
|
+
close(): Promise<void>;
|
|
2202
|
+
/**
|
|
2203
|
+
* Subscribes to a NATS subject published by the server, invoking `handler`
|
|
2204
|
+
* with the JSON-decoded payload of every message received.
|
|
2205
|
+
*
|
|
2206
|
+
* `subject` is the subject template as it appears on the wire, e.g.
|
|
2207
|
+
* `"nova.v2.cells.{cell}"`, with `{param}` placeholders filled in from
|
|
2208
|
+
* `params`.
|
|
2209
|
+
*
|
|
2210
|
+
* Returns a function that unsubscribes when called.
|
|
2211
|
+
*/
|
|
2212
|
+
subscribe<K extends NatsSubscribeSubject>(subject: K, params: NatsOperationParams[K], handler: (payload: NatsSubscribePayloads[K], msg: Msg) => void): Promise<() => void>;
|
|
2213
|
+
/**
|
|
2214
|
+
* Sends a request payload for a NATS subject the server receives, and
|
|
2215
|
+
* waits for the JSON-decoded reply.
|
|
2216
|
+
*
|
|
2217
|
+
* `subject` is the subject template as it appears on the wire, e.g.
|
|
2218
|
+
* `"nova.v2.cells.{cell}.bus-ios.ios.set"`, with `{param}` placeholders
|
|
2219
|
+
* filled in from `params`.
|
|
2220
|
+
*/
|
|
2221
|
+
request<K extends NatsRequestSubject>(subject: K, params: NatsOperationParams[K], payload: NatsRequestPayloads[K], opts?: {
|
|
2222
|
+
timeout?: number;
|
|
2223
|
+
}): Promise<NatsReplyPayloads[K]>;
|
|
2224
|
+
}
|
|
2225
|
+
//#endregion
|
|
2226
|
+
export { type NatsOperationParams, type NatsReplyPayloads, type NatsRequestPayloads, type NatsRequestSubject, type NatsSubscribePayloads, type NatsSubscribeSubject, NovaNatsClient, type NovaNatsClientConfig };
|
|
2227
|
+
//# sourceMappingURL=index.d.cts.map
|