Skip to content

Commit a21753e

Browse files
committed
Rename solo to elmo in profile utilities
1 parent 2713ca9 commit a21753e

5 files changed

Lines changed: 21 additions & 21 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To learn more about fastcat, checkout the following documents:
88

99
- [Fastcat Primer](doc/fastcat_primer.md)
1010
- [Complete list of Fastcat Device Configuration YAML Parameters](doc/fastcat_device_config_parameters.md)
11-
- [Command-line Utilities](doc/utilities.md)`jsd_slaveinfo`, `solo_vel_profile`, `solo_pos_profile`
11+
- [Command-line Utilities](doc/utilities.md)`jsd_slaveinfo`, `elmo_vel_profile`, `elmo_pos_profile`
1212
- 2021 Aeroconf paper submission `Fastcat: An Open-Source Library for Composable
1313
EtherCAT Control Systems`
1414
- README for build details
@@ -60,19 +60,19 @@ $ make
6060

6161
### Network Port Access for EtherCAT
6262

63-
The shipped utilities (`jsd_slaveinfo`, `solo_vel_profile`, `solo_pos_profile`) and any modules built using fastcat open raw EtherCAT sockets and need `CAP_NET_ADMIN` + `CAP_NET_RAW` permissions.
63+
The shipped utilities (`jsd_slaveinfo`, `elmo_vel_profile`, `elmo_pos_profile`) and any modules built using fastcat open raw EtherCAT sockets and need `CAP_NET_ADMIN` + `CAP_NET_RAW` permissions.
6464
This can be achieved either by running the binary as the root user, or by using the `sudo setcap` command to permit non-root users to access the raw socket.
65-
For example, you can permit a non-root user to run the `solo_vel_profile` binary with the command:
65+
For example, you can permit a non-root user to run the `elmo_vel_profile` binary with the command:
6666

6767
```bash
68-
$ sudo setcap cap_net_admin,cap_net_raw=eip /absolute/path/to/build/bin/solo_vel_profile
68+
$ sudo setcap cap_net_admin,cap_net_raw=eip /absolute/path/to/build/bin/elmo_vel_profile
6969
```
7070

7171
**The raw socketr permissions are cleared on every relink**, so you must re-run `sudo setcap` after each rebuild.
7272

7373
#### Auto-setcap during build
7474

75-
For dev machines, build with `-DAUTO_SETCAP=ON` to automatically run `sudo setcap` on `solo_vel_profile` and `solo_pos_profile` after each link:
75+
For dev machines, build with `-DAUTO_SETCAP=ON` to automatically run `sudo setcap` on `elmo_vel_profile` and `elmo_pos_profile` after each link:
7676

7777
```bash
7878
$ cmake -S . -B build -DAUTO_SETCAP=ON

doc/utilities.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ them land in `build/bin/`:
66
| Binary | Purpose |
77
|---|---|
88
| `jsd_slaveinfo` | Enumerate EtherCAT slaves on a given interface |
9-
| `solo_vel_profile` | Run a trapezoidal velocity profile on a single actuator |
10-
| `solo_pos_profile` | Run a trapezoidal position profile on a single actuator |
9+
| `elmo_vel_profile` | Run a trapezoidal velocity profile on a single actuator |
10+
| `elmo_pos_profile` | Run a trapezoidal position profile on a single actuator |
1111

1212
`jsd_slaveinfo` is built as part of fastcat's [JSD](https://github.com/nasa-jpl/jsd)
13-
dependency. The two `solo_*_profile` binaries are native fastcat utilities
13+
dependency. The two `elmo_*_profile` binaries are native fastcat utilities
1414
under `utils/`.
1515

1616
## Capabilities
@@ -46,7 +46,7 @@ To enable password-less `setcap`, run `sudo visudo` and add:
4646
<your_username> ALL=(ALL) NOPASSWD: /usr/sbin/setcap
4747
```
4848

49-
Note: `AUTO_SETCAP` only applies to `solo_vel_profile` and `solo_pos_profile`.
49+
Note: `AUTO_SETCAP` only applies to `elmo_vel_profile` and `elmo_pos_profile`.
5050
`jsd_slaveinfo` is built by the JSD dependency and is not covered by this
5151
option — set its capabilities manually after each rebuild.
5252

