-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new Jazzy yaml parameters to documentation (#294)
* Add the newly-supported controllers to the yaml docs * Add Zenoh docs to system yaml * Add basic zenoh docs, re-insert newlines around code blocks * Add a new page for the platform/enable_ekf feature * Add HE2411 and HE2410 batteries * Add observer backpack attachment * Add a note that Zenoh only works on A200 for now * Hopefully fix path to A200 observer backpack * Remove ds4drv instructions; this package is no longer used in Jazzy * Revert "Remove ds4drv instructions; this package is no longer used in Jazzy" This reverts commit 9d85901. * Add missing '`' characters to close code tags. Built docs locally, didn't see any of the errors from CI
- Loading branch information
1 parent
24e4f80
commit 850f274
Showing
9 changed files
with
127 additions
and
12 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions
36
docs/components/yaml/attachments/a200/observer_backpack.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
<table> | ||
<tr> | ||
<td> | ||
<center> | ||
<figure> | ||
<img src={require("./img/observer_backpack.png").default} width="250"/> | ||
</figure> | ||
</center> | ||
</td> | ||
<td> | ||
|
||
```yaml | ||
platform: | ||
attachments: | ||
- name: observer_backpack | ||
type: a200.observer_backpack | ||
model: observer_backpack | ||
parent: default_mount | ||
xyz: [0.0, 0.0, 0.0] | ||
rpy: [0.0, 0.0, 0.0] | ||
enabled: true | ||
``` | ||
</td> | ||
</tr> | ||
</table> | ||
The `observer_backpack` has the following mounts for attaching sensors, antennas, and other | ||
accessories: | ||
- `${name}_center_mount` | ||
- `${name}_center_lidar_mount` | ||
- `${name}_front_lidar_mount` | ||
- `${name}_rear_lidar_mount` | ||
- `${name}_front_realsense_mount` | ||
- `${name}_rear_realsense_mount` | ||
- `${name}_left_antenna_mount` | ||
- `${name}_right_antenna_mount` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: Enable/Disable EKF | ||
sidebar_label: Enable EKF | ||
sidebar_position: 5 | ||
toc_min_heading_level: 2 | ||
toc_max_heading_level: 5 | ||
--- | ||
|
||
import Tabs from "@theme/Tabs"; | ||
import TabItem from "@theme/TabItem"; | ||
|
||
By default, all Clearpath platforms launch an [EKF node](https://index.ros.org/p/robot_localization) | ||
as part of its localization stack. Some applications may want to use their own localization node, | ||
in which case the default EKF node can be disabled. | ||
|
||
| Key | Value / Datatype | Description | | ||
|:---:| :--------------: | ----------- | | ||
| enable_ekf | boolean | Enables or disables the default EKF node. Default: `true` | | ||
|
||
For example, to disable the EKF node: | ||
|
||
```yaml | ||
platform: | ||
enable_ekf: false | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters