Skip to content

Commit a1da77c

Browse files
authored
Changes to support Boxer V2.5 (#105)
* First draft of Boxer V2.5 updates
1 parent 22d11c1 commit a1da77c

File tree

10 files changed

+111
-59
lines changed

10 files changed

+111
-59
lines changed

docs/robots/indoor_robots/boxer/integration_boxer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Contact [Support](#support) if you need more information.
5555
Ensure that the Boxer is shut off and the circuit breaker is turned to the _off_ position before performing any electrical work on the Boxer.
5656

5757
The Boxer is equipped with an attachment interface that consists of a Power-over-Ethernet (PoE) RJ45 bulkhead connector, a USB Type-A bulkhead connector, and a 37-position panel receptacle and mated plug.
58-
To connect with the Boxer attachment interface see Section 10 of the [OTTO 100 V2.4 Operation and Maintenance Manual](https://help.ottomotors.com/docs/files/53683025/99909709/1/1606232510624/OMM-000094-Operation+and+Maintenance+Manual+OTTO+100+V2.4_A.pdf).
58+
To connect with the Boxer attachment interface see Section 10 of the [OTTO 100 V2.5 Operation and Maintenance Manual](https://docs.ottomotors.com/PDFs/100-v2.5-OMM.pdf).
5959

6060
To add wires to the 37-position connector for you application, follow the TE Connectivity documentation for [connector 206305-1](https://www.te.com/usa-en/product-206305-1.html) to use appropriate crimp pins.
6161
Note that the 37-position connector will come pre-populated from Clearpath Robotics with 2 wires.

docs/robots/indoor_robots/boxer/tutorials_boxer.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ import Support from "/components/support.mdx";
2323

2424
:::caution
2525

26-
This guide is for the Boxer 2.4, released in November 2021. The Boxer 2.4 is not compatible with the older Boxer.
27-
Owners of previous-generation Boxers should refer to the documentation [here](http://www.clearpathrobotics.com/assets/guides/kinetic/boxer/).
26+
This guide is for the Boxer V2.4 (released in November 2021) and V2.5 (released in May 2023). Boxer V2.4 and V2.5 are not compatible with the older Boxer (V2.2).
27+
Owners of previous-generation (V2.2) Boxers should refer to the documentation [here](http://www.clearpathrobotics.com/assets/guides/kinetic/boxer/).
2828

2929
:::
3030

3131
:::note
3232

3333
OTTO Motors and Clearpath Robotics operate under the same parent company.
34-
Boxer 2.4 is a collaboration between the teams at OTTO Motors and Clearpath Robotics.
34+
Boxer V2.4 and V2.5 are a collaboration between the teams at OTTO Motors and Clearpath Robotics.
3535

3636
:::
3737

@@ -81,7 +81,7 @@ The following terms are used throughout this guide:
8181

8282
### Differences from OTTO 100
8383

84-
The most obvious difference between OTTO 100 and Boxer 2.4 is that Boxer has been painted black with a yellow
84+
The most obvious difference between OTTO 100 and Boxer V2.4/V2.5 is that Boxer has been painted black with a yellow
8585
stripe on the sides. This change is purely cosmetic, and is to keep the Boxer visually distinct.
8686

8787
Mechanically, the top deck of the Boxer has a slightly thicker, heavier top-plate with a different arrangement of
@@ -366,7 +366,7 @@ Boxer is normally equipped with a combination Wi-Fi + Bluetooth module.
366366
If this is your first unboxing, ensure that Boxer's wireless antennae are firmly screwed on to the chassis.
367367
Boxer is equipped with a Backpack Computer mounted to the top of the Base Unit. The Base Unit is
368368
also equipped with an internal computer. This section explains how to configure the networking for the Backpack Computer only. For
369-
instructions on connecting the Base Unit's computer to a network, refer to the [OTTO 100 Documentation](https://help.ottomotors.com).
369+
instructions on connecting the Base Unit's computer to a network, refer to the [OTTO 100 Documentation](https://docs.ottomotors.com).
370370

371371
#### Enabling the OTTO App
372372

@@ -376,7 +376,7 @@ Configure your laptop to have a static IP address on the 10.255.255.0/16 subnet,
376376

377377
Open a web browser and navigate to http://10.255.255.1:8090. You will be promted to enter your network credentials.
378378

379-
Refer to [OTTO Motors' documentation](https://help.ottomotors.com/latest/commissioning/connecting-a-robot-to-the-network)
379+
Refer to [OTTO Motors' documentation](https://docs.ottomotors.com/en/30495-30526-connecting-a-robot-to-a-network.html)
380380
for more details on configuring the Base Unit's networking.
381381

382382
#### First Connection
@@ -770,7 +770,7 @@ For details on updating Boxer software or firmware, refer to [Software Maintenan
770770

771771
Boxer includes the latest autonomy software from OTTO, including [Fleet Manager](https://ottomotors.com/fleet-manager).
772772

773-
Please refer to [OTTO Motors' documentation](https://help.ottomotors.com) and the OTTO 100 user manual
773+
Please refer to [OTTO Motors' documentation](https://docs.ottomotors.com) and the OTTO 100 user manual
774774
for details on how to use OTTO's advanced autonomy software
775775

776776
:::
@@ -987,11 +987,11 @@ The details of each test are shown below.
987987

988988
This test also the robot's model is loaded into the `robot_description` ROS parameter.
989989

990-
- **E-Stop Test**
990+
- **Emergency Stop Test**
991991

992-
The **E-Stop Test** checks that the robot's E-Stop is working properly.
992+
The **Emergency Stop Test** checks that the robot's emergency stop is working properly.
993993

994-
This test subscribes to the `/platform/emergency_stop` ROS topic and checks that when the E-Stop is manually engaged and disengaged by the user, the E-Stop states are correctly reported on the `/platform/emergency_stop` ROS topic.
994+
This test subscribes to the `/platform/emergency_stop` ROS topic and checks that when the emergency stop is manually engaged and disengaged by the user, the emergency stop states are correctly reported on the `/platform/emergency_stop` ROS topic.
995995

996996
- **Rotate Test**
997997

docs/robots/indoor_robots/boxer/user_manual_boxer.mdx

Lines changed: 93 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,25 @@ import ComponentUsingRos from "/components/using_ros.mdx";
1212
import ComponentCommonSafeWorkProcedures from "/components/common_safe_work_procedures.mdx";
1313
import ComponentSafetyWarning from "/components/safety_warning.mdx";
1414

15+
import Tabs from "@theme/Tabs";
16+
import TabItem from "@theme/TabItem";
17+
1518
<ComponentIntroductionBoxer />
1619

1720
## Introduction
1821

1922
Boxer is a large indoor mobile robot for prototyping and development of industrial applications.
20-
Adapted from the OTTO Motors _OTTO 100 V2.4 autonomous mobile robot (AMR)_, Boxer is programmable
23+
Adapted from the OTTO Motors _OTTO 100 autonomous mobile robot (AMR)_, Boxer is programmable
2124
and easily extensible with additional hardware.
2225

26+
:::note
27+
28+
Current Boxer shipments are based on OTTO 100 V2.5. Some shipments from 2021-2023 are based on
29+
OTTO 100 V2.4. All information in this manual applies equally to both versions except where
30+
otherwise noted.
31+
32+
:::
33+
2334
<ComponentSafetyWarning />
2435

2536
### Shipment Contents
@@ -37,28 +48,53 @@ If you elected to purchase standard payload modules or custom integration servic
3748

3849
#### System Architecture
3950

40-
Boxer is built on the OTTO 100 AMR, which provides the core locomotion, safety, and sensing cababilities, along with a ROS2 API
51+
Boxer is built on the OTTO 100 AMR, which provides the core locomotion, safety, and sensing capabilities, along with a ROS 2 API
4152
for control of the system. Boxer is typically augmented with a Backpack Computer, which allows for user software to be installed
42-
and executed on the system, controlling the Base Unit through the ROS2 API over a local Ethernet connection. The backpack
53+
and executed on the system, controlling the Base Unit through the ROS 2 API over a local Ethernet connection. The backpack
4354
computer also allows for control and monitoring of any additional payloads added to Boxer.
4455

4556
#### Exterior Features
4657

47-
Below is an overview of the Boxer robot hardware that outlines the key components that you should be aware of in order to get started with using your robot.
48-
49-
<center>
50-
<img
51-
src="/img/robot_images/boxer_images/robot_boxer_3.png"
52-
width="800"
53-
/>
54-
</center>
58+
Below is an overview of the Boxer robot hardware that outlines the key components that you should be aware of in order to get started
59+
with using your robot. Note that the front emergency stop button is only present on Boxer V2.5.
5560

56-
<center>
57-
<img
58-
src="/img/robot_images/boxer_images/robot_boxer_4.png"
59-
width="800"
60-
/>
61-
</center>
61+
<Tabs groupId="boxer_versions">
62+
<TabItem
63+
value="V24"
64+
label="V2.4"
65+
>
66+
<center>
67+
<img
68+
src="/img/robot_images/boxer_images/robot_boxer_3.png"
69+
width="800"
70+
/>
71+
</center>
72+
<center>
73+
<img
74+
src="/img/robot_images/boxer_images/robot_boxer_4.png"
75+
width="800"
76+
/>
77+
</center>
78+
</TabItem>
79+
<TabItem
80+
value="V25"
81+
label="V2.5"
82+
default
83+
>
84+
<center>
85+
<img
86+
src="/img/robot_images/boxer_images/robot_boxer_v25_3.png"
87+
width="800"
88+
/>
89+
</center>
90+
<center>
91+
<img
92+
src="/img/robot_images/boxer_images/robot_boxer_v25_4.png"
93+
width="800"
94+
/>
95+
</center>
96+
</TabItem>
97+
</Tabs>
6298

6399
#### Human-Machine Interface (HMI) Panel
64100

@@ -67,9 +103,9 @@ The HMI has 5 elements:
67103

68104
1. Ethernet port
69105
2. Power button
70-
3. Motion Stop reset button
106+
3. Emergency stop reset button
71107
4. Chargeport
72-
5. Motion Stop button
108+
5. Rear emergency stop button
73109

74110
<center>
75111
<img
@@ -78,15 +114,30 @@ The HMI has 5 elements:
78114
/>
79115
</center>
80116

117+
#### Front Emergency Stop Button
118+
119+
In addition to the rear emergency stop button described in the HMI Panel above, Boxer 2.5 (but not Boxer 2.4)
120+
has a front emergency stop button, which is mounted to the right of the front safety LiDAR. Refer to
121+
[Emergency Stop Buttons](#boxer-stop-buttons) for additional details.
122+
123+
<center>
124+
<img
125+
src="/img/robot_images/boxer_images/robot_boxer_13.jpg"
126+
width="100"
127+
/>
128+
</center>
129+
130+
<!-- TODO: add picture of front estop when available. -->
131+
81132
#### Body Lights
82133

83134
Boxer includes RGB LED strips around its body. These lights express system status according to the table below.
84135

85-
| LED Pattern | System State |
86-
| :------------ | :------------------------------------------------------------------------- |
87-
| Solid Red | Robot is starting up |
88-
| Flashing Red | Robot is E-Stopped or Safety Stopped |
89-
| Circling Blue | Base Unit is in Manual mode, allowing it to be controlled via the ROS2 API |
136+
| LED Pattern | System State |
137+
| :------------ | :-------------------------------------------------------------------------- |
138+
| Solid Red | Robot is starting up |
139+
| Flashing Red | Robot is emergency stopped or safety stopped |
140+
| Circling Blue | Base Unit is in Manual mode, allowing it to be controlled via the ROS 2 API |
90141

91142
At present these lights are not controllable through any ROS topics.
92143

@@ -176,7 +227,8 @@ Pull the robot out of the crate by hand, and then roll the robot down the wood r
176227
### Base Unit Configuration
177228

178229
Connect the Boxer to the Wi-Fi network using the steps below.
179-
Refer to [Connecting a Vehicle to Your Network](https://help.ottomotors.com/sw220/commissioning/connecting-a-vehicle-to-your-network) and [Connecting to an OTTO 100](https://help.ottomotors.com/sw220/commissioning/connecting-to-a-vehicle/connecting-to-an-otto-100) for more details.
230+
Refer to [Connecting to a robot using an Ethernet cable](https://docs.ottomotors.com/en/30495-30527-connecting-to-a-robot-using-ethernet.html) and
231+
[Connecting a robot to a network](https://docs.ottomotors.com/en/30495-30526-connecting-a-robot-to-a-network.html) for more details.
180232

181233
1. Configure a network port on your laptop with the IP address <10.255.255.200>.
182234
2. Connect a network cable from the port on your laptop to the network port on the rear of the Base Unit.
@@ -308,7 +360,7 @@ To connect the Backpack Computer to a wireless network follow these steps:
308360

309361
### Battery Charging
310362

311-
The system can be charged using an [OTTO 100 Manual Charger](https://help.ottomotors.com/docs/chargers/otto-100-manual-charger) or an [OTTO 100 Fast Charger](https://help.ottomotors.com/docs/chargers/otto-100-fast-charger).
363+
The system can be charged using an [OTTO 100 Manual Charger](https://ebikes.ca/product-info/grin-products/cycle-satiator.html) or an [OTTO 100 Fast Charger](https://docs.ottomotors.com/en/84902-86097-100-fast-charger.html).
312364
Details for use and installation are provided in the linked User Manuals.
313365

314366
Only use the OTTO 100 Manual Charger or OTTO 100 Fast Charger provided with your Boxer.
@@ -326,7 +378,7 @@ There are several methods of operating the robot.
326378
This section details how to get the Robot driving around using the OTTO user interface.
327379

328380
1. Power on the system.
329-
2. Ensure that the Motion Stop is released by pulling out the red button at the rear of the unit, and then pressing the blue Reset button.
381+
2. Ensure that all emergency stop buttons are released by pulling out the red buttons at the front (V2.5 only) and rear of the unit, and then pressing the blue emergency stop Reset button.
330382
<center>
331383
<img
332384
src="/img/robot_images/boxer_images/robot_boxer_13.jpg"
@@ -387,7 +439,7 @@ To use the controller:
387439
1. Power up the robot and connect to the OTTO App at `http://<hostname>:5000`
388440
2. The system will boot up into a neutral state.
389441
Take the robot out of _Neutral_ by clicking the _Joystick_ icon at the bottom right of the interface.
390-
3. Release the E-Stop.
442+
3. Release all emergency stop buttons and press the emergency stop reset button.
391443
4. Press the PS button on the controller to sync with the robot.
392444
Once the blue LED on the top of the controller is solid, the Robot is paired and ready to move.
393445
Hold the L1 trigger button to engage the enable switch.
@@ -496,28 +548,28 @@ Operating at such speeds will allow for more reaction time in the case of unexpe
496548

497549
When the robot is operating, keep clear of the wheels.
498550

499-
Refer to the [OTTO 100 V2.4 Operation and Maintenance Manual](https://help.ottomotors.com/docs/robots/otto-100-v2-4?preview=/53683025/99909709/OMM-000094-Operation%20and%20Maintenance%20Manual%20OTTO%20100%20V2.4_A.pdf) for further safety precautions when using self-driving vehicles.
551+
Refer to the [OTTO 100 V2.5 Operation and Maintenance Manual](https://docs.ottomotors.com/PDFs/100-v2.5-OMM.pdf) for further safety precautions when using self-driving vehicles.
500552

501-
### E-Stop Button {#boxer-stop-button}
553+
### Emergency Stop Buttons {#boxer-stop-buttons}
502554

503555
:::warning
504556

505-
Ensure the E-Stop button is accessible at all times.
506-
Avoid mounting payloads that extend over the rear of Boxer and would occlude the E-Stop button.
557+
Ensure the emergency stop buttons are accessible at all times.
558+
Avoid mounting payloads that extend over the front or rear of Boxer and would occlude the emergency stop buttons.
507559

508560
:::
509561

510-
Please take time to locate the red E-Stop button on the rear-right of the system.
511-
The e-stop function allows a person in the physical vicinity of the robot to halt its motion and prevent re-initiation of motion.
512-
This e-stop system is intended for use in emergency situations.
513-
The e-stop system should not be used as the means of controlling robot motion during regular operation.
562+
Please take time to locate the red emergency stop buttons on the front (V2.5 only) and rear and of the system.
563+
The emergency stop function allows a person in the physical vicinity of the robot to halt its motion and prevent re-initiation of motion.
564+
This emergency stop system is intended for use in emergency situations.
565+
The emergency stop system should not be used as the means of controlling robot motion during regular operation.
514566

515-
When the E-Stop button is pressed, it provides a secure way to stop the robot movement, but does not control power attached by the attachment panel.
516-
The e-stop function can be reset by pulling out the red E-Stop button until it returns to an extended position and then pressing the E-Stop Reset button.
517-
The robot may begin moving again immediately after the E-Stop Reset button has been pressed.
567+
When any emergency stop button is pressed, it provides a secure way to stop the robot movement, but does not control power attached by the attachment panel.
568+
The emergency stop function can be reset by pulling out all the red emergency stop buttons until they return to an extended position and then pressing the emergency stop reset button.
569+
The robot may begin moving again immediately after the emergency stop reset button has been pressed.
518570

519-
When in e-stop mode, the light strip will be flashing red and Boxer will not drive.
520-
The commands received during e-stop mode are not buffered; Boxer will always act on the latest commands received.
571+
When in emergency stop mode, the light strip will be flashing red and Boxer will not drive.
572+
The commands received during emergency stop mode are not buffered; Boxer will always act on the latest commands received.
521573
This means that if the commands are stopped before the stop is released, the Boxer will not move.
522574
If the commands are continued, Boxer will move at the speed commanded once the stop is released.
523575

docs_outdoornav_user_manual/cpr_hardware.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -397,9 +397,9 @@ below.
397397

398398
For further information please refer to [these instructions](https://swiftnav.freshdesk.com/support/solutions/articles/44001907898-rtk-heading-gnss-compass-configuration%7D%7Bhttps://swiftnav.freshdesk.com/support/solutions/articles/44001907898-rtk-heading-gnss-compass-configuration).
399399

400-
## Wireless E-Stop
400+
## Wireless Motion Stop
401401

402-
Please refer to the hardware user manual of the E-Stop device for proper
402+
Please refer to the hardware user manual of the motion stop device for proper
403403
usage. A trained operator should be used to supervise navigation of the
404404
UGV under autonomous control at all times. The Operator should be
405-
familiar with the use of the Wireless emergency stop device.
405+
familiar with the use of the wireless motion stop device.

docs_outdoornav_user_manual/getting_started/first_time_checklist.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ how to set the docking location.
7878

7979
### ☐ Is the Navbar status icon functioning?
8080

81-
To check if the Navbar icon is functioning, trigger the UGV's e-stop
81+
To check if the Navbar icon is functioning, trigger the UGV's motion stop
8282
and check to see if it has turned to a red icon. Clicking the icon
8383
will bring up the status information as well as any recent messages
8484
(see below).

docs_outdoornav_user_manual/overview/overview_introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Key features of OutdoorNav Software include:
7070
camera image) or user provided functions
7171
- View the robot's live position and attitude on the map
7272
- Display robot data such as velocity, signal strength, status
73-
of the E-Stop, status of navigation system, and battery charge
73+
of the motion stop, status of navigation system, and battery charge
7474
- Save and export Missions
7575

7676
- Application Programming Interface (API)

0 commit comments

Comments
 (0)