@@ -76,7 +76,7 @@ For more detailed documentation see the JSD project's own
7676

7777
---
7878

79-
## `solo_vel_profile`
79+
## `elmo_vel_profile`
8080

8181
Runs a trapezoidal velocity profile on one actuator described by a fastcat
8282
YAML config. The profile accelerates from rest to a cruise speed, holds for a
@@ -86,7 +86,7 @@ timestamped CSV file in the current working directory.
8686
### Usage
8787

8888
```
89-
./build/bin/solo_vel_profile <config> <actuator_name> <accel> <cruise_speed> <cruise_duration>
89+
./build/bin/elmo_vel_profile <config> <actuator_name> <accel> <cruise_speed> <cruise_duration>
9090
```
9191

9292
| Argument | Description |
@@ -101,7 +101,7 @@ timestamped CSV file in the current working directory.
101101

102102
```
103103
cd build/bin
104-
./solo_vel_profile ../../example_configs/single_elmo.yaml gold_act_1 2.0 5.0 3.0
104+
./elmo_vel_profile ../../example_configs/single_elmo.yaml gold_act_1 2.0 5.0 3.0
105105
```
106106

107107
### Telemetry output
@@ -119,7 +119,7 @@ control tick:
119119

120120
---
121121

122-
## `solo_pos_profile`
122+
## `elmo_pos_profile`
123123

124124
Runs a trapezoidal position profile on one actuator. The trapezoid shape is
125125
chosen automatically based on the requested distance: triangular if the move
@@ -130,7 +130,7 @@ Negative `relative_position` values move in the negative direction.
130130
### Usage
131131

132132
```
133-
./build/bin/solo_pos_profile <config> <actuator_name> <accel> <max_velocity> <relative_position>
133+
./build/bin/elmo_pos_profile <config> <actuator_name> <accel> <max_velocity> <relative_position>
134134
```
135135

136136
| Argument | Description |
@@ -145,8 +145,8 @@ Negative `relative_position` values move in the negative direction.
145145

146146
```
147147
cd build/bin
148-
./solo_pos_profile ../../example_configs/single_elmo.yaml gold_act_1 2.0 5.0 3.0
149-
./solo_pos_profile ../../example_configs/single_elmo.yaml gold_act_1 2.0 5.0 -3.0
148+
./elmo_pos_profile ../../example_configs/single_elmo.yaml gold_act_1 2.0 5.0 3.0
149+
./elmo_pos_profile ../../example_configs/single_elmo.yaml gold_act_1 2.0 5.0 -3.0
150150
```
151151

152152
### Telemetry output

utils/CMakeLists.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ include_directories(
55
${YAMLCPP_INCLUDE_DIR}
66
)
77

8-
add_executable(solo_vel_profile solo_vel_profile.cpp)
9-
target_link_libraries(solo_vel_profile fastcat ${YAMLCPP_LIBRARY} pthread rt)
8+
add_executable(elmo_vel_profile elmo_vel_profile.cpp)
9+
target_link_libraries(elmo_vel_profile fastcat ${YAMLCPP_LIBRARY} pthread rt)
1010

11-
add_executable(solo_pos_profile solo_pos_profile.cpp)
12-
target_link_libraries(solo_pos_profile fastcat ${YAMLCPP_LIBRARY} pthread rt)
11+
add_executable(elmo_pos_profile elmo_pos_profile.cpp)
12+
target_link_libraries(elmo_pos_profile fastcat ${YAMLCPP_LIBRARY} pthread rt)
1313

1414
option(AUTO_SETCAP "Run sudo setcap on profile utilities post-build" OFF)
1515
if(AUTO_SETCAP)
16-
foreach(tgt solo_vel_profile solo_pos_profile)
16+
foreach(tgt elmo_vel_profile elmo_pos_profile)
1717
add_custom_command(TARGET ${tgt} POST_BUILD
1818
COMMAND sudo setcap cap_net_admin,cap_net_raw=eip $<TARGET_FILE:${tgt}>
1919
COMMENT "Setting capabilities on ${tgt}")

0 commit comments

Comments
 (0)