index.md

Kortex Api Reference

• ActuatorConfig (Python)
  • class AxisOffsets
  • class AxisPosition
  • class CoggingFeedforwardModeInformation
  • class CommandModeInformation
  • class ControlLoop
  • class ControlLoopParameters
  • class ControlModeInformation
  • class CustomDataSelection
  • class EncoderDerivativeParameters
  • class FrequencyResponse
  • class LoopSelection
  • class PositionCommand
  • class RampResponse
  • class Servoing
  • class StepResponse
  • class TorqueCalibration
  • class TorqueOffset
  • class VectorDriveParameters
  • Enum CoggingFeedforwardMode
  • Enum CommandMode
  • Enum ControlLoopSelection
  • Enum ControlMode
  • Enum CustomDataIndex
  • Enum SafetyIdentifierBankA
  • Enum SafetyLimitType
  • Enum ServiceVersion
• ActuatorCyclic (Python)
  • class Command
  • class CustomData
  • class Feedback
  • class MessageId
  • Enum CommandFlags
  • Enum ServiceVersion
  • Enum StatusFlags
• Api (Python)
  • Enum ErrorCodes
  • Enum SubErrorCodes
• Base (Python)
  • class Action
  • class ActionExecutionState
  • class ActionHandle
  • class ActionList
  • class ActionNotification
  • class ActionNotificationList
  • class ActivateMapHandle
  • class ActuatorInformation
  • class Admittance
  • class AdvancedSequenceHandle
  • class AngularWaypoint
  • class AppendActionInformation
  • class ArmStateInformation
  • class ArmStateNotification
  • class BluetoothEnableState
  • class BridgeConfig
  • class BridgeIdentifier
  • class BridgeList
  • class BridgePortConfig
  • class BridgeResult
  • class CapSenseConfig
  • class CartesianLimitation
  • class CartesianLimitationList
  • class CartesianSpeed
  • class CartesianTrajectoryConstraint
  • class CartesianWaypoint
  • class ChangeJointSpeeds
  • class ChangeTwist
  • class ChangeWrench
  • class CommunicationInterfaceConfiguration
  • class ConfigurationChangeNotification
  • class ConfigurationChangeNotificationList
  • class ConstrainedJointAngle
  • class ConstrainedJointAngles
  • class ConstrainedOrientation
  • class ConstrainedPose
  • class ConstrainedPosition
  • class ControlModeInformation
  • class ControlModeNotification
  • class ControlModeNotificationList
  • class ControllerConfiguration
  • class ControllerConfigurationList
  • class ControllerConfigurationMode
  • class ControllerElementHandle
  • class ControllerElementState
  • class ControllerEvent
  • class ControllerHandle
  • class ControllerList
  • class ControllerNotification
  • class ControllerNotificationList
  • class ControllerState
  • class Delay
  • class EmergencyStop
  • class FactoryNotification
  • class Faults
  • class Finger
  • class FirmwareBundleVersions
  • class FirmwareComponentVersion
  • class FullIPv4Configuration
  • class FullUserProfile
  • class GpioCommand
  • class GpioConfiguration
  • class GpioConfigurationList
  • class GpioEvent
  • class GpioPinConfiguration
  • class Gripper
  • class GripperCommand
  • class GripperRequest
  • class IKData
  • class IPv4Configuration
  • class IPv4Information
  • class JointAngle
  • class JointAngles
  • class JointLimitation
  • class JointSpeed
  • class JointSpeeds
  • class JointTorque
  • class JointTorques
  • class JointTrajectoryConstraint
  • class JointsLimitationsList
  • class KinematicTrajectoryConstraints
  • class Map
  • class MapElement
  • class MapEvent
  • class MapGroup
  • class MapGroupHandle
  • class MapGroupList
  • class MapHandle
  • class MapList
  • class Mapping
  • class MappingHandle
  • class MappingInfoNotification
  • class MappingInfoNotificationList
  • class MappingList
  • class NetworkHandle
  • class NetworkNotification
  • class NetworkNotificationList
  • class OperatingModeInformation
  • class OperatingModeNotification
  • class OperatingModeNotificationList
  • class Orientation
  • class PasswordChange
  • class Point
  • class Pose
  • class Position
  • class PreComputedJointTrajectory
  • class PreComputedJointTrajectoryElement
  • class ProtectionZone
  • class ProtectionZoneHandle
  • class ProtectionZoneInformation
  • class ProtectionZoneList
  • class ProtectionZoneNotification
  • class ProtectionZoneNotificationList
  • class Query
  • class RFConfiguration
  • class RequestedActionType
  • class RobotEventNotification
  • class RobotEventNotificationList
  • class RotationMatrix
  • class RotationMatrixRow
  • class SafetyEvent
  • class SafetyNotificationList
  • class Sequence
  • class SequenceHandle
  • class SequenceInfoNotification
  • class SequenceInfoNotificationList
  • class SequenceInformation
  • class SequenceList
  • class SequenceTask
  • class SequenceTaskConfiguration
  • class SequenceTaskHandle
  • class SequenceTasks
  • class SequenceTasksConfiguration
  • class SequenceTasksPair
  • class SequenceTasksRange
  • class ServoingModeInformation
  • class ServoingModeNotification
  • class ServoingModeNotificationList
  • class Snapshot
  • class Ssid
  • class Stop
  • class SwitchControlMapping
  • class SystemTime
  • class Timeout
  • class TrajectoryErrorElement
  • class TrajectoryErrorReport
  • class TrajectoryInfo
  • class TransformationMatrix
  • class TransformationRow
  • class Twist
  • class TwistCommand
  • class TwistLimitation
  • class UserList
  • class UserNotification
  • class UserNotificationList
  • class UserProfile
  • class UserProfileList
  • class Waypoint
  • class WaypointList
  • class WaypointValidationReport
  • class WifiConfiguration
  • class WifiConfigurationList
  • class WifiEnableState
  • class WifiInformation
  • class WifiInformationList
  • class Wrench
  • class WrenchCommand
  • class WrenchLimitation
  • class ZoneShape
  • Enum ActionEvent
  • Enum ActionType
  • Enum AdmittanceMode
  • Enum BackupEvent
  • Enum BridgeStatus
  • Enum BridgeType
  • Enum CapSenseMode
  • Enum ConfigurationNotificationEvent
  • Enum ControlMode
  • Enum ControllerBehavior
  • Enum ControllerElementEventType
  • Enum ControllerEventType
  • Enum ControllerInputType
  • Enum ControllerType
  • Enum EventIdSequenceInfoNotification
  • Enum FactoryEvent
  • Enum Gen3GpioPinId
  • Enum GpioAction
  • Enum GpioBehavior
  • Enum GpioPinPropertyFlags
  • Enum GripperMode
  • Enum JointNavigationDirection
  • Enum JointTrajectoryConstraintType
  • Enum LedState
  • Enum LimitationType
  • Enum NavigationDirection
  • Enum NetworkEvent
  • Enum NetworkType
  • Enum OperatingMode
  • Enum ProtectionZoneEvent
  • Enum RobotEvent
  • Enum SafetyIdentifier
  • Enum ServiceVersion
  • Enum ServoingMode
  • Enum ShapeType
  • Enum SignalQuality
  • Enum SnapshotType
  • Enum SoundType
  • Enum TrajectoryContinuityMode
  • Enum TrajectoryErrorIdentifier
  • Enum TrajectoryErrorType
  • Enum TrajectoryInfoType
  • Enum UserEvent
  • Enum WifiEncryptionType
  • Enum WifiSecurityType
  • Enum WrenchMode
  • Enum WristDigitalInputIdentifier
  • Enum Xbox360AnalogInputIdentifier
  • Enum Xbox360DigitalInputIdentifier
