Skip to content

Commit

Permalink
English lesson
Browse files Browse the repository at this point in the history
Co-authored-by: David Wong <[email protected]>
  • Loading branch information
mojomex and drwnz authored Nov 6, 2024
1 parent 5b142c4 commit e8a0034
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions docs/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If disabled, the current configuration state is downloaded from the sensor, and

This parameter is mainly used for TCP communication, such as diagnostics and for setting parameters.
TCP connections will be made to `sensor_ip`, and if `multicast_ip` is supported and set to a multicast group,
Nebula will drop all UDP traffic received via multicast and not sent from `sensor_ip`.
Nebula will drop all UDP traffic received via multicast that was not sent from `sensor_ip`.

#### `host_ip`

Expand All @@ -43,7 +43,7 @@ Set this parameter to the IP address of your host.

#### `multicast_ip`

Sensors for which Nebula supports IP multicast, `multicast_ip` can be set to an address in `224.0.0.0/28` (the range from `224.0.0.0` to `239.255.255.255`).
For sensors with IP multicast support in Nebula, `multicast_ip` can be set to an address in `224.0.0.0/28` (the range from `224.0.0.0` to `239.255.255.255`).
Nebula will then configure the sensor to send its data to that group, and Nebula will join that group and accept only data sent by `sensor_ip`.
Set this parameter to `""` to disable multicast.

Expand All @@ -60,7 +60,7 @@ The name of the CAN interface the sensor is connected to. Find available interfa

#### `filters`

A string expressing the filters used to accept/reject arriving CAN frames. See [man candump](https://manpages.ubuntu.com/manpages/jammy/man1/candump.1.html) for info on syntax.
A string expressing the filters used to accept/reject arriving CAN frames. See [man candump](https://manpages.ubuntu.com/manpages/jammy/man1/candump.1.html) for syntax information.
You can install `candump` via `apt install can-utils`.

## ROS-Specific Settings
Expand All @@ -71,11 +71,11 @@ The TF2 frame ID used for the published point clouds, objects, etc.

## LiDAR-Specific Settings

These settings are common to most LiDARs, but the supported ranges or options supported by specific sensor models can vary. Refer to the sensor's parameter page for details.
These settings are common to most LiDARs, but the ranges or options supported by specific sensor models can vary. Please refer to the individual sensor parameter pages for details.

### `rotation_speed`

The rotations per minute (RPM) the sensor's motor should spin at (mechanical LiDARs only). To calculate the resulting frame rate in frames per second (FPS), use `FPS = RPM / 60`.
The revolutions per minute (RPM) setting for the sensor's motor (mechanical LiDARs only). To calculate the resulting frame rate in frames per second (FPS), use `FPS = RPM / 60`.

### `min_range`

Expand Down
4 changes: 2 additions & 2 deletions docs/parameters/vendors/hesai/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Scan cutting influences the time stamps of points and the point cloud headers.
The point cloud header time stamp is always the absolute time of the earliest (theoretical) point in the cloud.
This means that for different parameter combinations, different timing behaviors are observed:

- `cut_angle` is in `(cloud_min_angle, cloud_max_angle)` (both bounds exclusive): the earliest point is the one directly after `cut_angle`
- `cut_angle` is within `(cloud_min_angle, cloud_max_angle)` (both bounds exclusive): the earliest point is the one directly after `cut_angle`
- `cut_angle = cloud_max_angle` and the FoV is not 360 deg: the earliest point is at `cloud_min_angle`

Depending on whether `cut_angle` and `sync_angle` are aligned, the point cloud time stamp will be somewhere in `[ToS, ToS + 100 ms)` assuming a `10 Hz` LiDAR.
Expand All @@ -42,7 +42,7 @@ The upper bounds of these areas of influence are shown in orange and are auto-ca
<!-- prettier-ignore-start -->
!!! note
The parts of the correction ranges that are outside of the (corrected) FoV also need to be captured by the sensor as they contribute points to regions within the FoV.
Nebula automatically sets the sensors' FoV settings to an oversized range compared to the desired corrected FoV.
Nebula automatically sets the sensor's FoV settings to an oversized range compared to the desired corrected FoV.
<!-- prettier-ignore-end -->

The two examples shown below illustrate the behavior of a `cut_angle` inside the FoV (left) and one that coincides with the `cloud_max_angle`.
Expand Down

0 comments on commit e8a0034

Please sign in to comment.