@synapticon/motion-master-client 6.0.0-alpha.43 → 6.0.0-alpha.45

package/dist/generated/Api.d.ts

@@ -1,4 +1,4 @@
-import { AlStatusCode, DcSyncStatus, DeviceDiagnostics, DeviceParameter, EscRegister, FoeErrorCode, GameLoopHealth, Monitoring, ObjectDataTypeInfo, OutputStageResult, ParameterCacheEntry, PdoMapping, PdoMappingRequest, ProcessDataWatchdog, ProcessImageObject, SlaveConfig, SlaveInformationInterface } from "./data-contracts.js";
+import { AlStatusCode, DcSyncStatus, DeviceDiagnostics, DeviceParameter, EscRegister, FoeErrorCode, GameLoopHealth, MailboxErrorCode, Monitoring, ObjectDataTypeInfo, OutputStageResult, ParameterCacheEntry, PdoMapping, PdoMappingRequest, ProcessDataWatchdog, ProcessImageObject, SdoAbortCode, SlaveConfig, SlaveInformationInterface } from "./data-contracts.js";
 import { HttpClient, RequestParams } from "./http-client.js";
 export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
     /**
@@ -360,6 +360,22 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @request GET:/api/meta/foe-error-codes
      */
     getFoeErrorCodes: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<FoeErrorCode[], any>>;
+    /**
+     * @description Returns the static catalogue of CoE SDO abort codes defined in ETG.1000.6 §5.6.2.7.2, Table 41 (which reproduces the CANopen CiA 301 abort transfer codes).  A slave returns one of these when a mailbox SDO read/write fails; the code is embedded in the error text returned by the SDO endpoints.
+     *
+     * @name GetSdoAbortCodes
+     * @summary List all known CoE SDO abort codes
+     * @request GET:/api/meta/sdo-abort-codes
+     */
+    getSdoAbortCodes: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<SdoAbortCode[], any>>;
+    /**
+     * @description Returns the static catalogue of CoE mailbox error codes defined in ETG.1000.4, Table 30 ("Error Reply Service Data").  A slave returns one of these when the mailbox layer (below a specific protocol such as CoE/FoE) rejects a transfer; the code is embedded in the error text the mailbox endpoints return.
+     *
+     * @name GetMailboxErrorCodes
+     * @summary List all known CoE mailbox error codes
+     * @request GET:/api/meta/mailbox-error-codes
+     */
+    getMailboxErrorCodes: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<MailboxErrorCode[], any>>;
     /**
      * @description Returns the static catalogue of ETG.1020 data type codes used in CoE object dictionary entries.  Each entry of a `DeviceParameter` carries a `dataType` field whose value is one of the codes listed here.
      *

package/dist/generated/Api.js

@@ -194,6 +194,32 @@ export class Api extends HttpClient {
         format: "json",
         ...params,
     });
+    /**
+     * @description Returns the static catalogue of CoE SDO abort codes defined in ETG.1000.6 §5.6.2.7.2, Table 41 (which reproduces the CANopen CiA 301 abort transfer codes).  A slave returns one of these when a mailbox SDO read/write fails; the code is embedded in the error text returned by the SDO endpoints.
+     *
+     * @name GetSdoAbortCodes
+     * @summary List all known CoE SDO abort codes
+     * @request GET:/api/meta/sdo-abort-codes
+     */
+    getSdoAbortCodes = (params = {}) => this.request({
+        path: `/api/meta/sdo-abort-codes`,
+        method: "GET",
+        format: "json",
+        ...params,
+    });
+    /**
+     * @description Returns the static catalogue of CoE mailbox error codes defined in ETG.1000.4, Table 30 ("Error Reply Service Data").  A slave returns one of these when the mailbox layer (below a specific protocol such as CoE/FoE) rejects a transfer; the code is embedded in the error text the mailbox endpoints return.
+     *
+     * @name GetMailboxErrorCodes
+     * @summary List all known CoE mailbox error codes
+     * @request GET:/api/meta/mailbox-error-codes
+     */
+    getMailboxErrorCodes = (params = {}) => this.request({
+        path: `/api/meta/mailbox-error-codes`,
+        method: "GET",
+        format: "json",
+        ...params,
+    });
     /**
      * @description Returns the static catalogue of ETG.1020 data type codes used in CoE object dictionary entries.  Each entry of a `DeviceParameter` carries a `dataType` field whose value is one of the codes listed here.
      *

package/dist/generated/data-contracts.d.ts

@@ -673,6 +673,35 @@ export interface FoeErrorCode {
      */
     description: string;
 }
+export interface SdoAbortCode {
+    /**
+     * 32-bit CoE SDO abort code (ETG.1000.6 §5.6.2.7.2, Table 41)
+     * @example 100794368
+     */
+    code: number;
+    /**
+     * Human-readable meaning of the abort
+     * @example "The object does not exist in the object dictionary"
+     */
+    description: string;
+}
+export interface MailboxErrorCode {
+    /**
+     * 16-bit mailbox error Detail code (ETG.1000.4, Table 30)
+     * @example 1
+     */
+    code: number;
+    /**
+     * Symbolic name
+     * @example "MBXERR_SYNTAX"
+     */
+    name: string;
+    /**
+     * Human-readable meaning of the error
+     * @example "Syntax of the 6-octet mailbox header is wrong"
+     */
+    description: string;
+}
 export interface ObjectDataTypeInfo {
     /**
      * ETG.1020 data type code

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synapticon/motion-master-client",
-  "version": "6.0.0-alpha.43",
+  "version": "6.0.0-alpha.45",
   "description": "Isomorphic TypeScript client for Motion Master: the generated HTTP API client, the WebSocket connection, and helpers.",
   "license": "MIT",
   "repository": {