D User Manual Jackal

Download as pdf or txt
Download as pdf or txt
You are on page 1of 15

JACKAL

UNMANNED GROUND VEHICLE

USER MANUAL
CONTENTS
1 Introduction 3

1.1 What’s Included . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.2 Hardware Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.3 System Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2 Getting Started 7

2.1 Wireless Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.1.1 Static IP Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.1.2 Connect to Jackal via SSH over ethernet . . . . . . . . . . . . . . . . . . . . . . . 8

2.1.3 Connect Jackal to Wireless Network . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.2 Remote ROS Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.3 Jackal Desktop Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

3 Apps 12

4 Charging & Battery Maintenance 13

5 Payload Integration Guide 14

5.1 Mechanical Mounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

5.2 Electrical Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

5.3 Software Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

6 Contact 15

Rev. 1.1.7 2 Jackal UGV


1 INTRODUCTION
Jackal is a rugged, lightweight, fast, and easy-to-use unmanned ground vehicle for ROS Indigo, presented
by Clearpath Robotics.

Jackal includes a standard internal PC, as well as basic IMU and GPS. Standard perception modules are
available, including URDF and simulator integration, and demonstration applications.

Please inquire with Clearpath Robotics for details. See Contact on page 15 for contact information.

1.1 What’s Included


Contained in your Jackal shipment are the following items:

• Jackal UGV
• 270 watt-hour lithium battery pack
• 110V/220V universal charger
• Sony Bluetooth controller
• Jackal User Manual

If you elected to purchase standard payload modules or custom integration services with Jackal, then addi-
tional equipment will be included per your specific configuration, plus further documentation as required.

1.2 Hardware Overview


Jackal’s external features include the mounting pattern on the lid panel, 190 mm diameter wheels, human
machine interface panel (HMI), and lid panel latches. The HMI panel is shown in Figure 1, and includes from
left: motor button, comms indictor, wifi indicator, battery indicator, and system power button.

Figure 1: HMI panel.

To access Jackal’s interior, actuate the latches under the front end of the lid, on the opposite end from the
HMI. When you lift the lid, you will see Jackal’s onboard Li-Ion battery pack, and its two connectors. The large
Anderson Power Pole connector is to supply power to Jackal and must be connected in order for Jackal to
operate. The smaller white Molex connector allows the battery pack to be charged inside Jackal while Jackal
is powered off. It is recommended to connect both. The interior components of Jackal are labeled in Figure 2.

Finally, you may undo the thumbscrews which hold Jackal’s computer tray to the lid. The tray lowers, revealing
Jackal’s onboard Mini-ITX PC, user power supplies, and internal user hardware mounting area. Please see

Rev. 1.1.7 3 Jackal UGV


Battery Connections
Battery Area

Internal Access Latches

Figure 2: Battery area inside Jackal.

User Tray Thumbscrews

User Power Supply

User Integration Area

Integrated Computer

Figure 3: Computer and user tray.

Rev. 1.1.7 4 Jackal UGV


Figure 3 and Figure 4 for the components of the tray and user power supplies. Note that the fused user
power is available as four-pin Molex connectors, or a plug-in screw terminal block. For more information on
integrating payloads electrically, see subsection 5.2, Electrical Integration.

High Current 24V User Power

GND 12V
User Power Ports
VBAT 5V

User Power Fuses

User Power Screw Terminals

5V

GND

12V

GND

24V

GND

Figure 4: User power supply.

1.3 System Architecture


Like many ROS robots, Jackal is built around an x86 PC running Ubuntu, paired with a 32-bit MCU. The MCU
handles IO, power supply monitoring, and motor control, as well as supplying data from the integrated IMU
and GPS receiver. The communication channel between the MCU and PC is a Full Speed USB connection,
with the MCU operating as a standard serial CDC device.

The communication protocol used is rosserial. An instance of the rosserial_server serial node is embedded
in the jackal_base node, where it is connected to Jackal’s kinematic controller.

Rev. 1.1.7 5 Jackal UGV


The key topics which comprise Jackal’s ROS API are given in Table 1.

Topic Message Type Purpose


