Skip to content

Commit 658ad72

Browse files
ci(pre-commit): autofix
1 parent 0cb2b7c commit 658ad72

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,24 @@ This repository provides a ROS2 package for generating sensor trigger signals on
1616

1717
1. Create or change into your workspace directory, and execute the following:
1818

19-
```bash
20-
mkdir -p src
21-
git clone [email protected]:tier4/sensor_trigger.git src
22-
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release --packages-up-to sensor_trigger
23-
```
19+
```bash
20+
mkdir -p src
21+
git clone [email protected]:tier4/sensor_trigger.git src
22+
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release --packages-up-to sensor_trigger
23+
```
2424

2525
2. The sensor trigger node requires as close to real-time operation as possible to maintain reliable trigger timing under heavy CPU load. If this is required, it is recommended to allow thread schedule priority setting to the ROS2 user by adding the following line to `/etc/security/limits.conf`:
2626

27-
```
28-
<username> - rtprio 98
29-
```
27+
```
28+
<username> - rtprio 98
29+
```
3030

31-
After saving the edited file (as sudo), a reboot will be required.
31+
After saving the edited file (as sudo), a reboot will be required.
3232

33-
Some notes about thread scheduling:
34-
- If you do not make the settings in (2), the node will run but the timing thread will not be scheduled at any higher priority that other user threads and interruption may occur, resulting in high jitter in the trigger output.
35-
- When running in a ROS2 docker, the settings in (2) are not required as the docker user is by default the root user.
33+
Some notes about thread scheduling:
34+
35+
- If you do not make the settings in (2), the node will run but the timing thread will not be scheduled at any higher priority that other user threads and interruption may occur, resulting in high jitter in the trigger output.
36+
- When running in a ROS2 docker, the settings in (2) are not required as the docker user is by default the root user.
3637

3738
## Usage
3839

@@ -63,13 +64,13 @@ This node does not take any inputs.
6364

6465
### Core Parameters
6566

66-
| Name | Type | Description |
67-
| ------------- | ------ | ------------------------------------------------------------ |
68-
| `gpio` | int | Output GPIO pin - see below for assigned pins on RQX-58G |
69-
| `phase` | double | Desired phase of the trigger relative to ToS (Top of Second) |
70-
| `frame_rate` | double | Desired frequency of the trigger in Hz |
71-
| `cpu_core_id` | int | Desired CPU core for execution\* |
72-
| `pulse_width_ms` | int | Desired pulse width (the time period in milliseconds for the GPIO pin to remain high) |
67+
| Name | Type | Description |
68+
| ---------------- | ------ | ------------------------------------------------------------------------------------- |
69+
| `gpio` | int | Output GPIO pin - see below for assigned pins on RQX-58G |
70+
| `phase` | double | Desired phase of the trigger relative to ToS (Top of Second) |
71+
| `frame_rate` | double | Desired frequency of the trigger in Hz |
72+
| `cpu_core_id` | int | Desired CPU core for execution\* |
73+
| `pulse_width_ms` | int | Desired pulse width (the time period in milliseconds for the GPIO pin to remain high) |
7374

7475
\*This is indexed from CPU core 0 (which will be CPU 1 in `htop`).
7576

0 commit comments

Comments
 (0)