Skip to content

Commit f74ace5

Browse files
rhysfaultless-cprjmastrangelo-cprnvanheysttonybaltovskinvh-cpr
authored
Production sync (#484)
* first pass at adding ROS-like api to the documentaion * added a using the api page * visual as table * proofreading - mostly spelling (#459) * Update drivetrain.mdx * Update robot.mdx removed a because prompts is plural * Update _clearpath_firmware.mdx spelling of ethernet * Update robot.mdx removed "a" because prompts is plural * Update user_manual_husky.mdx * Update user_manual_husky.mdx * Update husky_a300_power_connections.mdx * Update husky_a300_tire_pressure.mdx * Update husky_a300_motors.mdx * Update husky_a300_computer.mdx * Update husky_a300_replacing_circuit_boards.mdx * Update husky_a300_safety_alternate.mdx * Update husky_a300_whats_included.mdx * Update husky_a300_system_architecture.mdx * Update husky_a300_ip_addresses.mdx * Update husky_a300_safety_system_functionality.mdx * Update husky_a300_emergency_stop_buttons.mdx * Update husky_a300_emergency_stop_clearing.mdx * Update common_wireless_joystick_ps4.mdx * Update husky_a300_amp_check_sensors.mdx * Update husky_a300_pre_operation_inspection.mdx * Update husky_a300_system_limits.mdx * Update husky_a300_lockout_tagout.mdx * Update husky_a300_tire.mdx * Update husky_a300_electronics_tray.mdx * Update supported_manipulators.mdx * spelling (#461) * proofreading and clean up fork * Update drivetrain.mdx * Update robot.mdx removed a because prompts is plural * Update _clearpath_firmware.mdx spelling of ethernet * Update robot.mdx removed "a" because prompts is plural * Update user_manual_husky.mdx * Update user_manual_husky.mdx * Update husky_a300_power_connections.mdx * Update husky_a300_tire_pressure.mdx * Update husky_a300_motors.mdx * Update husky_a300_computer.mdx * Update husky_a300_replacing_circuit_boards.mdx * Update husky_a300_safety_alternate.mdx * Update husky_a300_whats_included.mdx * Update husky_a300_system_architecture.mdx * Update husky_a300_ip_addresses.mdx * Update husky_a300_safety_system_functionality.mdx * Update husky_a300_emergency_stop_buttons.mdx * Update husky_a300_emergency_stop_clearing.mdx * Update common_wireless_joystick_ps4.mdx * Update husky_a300_amp_check_sensors.mdx * Update husky_a300_pre_operation_inspection.mdx * Update husky_a300_system_limits.mdx * Update husky_a300_lockout_tagout.mdx * Update husky_a300_tire.mdx * Update husky_a300_electronics_tray.mdx * Update husky_a300_safety_alternate.mdx * Update husky_a300_power_connections.mdx * spelling (#2) * Update drivetrain.mdx * Update robot.mdx removed a because prompts is plural * Update _clearpath_firmware.mdx spelling of ethernet * Update robot.mdx removed "a" because prompts is plural * Update user_manual_husky.mdx * Update user_manual_husky.mdx * Update husky_a300_power_connections.mdx * Update husky_a300_tire_pressure.mdx * Update husky_a300_motors.mdx * Update husky_a300_computer.mdx * Update husky_a300_replacing_circuit_boards.mdx * Update husky_a300_safety_alternate.mdx * Update husky_a300_whats_included.mdx * Update husky_a300_system_architecture.mdx * Update husky_a300_ip_addresses.mdx * Update husky_a300_safety_system_functionality.mdx * Update husky_a300_emergency_stop_buttons.mdx * Update husky_a300_emergency_stop_clearing.mdx * Update common_wireless_joystick_ps4.mdx * Update husky_a300_amp_check_sensors.mdx * Update husky_a300_pre_operation_inspection.mdx * Update husky_a300_system_limits.mdx * Update husky_a300_lockout_tagout.mdx * Update husky_a300_tire.mdx * Update husky_a300_electronics_tray.mdx * Update husky_a300_safety_alternate.mdx * Update husky_a300_power_connections.mdx * spelling! * Accessories section – spelling and grammar (#462) * proofreading and clean up fork * Update drivetrain.mdx * Update robot.mdx removed a because prompts is plural * Update _clearpath_firmware.mdx spelling of ethernet * Update robot.mdx removed "a" because prompts is plural * Update user_manual_husky.mdx * Update user_manual_husky.mdx * Update husky_a300_power_connections.mdx * Update husky_a300_tire_pressure.mdx * Update husky_a300_motors.mdx * Update husky_a300_computer.mdx * Update husky_a300_replacing_circuit_boards.mdx * Update husky_a300_safety_alternate.mdx * Update husky_a300_whats_included.mdx * Update husky_a300_system_architecture.mdx * Update husky_a300_ip_addresses.mdx * Update husky_a300_safety_system_functionality.mdx * Update husky_a300_emergency_stop_buttons.mdx * Update husky_a300_emergency_stop_clearing.mdx * Update common_wireless_joystick_ps4.mdx * Update husky_a300_amp_check_sensors.mdx * Update husky_a300_pre_operation_inspection.mdx * Update husky_a300_system_limits.mdx * Update husky_a300_lockout_tagout.mdx * Update husky_a300_tire.mdx * Update husky_a300_electronics_tray.mdx * Update husky_a300_safety_alternate.mdx * Update husky_a300_power_connections.mdx * spelling (#2) * Update drivetrain.mdx * Update robot.mdx removed a because prompts is plural * Update _clearpath_firmware.mdx spelling of ethernet * Update robot.mdx removed "a" because prompts is plural * Update user_manual_husky.mdx * Update user_manual_husky.mdx * Update husky_a300_power_connections.mdx * Update husky_a300_tire_pressure.mdx * Update husky_a300_motors.mdx * Update husky_a300_computer.mdx * Update husky_a300_replacing_circuit_boards.mdx * Update husky_a300_safety_alternate.mdx * Update husky_a300_whats_included.mdx * Update husky_a300_system_architecture.mdx * Update husky_a300_ip_addresses.mdx * Update husky_a300_safety_system_functionality.mdx * Update husky_a300_emergency_stop_buttons.mdx * Update husky_a300_emergency_stop_clearing.mdx * Update common_wireless_joystick_ps4.mdx * Update husky_a300_amp_check_sensors.mdx * Update husky_a300_pre_operation_inspection.mdx * Update husky_a300_system_limits.mdx * Update husky_a300_lockout_tagout.mdx * Update husky_a300_tire.mdx * Update husky_a300_electronics_tray.mdx * Update husky_a300_safety_alternate.mdx * Update husky_a300_power_connections.mdx * spelling! * spelling and grammar in accessories section --------- Co-authored-by: nvh-cpr <nvheyst@clearpathrobotics.com> * Ridgeback r100 step model (#463) * Added a STEP model and component for the Ridgeback R100's Integration page. * Reduced heading indenture throughout the page, to render the CSS autonumbering correctly. * spelling and grammar (#464) * Spelling and grammar and components used for accessories. * Modified Fixposition XVN to Movella XVN * change headings * moved changes made to 2.0.0 to the docs_outdoornav_usesr_manual folder * fix link to delete dock * review changes * turn off next version * fix broken link * fix broken links * added update instructions * move note location and update scp command * Added setup path details for running clearpath_viz. (#467) * finalized update pages for 2.0.0 and 2.1.0 * CPE87-2851: Add more A300 regulatory notes (#472) * Added more regulatory standards * Reorganize regulatory by country * Remove duplicate regulatory entry (#473) * Remove duplicate regulatory entry * Rename oakd namespace in robot.yaml (#471) * Added note to use CLI to get diagnostics if Cockpit is not running. (#468) * Jackal pacs integration (#474) * Updated hole pattern, thread, and screw type. * Added cable and plate to Jackal's PACS section. * Added TM symbol to PACS references. * review changes * review fix * Readme updates (#476) * Removed a period. * Resolved hyperlink, by removing #- * Resoved bold text issue inside a details block, by changing ** to a <b> tag. * Resloved inline code section inside a details tag, by changing ` to <code>. * Capital letter. * Changed 'Robots / ROS' to 'Software'. This is aligned with the current Navbar buttons. * Added a spelling guide section. * Jackal heading indenture (#477) * Updated heading indeture to resolve CSS autonumbering. * Removed quotes, and added a link to the PACS page. * Updated the hyperlink to the Husky A200's STEP model. (#478) * fixed some small issues with the update process * Add documentation for system.bash and updated platform.extras.launch (#475) * Add documentation for new automatic discovery fields (#470) Document changes from - clearpathrobotics/clearpath_common#262 - clearpathrobotics/clearpath_config#191 * Update navigation tutorials with `scan_topic` argument (#480) * Update the navigation tutorial to include the new scan_topic argument, add a new page for Rviz tools, update the launching page to include steps for Nav2+SLAM and Nav2+Localization instructions for simulation & physical robots. Add a warning about the minumum range of some 3D lidars * Fix broken link * Another link * added messages for the 2.1.1 release (will released as documentation 2.1) * added task executor action/service * release onav 2.1.0 * Added Jazzy 2.8 changes for clearpath_config. * Added Jazzy 2.8 changes for clearpath_common. * Added Jazzy 2.8 changes for clearpath_robot. * Manipulators (#485) * Add Franka components * Use 'details' to create expandable sections * Add manipulator RViz models to non-versioned components * Add manipulator setup images to non-versioned components * Add Franka to Humble config doc * Updated Jazzy Manipulator documentation * Use updated Kinova components in accessory documentation * Fix paths * Fixed spelling inconsistencies. * Added note about 3D lidar scans being experimental. * Grammer changes. --------- Co-authored-by: José Mastrangelo <jmastrangelo@clearpathrobotics.com> Co-authored-by: Nathan Van Heyst <57072440+nvanheyst@users.noreply.github.com> Co-authored-by: Tony Baltovski <tbaltovski@clearpathrobotics.com> Co-authored-by: nvh-cpr <nvheyst@clearpathrobotics.com> Co-authored-by: jmastrangelo-cpr <68664094+jmastrangelo-cpr@users.noreply.github.com> Co-authored-by: jhiggins-cpr <60929523+jhiggins-cpr@users.noreply.github.com> Co-authored-by: Chris Iverach-Brereton <59611394+civerachb-cpr@users.noreply.github.com> Co-authored-by: luis-camero <88782189+luis-camero@users.noreply.github.com>
1 parent 872052c commit f74ace5

File tree

556 files changed

+17822
-698
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

556 files changed

+17822
-698
lines changed

README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@
5050

5151
git clone https://github.com/clearpathrobotics/cpr-documentation.git
5252

53-
2. Create a branch from development. with a name indicating the purpose, such as _feature_xxxxxx_
53+
2. Create a branch from development with a name indicating the purpose, such as _feature_xxxxxx_
5454
3. Make changes to the relevant files.
55-
4. Test using your local server, using the steps mentioned [Steps to run this on your computer locally](##-steps-to-run-this-on-your-computer-locally)
55+
4. Test using your local server, using the steps mentioned [Steps to run this on your computer locally](#steps-to-run-this-on-your-computer-locally)
5656
5. When ready, enter `ctrl-c` in your terminal to stop the server. Then run `npm run build` to test that the site builds corretly.
5757
6. Resolve any errors that the terminal reports, and rerun the command `npm run build`.
5858
7. Finally, check that your updates adhere to our code formatting standard, by running the command `npm run format-check`.
@@ -129,18 +129,18 @@ When it is time to publish a numbered release of the user manual:
129129

130130
<br>
131131
Follow the steps for the OutdoorNav User Manual workflow above, replacing
132-
**outdoornav** with **indoornav**.
132+
<b>outdoornav</b> with <b>indoornav</b>.
133133

134134
</details>
135135

136-
## Workflow for publishing Robots / ROS User Manual updates
136+
## Workflow for publishing Software User Manual updates
137137

138138
<details>
139139

140-
<summary>Click to expand for details on how to update the Robots / ROS User Manual</summary>
140+
<summary>Click to expand for details on how to update the Software User Manual</summary>
141141

142142
<br>
143-
The Robots / ROS sections of the website are a "versioned" document called `docs`, which means that a snapshot of the content is
143+
The Software sections of the website are a "versioned" document called <code>docs</code>, which means that a snapshot of the content is
144144
made to align with each ROS version. This allows users to access version-specific copies of the
145145
documentation.
146146

@@ -217,7 +217,7 @@ includeCurrentVersion: false,
217217
HTML commenting—`<!-- -->`—causes issues with the MDX extension in VS Code.
218218
2. Refer to [Docusaurus's guide](https://docusaurus.io/docs/next/markdown-features) for supported Markdown features.
219219
3. For advanced users, refer to [Markdown MDX](https://mdxjs.com/) for adding React Components to a Markdown file.
220-
4. for advanced users, you may create React pages using _.js_ or _.ts_ file types.
220+
4. For advanced users, you may create React pages using _.js_ or _.ts_ file types.
221221

222222
## How should I name files?
223223

@@ -513,3 +513,33 @@ Even though the font size has been modified, the rendered diagram's font may not
513513
`}
514514
/>
515515
```
516+
517+
## Spelling Guide
518+
519+
Spelling on within this repository should align with the Government of Canada's [TERMIUM Plus®](https://www.btb.termiumplus.gc.ca/).
520+
Industry terms should align with the related organization's preferred spelling.
521+
522+
<details>
523+
<summary>Click to expand spelling examples</summary>
524+
<table>
525+
<tr><th>Correct spelling</th><th>Mistake</th></tr>
526+
<tr><th>10</th><th>Ten</th></tr>
527+
<tr><th>2X</th><th>2x</th></tr>
528+
<tr><th>Aluminum</th><th>Aluminium</th></tr>
529+
<tr><th>Antennas</th><th>Antennae</th></tr>
530+
<tr><th>Antennas</th><th>Aerial</th></tr>
531+
<tr><th>AWS, or Amazon Web Services</th><th>Amazon AWS</th></tr>
532+
<tr><th>Colour</th><th>Color</th></tr>
533+
<tr><th>Computer</th><th>PC</th></tr>
534+
<tr><th>Enable Switch</th><th>Deadman Switch</th></tr>
535+
<tr><th>Emergency Stop</th><th>E-stop</th></tr>
536+
<tr><th>GitHub</th><th>Github</th></tr>
537+
<tr><th>Lidar</th><th>LiDAR</th></tr>
538+
<tr><th>Metre</th><th>Meter</th></tr>
539+
<tr><th>ROS 2</th><th>ROS2</th></tr>
540+
<tr><th>RViz</th><th>Rviz</th></tr>
541+
<tr><th>Gmapping</th><th>gmapping</th></tr>
542+
<tr><th>Tire</th><th>Tyre</th></tr>
543+
<tr><th>Wi-Fi</th><th>wifi</th></tr>
544+
</table>
545+
</details>

components/common_wireless_joystick_ps4.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To connect the joystick to your robot:
1111
3. Press the _PS_ button in the centre of the joystick.
1212
4. The joystick's top LED should start pulsing white or blue.
1313
This means the joystick is attempting to connect.
14-
5. The joysick's top LED should eventually become solid blue, indicating that it has connected to the robot's computer.
14+
5. The joystick's top LED should eventually become solid blue, indicating that it has connected to the robot's computer.
1515

1616

1717
<center>

components/husky_a200/husky_a200_step_model.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import ComponentButtonStepDownload from "/components/button_download_step.tsx";
33
### STEP Model {#step-model}
44

55
<div>
6-
<ComponentButtonStepDownload filePath={"https://cpr-documentation-large-files.s3.us-east-2.amazonaws.com/034991-GEO_1.STEP"}/>
6+
<ComponentButtonStepDownload filePath={"https://cpr-documentation-large-files.s3.us-east-2.amazonaws.com/034991-GEO_2.STEP"}/>
77

88
This simplified 3D model of the Husky A200 includes details like the internal
99
battery, circuit board where you can connect to the robot's electrical

components/husky_a300/husky_a300_amp_arch_cables.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The _Sensor Arch_ places Husky's cameras and GNSS antennas above the robot for o
44
These steps will give you access to the related cable routings for repairs:
55

66
1. Remove the 3 screws from the inside access panel.
7-
2. Remove the panel by sliding is toward the end of the robot.
7+
2. Remove the panel by sliding it toward the end of the robot.
88
3. The _Arch Posts_ have cable tie anchors.
99
You can remove the cable ties with side cutters.
1010
4. Cables route through an obround cutout in the _Enclosure_.

components/husky_a300/husky_a300_amp_check_sensors.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Husky AMP includes several sensors that are used for robot navigation. After connecting
44
to Husky AMP's network, confirm that each sensor is functional by using the steps below.
55

6-
1. Connect to your laptop to the robot using SSH. To do so, execute the following in a terminal window:
6+
1. Connect your laptop to the robot using SSH. To do so, execute the following in a terminal window:
77
```
88
ssh robot@192.168.131.1
99
```

components/husky_a300/husky_a300_amp_connector_bulkhead.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
</center>
1212

1313
To make a Husky AMP, we take a Husky A300, remove the Top Plate, and then install an enclosure on top of the base robot.
14-
We added a connector bulkhead between the base robot and the enclosure to keep cable routings tidy, and make the maintenence process quick.
14+
We added a connector bulkhead between the base robot and the enclosure to keep cable routings tidy, and make the maintenance process quick.
1515
The connectors on this bulkhead are extension cables from existing [Husky A300 interfaces](/docs_robots/outdoor_robots/husky/a300/integration_husky/#system-interface-circuit-board-connector-summary), which are listed below.
1616

1717
<center>

components/husky_a300/husky_a300_components_observer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ Refer to the [Husky A300 AMP's Components Overview](/docs_robots/solutions/husky
3232
src="/img/robot_images/husky_a300_images/husky_a300_observer_isometric_3.png"
3333
width="800"
3434
/>
35-
<figcaption>The Husky Oberver, with the included Stationary Dock.</figcaption>
35+
<figcaption>The Husky Observer, with the included Stationary Dock.</figcaption>
3636
</figure>
3737
</center>

components/husky_a300/husky_a300_computer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Clearpath offers a standard computer with an Intel i3 processor, or a performanc
3030
4. Wi-Fi antennas.
3131
5. Power cable.
3232
6. Optional graphics card's PCIe riser cable.
33-
4. Remove the 4 screws fastning the computer to Husky's _Electronics Tray_.
33+
4. Remove the 4 screws fastening the computer to Husky's _Electronics Tray_.
3434
5. Remove the computer from the robot.
3535

3636
:::note

components/husky_a300/husky_a300_electronics_tray.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This tray includes the:
1919
* Optional secondary computer or graphics card, _(not shown in the image)_
2020
* Optional USB hub, _(not shown in the image)_
2121

22-
You may want to access remove the _Electonics Tray_ to access the integration bay under the tray,
22+
You may want to remove the _Electronics Tray_ to access the integration bay under the tray,
2323
or to maintain Husky's _Batteries_ and _Power Distribution_ components.
2424

2525
#### Hinging The Electronics Tray

components/husky_a300/husky_a300_emergency_stop_buttons.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The 2 relays are connected in series, so if one welds closed due to a failure, t
3333
The relays's physical states are monitored with Husky's Common Core microcontroller, and should flag a maintenance issue if either relay is damaged.
3434

3535
<Admonition type="danger" title=" ">
36-
Husky's microcontroller is does not meet any performance level per ISO 13849-1.
36+
Husky's microcontroller does not meet any performance level per ISO 13849-1.
3737
Husky's microcontroller can be replaced with a PLC to achieve a known performance level for fault monitoring.
3838
[Contact our Support Team](#support) if you have questions about this.
3939
</Admonition>

0 commit comments

Comments
 (0)