/cmd_vel geometry_msgs/Twist Input to Jackal’s kinematic controller. Publish here
to make Jackal go.
/odometry/filtered nav_msgs/Odometry Published by robot_localization, a filtered local-
ization estimate based on wheel odometry (en-
coders), integrated IMU, and integrated GPS.
/imu/data sensor_msgs/IMU Published by imu_filter_madgwick, an orientation
estimate based on Jackal’s internal gyroscope, ac-
celerometer, and magnetometer.
/navsat/fix sensor_msgs/NavSatFix Position fix from Jackal’s built in GPS receiver.
/navsat/vel geometry_msgs/TwistStamped Velocity over ground according to the integrated
GPS receiver.
/cmd_drive jackal_msgs/Drive Output from Jackal’s kinematic controller, input to
the motor controllers. Subscribe here for a lower-
level look at what’s going on.
/feedback jackal_msgs/Feedback High-frequency inputs from Jackal’s encoders and
motor current sensors.
/status jackal_msgs/Status Low-frequency status data for Jackal’s systems.
This information is republished in human readable
form on the diagnostics topic and is best con-
sumed with the Robot Monitor.

Table 1: Jackal ROS API Topics

Rev. 1.1.7 6 Jackal UGV


2 GETTING STARTED
The first step is to power up your Jackal and have some fun driving it around! If you’ve just unpacked Jackal
from its shipment packaging, you’ll need to open it up and connect the battery.

Press the power button on Jackal’s HMI panel. The LEDs should show a test pattern, after which you will
wait about 30 seconds for the internal PC to finish booting up.

Press the PS/P4 button on the Sony Bluetooth controller to sync the controller to Jackal. Once the small
red LED on the controller goes solid, you’re paired and ready to drive. Hold the L1 trigger button (deadman
switch), and push the left thumbstick forward to drive the Jackal. For full speed mode, hold the R1 trigger.
See Figure 5 for the Sony PS4 controls layout.

Deadman Switch [L1] Turbo [R1]


Full Speed Mode

Steer [Left Thumbstick]


Forward/Right/Backward/Left

Figure 5: PS4 Controls Layout

If you’re not seeing any action, check Contact on page 15 to get in touch with support.

2.1 Wireless Access


To get Jackal connected to your local wifi, you must first access the internal computer using a wired connection.
Open the chassis, lower the computer tray, and connect to the network port labeled STATIC with a standard
ethernet cable.

Rev. 1.1.7 7 Jackal UGV


2.1.1 Static IP Configuration

Set your laptop’s ethernet port to a static IP such as 192.168.1.51. To do this in Ubuntu, follow the steps
below:

1. Click on the Wifi icon in the upper-right corner of your screen, and select Edit Connections

2. In the Network Connections window, under Ethernet, select your wired connection and then click
Edit

3. Select the IPv4 Settings tab and then change the Method to Manual

4. Click the Add button to add a new address

5. Enter a 192.168.1.51 as the static IP under the Address column, and enter 255.255.255.0 under the
NetMask column, and then select Save

Figure 6: Static IP Configuration

2.1.2 Connect to Jackal via SSH over ethernet

The next step is to connect to Jackal via SSH. To do so execute the following in a terminal window:

ssh administrator@192.168.1.11

You will be promoted to enter a password. The default password is clearpath.

Rev. 1.1.7 8 Jackal UGV


2.1.3 Connect Jackal to Wireless Network

Now that you’re connected via SSH over a wired connection, you can setup Jackal to connect to a local wifi
network. To do this, you will use the wireless interface configuration daemon (WICD) - a preinstalled network
manager.

In a terminal window, execute the following command:

wicd-curses

You should see a browsable list of networks which the robot has detected. Use arrow keys to select the one
you would like to connect to, and then press the right arrow to configure it. You can enter your network’s
password near the bottom of the page, and note that you must select the correct encryption scheme; most
modern networks use WPA1/2 Passphrase, so if that’s you, make sure that option is selected. You also likely
want to select the option to automatically reconnect to this network, so that Jackal will be there for you on
your wireless automatically in the future.

When you’re finished, press F10 to save, and then C to connect. Jackal is now connected to wifi!

