Skip to content

Commit 16bc99b

Browse files
committed
fixed documentation based on MR feedback from d-loret
1 parent fdf3740 commit 16bc99b

File tree

2 files changed

+19
-20
lines changed

2 files changed

+19
-20
lines changed

doc/fastcat_device_config_parameters.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@
44

55
For every `JSD Device` there is an `Offline Device` to emulate the behavior of the hardware.
66

7-
| Name | Manufacturer | Description |
8-
| ---------------- | ------------- | ----------------------------------- |
9-
| PlatinumActuator | Elmo | EPD with extra features |
10-
| GoldActuator | Elmo | EGD with extra features |
11-
| Egd | Elmo | Elmo Gold Drive line of controllers |
12-
| El3208 | Beckhoff | 8-channel RTD Input |
13-
| El3162 | Beckhoff | 2-channel 0-10v SE Analog Input |
14-
| El3602 | Beckhoff | 2-channel +/-10v Diff. Analog Input |
15-
| El2124 | Beckhoff | 4-channel 5v Digital Output |
16-
| El4102 | Beckhoff | 2-channel 0-10v Analog Output |
17-
| Ild1900 | Micro-Epsilon | Distance Laser Sensor |
18-
| AtiFts | ATI | Force-Torque Sensor |
19-
| JED0101 | JPL | JPL EtherCAT Device 0101 - EELS |
20-
| JED0200 | JPL | JPL EtherCAT Device 0200 - SAEL |
7+
| Name | Manufacturer | Description |
8+
| ---------------- | ------------- | ----------------------------------------- |
9+
| PlatinumActuator | Elmo | Elmo Platinum derived Actuator controller |
10+
| GoldActuator | Elmo | Elmo Gold derived Actuator controller |
11+
| Egd | Elmo | Elmo Gold Drive |
12+
| El3208 | Beckhoff | 8-channel RTD Input |
13+
| El3162 | Beckhoff | 2-channel 0-10v SE Analog Input |
14+
| El3602 | Beckhoff | 2-channel +/-10v Diff. Analog Input |
15+
| El2124 | Beckhoff | 4-channel 5v Digital Output |
16+
| El4102 | Beckhoff | 2-channel 0-10v Analog Output |
17+
| Ild1900 | Micro-Epsilon | Distance Laser Sensor |
18+
| AtiFts | ATI | Force-Torque Sensor |
19+
| JED0101 | JPL | JPL EtherCAT Device 0101 - EELS |
20+
| JED0200 | JPL | JPL EtherCAT Device 0200 - SAEL |
2121

2222
**Fastcat Devices**
2323

@@ -192,10 +192,10 @@ Engineering Units (EU) are radians for revolute actuators and meters for linear
192192
| `high_pos_cal_limit_eu` | Upper Position Limit typically corresponding to a hardstop. Used for Calibration Command |
193193
| `high_pos_cmd_limit_eu` | Highest allowable command position value |
194194
| `holding_duration_sec` | Duration to hold position after reset or after a motion command before re-engaging brakes |
195-
| `elmo_brake_engage_msec` | How long it takes to re-engage the brakes |
196-
| `elmo_brake_disengage_msec` | How long it takes to disengaged the brakes |
197-
| `elmo_crc` | CRC of the flashed Elmo parameter set |
198-
| `elmo_drive_max_current_limit` | The fixed, aximum drive current for the Elmo Drive |
195+
| `elmo_brake_engage_msec` | How long it takes to re-engage the brakes |
196+
| `elmo_brake_disengage_msec` | How long it takes to disengaged the brakes |
197+
| `elmo_crc` | CRC of the flashed Elmo parameter set |
198+
| `elmo_drive_max_current_limit` | The fixed, maximum drive current for the Elmo Drive |
199199
| `smooth_factor` | Affects controller smoothing, defaults to `0` |
200200
| `winding_resistance` | OPTIONAL: Winding resistance of motor for optional power calculation |
201201
| `torque_constant` | OPTIONAL: Torque constant of motor for optional power calculation |
@@ -265,7 +265,7 @@ This is a thin wrapper around the JSD EGD device. This does not have fastcat-sid
265265
| `motor_stuck_current_level_pct` | See Elmo docs for details on this feature, `0` disables|
266266
| `motor_stuck_velocity_threshold` | See Elmo docs for details on this feature, `0` disables|
267267
| `motor_stuck_timeout` | See Elmo docs for details on this feature |
268-
| `over_speed_threshold` | Multiplicative factor over `max_motor_speed` that triggers a fault |
268+
| `over_speed_threshold` | High motor speed used for overspeed violations in counts/sec |
269269
| `low_position_limit` | Lower position the drive can move to in position mode, in counts |
270270
| `high_position_limit` | Upper position the drive can move to in position mode, in counts|
271271
| `brake_enage_msec` | How long it takes to re-engage the brake |

src/jsd/platinum_actuator_offline.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010

1111
namespace fastcat
1212
{
13-
// ActuatorOffline simulates both GoldActuator and PlatinumActuator.
1413
class PlatinumActuatorOffline : public PlatinumActuator
1514
{
1615
public:

0 commit comments

Comments
 (0)