Clearpath Config Skeleton Documentation #127
Conversation
luis-camero
requested review from
jhiggins-cpr,
rhysfaultless-cpr and
tonybaltovski
as code owners
docs/ros/config/yaml.mdx
Outdated
| </details> | ||
|
|
||
| ## Platform | ||
| Every robot platform has unique structures just as versatile sensor mounting solutions, wireless charging receivers, and waterproofing enclosures; we refer to these as decorations. |
There was a problem hiding this comment.
Decorations seems misaligned with other Clearpath branding terms. Brackets seems more aligned with existing Clearpath webpages. Consider reviewing this with someone from Marketing.
There was a problem hiding this comment.
You can also use OTTO's glossary of Product / Branding terms:
https://wiki.clearpathrobotics.com/pages/viewpage.action?pageId=106572126
There was a problem hiding this comment.
Taking a look at the glossary, the closest entry to what a decoration would be is an attachment.
| attachment | Additional hardware products that are installed on robots to enhance their capabilities. For example lifts, conveyors, and arms. | DO NOT USE: Accessory, Appliance |
|---|
Decorations was used in the ROS 1 Husky code to refer to attachments that were unique to the Husky, such as bumpers, top plates, and sensor archs.
The attachment, as is defined by OTTO, applies to all entities in the config, i.e. decorations, accessories (probably needs changing), mounts, and sensors.
I think that the word decorations has connotations of an ornamental, non-functional item; and, it does not fit the concept of a charging bumper, versatile top plate, or sensor arch. Therefore, it will seem out of place to anyone not familiar with the Husky codebase.
|
@rhysfaultless-cpr, @tonybaltovski I've added samples to add all config entities and an example Husky that adds decorations, mounts, and sensors step by step to the config with images. |
5 participants
Initial pass on configuration YAML for review.