motion-master-client 0.0.77 → 0.0.86

package/src/lib/os-command.d.ts

@@ -1,173 +1,387 @@
-import { RequestStatus } from "./types";
-export interface OsCommandResponse {
-    data?: number[];
-    errorCode?: number;
-    errorName?: string;
-    errorDescription?: string;
-    progress?: number;
-    request: RequestStatus;
-    response: Uint8Array;
-}
-export declare function parseOsCommandResponse(response: Uint8Array): OsCommandResponse;
-export declare enum OsCommandMode {
-    EXECUTE_THE_NEXT_COMMAND_IMMEDIATELY = 0,
-    ABORT_THE_CURRENT_COMMAND_AND_ALL_COMMANDS_IN_THE_BUFFER = 3
-}
-export declare enum OsCommandId {
-    ENCODER_REGISTER_COMMUNICATION = 0,
-    ICMU_CALIBRATION_MODE = 1,
-    OPEN_LOOP_FIELD_MODE = 2,
-    HRD_STREAMING = 3,
-    MOTOR_PHASE_ORDER_DETECTION = 4,
-    COMMUTATION_OFFSET_MEASUREMENT = 5,
-    OPEN_PHASE_DETECTION = 6,
-    POLE_PAIR_DETECTION = 7,
-    PHASE_RESISTANCE_MEASUREMENT = 8,
-    PHASE_INDUCTANCE_MEASUREMENT = 9,
-    TORQUE_CONSTANT_MEASUREMENT = 10,
-    SMM = 11
-}
-export declare const osCommandErrorCode: {
-    [key: number]: string;
-};
-export declare function createOsCommandTypedArray(elements: number[]): Uint8Array;
-/**
- * OS command 0: Encoder register communication
- *
- * This OS command is utilized for reading or writing registers from an encoder service.
- * Presently, the only service supporting this functionality is BiSS, but it can be easily extended to other encoder services.
- * For more information on how BiSS register communication operates, please consult the official BiSS C Interface Protocol Description.
- *
- * |        | Bit 7 | Bit 6 | Bit 5 | Bit 4 | Bit 3 | Bit 2 | Bit 1 | Bit 0 |
- * |--------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|
- * | Byte 0 |   0   |   0   |   0   |   0   |   0   |   0   |   0   |   0   |
- * | Byte 1 |   -   |   -   |   -   |   -   |   -   |   A   |   A   |   A   |
- * | Byte 2 |   B   |   B   |   B   |   B   |   B   |   B   |   B   |   C   |
- * | Byte 3 |   D   |   D   |   D   |   D   |   D   |   D   |   D   |   D   |
- * | Byte 4 |   E   |   E   |   E   |   E   |   E   |   E   |   E   |   E   |
- * | Byte 5 |   -   |   -   |   -   |   -   |   -   |   -   |   -   |   -   |
- * | Byte 6 |   -   |   -   |   -   |   -   |   -   |   -   |   -   |   -   |
- * | Byte 7 |   -   |   -   |   -   |   -   |   -   |   -   |   -   |   -   |
- *
- * @param encoderOrdinal (A) 2^3=8 encoder ordinals. Counting starts from 1, so '1' refers to Encoder 1 configured in 0x2110.
- * @param slaveAddress (B) 2^7=128 slave addresses. Select the address of the slave to read (BiSS protocol level). Since our BiSS service doesn't support multiple slaves in the same device, this value should always be 0.
- * @param rw (C) Read or write the encoder register. Select the direction of the command: 0 for reading a register, and 1 for writing it.
- * @param registerAddress (D) Register to be read/written.
- * @param registerWriteValue (E) The value to write to the register. This value is ignored when reading a register (when rw is set to 0).
- */
-export declare function createEncoderRegisterCommunicationOsCommand(encoderOrdinal?: number, slaveAddress?: number, rw?: number, registerAddress?: number, registerWriteValue?: number): Uint8Array;
-export interface EncoderRegisterCommunicationOsCommandResponse extends OsCommandResponse {
-    registerValue?: number;
-}
-/**
- * Command 4: Motor phase order detection
- *
- * This command is used to detect the order of the motor phases.
- * When this command finishes successfully, the found value is automatically written to the object 0x2003:5 Motor phases inverted.
- * This command rotates the motor.
- *
- * This OS command has no arguments.
- *
- * When the command finishes successfully, it will return a value of 0 for normal and 1 for inverted motor phases.
- *
- * This command doesn't have any command-specific OS error code, so this status will only happen when a general OS error code occurs.
- *
- * This command will report its progress without indicating a percentage.
- *
- * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled, there is no active limit switch,
- * and the brake status is disengaged (in case there is a configured brake). If any of these conditions is not true during the execution of the command,
- * the execution will stop, and it will return the OS error code 251 (command not allowed).
- */
-export declare function createMotorPhaseOrderDetectionOsCommand(): Uint8Array;
-export interface MotorPhaseOrderDetectionOsCommandResponse extends OsCommandResponse {
-    motorPhaseOrder?: number;
-}
-/**
- * Command 5: Commutation offset measurement
- *
- * This command is used to measure the commutation angle offset.
- * The configuration of the procedure is derived from the pre-existing and previously used commutation offset objects in the object dictionary.
- * Upon successful completion of this command, the determined value is automatically written to:
- * - 0x2001:00 Commutation angle offset
- * - 0x2009:01 State is set to OFFSET_VALID
- *
- * In version 5.0, three different methods can be selected for command 5. These methods are named:
- * - Commutation offset measurement - method 0
- * - Commutation offset measurement - method 1
- * - Commutation offset measurement - method 2
- * Among these three methods, "method 0" and "method 1" involve rotating the rotor.
- *
- * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS) and the CIA402 state is Operation enabled.
- * Additionally, if the commutation offset measurement method (0x2009:3) is set to 0 or 1,
- * the command is permissible only when there are no active limit switches, and the brake status is disengaged (in case a brake is configured).
- * If any of these conditions is not met during the execution of the command, the execution will be halted,
- * and it will return the OS error code 251 (Command not allowed).
- */
-export declare function createCommutationOffsetMeasurementOsCommand(): Uint8Array;
-export interface CommutationOffsetMeasurementOsCommandResponse extends OsCommandResponse {
-    commutationAngleOffset?: number;
-}
-/**
- * Command 6: Open phase detection
- *
- * This command is used to detect whether one of the phases is open.
- * It might rotate the motor if there is no brake or if it is disengaged.
- *
- * If this command finishes successfully, it indicates that all motor phases seem to be fine.
- *
- * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
- * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
- * the execution will stop, and it will return the OS error code 251 (Command not allowed).
- */
-export declare function createOpenPhaseDetectionOsCommand(): Uint8Array;
-export interface OpenPhaseDetectionOsCommandResponse extends OsCommandResponse {
-    phaseOpened?: boolean;
-}
-export declare const openPhaseDetectionErrors: {
-    [key: number]: {
-        errorName: string;
-        errorDescription: string;
-    };
-};
-/**
- * Command 7: Pole pair detection
- *
- * This command is used to detect the number of pole pairs that the connected motor has.
- * It requires the rotation of the rotor.
- *
- * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
- * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
- * the execution will stop, and it will return the OS error code 251 (Command not allowed).
- */
-export declare function createPolePairDetectionOsCommand(): Uint8Array;
-export interface PolePairDetectionOsCommandResponse extends OsCommandResponse {
-    numberOfPolePairs?: number;
-}
-/**
- * Command 8: Phase resistance measurement
- *
- * This command is used to measure the phase resistance of the motor in milliohms (mΩ).
- * It might rotate the motor if there is no brake or if it is disengaged.
- *
- * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
- * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
- * the execution will stop, and it will return the OS error code 251 (Command not allowed).
- */
-export declare function createPhaseResistanceMeasurementOsCommand(): Uint8Array;
-export interface PhaseResistanceMeasurementOsCommandResponse extends OsCommandResponse {
-    phaseResistance?: number;
-}
-/**
- * Command 9: Phase inductance measurement
- *
- * This command is used to measure the phase inductance of the motor in microhenries (μH).
- * It might rotate the motor if there is no brake or if it is disengaged.
- *
- * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
- * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
- * the execution will stop, and it will return the OS error code 251 (Command not allowed).
- */
-export declare function createPhaseInductanceMeasurementOsCommand(): Uint8Array;
-export interface PhaseInductanceMeasurementOsCommandResponse extends OsCommandResponse {
-    phaseInductance?: number;
-}
+import { RequestStatus } from "./types";
+export interface OsCommandResponse {
+    /**
+     * The command that was sent to the device through the 0x1023:01 OS Command.
+     */
+    command?: Uint8Array;
+    /**
+     * Array of numbers representing the received data.
+     *
+     * The length of data depends on the response type.
+     * If the response number is 3 (Command completed with error and with response),
+     * the length can be up to 5 numbers; otherwise, it can be up to 6 numbers.
+     */
+    data?: number[];
+    /**
+     * The error code is only set when the response number is 3 (Command completed with error and with response).
+     *
+     * The meaning of the error code can be general or command specific.
+     * General error codes start at 254 and go downwards:
+     * - 254: Unsupported command
+     * - 253: Command timeout
+     * - 252: Command aborted
+     * - 251: Command not allowed
+     * OS command specific error codes start at 0 and go upwards.
+     */
+    errorCode?: number;
+    /**
+     * The error name is derived from the OS command number and error code number.
+     */
+    errorName?: string;
+    /**
+     * The error description is derived from the OS command number and error code number.
+     * The purpose of the error description is to provide more information about the error than the name can.
+     */
+    errorDescription?: string;
+    /**
+     * Reported progress during the OS command execution.
+     *
+     * The progress can be in the range from 0 to 100 and is computed from the command status.
+     * A status value between 100 and 200 indicates that the command is executing with a percentage (100 = 0%, 200 = 100%).
+     */
+    progress?: number;
+    /**
+     * Status of the request.
+     */
+    request: RequestStatus;
+    /**
+     * Raw response as sent by the device.
+     */
+    response: Uint8Array;
+}
+export declare function parseOsCommandResponse(response: Uint8Array, command?: Uint8Array): OsCommandResponse;
+export declare enum OsCommandMode {
+    EXECUTE_THE_NEXT_COMMAND_IMMEDIATELY = 0,
+    ABORT_THE_CURRENT_COMMAND_AND_ALL_COMMANDS_IN_THE_BUFFER = 3
+}
+export declare enum OsCommandId {
+    CUSTOM_OS_COMMAND = -1,
+    ENCODER_REGISTER_COMMUNICATION = 0,
+    ICMU_CALIBRATION_MODE = 1,
+    OPEN_LOOP_FIELD_MODE = 2,
+    HRD_STREAMING = 3,
+    MOTOR_PHASE_ORDER_DETECTION = 4,
+    COMMUTATION_OFFSET_MEASUREMENT = 5,
+    OPEN_PHASE_DETECTION = 6,
+    POLE_PAIR_DETECTION = 7,
+    PHASE_RESISTANCE_MEASUREMENT = 8,
+    PHASE_INDUCTANCE_MEASUREMENT = 9,
+    TORQUE_CONSTANT_MEASUREMENT = 10,
+    SMM = 11,
+    SKIPPED_CYCLED_COUNTER = 13,
+    IGNORE_BISS_STATUS_BITS = 14,
+    SYSTEM_IDENTIFICATION = 15,
+    TRIGGER_ERROR = 16,
+    KUBLER_ENCODER_COMMAND = 17,
+    USE_INTERNAL_ENCODER_VELOCITY = 18,
+    KUBLER_ENCODER_REGISTER_COMMUNICATION = 19
+}
+export declare const osCommandErrorCode: {
+    [key: number]: string;
+};
+export declare function createOsCommandTypedArray(elements: number[]): Uint8Array;
+/**
+ * OS command 0: Encoder register communication
+ *
+ * This OS command is utilized for reading or writing registers from an encoder service.
+ * Presently, the only service supporting this functionality is BiSS, but it can be easily extended to other encoder services.
+ * For more information on how BiSS register communication operates, please consult the official BiSS C Interface Protocol Description.
+ *
+ * |        | Bit 7 | Bit 6 | Bit 5 | Bit 4 | Bit 3 | Bit 2 | Bit 1 | Bit 0 |
+ * |--------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|
+ * | Byte 0 |   0   |   0   |   0   |   0   |   0   |   0   |   0   |   0   |
+ * | Byte 1 |   -   |   -   |   -   |   -   |   -   |   A   |   A   |   A   |
+ * | Byte 2 |   B   |   B   |   B   |   B   |   B   |   B   |   B   |   C   |
+ * | Byte 3 |   D   |   D   |   D   |   D   |   D   |   D   |   D   |   D   |
+ * | Byte 4 |   E   |   E   |   E   |   E   |   E   |   E   |   E   |   E   |
+ * | Byte 5 |   -   |   -   |   -   |   -   |   -   |   -   |   -   |   -   |
+ * | Byte 6 |   -   |   -   |   -   |   -   |   -   |   -   |   -   |   -   |
+ * | Byte 7 |   -   |   -   |   -   |   -   |   -   |   -   |   -   |   -   |
+ *
+ * @param encoderOrdinal (A) 2^3=8 encoder ordinals. Counting starts from 1, so '1' refers to Encoder 1 configured in 0x2110.
+ * @param slaveAddress (B) 2^7=128 slave addresses. Select the address of the slave to read (BiSS protocol level). Since our BiSS service doesn't support multiple slaves in the same device, this value should always be 0.
+ * @param rw (C) Read or write the encoder register. Select the direction of the command: 0 for reading a register, and 1 for writing it.
+ * @param registerAddress (D) Register to be read/written.
+ * @param registerWriteValue (E) The value to write to the register. This value is ignored when reading a register (when rw is set to 0).
+ */
+export declare function createEncoderRegisterCommunicationOsCommand(encoderOrdinal?: number, slaveAddress?: number, rw?: number, registerAddress?: number, registerWriteValue?: number): Uint8Array;
+export interface EncoderRegisterCommunicationOsCommandResponse extends OsCommandResponse {
+    registerValue?: number;
+}
+/**
+ * OS command 1: iC-MU calibration mode
+ *
+ * This command is used to set a particular BiSS mode when using an iC-MU encoder, which is primarily employed for iC-MU calibration.
+ *
+ * The supported modes are explained below:
+ *
+ * **Configuration mode**: The BiSS service clocks the encoder normally, but it only utilizes the bits for register communication and discards the rest,
+ * thereby not updating the encoder data.
+ * This also implies that the BisCrc error is not triggered while in this mode.
+ * This mode is intended to allow the user to change the configuration in the encoder BiSS registers without encountering a BisCrc error.
+ *
+ * **Raw mode**: The BiSS service clocks the encoder assuming it was correctly configured for raw mode.
+ * It continues to calculate all the encoder data, but additionally, it averages the raw data and makes it available in 0x2704 User MISO, as follows:
+ *
+ * <table border="1">
+ *   <tr>
+ *     <td>31</td>
+ *     <td>30</td>
+ *     <td>29</td>
+ *     <td>28</td>
+ *     <td>27</td>
+ *     <td>26</td>
+ *     <td>25</td>
+ *     <td>24</td>
+ *     <td>23</td>
+ *     <td>22</td>
+ *     <td>21</td>
+ *     <td>20</td>
+ *     <td>19</td>
+ *     <td>18</td>
+ *     <td>17</td>
+ *     <td>16</td>
+ *     <td>15</td>
+ *     <td>14</td>
+ *     <td>13</td>
+ *     <td>12</td>
+ *     <td>11</td>
+ *     <td>10</td>
+ *     <td>9</td>
+ *     <td>8</td>
+ *     <td>7</td>
+ *     <td>6</td>
+ *     <td>5</td>
+ *     <td>4</td>
+ *     <td>3</td>
+ *     <td>2</td>
+ *     <td>1</td>
+ *     <td>0</td>
+ *   </tr>
+ *   <tr>
+ *     <td colspan="4" style="text-align: center;">0</td>
+ *     <td colspan="14" style="text-align: center;">Nonius count</td>
+ *     <td colspan="14" style="text-align: center;">Master count</td>
+ *   </tr>
+ * </table>
+ *
+ * This data can also be read by using OS command 3.
+ *
+ * **Standard mode**: The BiSS service clocks the encoder normally.
+ *
+ * When transitioning from any mode to Configuration mode, the current position is saved.
+ * If we subsequently switch to Raw mode, this saved position serves as the starting point for position calculation because the raw data is relative.
+ * Therefore, the motor should not be moved while in Configuration mode if there are plans to switch to Raw mode afterward.
+ *
+ * @param encoderOrdinal (A) 2^3=8 encoder ordinals. Counting starts from 1, so '1' refers to Encoder 1 configured in 0x2110.
+ * @param modeEnable: Select the iC-MU calibration mode. Configuration mode is 0, raw mode is 1, and standard mode is 2.
+ */
+export declare function createIcMuCalibrationModeOsCommand(encoderOrdinal?: number, modeEnable?: number): Uint8Array;
+export interface IcMuCalibrationModeOsCommandResponse extends OsCommandResponse {
+    calibrationModeSet?: boolean;
+}
+export declare function createOpenLoopFieldModeOsCommand(parameterIndex?: number, parameterValue?: number): Uint8Array;
+export declare const openLoopFieldModeParameters: {
+    parameterIndex: number;
+    parameterName: string;
+}[];
+export interface OpenLoopFieldModeOsCommandResponse extends OsCommandResponse {
+    openLoopFieldMode?: boolean;
+}
+export declare function createHrdStreamingOsCommand(action?: number, dataIndex?: number, duration?: number): Uint8Array;
+export interface HrdStreamingOsCommandResponse extends OsCommandResponse {
+    hrdStreamingComplete: true;
+}
+export declare const hrdStreamingOsCommandErrors: {
+    [key: number]: {
+        errorName: string;
+        errorDescription: string;
+    };
+};
+/**
+ * Command 4: Motor phase order detection
+ *
+ * This command is used to detect the order of the motor phases.
+ * When this command finishes successfully, the found value is automatically written to the object 0x2003:5 Motor phases inverted.
+ * This command rotates the motor.
+ *
+ * This OS command has no arguments.
+ *
+ * When the command finishes successfully, it will return a value of 0 for normal and 1 for inverted motor phases.
+ *
+ * This command doesn't have any command-specific OS error code, so this status will only happen when a general OS error code occurs.
+ *
+ * This command will report its progress without indicating a percentage.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled, there is no active limit switch,
+ * and the brake status is disengaged (in case there is a configured brake). If any of these conditions is not true during the execution of the command,
+ * the execution will stop, and it will return the OS error code 251 (command not allowed).
+ */
+export declare function createMotorPhaseOrderDetectionOsCommand(): Uint8Array;
+export interface MotorPhaseOrderDetectionOsCommandResponse extends OsCommandResponse {
+    motorPhaseOrder?: number;
+}
+/**
+ * Command 5: Commutation offset measurement
+ *
+ * This command is used to measure the commutation angle offset.
+ * The configuration of the procedure is derived from the pre-existing and previously used commutation offset objects in the object dictionary.
+ * Upon successful completion of this command, the determined value is automatically written to:
+ * - 0x2001:00 Commutation angle offset
+ * - 0x2009:01 State is set to OFFSET_VALID
+ *
+ * In version 5.0, three different methods can be selected for command 5. These methods are named:
+ * - Commutation offset measurement - method 0
+ * - Commutation offset measurement - method 1
+ * - Commutation offset measurement - method 2
+ * Among these three methods, "method 0" and "method 1" involve rotating the rotor.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS) and the CIA402 state is Operation enabled.
+ * Additionally, if the commutation offset measurement method (0x2009:3) is set to 0 or 1,
+ * the command is permissible only when there are no active limit switches, and the brake status is disengaged (in case a brake is configured).
+ * If any of these conditions is not met during the execution of the command, the execution will be halted,
+ * and it will return the OS error code 251 (Command not allowed).
+ */
+export declare function createCommutationOffsetMeasurementOsCommand(): Uint8Array;
+export interface CommutationOffsetMeasurementOsCommandResponse extends OsCommandResponse {
+    commutationAngleOffset?: number;
+}
+/**
+ * Command 6: Open phase detection
+ *
+ * This command is used to detect whether one of the phases is open.
+ * It might rotate the motor if there is no brake or if it is disengaged.
+ *
+ * If this command finishes successfully, it indicates that all motor phases seem to be fine.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
+ * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
+ * the execution will stop, and it will return the OS error code 251 (Command not allowed).
+ */
+export declare function createOpenPhaseDetectionOsCommand(): Uint8Array;
+export interface OpenPhaseDetectionOsCommandResponse extends OsCommandResponse {
+    phaseOpened?: boolean;
+}
+export declare const openPhaseDetectionErrors: {
+    [key: number]: {
+        errorName: string;
+        errorDescription: string;
+    };
+};
+/**
+ * Command 7: Pole pair detection
+ *
+ * This command is used to detect the number of pole pairs that the connected motor has.
+ * It requires the rotation of the rotor.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
+ * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
+ * the execution will stop, and it will return the OS error code 251 (Command not allowed).
+ */
+export declare function createPolePairDetectionOsCommand(): Uint8Array;
+export interface PolePairDetectionOsCommandResponse extends OsCommandResponse {
+    numberOfPolePairs?: number;
+}
+/**
+ * Command 8: Phase resistance measurement
+ *
+ * This command is used to measure the phase resistance of the motor in milliohms (mΩ).
+ * It might rotate the motor if there is no brake or if it is disengaged.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
+ * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
+ * the execution will stop, and it will return the OS error code 251 (Command not allowed).
+ */
+export declare function createPhaseResistanceMeasurementOsCommand(): Uint8Array;
+export interface PhaseResistanceMeasurementOsCommandResponse extends OsCommandResponse {
+    phaseResistance?: number;
+}
+/**
+ * Command 9: Phase inductance measurement
+ *
+ * This command is used to measure the phase inductance of the motor in microhenries (μH).
+ * It might rotate the motor if there is no brake or if it is disengaged.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
+ * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
+ * the execution will stop, and it will return the OS error code 251 (Command not allowed).
+ */
+export declare function createPhaseInductanceMeasurementOsCommand(): Uint8Array;
+export interface PhaseInductanceMeasurementOsCommandResponse extends OsCommandResponse {
+    phaseInductance?: number;
+}
+export declare function createTorqueConstantMeasurementOsCommand(): Uint8Array;
+export interface TorqueConstantMeasurementOsCommandResponse extends OsCommandResponse {
+    torqueConstant: number;
+}
+export declare function createSkippedCyclesCounterOsCommand(firmwareService?: number): Uint8Array;
+export interface SkippedCyclesCounterOsCommandResponse extends OsCommandResponse {
+    skippedCycles: number;
+}
+export declare function createIgnoreBissStatusBitsOsCommand(trigger?: number, encoderOrdinal?: number): Uint8Array;
+export interface IgnoreBissStatusBitsOsCommandResponse extends OsCommandResponse {
+    ignoringBissStatusBits: boolean;
+}
+export declare function createSystemIdentificationOsCommand(parameterIndex?: number, parameterValue?: number): Uint8Array;
+export declare const systemIdentificationParameters: {
+    parameterIndex: number;
+    parameterName: string;
+}[];
+export interface SystemIdentificationOsCommandResponse extends OsCommandResponse {
+    systemIdentificationCompleted?: boolean;
+}
+export declare function createTriggerErrorOsCommand(firmwareService?: number, errorType?: number): Uint8Array;
+export interface TriggerErrorOsCommandResponse extends OsCommandResponse {
+    errorSet: boolean;
+}
+export declare const triggerErrorTypes: {
+    value: number;
+    name: string;
+}[];
+export declare function createKublerEncoderCommand(command?: number): Uint8Array;
+export interface KublerEncoderCommandOsCommandResponse extends OsCommandResponse {
+    numberOfBytesWritten: number;
+    responseInFoeBuffer: boolean;
+}
+export declare const kublerEncoderCommandWriteCorrectionTableOsCommandErrors: {
+    [key: number]: {
+        errorName: string;
+        errorDescription: string;
+    };
+};
+export declare const kublerEncoderCommandSendScpiCommandOsCommandErrors: {
+    [key: number]: {
+        errorName: string;
+        errorDescription: string;
+    };
+};
+export declare function createUseInternalEncoderVelocityOsCommand(trigger?: number): Uint8Array;
+export interface UseInternalEncoderVelocityOsCommandResponse extends OsCommandResponse {
+    usingInternalEncoderVelocity: boolean;
+}
+export declare function createKublerEncoderRegisterCommunicationOsCommand(rw?: number, registerAddress?: number, registerLength?: number, registerWriteValue?: number): Uint8Array;
+export interface KublerEncoderRegisterCommunicationOsCommandResponse extends OsCommandResponse {
+    kublerRegisterValue: number;
+}
+export declare const kublerEncoderRegisterCommunicationReadOsCommandErrors: {
+    [key: number]: {
+        errorName: string;
+        errorDescription: string;
+    };
+};
+export declare const kublerEncoderRegisterCommunicationWriteOsCommandErrors: {
+    [key: number]: {
+        errorName: string;
+        errorDescription: string;
+    };
+};
+export declare const kublerEncoderRegisterValueMeaning: {
+    [register: string]: {
+        [value: string]: string;
+    };
+};
+export interface OsCommand {
+    id: OsCommandId;
+    name: string;
+}
+export declare const osCommands: OsCommand[];