-
Notifications
You must be signed in to change notification settings - Fork 12
Add A300 attachments to config/yaml/attachments section #404
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
civerachb-cpr
wants to merge
5
commits into
development
Choose a base branch
from
feature/a300-amp-attachments
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+306
−5
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
dbfde48
Add A300 attachments to the yaml documentation. Move other pages back…
civerachb-cpr fe44321
Remove references to IP rating
civerachb-cpr 21288a5
Add missing newline at EOF
civerachb-cpr e0f39a7
Add newline at EOF
civerachb-cpr f5937d1
Make it clearer that the two mounting plates are only for the descrip…
civerachb-cpr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
39 changes: 39 additions & 0 deletions
39
...ioned_docs/version-ros2jazzy/components/yaml/attachments/a300/amp_enclosure.mdx
This file contains hidden or 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,39 @@ | ||
<table> | ||
<tr> | ||
<td> | ||
<center> | ||
<figure> | ||
<img src={require("./img/amp_enclosure.png").default} width="250" /> | ||
</figure> | ||
</center> | ||
</td> | ||
<td> | ||
|
||
```yaml | ||
platform: | ||
attachments: | ||
- name: enclosure | ||
type: a300.amp_enclosure | ||
model: default | ||
parent: base_link | ||
xyz: [0.0, 0.0, 0.0] | ||
rpy: [0.0, 0.0, 0.0] | ||
enabled: true | ||
``` | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
The top of the enclosure features user rails running down the full length, to allow easy mounting | ||
of additional payloads. The `a300.amp_enclosure` URDF includes the following links that can be set | ||
as the `parent_link` of other attachments: | ||
|
||
- `${name}_center_mount`: the centre of the upper surface of the enclosure. Items mounted to the | ||
user rails should measure from this point. | ||
- `${name}_antenna_mount`: the standard parent for the AMP Sensor Arch, located at the rear of the | ||
user rails | ||
- `${name}_front_lidar_mount`: located on the front face of the enclosure, this is the default location | ||
for the AMP's front-facing 3D lidar | ||
- `${name}_ins_mount`: located on the rear face of the enclosure, this is the default location for | ||
the AMP's INS sensor | ||
|
35 changes: 35 additions & 0 deletions
35
...ned_docs/version-ros2jazzy/components/yaml/attachments/a300/amp_sensor_arch.mdx
This file contains hidden or 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,35 @@ | ||
<table> | ||
civerachb-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<tr> | ||
<td> | ||
<center> | ||
<figure> | ||
<img src={require("./img/amp_sensor_arch.png").default} width="250" /> | ||
</figure> | ||
</center> | ||
</td> | ||
<td> | ||
|
||
```yaml | ||
platform: | ||
attachments: | ||
- name: sensor_arch | ||
type: a300.amp_sensor_arch | ||
model: default | ||
parent: enclosure_antenna_mount | ||
xyz: [0.0, 0.0, 0.0] | ||
rpy: [0.0, 0.0, 0.0] | ||
enabled: true | ||
``` | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
The AMP sensor arch includes the following links to attach sensors and other accessories: | ||
- `${name}_front_camera_mount`: located under the centre-top of the arch, this is the default | ||
location for the front-facing teleoperation camera | ||
- `${name}_rear_camera_mount`: located under the centre-top of the arch, this is the default | ||
location for the rear-facing teleoperation camera | ||
- `${name}_lidar_mount`: default mounting location for a secondary 3D lidar. This mount is only | ||
usable when an additional bracket is physically installed on the arch. | ||
- `${name}_left_antenna_mount`: the default mounting location for the GNSS/INS sensor's left antenna | ||
- `${name}_right_antenna_mount`: the default mounting location for the GNSS/INS sensor's right antenna | ||
civerachb-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
34 changes: 34 additions & 0 deletions
34
docs_versioned_docs/version-ros2jazzy/components/yaml/attachments/a300/bumper.mdx
This file contains hidden or 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,34 @@ | ||
<table> | ||
<tr> | ||
<td> | ||
<center> | ||
<figure> | ||
<img src={require("./img/bumpers.png").default} width="250"/> | ||
</figure> | ||
</center> | ||
</td> | ||
<td> | ||
|
||
```yaml | ||
platform: | ||
attachments: | ||
- name: front_bumper | ||
type: a300.bumper | ||
model: default | ||
parent: front_bumper_mount | ||
xyz: [0.0, 0.0, 0.0] | ||
rpy: [0.0, 0.0, 0.0] | ||
enabled: true | ||
- name: rear_bumper | ||
type: a300.bumper | ||
model: default | ||
parent: rear_bumper_mount | ||
xyz: [0.0, 0.0, 0.0] | ||
rpy: [0.0, 0.0, 0.0] | ||
enabled: true | ||
``` | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
The bumpers can be extended by setting the `extension` parameter. | ||
civerachb-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
Binary file added
BIN
+112 KB
...d_docs/version-ros2jazzy/components/yaml/attachments/a300/img/amp_enclosure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+173 KB
...docs/version-ros2jazzy/components/yaml/attachments/a300/img/amp_sensor_arch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+187 KB
...rsioned_docs/version-ros2jazzy/components/yaml/attachments/a300/img/bumpers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+159 KB
...oned_docs/version-ros2jazzy/components/yaml/attachments/a300/img/spotlights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+154 KB
...cs/version-ros2jazzy/components/yaml/attachments/a300/img/top_plate_default.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+207 KB
..._docs/version-ros2jazzy/components/yaml/attachments/a300/img/top_plate_pacs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+175 KB
...ocs/version-ros2jazzy/components/yaml/attachments/a300/img/wireless_charger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions
38
...versioned_docs/version-ros2jazzy/components/yaml/attachments/a300/spotlight.mdx
This file contains hidden or 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,38 @@ | ||
<table> | ||
civerachb-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<tr> | ||
<td> | ||
<center> | ||
<figure> | ||
<img src={require("./img/spotlights.png").default} width="250" /> | ||
</figure> | ||
</center> | ||
</td> | ||
<td> | ||
|
||
```yaml | ||
platform: | ||
attachments: | ||
- name: driving_light_1 | ||
type: a300.spotlight | ||
parent: sensor_arch_front_left_corner_mount | ||
xyz: [0.0, 0.0, -0.08] | ||
rpy: [0.0, 0.5235987755982988, 0.5235987755982988] | ||
- name: driving_light_2 | ||
type: a300.spotlight | ||
parent: sensor_arch_front_right_corner_mount | ||
xyz: [0.0, 0.0, -0.08] | ||
rpy: [0.0, 0.5235987755982988, -0.5235987755982988] | ||
- name: driving_light_3 | ||
type: a300.spotlight | ||
parent: sensor_arch_rear_left_corner_mount | ||
xyz: [0.0, 0.0, -0.08] | ||
rpy: [0.0, 0.5235987755982988, -0.5235987755982988] | ||
- name: driving_light_4 | ||
type: a300.spotlight | ||
parent: sensor_arch_rear_right_corner_mount | ||
xyz: [0.0, 0.0, -0.08] | ||
rpy: [0.0, 0.5235987755982988, 0.5235987755982988] | ||
``` | ||
</td> | ||
</tr> | ||
</table> |
31 changes: 31 additions & 0 deletions
31
...d_docs/version-ros2jazzy/components/yaml/attachments/a300/top_plate_default.mdx
This file contains hidden or 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,31 @@ | ||
<table> | ||
civerachb-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<tr> | ||
<td> | ||
<center> | ||
<figure> | ||
<img src={require("./img/top_plate_default.png").default} width="250" /> | ||
</figure> | ||
</center> | ||
</td> | ||
<td> | ||
|
||
```yaml | ||
platform: | ||
attachments: | ||
- name: top_plate | ||
type: a300.top_plate | ||
model: default | ||
parent: default_mount | ||
xyz: [0.0, 0.0, 0.0] | ||
rpy: [0.0, 0.0, 0.0] | ||
enabled: true | ||
``` | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
The default top plate has 3 mounting locations that can be used as the `parent_link` for sensors and other | ||
attachments: | ||
- `${name}_front_mount` at the front edge of the plate, | ||
- `${name}_rear_mount` at the rear edge of the plate, and | ||
- `${name}_default_mount` located in the centre of the plate. | ||
civerachb-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
30 changes: 30 additions & 0 deletions
30
...oned_docs/version-ros2jazzy/components/yaml/attachments/a300/top_plate_pacs.mdx
This file contains hidden or 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,30 @@ | ||
<table> | ||
civerachb-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<tr> | ||
<td> | ||
<center> | ||
<figure> | ||
<img src={require("./img/top_plate_pacs.png").default} width="250" /> | ||
</figure> | ||
</center> | ||
</td> | ||
<td> | ||
|
||
```yaml | ||
platform: | ||
attachments: | ||
- name: top_plate | ||
type: a300.top_plate | ||
model: pacs | ||
parent: default_mount | ||
xyz: [0.0, 0.0, 0.0] | ||
rpy: [0.0, 0.0, 0.0] | ||
enabled: true | ||
``` | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
Attach accessories to the top plate mounts by setting the accessory's `parent` parameter to one of the grid mounting | ||
locations displayed above. The grid mounting locations span from `${name}_mount_a1` to `${name}_mount_e9`, where the | ||
front left-most location is the `a1` mount and the rear right-most location is the `e9` mount. The letters correspond | ||
to the columns and the number to the rows. | ||
civerachb-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
29 changes: 29 additions & 0 deletions
29
...ed_docs/version-ros2jazzy/components/yaml/attachments/a300/wireless_charger.mdx
This file contains hidden or 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,29 @@ | ||
<table> | ||
civerachb-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<tr> | ||
<td> | ||
<center> | ||
<figure> | ||
<img src={require("./img/wireless_charger.png").default} width="250" /> | ||
</figure> | ||
</center> | ||
</td> | ||
<td> | ||
|
||
```yaml | ||
platform: | ||
attachments: | ||
- name: wireless_charger | ||
type: a300.wireless_charger | ||
model: default | ||
parent: base_link | ||
xyz: [0.0, 0.0, 0.0] | ||
rpy: [0.0, 0.0, 0.0] | ||
enabled: true | ||
``` | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
The A300 can optionally be equipped with a wireless charging coil, mounted to the the right side of the robot. | ||
|
||
The `${name}_face` link is located in the centre of the charging coil's face, with the X axis pointing outwards. |
2 changes: 1 addition & 1 deletion
2
..._versioned_docs/version-ros2jazzy/ros/config/yaml/platform/attachments/a200.mdx
This file contains hidden or 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
65 changes: 65 additions & 0 deletions
65
..._versioned_docs/version-ros2jazzy/ros/config/yaml/platform/attachments/a300.mdx
This file contains hidden or 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,65 @@ | ||
--- | ||
title: A300 Attachments | ||
sidebar_label: A300 | ||
sidebar_position: 2 | ||
toc_min_heading_level: 2 | ||
toc_max_heading_level: 5 | ||
--- | ||
import A300AmpEnclosure from "/docs_versioned_docs/version-ros2jazzy/components/yaml/attachments/a300/amp_enclosure.mdx"; | ||
import A300AmpSensorArch from "/docs_versioned_docs/version-ros2jazzy/components/yaml/attachments/a300/amp_sensor_arch.mdx"; | ||
import A300Bumper from "/docs_versioned_docs/version-ros2jazzy/components/yaml/attachments/a300/bumper.mdx"; | ||
import A300Spotlight from "/docs_versioned_docs/version-ros2jazzy/components/yaml/attachments/a300/spotlight.mdx"; | ||
import A300TopPlateDefault from "/docs_versioned_docs/version-ros2jazzy/components/yaml/attachments/a300/top_plate_default.mdx"; | ||
import A300TopPlatePacs from "/docs_versioned_docs/version-ros2jazzy/components/yaml/attachments/a300/top_plate_pacs.mdx"; | ||
import A300WirelessCharger from "/docs_versioned_docs/version-ros2jazzy/components/yaml/attachments/a300/wireless_charger.mdx"; | ||
|
||
## Bumper | ||
|
||
The A300 can have bumpers. By default, we have two bumpers, on the front and rear of the robot. | ||
|
||
<A300Bumper /> | ||
|
||
|
||
## Top Plate | ||
|
||
The A300 description supports two types of top plates that modify the mounting links of the robot. | ||
|
||
### Default | ||
|
||
The **default** top plate is mounted on top of the robot. | ||
<A300TopPlateDefault/> | ||
<br/> | ||
|
||
### PACS | ||
The **PACS** top is physically identical to the **default** plate, but adds PACS-compatible mounting links. | ||
<A300TopPlatePacs/> | ||
<br/> | ||
|
||
## Wireless Charger | ||
|
||
<A300WirelessCharger /> | ||
|
||
## AMP Attachments | ||
|
||
The Husky AMP (Autonomous Mobile Platform) has large enclosure on top to contain additional computers, sensors, and | ||
power-distribution equipment and an arch to support additional sensors. These attachments can be added to | ||
the A300 just like any other attachment. | ||
|
||
### AMP Enclosure | ||
|
||
If the AMP Enclosure is used, the [top plate](#top-plate) should be omitted. | ||
|
||
<A300AmpEnclosure /> | ||
|
||
### AMP Sensor Arch | ||
|
||
The AMP sensor arch is used to attach additional sensors and antennas. | ||
|
||
<A300AmpSensorArch /> | ||
|
||
### Spotlights | ||
|
||
The AMP is equipped with multiple spotlights to assist in teleoperation in dark environments. The models also include | ||
simulated light sources when used with [Gazebo](../../../../tutorials/simulator/overview.mdx) | ||
|
||
<A300Spotlight /> |
2 changes: 1 addition & 1 deletion
2
...versioned_docs/version-ros2jazzy/ros/config/yaml/platform/attachments/dx1X0.mdx
This file contains hidden or 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
2 changes: 1 addition & 1 deletion
2
..._versioned_docs/version-ros2jazzy/ros/config/yaml/platform/attachments/j100.mdx
This file contains hidden or 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
2 changes: 1 addition & 1 deletion
2
..._versioned_docs/version-ros2jazzy/ros/config/yaml/platform/attachments/r100.mdx
This file contains hidden or 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
2 changes: 1 addition & 1 deletion
2
..._versioned_docs/version-ros2jazzy/ros/config/yaml/platform/attachments/w200.mdx
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Intent the HTML block.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HTML table formatting was copied from another page already in the repo, e.g.
cpr-documentation/docs_versioned_docs/version-ros2jazzy/components/yaml/attachments/a200/bumper.mdx
Lines 1 to 10 in cc5420e
The entire
components
directory consistently uses unindented HTML blocks, so I'd rather keep the formatting in this MR consistent with existing files. If formatting is an issue in the future we can bulk-update the whole directory at once in a different MR.