@wandelbots/nova-api 26.7.0-dev.60 → 26.7.0-dev.61
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/v2/index.cjs +1 -1
- package/dist/v2/index.d.cts +10 -4
- package/dist/v2/index.d.ts +10 -4
- package/dist/v2/index.js +1 -1
- package/package.json +1 -1
package/dist/v2/index.cjs
CHANGED
|
@@ -4813,7 +4813,7 @@ var MotionGroupApi = class extends BaseAPI {
|
|
|
4813
4813
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4814
4814
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
4815
4815
|
* @param {string} motionGroup The motion-group identifier.
|
|
4816
|
-
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms).
|
|
4816
|
+
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). If not set, the state is streamed at the step rate of the controller. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
4817
4817
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
4818
4818
|
* @param {*} [options] Override http request option.
|
|
4819
4819
|
* @throws {RequiredError}
|
package/dist/v2/index.d.cts
CHANGED
|
@@ -1740,6 +1740,12 @@ interface DatasetFrame {
|
|
|
1740
1740
|
* Unique identifier of the dataset. Must start with a letter and may only contain letters, digits, and hyphens.
|
|
1741
1741
|
*/
|
|
1742
1742
|
'dataset': string;
|
|
1743
|
+
/**
|
|
1744
|
+
* Additional key-value pairs that can be attached to the frame.
|
|
1745
|
+
*/
|
|
1746
|
+
'metadata'?: {
|
|
1747
|
+
[key: string]: string;
|
|
1748
|
+
};
|
|
1743
1749
|
}
|
|
1744
1750
|
/**
|
|
1745
1751
|
* A dataset pose is a taught pose that belongs to a dataset. It extends the shared `ConfiguredPose` with dataset-specific fields such as an identifier, human-readable name, timestamps, and metadata.
|
|
@@ -9674,7 +9680,7 @@ declare const MotionGroupApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
9674
9680
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9675
9681
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9676
9682
|
* @param {string} motionGroup The motion-group identifier.
|
|
9677
|
-
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms).
|
|
9683
|
+
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). If not set, the state is streamed at the step rate of the controller. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
9678
9684
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
9679
9685
|
* @param {*} [options] Override http request option.
|
|
9680
9686
|
* @throws {RequiredError}
|
|
@@ -9712,7 +9718,7 @@ declare const MotionGroupApiFp: (configuration?: Configuration) => {
|
|
|
9712
9718
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9713
9719
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9714
9720
|
* @param {string} motionGroup The motion-group identifier.
|
|
9715
|
-
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms).
|
|
9721
|
+
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). If not set, the state is streamed at the step rate of the controller. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
9716
9722
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
9717
9723
|
* @param {*} [options] Override http request option.
|
|
9718
9724
|
* @throws {RequiredError}
|
|
@@ -9750,7 +9756,7 @@ declare const MotionGroupApiFactory: (configuration?: Configuration, basePath?:
|
|
|
9750
9756
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9751
9757
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9752
9758
|
* @param {string} motionGroup The motion-group identifier.
|
|
9753
|
-
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms).
|
|
9759
|
+
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). If not set, the state is streamed at the step rate of the controller. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
9754
9760
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
9755
9761
|
* @param {*} [options] Override http request option.
|
|
9756
9762
|
* @throws {RequiredError}
|
|
@@ -9788,7 +9794,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
9788
9794
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9789
9795
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9790
9796
|
* @param {string} motionGroup The motion-group identifier.
|
|
9791
|
-
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms).
|
|
9797
|
+
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). If not set, the state is streamed at the step rate of the controller. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
9792
9798
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
9793
9799
|
* @param {*} [options] Override http request option.
|
|
9794
9800
|
* @throws {RequiredError}
|
package/dist/v2/index.d.ts
CHANGED
|
@@ -1740,6 +1740,12 @@ interface DatasetFrame {
|
|
|
1740
1740
|
* Unique identifier of the dataset. Must start with a letter and may only contain letters, digits, and hyphens.
|
|
1741
1741
|
*/
|
|
1742
1742
|
'dataset': string;
|
|
1743
|
+
/**
|
|
1744
|
+
* Additional key-value pairs that can be attached to the frame.
|
|
1745
|
+
*/
|
|
1746
|
+
'metadata'?: {
|
|
1747
|
+
[key: string]: string;
|
|
1748
|
+
};
|
|
1743
1749
|
}
|
|
1744
1750
|
/**
|
|
1745
1751
|
* A dataset pose is a taught pose that belongs to a dataset. It extends the shared `ConfiguredPose` with dataset-specific fields such as an identifier, human-readable name, timestamps, and metadata.
|
|
@@ -9674,7 +9680,7 @@ declare const MotionGroupApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
9674
9680
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9675
9681
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9676
9682
|
* @param {string} motionGroup The motion-group identifier.
|
|
9677
|
-
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms).
|
|
9683
|
+
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). If not set, the state is streamed at the step rate of the controller. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
9678
9684
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
9679
9685
|
* @param {*} [options] Override http request option.
|
|
9680
9686
|
* @throws {RequiredError}
|
|
@@ -9712,7 +9718,7 @@ declare const MotionGroupApiFp: (configuration?: Configuration) => {
|
|
|
9712
9718
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9713
9719
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9714
9720
|
* @param {string} motionGroup The motion-group identifier.
|
|
9715
|
-
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms).
|
|
9721
|
+
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). If not set, the state is streamed at the step rate of the controller. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
9716
9722
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
9717
9723
|
* @param {*} [options] Override http request option.
|
|
9718
9724
|
* @throws {RequiredError}
|
|
@@ -9750,7 +9756,7 @@ declare const MotionGroupApiFactory: (configuration?: Configuration, basePath?:
|
|
|
9750
9756
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9751
9757
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9752
9758
|
* @param {string} motionGroup The motion-group identifier.
|
|
9753
|
-
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms).
|
|
9759
|
+
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). If not set, the state is streamed at the step rate of the controller. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
9754
9760
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
9755
9761
|
* @param {*} [options] Override http request option.
|
|
9756
9762
|
* @throws {RequiredError}
|
|
@@ -9788,7 +9794,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
9788
9794
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9789
9795
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9790
9796
|
* @param {string} motionGroup The motion-group identifier.
|
|
9791
|
-
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms).
|
|
9797
|
+
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). If not set, the state is streamed at the step rate of the controller. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
9792
9798
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
9793
9799
|
* @param {*} [options] Override http request option.
|
|
9794
9800
|
* @throws {RequiredError}
|
package/dist/v2/index.js
CHANGED
|
@@ -4789,7 +4789,7 @@ var MotionGroupApi = class extends BaseAPI {
|
|
|
4789
4789
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4790
4790
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
4791
4791
|
* @param {string} motionGroup The motion-group identifier.
|
|
4792
|
-
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms).
|
|
4792
|
+
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). If not set, the state is streamed at the step rate of the controller. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
4793
4793
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
4794
4794
|
* @param {*} [options] Override http request option.
|
|
4795
4795
|
* @throws {RequiredError}
|