• BaseCyclic (Python)
  • class ActuatorCommand
  • class ActuatorCustomData
  • class ActuatorFeedback
  • class BaseFeedback
  • class Command
  • class CustomData
  • class Feedback
  • Enum ServiceVersion
• Common (Python)
  • class Connection
  • class CountryCode
  • class DeviceHandle
  • class Empty
  • class NotificationHandle
  • class NotificationOptions
  • class SafetyHandle
  • class SafetyNotification
  • class Timestamp
  • class UARTConfiguration
  • class UARTDeviceIdentification
  • class UserProfileHandle
  • Enum ArmState
  • Enum CartesianReferenceFrame
  • Enum CountryCodeIdentifier
  • Enum DeviceTypes
  • Enum NotificationType
  • Enum Permission
  • Enum SafetyStatusValue
  • Enum UARTParity
  • Enum UARTSpeed
  • Enum UARTStopBits
  • Enum UARTWordLength
  • Enum Unit
• ControlConfig (Python)
  • class AngularTwist
  • class CartesianReferenceFrameInfo
  • class CartesianTransform
  • class ControlConfigurationNotification
  • class ControlModeInformation
  • class ControlModeNotification
  • class DesiredSpeeds
  • class GravityVector
  • class JointAccelerationSoftLimits
  • class JointSpeedSoftLimits
  • class JointSpeeds
  • class KinematicLimits
  • class KinematicLimitsList
  • class LinearTwist
  • class PayloadInformation
  • class Position
  • class ToolConfiguration
  • class TwistAngularSoftLimit
  • class TwistLinearSoftLimit
  • Enum ControlConfigurationEvent
  • Enum ControlMode
  • Enum ServiceVersion
