Changes between Initial Version and Version 1 of WAM/WAMPropertiesList

May 13, 2011, 2:12:11 PM (11 years ago)



  • WAM/WAMPropertiesList

    v1 v1  
     1= WAM Properties List =
     3== Common Properties ==
     4These properties are common to both the motor encoders and the Safety Module.
     6||Property:||Definition:||Values (Units):||Read/Write:||Default:||Saved:||Notes:
     7||ADDR||Address to peek/poke||||R/W||0||No||
     8||ANA0, ANA1||Analog input values from the  on-board DAC||0 – 4095      ||R/-||None     ||No||0-3.0 V only
     9||BAUD||RS-232 serial baud rate||Bits/sec       ||R/W||9600     ||No||
     10||CMD||Execute a special command over CANbus, instead of the typical Get/Set command.|| ||-/W||None     ||No||Set CMD to the enumerated value of the desired command. Can only be used with commands that don’t take values: RESET, HOME, KEEP, PASS, LOOP, HI, IC, IO, TC, TO, C, O, T
     11||DEF||Default command for CAN||        ||-/W||None     ||No||Resets all parameters to their defaults (use SAVE to store them permanently in EEPROM)
     12||DIG0||Digital I/O, PWM-capable||-1 to 100     ||R/W||0        ||No||0-3.3 V only (no optical isolation, reverse voltage, or overvoltage protection, be careful). -1 = Input, 0 = Output low, 1 = Output high, 2-100 = PWM duty cycle of n%, Pin 41 (Pin 44 = GND)
     13||DIG1||Digital I/O||-1, 0, 1   ||R/W||0        ||No||0-3.3 V only (no optical isolation, reverse voltage, or overvoltage protection, be careful). -1 = Input, 0 = Output low, 1 = Output high, Pin 43 (Pin 44 = GND)
     14||ERROR||Reports the last error encountered by the Puck||       ||R/-||None     ||No||Not yet implemented
     15||FET0||Tensioner output (0 = Off, 1 = On)||0, 1        ||R/W||0        ||No||Pin 33 floats when FET0 = 0, it is grounded when FET0 = 1 (Pin 34 = 5V, current source)
     16||FET1||Brake output (0 = Off, 1 = On)||0, 1    ||R/W||0        ||No||Pin 31 floats when FET1 = 0, it is grounded when FET1 = 1 (Pin 32 = 5V, current source)
     17||FIND||Find command for CAN||  ||-/W||None     ||No||Used for calibration. Set FIND to the value you want to calibrate: setProperty(0, FIND, FALSE, MOFST);
     18||GRPA, GRPB, GRPC||The communication groups to which the puck belongs||0 to 31 ||R/W||None     ||Yes||A Puck can be addressed by ID, or as part of a group
     19||ID||CANbus ID||0 to 31        ||R/W||None     ||Yes||Each Puck on a CANbus must have a unique ID
     20||ILOGIC||||    ||R/-||None     ||No||
     21||IMOTOR||||    ||R/-||None     ||No||
     22||LOAD||Load a property from non-volatile memory into active puck memory via the CAN bus||      ||-/W||None     ||No||Example of use: setProperty(0,4,LOAD,FALSE,MT)
     23||LOCK||A combination lock to allow write access to locked properties|| ||-/W||None     ||No||These properties are locked: ROLE, SN, PTEMP, UPSECS, OD
     24||MODE||The control method for the motor controller||0, 2, 3, 4, 5      ||R/W||0        ||No||0 = Idle, 2 = Torque, 3 = PID, 4 = Velocity, 5 = Trapezoidal
     25||OTEMP||Over temperature limit||       ||R/W||82       ||No||MT is reduced gradually 16C before OTEMP. When TEMP >= OTEMP, MT will be zero.
     26||PTEMP||Peak temperature recorded||    ||R/W||None     ||Yes||
     27||ROLE||A value used by the firmware to determine the function of the device||  ||R/W||None     ||Yes||Bitfield: F=Feedback, R=Role: XXXX FFFF XXXX RRRR ROLE: 0 = Tater, 1 = Gimbals, 2 = Safety, 3 = Wraptor, 4 = Trigger FEEDBACK: 0 = Optical encoder, 1 = Magnetic encoder
     28||SAVE||After setting a non-volatile property, save it to non-volatile Puck™ memory||   ||-/W||None     ||No|||| setProperty(0, 4, SAVE, FALSE, MT);
     29||SG||Analog reading of the strain gage peripheral||0-4095      ||R/-||None     ||No||The 12-bit value 0-4095 corresponds to an analog reading of 0-3.0V
     30||SN||The unique manufacturing serial number for this Puck||    ||R/W|| ||Yes||
     31||STAT||0 = Reset/Monitor, 2 = Ready/Main||0, 2 ||R/W|| ||No||The Puck firmware is divided into two parts: Monitor and Main. The Puck initially boots into Monitor where there is a very limited command/property set. From here, you can download new Main firmware, or SET STAT 2 to execute the Main firmware. Setting STAT=0 forces a firmware reset, which will leave the motors free-spinning (no torque, no braking).
     32||TEMP||Puck™ temperature||     ||R/-|| ||No||The Puck temperature should not exceed  70 ˚C for extended periods.
     33||THERM||Thermistor (motor) temperature||       ||R/-|| ||No||The motor temperature should not exceed 125 ˚C for extended periods.
     34||VALUE||Value to poke/peek||   ||R/W|| ||No||Use with ADDR to read/write data from the Puck memory. || Read the TMS320F2812 DSP’s GPBDAT register; setProperty(0, 4, ADDR, FALSE, 28900); getProperty(0, 4, VALUE, &longVal);
     35||VBUS||The bus voltage on a Puck™||    ||R/-|| ||No||The standard Puck is designed for operation between 18V and 90V. However, contact Barrett Technology if operating the bus at a voltage other than 48 V.
     36||VERS||Firmware version (or the monitor version, if the Puck™ is in reset)||   ||R/W|| ||No||
     37||VLOGIC||||    ||R/-|| ||No||Not yet implemented
     38||X0, X1, X2||||        ||R/W|| ||Yes||N/A||
     39||X3, X4, X5||||        ||R/W|| ||Yes||
     40||X6, X7||||    ||R/W|| ||Yes||
     42== Motor Properties ==
     43These properties are used only by the motor controllers (not the safety module).
     44||ACCEL||||     ||R/W||2048     ||Yes||
     45||CT||32-Bit Close Target||     ||R/W||30000    ||Yes||
     46||CTS||32-Bit Counts per revolution||   ||R/W||4096     ||Yes||CTS
     47||DP||32-Bit Default Position|| ||R/W||0        ||Yes||
     48||DS||||        ||R/W||25000    ||Yes||
     49||E||32-Bit Endpoint||  ||R/W||0        ||No||
     50||ECMAX||Encoder Correction Maximum Value||     ||R/W||0        ||No||
     51||ECMIN||Encoder Correction Minimum Value||     ||R/W||0        ||No||
     52||EN||||        ||R/W|| ||No||
     53||HALLH||32-Bit Hall History Bitfield|| ||R/W||0        ||No||
     54||HALLS||Hall feedback bitfield: CBA||  ||R/W|| ||No||
     55||HOLD||Flag to hold position after move||      ||R/W||0        ||Yes||
     56||HSG||||       ||R/W||255      ||Yes||
     57||IKCOR||Current sense correction factor||      ||R/W||1638     ||Yes||
     58||IKI||Current sense integral gain||    ||R/W||3276     ||Yes||
     59||IKP||Current sense proportional gain||        ||R/W||8192     ||Yes||
     60||IOFF||32-Bit Intialization Offset||   ||R/W|| ||Yes||
     61||IOFST||Current Offset Calibration||   ||R/W|| ||Yes||
     62||IPNM||The puck torque unit to Nm (Command Current / Nm) conversion is stored here||   ||R/W||2755     ||Yes||IPNM is set at the factory. IPNM is never actually used in the pucks themselves. It is simply a non-volatile place to store the conversion constant so that the controlling PC can read it upon startup and use it to convert between puck units and SI units of torque for the end user.
     63||IVEL||||      ||R/W||20       ||Yes||
     64||JIDX||||      ||R/W|| ||Yes||
     65||KD||||        ||R/W||8000     ||Yes||
     66||KI||||        ||R/W||0        ||Yes||
     67||KP||||        ||R/W||2000     ||Yes||
     68||LCTC||||      ||R/W||1        ||No||
     69||LCVC||||      ||R/W||1        ||No||
     70||LFLAGS||||    ||R/W||0        ||No||
     71||LSG||||       ||R/W||0        ||Yes||
     72||M||32-Bit Mechanical Angle in ENCODER counts?||       ||-/W|| ||No||
     73||MCV|| In counts/ms||  ||R/W||1500     ||Yes||
     74||MDS||Max Duty Sum for Power Limiting||        ||R/W||1650     ||Yes||
     75||MECH||Mechanical encoder angle||      ||R/-|| ||No||For magnetic encoders, MECH is the raw encoder feedback, absolute within one rotation of the motor. For optical encoders, MECH is the number of encoder counts between the present location and the index pulse. (See Appendix C for details about MECH with optical encoders).
     76||MOFST||Mechanical Offset Calibration||        ||R/W|| ||Yes||Calibrated at lab. MOFST is the encoder reading at the start of an electrical cycle. (See Appendix C for details about MOFST with Optical Encoders).
     77||MOV||Counts/ms||      ||R/W||1500     ||Yes||
     78||MPE||||       ||R/W||5        ||Yes||
     79||MT||The maximum torque a Puck™ will apply, even if commanded to apply more (in milliamps).||  ||R/W||4700     ||Yes||OpenWAM() calls !InitializeSystem() (see the Doxygen documentation) which sets MT to 4731 for each puck. A value of 1024 corresponds to 1.00A of current in the motor windings. Let's say MT = 750, TL1 = 2500, TL2 = 4000. You send a T of 2800. The safety system is okay with this, it just shows the warning light on the pendant. The puck notices that abs(2800) exceeds 750, so it sets its own torque output to 750 * sign(2800).
     80||MV||Maximum Velocity in counts/millisecond||  ||R/W||1500     ||Yes||
     81||OD||||        ||R/W|| ||Yes||
     82||OT||32-Bit Open Target||      ||R/W||0        ||Yes||
     83||P||Motor position in encoder counts.||        ||R/W|| ||Yes||You can set P in a puck only when the puck's MODE = 0 (MODE = MODE_IDLE). Just be careful to set IFAULT (see Safety-Module properties section below) in the safety module before you do this, else you will likely get a velocity fault
     84||PIDX||Puck™ Index for Torque||        ||R/W|| ||Yes||
     85||POLES||Number of magnets on rotor||   ||R/W||12, 8, or 6, depending on motor type     ||Yes||
     86||T||Set the Puck™ torque (in milliamps)||      ||R/W||0        ||No||The pucks will apply the last received torque until a new torque is sent, or the MODE changes to MODE_IDLE.
     87||TENSO||||     ||R/W|| ||Yes||
     88||TENST||||     ||R/W|| ||Yes||
     89||TIE||Flag to tie inner and outer links||      ||R/W||0        ||Yes||
     90||TSTOP||Time until considered stopped||        ||R/W||1000     ||Yes||
     91||UPSECS||The total power-up time for this WAM||        ||R/W|| ||Yes||
     92||V||Velocity in counts/milliseconds||  ||R/W||0        ||No||
     94== Safety-Module Properties ==
     95The Safety Module is an additional Puck located in the base of the WAM (not attached to a motor). The Safety Module has a puck ID of 10, and is identified in the software as SAFETY_MODULE. Its job is to listen to the CANbus traffic and shut the WAM down in the event of an over-torque, over-velocity, voltage problem, or heartbeat error (missing communication from any puck or the PC). It also controls the pendant lights and switches. The properties below are only applicable to the Safety Module. All safety module properties apply to the whole arm on a global basis. For example, if the torque of ANY motor exceeds TL2, the safety system will force the arm into IDLE mode (all phase leads tied together).
     97||Property:||Definition:||Values (Units):||Read/Write:||Default:||Saved:||Notes:
     98||IFAULT||If IFAULT is greater than 0 and a fault is observed by the safety system, IFAULT is decremented by one, and the fault is ignored.||0 to 20 (typical)||0||To set the initial positions of the pucks, you must also set IFAULT (Ignore Fault) at that time to prevent the giant instantaneous position change from causing an over-velocity fault in the safety module. See the DefineWAMpos() function in the Doxygen documentation for an example.
     99||MAXPWR||||    ||||    ||||
     100||PEN||||       ||||    ||||
     101||PWR||||       ||||    ||||
     102||SAFE||||      ||||    ||||
     103||TL1, TL2||The safety system’s motor torque warning, fault levels (Puck™ torque units)||       ||||    ||||TL1 is the minimum torque that will cause a warning; TL2 is the minimum torque that will cause a fault.
     104||VL1, VL2||VL1 is the minimum velocity that will cause a warning; VL2 is the minimum velocity that will cause a fault.||(rad/s or m/s) ||||0.5, 1.0 (respectively)     ||||Before calling DefineWAMpos() (otherwise known as zeroing the WAM), VL1 and VL2 limit the angular velocity (rad/s) of every joint, and the 7-segment LED display on the pendants will show which joint exceeded the velocity limit if a velocity warning or fault occurs. After DefineWAMpos() is called, the WAM switches to limiting the Cartesian velocity (m/s) of the elbow and 4-DOF endpoint, instead of each joint’s velocity. In the event of a fault after DefineWAMpos() is called, the 7-segment LED display on the pendants will show “E” or “A” to indicate whether the Elbow or the Arm endpoint exceeded the velocity limit. The value of these limits can be changed at any time, but both limits are always applicable to the entire robot – the limits cannot be applied only to particular joints or points on the WAM.
     105If you want to set these properties directly (using setProperty()), please note that they are in Q4.12 notation, so take whatever you want the value to be and multiply it by 4096 before you set it. Q4.12 means "4 bits of integer, 12 bits of fraction". 0x1000 = 1.0, 0x1800 = 1.5, 0x7800 = 7.5. If you go much higher, you'll go negative (do not do this). See the source code for !SetSafetyLimits() in src/btwam/btwam.c for an example.
     106||VNOM||||      ||||    ||||
     107||VOLTH1, VOLTH2||The safety system’s high voltage warning, fault limit||Volts  ||||54, 57      ||||If the bus voltage exceeds VOLTH1, the safety system will begin bleeding off bus voltage through a resistor, and the pendants will display a voltage warning with the letter ‘H’. If the bus voltage exceeds VOLTH2, the safety system will disconnect the bus and clamp it, and the pendants will display a voltage fault with the letter ‘H’.
     108||VOLTL1, VOLTL2||The safety system’s low voltage warning, fault limit.||Volts  ||||36, 30      ||||If the bus voltage falls below VOLTL1, the pendants will display a voltage warning with the letter ‘L’. If the bus voltage falls below VOLTL2, the safety system will disconnect the bus and clamp it, and the pendants will display a voltage fault with the letter ‘L’.
     109||ZERO||After sending the pucks their known initial position, set the safety system's ZERO property to 1 so it can start calculating Cartesian velocities.||    ||||    ||||Use the DefineWAMpos() function in src/btwam/btwam.c to set the initial positions of the other motor controllers. This is called automatically during the normal OpenWAM() call.
     111== Key to Property Table ==