Get desktop application:
View/edit binary Protocol Buffers messages
Service to configure actuators
@PROXY_ID=10 @ERROR=Kinova.Api.Error
Retrieves axis offsets for absolute and relative encoder
@RPC_ID=1
Axis offsets
Absolute offset value (degrees)
Relative offset value (degrees)
Sets offsets for absolute and relative encoder Invoking this method shall invalidate arm calibration if one exists. This method is for kinova usage only.
@RPC_ID=2
Axis position
Axis position (degrees)
Reads torque calibration parameters (internal use only)
@RPC_ID=3
Writes torque calibration parameters (internal use only)
@RPC_ID=4
Sets zero torque calibration
@RPC_ID=5
Retrieves actuator control mode
@RPC_ID=6
Sets actuator control mode
@RPC_ID=7
Retrieves activated control loop(s)
@RPC_ID=8
Sets activated control loop(s)
@RPC_ID=9
Retrieves motor drive FOC parameters (internal use only)
@RPC_ID=10
Sets motor drive FOC parameters (internal use only)
@RPC_ID=11
Retrieves encoder derivative parameters (internal use only)
@RPC_ID=12
Sets encoder derivative parameters (internal use only)
@RPC_ID=13
Retrieves control loop parameters
@RPC_ID=14
Defines the loop selection
ControlLoopSelection enum
Sets control loop parameters
@RPC_ID=15
Starts frequency response test (internal use only)
@RPC_ID=16
Frequency response
ControlLoopSelection enum
Minimum frequency value
Maximum frequency value
Amplitude value
Duration (in seconds)
Stops frequency response test (internal use only)
@RPC_ID=17
Starts step response test (internal use only)
@RPC_ID=18
Step response
ControlLoopSelection enum
Amplitude value
Step delay value
Duration (in seconds)
Stops step response test (internal use only)
@RPC_ID=19
Starts ramp response test (internal use only)
@RPC_ID=20
Ramp response
ControlLoopSelection enum
Slope value
Ramp delay value
Duration (in seconds)
Stops ramp response test (internal use only)
@RPC_ID=21
Selects custom data
@RPC_ID=22
Retrieves selected custom data
@RPC_ID=23
Sets command mode (config versus cyclic)
@RPC_ID=24
Clears all error(s) and warning(s) (bank A and B)
@RPC_ID=25
Enables or disables servoing
@RPC_ID=26
Moves the actuator to the desired position
@RPC_ID=27
Angular position command for an actuator
Position value (degrees)
Velocity value (degrees per second)
Acceleration value (degrees per second^squared)
Retrieves command mode (config versus cyclic)
@RPC_ID=28
Retrieves servoing state
@RPC_ID=29
Retrieves torque offset calibration
@RPC_ID=30
Sets cogging feedforward mode
@RPC_ID=31
Retrieves cogging feedforward mode
@RPC_ID=32
Admissable cogging feedforward modes
Used in:
No cogging compensation
Cogging compensation with adaptive parameters
Cogging compensation with calibrated parameters
Cogging feedforward mode
Used as request type in: ActuatorConfig.SetCoggingFeedforwardMode
Used as response type in: ActuatorConfig.GetCoggingFeedforwardMode
Cogging feedforward mode
Admissible command modes
Used in:
Cyclic data only
Not supported
Config messages only
Smoothing using only position inputs
Smoothing using position and velocity inputs
Smoothing using position, velocity and acceleration inputs (not supported)
Command mode
Used as request type in: ActuatorConfig.SetCommandMode
Used as response type in: ActuatorConfig.GetCommandMode
Command mode
Control loop
Used as request type in: ActuatorConfig.SetActivatedControlLoop
Used as response type in: ActuatorConfig.GetActivatedControlLoop
Use ControlLoopSelection enum values to form bitmask
Control loop parameters (discrete transfer function)
Used as request type in: ActuatorConfig.SetControlLoopParameters
Used as response type in: ActuatorConfig.GetControlLoopParameters
ControlLoopSelection enum
Error saturation value
Output saturation value
KAz (index 0 to 4): denominator gains A1 to A5
KBz (index 0 to 5): numerator gains B0 to B5
Error dead band value
Admissible control loop selections
Used in:
, , , ,0x0 - Reserved (internal use only)
0x1 - Joint position control (if available)
0x2 - Motor position control
0x4 - Joint velocity control (if available)
0x8 - Motor velocity control
0x10 - Joint torque control
0x20 - Motor current control
0x30 - High velocity joint torque control
Admissible control modes
Used in:
None
Position mode
Velocity mode
Torque mode
Current mode
Custom mode
High velocity torque mode
Control mode information
Used as request type in: ActuatorConfig.SetControlMode
Used as response type in: ActuatorConfig.GetControlMode
Control mode
Custom data options
Used in:
No custom data selected
Incremental value used for test and validation
Rotor optical encoder incremental value (raw)
Joint optical encoder incremental value (raw)
Motor phase 0 temperature (degrees Celsius)
Motor phase 1 temperature (degrees Celsius)
Motor phase 2 temperature (degrees Celsius)
Individual torque sensor strain gauge 0 ADC value (raw)
Individual torque sensor strain gauge 1 ADC value (raw)
Individual torque sensor strain gauge 2 ADC value (raw)
Individual torque sensor strain gauge 3 ADC value (raw)
Individual torque sensor strain gauge 0 converted value (Newton-meters)
Individual torque sensor strain gauge 1 converted value (Newton-meters)
Individual torque sensor strain gauge 2 converted value (Newton-meters)
Individual torque sensor strain gauge 3 converted value (Newton-meters)
Rotor optical encoder incremental value at last index signal rising edge (raw)
Joint optical encoder incremental value at last index signal rising edge (raw)
Absolute position sensor integer value (raw)
Absolute position sensor converted value (degrees)
Last axis position command received via Ethernet
Jig status flags (internal use)
Rotor optical encoder incremental value corrected for counter overflow (raw)
Joint optical encoder incremental value corrected for counter overflow (raw)
Rotor optical encoder incremental value corrected for counter overflow at last index signal rising edge (raw)
Joint optical encoder incremental value corrected for counter overflow at last index signal rising edge (raw)
x-axis acceleration (meters per second squared)
y-axis acceleration (meters per second squared)
z-axis acceleration (meters per second squared)
x-axis angular velocity (degrees per second)
y-axis angular velocity (degrees per second)
z-axis angular velocity (degrees per second)
Axis position command sent to motor position control loop (degrees)
Axis velocity command sent to motor velocity control loop (degrees per second)
Actuator position measured by rotor optical encoder (degrees)
Actuator angular velocity measured by rotor optical encoder (degrees per second)
Jitter from the communication (microseconds)
Actuator torque (Newton-meters)
Motor current (Amperes)
Main board voltage (Volts)
Motor temperature (maximum of the three (3) phase temperatures) (degrees Celsius)
Microcontroller temperature (degrees Celsius)
Bank A faults (see ActuatorConfig.SafetyIdentifier)
Bank B faults (see ActuatorConfig.SafetyIdentifier)
Bank A warnings (see ActuatorConfig.SafetyIdentifier)
Bank B warnings (see ActuatorConfig.SafetyIdentifier)
Actuator position measured by motor hall sensors (degrees)
Motor phase 0 current (Amperes)
Motor phase 1 current (Amperes)
Motor phase 2 current (Amperes)
Pulse width modulation duty cycle applied to motor phase 0 (percentage)
Pulse width modulation duty cycle applied to motor phase 1 (percentage)
Pulse width modulation duty cycle applied to motor phase 2 (percentage)
Motor electrical angle (degrees)
Motor current command sent to motor drive (Amperes)
Axis torque command sent to joint torque control loop (Newton-meters)
Actuator position unwrapped (degrees)
Hall sensor 0 value (raw)
Hall sensor 1 value (raw)
Hall sensor 2 value (raw)
Hall sensor 0 scaled value (raw)
Hall sensor 1 scaled value (raw)
Hall sensor 2 scaled value (raw)
Cogging torque cancellation coefficient A0 (Amperes)
Cogging torque cancellation coefficient A1 (Amperes)
Cogging torque cancellation coefficient A2 (Amperes)
Cogging torque cancellation coefficient A3 (Amperes)
Cogging torque cancellation coefficient A4 (Amperes)
Cogging torque cancellation coefficient A5 (Amperes)
Cogging torque cancellation coefficient A6 (Amperes)
Cogging torque cancellation coefficient A7 (Amperes)
Cogging torque cancellation coefficient A8 (Amperes)
Cogging torque cancellation coefficient A9 (Amperes)
Cogging torque cancellation coefficient A10 (Amperes)
Cogging torque cancellation coefficient A11 (Amperes)
Cogging torque cancellation coefficient A12 (Amperes)
Cogging torque cancellation coefficient A13 (Amperes)
Cogging torque cancellation coefficient A14 (Amperes)
Cogging torque cancellation coefficient A15 (Amperes)
Cogging torque cancellation coefficient B0 (Amperes)
Cogging torque cancellation coefficient B1 (Amperes)
Cogging torque cancellation coefficient B2 (Amperes)
Cogging torque cancellation coefficient B3 (Amperes)
Cogging torque cancellation coefficient B4 (Amperes)
Cogging torque cancellation coefficient B5 (Amperes)
Cogging torque cancellation coefficient B6 (Amperes)
Cogging torque cancellation coefficient B7 (Amperes)
Cogging torque cancellation coefficient B8 (Amperes)
Cogging torque cancellation coefficient B9 (Amperes)
Cogging torque cancellation coefficient B10 (Amperes)
Cogging torque cancellation coefficient B11 (Amperes)
Cogging torque cancellation coefficient B12 (Amperes)
Cogging torque cancellation coefficient B13 (Amperes)
Cogging torque cancellation coefficient B14 (Amperes)
Cogging torque cancellation coefficient B15 (Amperes)
Commanded cogging cancellation feedforward current sent to motor drive (Amperes)
Selected custom data channels content
Used as request type in: ActuatorConfig.SelectCustomData
Used as response type in: ActuatorConfig.GetSelectedCustomData
16 channels maximum
Variable window derivative parameters
Used as request type in: ActuatorConfig.SetEncoderDerivativeParameters
Used as response type in: ActuatorConfig.GetEncoderDerivativeParameters
Maximum window width
Minimum angle for derivative (degrees)
Admissible bank A actuator safeties
0x0 - Unspecified actuator safety
0x1 - Following error
0x2 - Maximum velocity
0x4 - Joint position limit high
0x8 - Joint position limit low
0x10 - Strain gauge mismatch
0x20 - Maximum torque
0x40 - Unreliable absolute position
0x80 - Magnetic position
0x100 - Hall position
0x200 - Hall sequence
0x400 - Input encoder Hall mismatch
0x800 - Input encoder index mismatch
0x1000 - Input encoder magnetic mismatch
0x2000 - Maximum motor current
0x4000 - Motor current mismatch
0x8000 - Maximum voltage
0x10000 - Minimum voltage
0x20000 - Maximum motor temperature
0x40000 - Maximum core temperature
0x80000 - Non-volatile memory corrupted
0x100000 - Motor driver fault
0x200000 - Emergency line asserted
0x400000 - Communication tick lost
0x800000 - Watchdog triggered
0x1000000 - Capacitive sensor is unreliable
0x2000000 - Incorrect gear ratio for detected configuration
0x4000000 - Position mismatch between hall and magnetic sensors
0x8000000 - Brake driver fault
0x10000000 - Brake release motion goes out of allowed range
Admissible limit types
Maximal limit
Minimal limit
Identifies ActuatorConfig service current version
Reserved
Current version
Enables/disables servoing
Used as request type in: ActuatorConfig.SetServoing
Used as response type in: ActuatorConfig.GetServoing
Servoing enabled
Torque calibration settings
Used as request type in: ActuatorConfig.WriteTorqueCalibration
Used as response type in: ActuatorConfig.ReadTorqueCalibration
Global gain value
Global offset value
Gain (index 0 to 3)
Offset (index 0 to 3)
Defines torque offset
Used as request type in: ActuatorConfig.SetTorqueOffset
Used as response type in: ActuatorConfig.GetTorqueOffset
Torque offset value
Field-oriented control PI controller gain values
Used as request type in: ActuatorConfig.SetVectorDriveParameters
Used as response type in: ActuatorConfig.GetVectorDriveParameters
Quadrature axis current proportional gain
Quadrature axis current integral gain
Direct axis current proportional gain
Direct axis current integral gain