• DeviceConfig (Python)
  • class BootloaderVersion
  • class Calibration
  • class CalibrationElement
  • class CalibrationParameter
  • class CalibrationResult
  • class CapSenseConfig
  • class CapSenseRegister
  • class DeviceType
  • class FirmwareVersion
  • class IPv4Settings
  • class MACAddress
  • class ModelNumber
  • class PartNumber
  • class PartNumberRevision
  • class PowerOnSelfTestResult
  • class RebootRqst
  • class RunMode
  • class SafetyConfiguration
  • class SafetyConfigurationList
  • class SafetyEnable
  • class SafetyInformation
  • class SafetyInformationList
  • class SafetyStatus
  • class SafetyThreshold
  • class SerialNumber
  • Enum CalibrationItem
  • Enum CalibrationStatus
  • Enum CapSenseMode
  • Enum RunModes
  • Enum SafetyLimitType
  • Enum ServiceVersion
• DeviceManager (Python)
  • class DeviceHandles
  • Enum ServiceVersion
• GripperConfig (Python)
  • Enum RobotiqGripperStatusFlags
  • Enum SafetyIdentifier
• GripperCyclic (Python)
  • class Command
  • class CustomData
  • class CustomDataUnit
  • class Feedback
  • class MessageId
  • class MotorCommand
  • class MotorFeedback
  • Enum ServiceVersion
• InterconnectConfig (Python)
  • class EthernetConfiguration
  • class EthernetDeviceIdentification
  • class GPIOConfiguration
  • class GPIOIdentification
  • class GPIOState
  • class I2CConfiguration
  • class I2CData
  • class I2CDeviceIdentification
  • class I2CReadParameter
  • class I2CReadRegisterParameter
  • class I2CWriteParameter
  • class I2CWriteRegisterParameter
  • Enum EthernetDevice
  • Enum EthernetDuplex
  • Enum EthernetSpeed
  • Enum GPIOIdentifier
  • Enum GPIOMode
  • Enum GPIOPull
  • Enum GPIOValue
  • Enum I2CDevice
  • Enum I2CDeviceAddressing
  • Enum I2CMode
  • Enum I2CRegisterAddressSize
  • Enum SafetyIdentifier
  • Enum ServiceVersion
  • Enum UARTPortId
• InterconnectCyclic (Python)
  • class Command
  • class CustomData
  • class Feedback
  • class MessageId
  • Enum ServiceVersion
• ProductConfiguration (Python)
  • class CompleteProductConfiguration
  • class ProductConfigurationEndEffectorType
  • Enum ArmLaterality
  • Enum BaseType
  • Enum BrakeType
  • Enum EndEffectorType
  • Enum InterfaceModuleType
  • Enum ModelId
  • Enum VisionModuleType
  • Enum WristType
• Session (Python)
  • class ConnectionList
  • class CreateSessionInfo
  • Enum ServiceVersion
• VisionConfig (Python)
  • class DistortionCoefficients
  • class ExtrinsicParameters
  • class FocusPoint
  • class IntrinsicParameters
  • class IntrinsicProfileIdentifier
  • class ManualFocus
  • class OptionIdentifier
  • class OptionInformation
  • class OptionValue
  • class RotationMatrix
  • class RotationMatrixRow
  • class SensorFocusAction
  • class SensorIdentifier
  • class SensorSettings
  • class TranslationVector
  • class VisionNotification
  • Enum BitRate
  • Enum FocusAction
  • Enum FrameRate
  • Enum Option
  • Enum Resolution
  • Enum Sensor
  • Enum ServiceVersion
  • Enum VisionEvent