While you’re still wired to Jackal, you’ll need to identify the IP address of Jackal’s wireless connection.

In a terminal window, execute:

ifconfig

A list of network connections will be displayed within the terminal. Locate the wireless network and make
note of its IP address. Now that you know Jackal’s wireless IP address, you may now exit the ethernet SSH
session by executing exit.

Remove the ethernet cord and close up Jackal. Now you can SSH into Jackal over the wireless network. To
do so, execute:

ssh administrator@ <IP_OF_JACKAL >

SSH sessions allow you to control Jackal’s internal computer. You can do various things such as download
packages, run updates, add/remove files, transfer files etc.

2.2 Remote ROS Connectivity


To use ROS desktop tools, you’ll need your computer to be able to connect to Jackal’s ROS master. This will
allow you to run ROS commands like rostopic list, rostopic echo, rosnode list, and others, from a remote
PC and the output will reflect the activity on Jackal’s ROS master, rather than on your own machine. This can
be a tricky process, but we’ve tried to make it as simple as possible.

In order for the ROS tools on your computer to talk to Jackal, they need to know two things:

• How to find the ROS master, which is set in the ROS_MASTER_URI environment variable, and

Rev. 1.1.7 9 Jackal UGV


• How processes on the other computer can find your computer, which is the ROS_IP environment vari-
able.

The suggested pattern is to create a file in your home directory called remote-jackal.sh with the following
contents:

export ROS_MASTER_URI=http://cpr-jackal -0001:11311 # Jackal ’s hostname


export ROS_IP=10.25.0.102 # Your laptop ’s wireless IP address

If your network doesn’t already resolve Jackal’s hostname to its wireless IP address, you may need to add a
corresponding line to your computer’s /etc/hosts file:

10.25.0.101 cpr-jackal -0001

NOTE: You can verify the hostname and IP address of Jackal using the following commands during an SSH
session with the onboard PC.

hostname
hostname -i

Then, when you’re ready to communicate remotely with Jackal, you can source that script like so, thus defining
those two key environment variables in the present context.

source remote -jackal.sh

To verify that everything is set up propelry, try running a few ROS commands, such as the standard visual
ROS tools:

roslaunch jackal_viz view_robot.launch


rosrun rqt_robot_monitor rqt_robot_monitor
rosrun rqt_console rqt_console

If the tools launch, then everything is setup properly.

Please contact Clearpath Support if you need assistance in conifugring remote access. For more general
details on how ROS works over TCP with multiple machines, please see:

http://wiki.ros.org/ROS/Tutorials/MultipleMachines.

For help troubleshooting a multiple machines connectivity issue, see:

http://wiki.ros.org/ROS/NetworkSetup

Rev. 1.1.7 10 Jackal UGV


2.3 Jackal Desktop Packages
To command or observe Jackal from your desktop computer, first set up a basic ROS installation. See the
following page for details:

http://wiki.ros.org/indigo/Installation/Ubuntu

When your ROS install is set up, install the Jackal desktop packages:

sudo apt-get install ros-indigo -jackal-desktop

Once your remote access to Jackal’s ROS master is configured (see options in subsection 2.2), you can
launch rviz, the standard ROS robot visualization tool:

roslaunch jackal_viz view_robot.launch

From within rviz, you can use interactive markers to drive Jackal, you can visualize its published localization
estimate, and you can visualize any attached sensors which have been added to its robot description XML
(URDF).

Additionally from the desktop, you can launch the standard RQT Robot Monitor, which watches the diagnostic
output from Jackal’s self-montoring capabilities:

rosrun rqt_robot_monitor rqt_robot_monitor

Rev. 1.1.7 11 Jackal UGV


3 APPS
When equipped with a laser scanner as is available in the Gazebo simulation, Jackal works with the standard
ROS navigation stack. See http://wiki.ros.org/jackal_navigation.

A standard outdoor GPS autonomy demonstration using Jackal’s built-in sensing is planned, as well as a
calibration app for the internal magnetometer.

Rev. 1.1.7 12 Jackal UGV


