Data Structures

Here are the data structures with brief descriptions:
ActivateOvervoltageProtectionEnable overvoltage protection
ActualAccelerationThe current acceleration (read only)
ActualCommutationOffsetThis value represents the internal commutation offset
ActualLoadValueReadout of the actual load value with used for stall detection (stallGuard2)
ActualModuleSupplyCurrentGet actual supply current of the module
ActualMotorDriverTemperatureActual temperature of the motor driver
ActualMotorVoltageActual supply voltage
ActualPositionActual position of one gripper bar
ActualVelocityActual velocity of one gripper bar
ApproveProtectedParametersEnter a password to approve the change of protected parameters
BarSpacingOffsetRepresents a bar spacing offset
BaseKinematicAbstract class of a base / platform kinematic
BEMFConstantBEMF constant of motor
CalibrateGripperCalibrate the gripper
CalibrateJointCalibrates the joint
ChopperBlankTimeSelects the comparator blank time
ChopperHysteresisDecrementHysteresis decrement setting
ChopperHysteresisEndHysteresis end setting
ChopperHysteresisStartHysteresis start setting
ChopperModeSelection of the chopper mode: 0 spread cycle 1 classic const
ChopperOffTimeThe off time setting controls the minimum chopper frequency
ClearI2tExceededFlagClear the flag that indicates that the I2t sum has exceeded the I2t limit
ClearMotorControllerTimeoutFlagClear the flag that indicates a communication timeout between the EtherCAT master and the controller
CommutationModeThe Commutation Mode
CommutationMotorCurrentMotor current for controlled commutation
ConfigFileReads and writes a configuration file
CurrentControlLoopDelayDelay of current limitation algorithm / PID current regulator
CurrentErrorActual error of current PID regulator
CurrentErrorSumSum of errors of current PID regulator
DataObjectLockFree< T >This DataObject is a Lock-Free implementation, such that reads and writes can happen concurrently without priority inversions
DataTraceCreates a trace of all process data and reads all configuration parameter from one joint
DoubleStepEnableEvery edge of the cycle releases a step/microstep
DParameterCurrentControlD-Parameter of PID current regulator
DParameterFirstParametersPositionControlD-Parameter of PID position regulator (first position parameter set)
DParameterFirstParametersSpeedControlD-Parameter of PID velocity regulator
DParameterSecondParametersPositionControlD-Parameter of PID position regulator (second position parameter set)
DParameterSecondParametersSpeedControlD-Parameter of PID velocity regulator (second position parameter set)
DParameterTrajectoryControlD-Parameter of PID trajectory regulator
ec_ALstatuscodelist_tAL status code list type definition
ec_configlist_tSlave configuration structure
ec_eepromFMMUtSII FMMU structure
ec_eepromPDOtRecord to store rxPDO and txPDO table from eeprom
ec_eepromSMtSII SM structure
ec_emcytEmergency request structure
ec_eringtRingbuf for error storage
ec_errortStruct to retrieve errors
ec_grouptFor list of ethercat slave groups
ec_idxstackTStack structure to store segmented LRD/LWR/LRW constructs
ec_ODlistt
ec_OElistt
ec_sdoerrorlist_tSDO error list type definition
ec_slavetFor list of ethercat slaves detected
ec_soeerrorlist_tSoE error list type definition
ec_stackTPointer structure to Tx and Rx stacks
EncoderResolutionEncoder Steps per Rotation
EncoderStopSwitchEncoder stop switch
EncoderTicksPerRoundResolution of the encoders, it is needed for the calculations of the youBot Driver
ErrorAndStatusError and Status flags of the joint
ErrorFlagsBit 0: stallGuardTM status (1: threshold reached) Bit 1: Overtemperature (1: driver is shut down due to overtemperature) Bit 2: Pre-warning overtemperature (1: Threshold is exceeded) Bit 3: Short to ground A (1: Short condition etected, driver currently shut down) Bit 4: Short to ground B (1: Short condition detected, driver currently shut down) Bit 5: Open load A (1: no chopper event has happened during the last period with constant coil polarity) Bit 6: Open load B (1: no chopper event has happened during the last period with constant coil polarity) Bit 7: Stand still (1: No step impulse occurred on the step input during the last 2^20 clock cycles)
EtherCATConnectionExceptionEtherCAT Connection Error
EthercatMasterThe Ethercat Master factory
EthercatMasterInterfaceThe Ethercat Master interface
EthercatMasterWithoutThreadThe Ethercat Master is managing the whole ethercat communication It have to be a singleton in the system
EthercatMasterWithThreadThe Ethercat Master is managing the whole ethercat communication It have to be a singleton in the system
FileNotFoundExceptionFile not found exception
FirmwareVersionFirmware version of the joint
FourSwedishWheelOmniBaseKinematicImplementation of a base kinematic with four swedish wheels
FourSwedishWheelOmniBaseKinematicConfigurationConfiguration for the base kinematic with four swedish wheels
FreewheelingTime after which the power to the motor will be cut when its velocity has reached zero
GearRatioGear ratio which is needed for the calculations in the youBot driver
GripperAbstract gripper
GripperBarEncoderSetpointThe encoder setpoint for one bar
GripperBarNameThe name for a gripper bar or finger
GripperBarPositionSetPointThe bar position for a one gripper bar
GripperBarSpacingSetPointSetpoint length of the bar spacing for a one DOF gripper
GripperDataAbstract class of gripper data
GripperDataTraceCreates a trace of one parameter of the gripper
GripperFirmwareVersionFirmware version of the gripper
GripperParameterAbstract gripper parameter
GripperSensedBarPositionThe sensed bar position for a one gripper bar
GripperSensedBarSpacingThe sensed bar spacing for a one DOF gripper
GripperSensedVelocityThe sensed bar velocity for a one DOF gripper
HallSensorPolarityReversalHall sensor invert
I2tExceedCounterCounts how often an I2t sum was higher than the I2t limit
I2tLimitAn actual I2t sum that exceeds this limit leads to increasing the I2t exceed counter
I2tSumActual sum of the I2t monitor
IClippingParameterCurrentControlI-Clipping Parameter of PID current regulator
IClippingParameterFirstParametersPositionControlAdjust in standstill to lowest possible value at which the motor keeps its position
IClippingParameterFirstParametersSpeedControlThis PID parameter set is used at lower velocity
IClippingParameterSecondParametersPositionControlAdjust in standstill to lowest possible value at which the motor keeps its position
IClippingParameterSecondParametersSpeedControlI-Clipping Parameter of PID current regulator
IClippingParameterTrajectoryControlGives a limit for the I sum part of the trajectory regulator
InitializationModeInitialization Mode
InitializeJointInitialize Joint
InitSineDelayDuration for sine initialization sequence
InverseMovementDirectionInverse the joint movement direction
IParameterCurrentControlI-Parameter of PID current regulator
IParameterFirstParametersPositionControlI-Parameter of PID position regulator (first position parameter set)
IParameterFirstParametersSpeedControlI-Parameter of PID velocity regulator
IParameterSecondParametersPositionControlI-Parameter of PID position regulator (second position parameter set)
IParameterSecondParametersSpeedControlI-Parameter of PID velocity regulator (second position parameter set)
IParameterTrajectoryControlI-Parameter of PID trajectory regulator
JointAbstract joint
JointAngleSetpointSet-point angle / position of the joint
JointComputedDataAbstract data class for computed joint data
JointComputedSetpointAbstract data class for computed joint data setpoints
JointControllerComputedDataAbstract data class for data which have been computed by the hardware controller
JointCurrentSetpointSet-point current of the joint
JointDataAbstract data class for joints
JointDataSetpointAbstract data class for commanded joint data
JointEncoderSetpointEncoder ticks setpoint of the joint
JointErrorExceptionJoint error exception
JointLimitMonitorIt monitors the joint position and will decelerate and stop the joint if it is close the limits
JointLimitsJoint position limits in encoder ticks
JointLimitsRadianJoint position limits in radian
JointNameName of the joint
JointParameterAbstract joint parameter
JointParameterExceptionJoint parameter exception
JointPWMSetpointPulse-width modulation set-point of the joint
JointRampGeneratorVelocitySensed velocity of the joint
JointRoundsPerMinuteSetpointRounds per minute set-point of the joint
JointSensedAngleSensed position / angle of the joint
JointSensedCurrentSensed electric current of the joint
JointSensedDataAbstract data class for sensed / measured joint data
JointSensedEncoderTicksSensed encoder ticks of the joint
JointSensedPWMActual pwm value of the joint
JointSensedRoundsPerMinuteSensed rounds per minute (rpm) of the joint
JointSensedTorqueThis torque of the joint is computed from the actual current
JointSensedVelocitySensed velocity of the joint
JointTorqueSetpointThe torque set-point of the joint will be set by setting the computed current set-point
JointTrajectoryJoint Trajectory representation
JointTrajectoryControllerJoint Trajectory Controller
JointVelocitySetpointSet-point velocity of the joint
KeyNotFoundExceptionKey in configuration file not found exception
LoggerImplementation logging to console and to a file
mailboxInputBufferInput part from the EtherCAT mailbox message of the youBot slaves
mailboxOutputBufferOutput part from the EtherCAT mailbox message of the youBot slaves
MassInertiaConstantMass inertia constant for position regulation
MaxEncoderValueThe encoder value when the gripper has reached it's maximum bar spacing position
MaximumAccelerationAcceleration parameter for velocity control and position control
MaximumCurrentThe most important motor setting, since too high values might cause motor damage! The maximum value is 255
MaximumMotorCurrentMaximum allowed current
MaximumPositioningSpeedThe limit for acceleration (and deceleration)
MaximumPositioningVelocityThe maximum velocity used for move to position command when executing a ramp to a position
MaximumVelocityToSetPositionMaximum velocity at which end position can be set
MaxTravelDistanceThe maximum bar spacing distance of the gripper
MicrostepResolution0: full step 1: half step 2: 4 microsteps 3: 8 microsteps 4: 16 microsteps 5: 32 microsteps 6: 64 microsteps 7: 128 microsteps 8: 256 microsteps
MinimumSpeedShould always be set 1 to ensure exact reaching of the target position
MotorAccelerationAcceleration parameter for velocity control and position control
MotorCoilResistanceResistance of motor coil
MotorControllerTimeoutSet/Get Timeout to determine an interrupted communication with the EtherCAT master
MotorHaltedVelocityIf the actual speed is below this value the motor halted flag will be set
MotorPolesNumber of motor poles
OneDOFGripperAbstract gripper with one degree of freedom
OneDOFGripperDataAbstract class of data for gripper with one degree of freedom
OperationalTimeCounts the module operational time
oro__xchg_dummy
oro_atomic_tStructure that contains an int for atomic operations
PACKEDSDO structure, not to be confused with EcSDOserviceT
ParameterAbstract parameter
PidControllerA basic pid class
PIDControlTimePID calculation delay: Set operational frequency PID
PositionControlSwitchingThresholdSwitching threshold for position control between the first and second set of parameters
PositionErrorActual error of PID position regulator
PositionErrorSumSums of errors of PID position regulator
PositionSetpointPosition setpoint for one gripper bar
PositionTargetReachedDistanceMaximum distance at which the position end flag is set
PowerDownDelayStandstill period before the current is changed down to standby current
PParameterCurrentControlP-Parameter of PID current regulator
PParameterFirstParametersPositionControlP-Parameter of PID position regulator (first position parameter set)
PParameterFirstParametersSpeedControlP-Parameter of PID velocity regulator
PParameterSecondParametersPositionControlP-Parameter of PID position regulator (second position parameter set)
PParameterSecondParametersSpeedControlP-Parameter of PID velocity regulator (second position parameter set)
PParameterTrajectoryControlP-Parameter of PID trajectory regulator
PulseDivisorThe exponent of the scaling factor for the pulse (step) generator should be de/incremented carefully (in steps of one)
RampDivisorThe exponent of the scaling factor for the ramp generator- should be de/incremented carefully (in steps of one)
RampGeneratorSpeedThe actual speed of the velocity ramp used for positioning and velocity mode
RampGeneratorSpeedAndPositionControlSwitches the ramp generator for speed and position control on and off
RampModeAutomatically set when using ROR, ROL, MST and MVP
ReversingEncoderDirectionEncoder direction Set this flag in a way, that turn right increases position counter
SegmentJoint trajectory segment
SetEncoderCounterZeroAtNextNChannelSet Encoder counter to zero at next N channel event
SetEncoderCounterZeroAtNextSwitchSet encoder counter to zero at next switch event
SetEncoderCounterZeroOnlyOnce1: Set encoder counter zero only once NULL 0: always at an N channel event, respectively switch event
ShortDetectionTimer0: 3.2 s 1: 1.6 s 2: 1.2 s 3: 0.8 s Use default value!
ShortProtectionDisable0: Short to GND protection is on 1: Short to GND protection is disabled Use default value!
SineInitializationVelocityVelocity for sine initialization
SlaveMessageInputInput part from the EtherCat message of the youBot EtherCat slaves
SlaveMessageOutputOutput part from the EtherCat message of the youBot EtherCat slaves
SlopeControlHighSideDetermines the slope of the motor driver outputs
SlopeControlLowSideDetermines the slope of the motor driver outputs
SmartEnergyActualCurrentThis status value provides the actual motor current setting as controlled by coolStepTM
SmartEnergyCurrentDownStepSets the number of stallGuard2 readings current down above the upper threshold necessary for each step current decrement of the motor current
SmartEnergyCurrentMinimumSets the lower motor current limit for current minimum coolStep operation by scaling the CS (Current Scale, see axis parameter 6) value
SmartEnergyCurrentUpStepSets the current increment step
SmartEnergyHysteresisSets the distance between the lower and the upper threshold for stallGuard2TM reading
SmartEnergyHysteresisStartThe lower threshold for the stallGuard2 value (see smart Energy current up step)
SmartEnergySlowRunCurrentSets the motor current which is used below the threshold speed
SmartEnergyThresholdSpeedAbove this speed coolStep becomes enabled
SortTreeVectorKeep track of sortorder from original configfile
SpeedControlSwitchingThresholdAdjusts the limit to switch between first velocity PID parameter set and second velocity PID parameter set
SplineSpline for a joint trajectory coef[0] + coef[1]*t +
StallGuard2FilterEnableEnables the stallGuard2 filter for more precision of the measurement
StallGuard2ThresholdThis signed value controls stallGuard2 threshold level for stall output and sets the optimum measurement range for readout
StandbyCurrentThe current limit two seconds after the motor has stopped
StepInterpolationEnableStep interpolation is supported with a 16 microstep setting only
StopOnStallMotor stop in case of stall
StopSwitchPolarityStop switch polarity
TargetPositionReachedIndicates that the actual position equals the target position
ThermalWindingTimeConstantThermal winding time constant for the used motor
TorqueConstantResolution of the encoders, it is needed for the calculations of the youBot Driver
TrajectorySegmentJoint Trajectory Segment
VelocityErrorActual error of PID velocity regulator
VelocityErrorSumSums of Errors of PID velocity regulator
VelocitySetpointVelocity setpoint for one gripper bar
VelocityThresholdForHallFXVelocity to switch from controlled to hallFX mode
VsenseSense resistor voltage based current scaling 0: Full scale sense resistor voltage is 1/18 VDD 1: Full scale sense resistor voltage is 1/36 VDD (refers to a current setting of 31 and DAC value 255) Use default value
WheeledBaseKinematicAbstract class of a wheeled based / platform kinematic
YouBotApiJointParameterAbstract youBot API joint parameter
YouBotArmTestA unit test for the youBot arm
YouBotArmTestWithoutThreadA unit test for the youBot arm
YouBotBaseIt groups the base joints together
YouBotBaseKinematicsTestA unit test for the base kinematics
YouBotBaseTestA unit test for the youBot base
YouBotBaseTestWithoutThreadA unit test for one youbot joint communicating without a thread
YouBotGripperThe youBot gripper with one degree of freedom
YouBotGripperBarOne bar of the youBot gripper
YouBotGripperParameterAbstract youBot gripper parameter
YouBotGripperTestA unit test for the youBot gripper
YouBotJointYouBot joint for the base and the manipulator
YouBotJointParameterAbstract youBot joint parameter
YouBotJointParameterPasswordProtectedAbstract youBot joint parameter
YouBotJointParameterReadOnlyAbstract youBot joint parameter which can be read only
YouBotJointStorageStores YouBotJoint informations which are needed in the driver
YouBotManipulatorIt groups the manipulator joints and the gripper together
YouBotSlaveMailboxMsgEtherCAT mailbox message of the youBot slaves
YouBotSlaveMailboxMsgThreadSafeEtherCAT mailbox message of the youBot slaves (thread safe)
YouBotSlaveMsgEtherCat message of the youBot EtherCat slaves
YouBotSlaveMsgThreadSafeEtherCat message of the youBot EtherCat slaves which is thread safe
Generated by  doxygen 1.6.3