Skip to content

Commit

Permalink
fix markdwon syntax for snapcraft.io
Browse files Browse the repository at this point in the history
  • Loading branch information
DominikN committed Jun 7, 2024
1 parent 1cdf79d commit 261c770
Showing 1 changed file with 16 additions and 22 deletions.
38 changes: 16 additions & 22 deletions snap/snapcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,26 @@ description: |
The `husarion-rplidar` snap contains all the necessary software to bring the RPLIDAR laser sensors up.
It offers the following parameters:
| Key | Default Value |
| - | - |
| driver | {...} |
| ros-domain-id | 0 |
| ros-localhost-only | 0 |
| transport | udp |
| serial-port | auto |
| serial-baudrate | 256000 |
* driver: `{...}`
* ros-domain-id: `0`
* ros-localhost-only: `0`
* transport: `udp`
* serial-port: `auto`
* serial-baudrate: `256000`
The driver parameter is a dictionary that contains the following keys:
| Key | Default Value |
| - | - |
| driver.device-namespace | (unset) |
| driver.namespace | (unset) |
| driver.scan-mode | (unset) |
| driver.channel-type | serial |
| driver.frame-id | laser |
| driver.inverted | false |
| driver.angle-compensate | true |
The `driver` parameter is a dictionary that contains the following keys:
* driver.device-namespace: `(unset)`
* driver.namespace: `(unset)`
* driver.scan-mode: `(unset)`
* driver.channel-type: `serial`
* driver.frame-id: `laser`
* driver.inverted: `false`
* driver.angle-compensate: `true`
To set the parameters, use the snap set command, e.g.,
```
snap set husarion-rplidar driver.namespace=robot
```
`snap set husarion-rplidar driver.namespace=robot`
grade: stable
confinement: strict
Expand Down

0 comments on commit 261c770

Please sign in to comment.