4 CHARGING & BATTERY MAINTENANCE
Jackal’s Li-Ion battery pack may be charged internal to the chassis—simply plug in the charger to the charge
port located under the rear fender. Charging will occur when Jackal is powered down.

Alternatively, if you have multiple battery packs, you can easily lift the lid and remove the battery for external
charging. When charging externally, remove the pigtail which adapts the charger to the platform’s weather
sealed charge port.

The battery pack is manufactured for Clearpath Robotics by AllCell Technologies. The pack includes inte-
grated protections against fault due to overcurrent, overdischarge, and short circuit. The pack is rugged and
designed for the demanding environments into which Jackal may be deployed.

However, please take note of the following:

• The pack must not be stored or operated above 60 ◦C or below −19 ◦C.

• The pack must not be punctured or disassembled.

• The pack should be dropped off or delivered to your local hazardous waste authority for disposal.

• When traveling with Jackal, consult your airline’s restrictions regarding lithium battery packs. If possible,
bring the pack in your carry on luggage, where it will be subject to normal cabin temperatures and
pressures.

Please contact Clearpath Robotics for additional information about Jackal’s battery or for information about
purchasing additional packs.

Rev. 1.1.7 13 Jackal UGV


5 PAYLOAD INTEGRATION GUIDE
If you’re wanting to attach custom hardware to Jackal, you’ll have to take care of mechanical mounting, elec-
trical supply, and software integration. This section aims to equip you with respect to these challenges.

5.1 Mechanical Mounting


For external payloads, the recommended configuration is manufacture a metal or plastic bracket which at-
taches to the 120 mm square mounting holes supplied in Jackal’s lid panel. The included thumbscrews use
an M5 thread, if you wish to replace them with conventional fasteners. As an alternative to manufacturing a
brand new plate, you may remove and modify one of the included ones.

For rear-facing or back-mounted payloads, it is also possible to replace (or drill into) the hatch panel which
covers over access to Jackal’s internal PC.

5.2 Electrical Integration


Except for bus-powered USB cameras, most payloads have separate leads for power and data. Data con-
nections may be brought through the hatch and connected directly to the internal computer. Both of Jackal’s
internal computer options support USB3 and Ethernet connectivity. With the performance PC, the PCIe slot
may be used to supply Firewire, Thunderbolt, or additional USB3 ports, as necessary.

Additionally, the internal mounting area may be used for an Ethernet switch, when attaching multiple Ethernet
payloads, or for a PoE power injector as required.

The power lead may likewise be brought through the hatch, and connected to the User Power Board. Pull out
the black terminal block, and use a small screwdriver to securely attach power leads to it. Confirm voltage
and polarity before reconnecting the terminal block.

You may also choose to terminate your payload’s power lead with the appropriate crimps and pins for the
four pin Molex connector— this option may be more convenient if you expect to be adding and removing
your payload from Jackal more frequently and would prefer not to be fiddling with the terminal block. Contact
Clearpath Support for details about these parts.

5.3 Software Integration


ROS has a large ecosystem of sensor drivers, some of which include pre-made URDF descriptions and even
simulation configurations. Please see the following page on the ROS wiki for a partial list:

http://wiki.ros.org/Sensors

For the best experience, consider purchasing supported accessories from Clearpath Robotics for your Jackal,
which will include simulation, visualization, and driver support. However, we will happily assist you in integrat-
ing your own devices as well.

Rev. 1.1.7 14 Jackal UGV


6 CONTACT
Clearpath is committed to your success with Jackal. Please get in touch with us and we’ll do our best to get
you rolling again quickly: support@clearpathrobotics.com

To get in touch with a salesperson regarding Jackal or other Clearpath Robotics products, please email
sales@clearpathrobotics.com.

If you have a an issue that is specifically about ROS and is something which may be of interest to the broader
community, consider asking it on answers.ros.org. If you don’t get a satisfactory response, please ping us
and include a link to your question as posted there. If appropriate, we’ll answer in the ROS Answers context
for the benefit of the community.

Jackal is designed not to require regular maintenance. As it is a newer product, Clearpath appreciates your
patience as we understand its weak-point components and fill out the appropriate care instructions for the
platform.

Rev. 1.1.7 15 Jackal UGV

You might also like