Botlink XRD User manual

Botlink XRD
Documentation Revision 2.7

Revision History
Customer Support
Product Description
Supported Airframe Types
Supported Message Protocols
Supported Manufacturers
Supported cellular carriers
Mechanical
Size, weight, and power
Ports
Antennas, modem, and SIM
Getting Started
1 Install the Botlink Relay software
2 Register your Botlink XRD
3 Configure the Botlink Relay software
Configuring UDP
Configuring TCP
Configuring Serial
[Optional] Configure GoPro Video Streaming
4 Configure your Ground Control Station
QGroundControl - TCP
QGroundControl - UDP
5 Install the Botlink XRD on your drone
5.1 Mounting the XRD
5.2 Connect the serial cable
5.3 Connect the power cable
5.4 Connect the antennas
6 Configure the Botlink XRD
6.1 Configuring the cellular service
6.2 Configuring the autopilot connection
With a configuration file
Without a configuration file (legacy)
6.3 [Optional] Configuring Video Streaming
6.4 [Optional] Configuring cell network metrics logging
1

7 Connect to your drone
7.1 [Optional] Start video streaming
Additional & optional tasks
WiFi Configuration
Determining the XRD Hardware ID
Determining Software Version
Software Updates
Force re-installation
Troubleshooting
XRD Remix status light diagnostic codes
Status Light
Network Light
Power Light
XRD Vanilla status light diagnostic codes
FCC Declaration of Conformity
2

Revision History
Version
Date
Notes
2.0
29 Oct 2018
Version 2.0 release
2.1
20 Mar 2019
Instructions for finding XRD ID
2.2
13 Apr 2019
Expected autopilot configuration
2.3
30 Jun 2019
Added sections on Wifi & Autopilot
configuration using config.toml; updated
status light section; added language about
beta support for Micropilot autopilots
2.4
24 Jul 2019
Add UART voltage information
2.5
16 Aug 2019
Update Quickstart
2.6
30 Oct 2019
FCC Declaration of Conformity; various
reorganizations
2.7
13 Mar 2020
Updated status light documentation; added
cell data logging documentation and video
documentation
Customer Support
Customer support is available 9 am - 5 pm, excluding weekends and holidays.
For phone support, dial +1 [phone] and ask to speak to customer support.
For email support, email [email protected].
3

Product Description
The Botlink XRD (eXtended Range Datalink) is a secure drop-in replacement for your existing
serial drone radio that allows you to control your drone using cellular networks from anywhere in
the world over the internet via a 128-bit AES encrypted and authenticated connection. About the
size of a deck of cards, and weighing about as much as a 60 watt lightbulb , the Botlink XRD
1
can be mounted on a variety of drones, from small quadcopters to large fixed-wing aircraft.
Botlink provides a variety of applications that enable you to continue using your existing ground
control software and workflow with the XRD, making it easy to incrementally adopt the Botlink
XRD for use with your drone fleet.
Supported Airframe Types
The Botlink XRD passes traffic from the autopilot to the ground control station, and therefore
supports any airframe type that the autopilot supports.
Supported Message Protocols
The Botlink XRD supports the following messaging protocols.
Protocol
Version
Notes
Mavlink
1
Example autopilots: Pixhawk,
Pixhawk 2, ArduPilotMega,
PixFalcon
2
Micropilot
Any
Beta
Supported Manufacturers
The Botlink XRD is broadly compatible with products from manufacturers that use the
Supported Message Protocols discussed in the previous section.
Consumer drones from DJI and other manufacturers which use proprietary communications
protocols are not supported.
1 Without enclosure or antennas
4

Supported cellular carriers
The Botlink XRD supports a variety of cellular carriers through the ability to swap modems & sim
cards. Carrier support includes, but is not limited to Verizon, AT&T, TMobile, Rogers, Telus,
Orange, and various other European carriers. For a list of supported modems and cellular
bands, see the Modem, Antennas, and SIM section
Mechanical
The Botlink XRD can be used either with an enclosure or without an enclosure. The enclosure
offers increased splash and dust resistance .
2
Size, weight, and power
Size & Weight
Power
Metric
Imperial
Input Voltage
5.5 - 30V
Weight, w/ enc:
36 grams
1.27 oz
Typical Power
1.5W
Weight, w/o enc:
61 grams
2.15 oz
Peak Power
10W + 2.5W per USB Port
Height:
22.1 mm
0.83 in
Operating Limits
Width:
64.7 mm
2.55 in
Temperature
0 to 40 C (32 to 104F)
Depth:
51.2 mm
2.02 in
Rel Humidity
0 - 85%
2 The Botlink XRD has not been tested for moisture or dust resistance using any industry
standards (i.e. IPX8).
5

Ports
The Botlink XRD include 2 Micro-USB B ports, 1 UART port, 1 power port, 1 I2C port, and 1
power port.
Power
Remote Switch
3
UART (3.3V)
P/N 43645-0200
P/N DF13-3S-1.25C
P/N DF13-6S-1.25C
Pin
Description
Pin
Description
Pin
Description
1
Positive
1
3.3 V
1
No Connect
2
Ground
2
LED
2
XRD RX
3
Press Detect
3
XRD TX
4
XRD RTS
5
XRD CTS
6
Ground
I2C
4
P/N DF13-4S-1.25C
Pin
Description
1
5 Volts
2
SCL
3
SDA
4
Ground
3 Not currently used
4 Not currently used
6

Antennas, modem, and SIM
The Botlink XRD modem, antennas, and SIM are field-swappable. Enclosure removal is
required to swap the modem or SIM. Please contact Botlink prior to swapping your modem to
ensure that the firmware supports the modem you are attempting to use.
Antennas
Name
Type
Part Number
Taoglas TG.30.8113 - A, ll/ GPS/Wifi Antenna
Rigid
TG.30.8113
Taoglas FXUB66.01.0305C
Flex
FXUB66.01.0305C
Modems
Name
4G Bands
3G Bands
Carriers Supported
NL-SW-LTE-TSVG
B4, B13
None
Verizon
NL-SW-LTE-TNAG
NL-SW-LTE-TNAG-B
B2, B5, B4, B17
B2, B5
AT&T, TMobile
NL-SW-LTE-TEUG
B3, B7, B20
B1, B5, B8
Various European
NL-SW-LTE-QBG96
B1, B2 B3, B4,B5, B8,
B12, B13, B18,B19,
B20, B26, B28, B39
None
2G fallback on
GSM850,GSM900,DC
S1800,PCS1900
Verizon, TMobile,
AT&T, Sprint,
Telus,
Various European
7

Getting Started
Getting started with the Botlink XRD is quick and easy. You’ll only need a computer with an
internet connection to create a Botlink account, register your XRD, and install some software,
and a work area with a flat surface that you use to install the Botlink XRD hardware on your
drone.
1 Install the Botlink Relay software
The first step to using your Botlink XRD is installing the Botlink Relay software. The Botlink
Relay software enables you to connect your ground control station to your Botlink
XRD-equipped drone without any modifications. The Botlink Relay software is available for Mac
and PC.
Download links are listed below.
OS
Version
Link
Windows
32 Bit
https://botlink-relay-artifacts.s3.us-east-2.amazonaws.com/archive/B
otlink-Relay-win32-ia32-v1-4-0-beta-2.zip
64 Bit
https://botlink-relay-artifacts.s3.us-east-2.amazonaws.com/archive/B
otlink-Relay-win32-x64-v1-4-0-beta-2.zip
Mac
64 Bit
https://botlink-relay-artifacts.s3.us-east-2.amazonaws.com/archive/B
otlink-Relay-darwin-x64-v1-4-0-beta-2.zip
2 Register your Botlink XRD
Once the Botlink Relay software is installed, you’re ready to register your Botlink XRD to your
account. To register your XRD, you’ll need to know the Hardware ID of your unit. This should
have been provided to you as part of your order documentation. If it wasn’t, or you can’t find the
information, see the “Determining the XRD Hardware ID” section below.
To register your Botlink XRD
1. Open the Botlink XRD Tray App
2. Enter your username and password
3. Click “Login”
4. Switch to the tab
8

5. Click “Register an XRD” and input the Hardware ID for the XRD.
3 Configure the Botlink Relay software
In order to use your existing ground control station and other software applications with the
Botlink XRD, you’ll need to tell the Botlink Relay software how your software will communicate --
using TCP, UDP, or Serial .
5
Configuring the Botlink Relay Software is simple.
Configuring UDP
1. Open the Botlink XRD Tray App
2. Enter your username and password
3. Click “Login”
4. Select the UDP Connection method
5. Enter a port
a. The “Listen” port will receive data from the Ground Control Software
b. The “Write Port” will transmit data to the Ground Control Software
6. Select a Botlink XRD to connect to
7. Click the start button
Configuring TCP
1. Open the Botlink XRD Tray App
2. Enter your username and password
3. Click “Login”
4. Select the TCP Connection method
5. Enter a port
6. Select a Botlink XRD to connect to
7. Click the start button
Configuring Serial
1. Open the Botlink XRD Tray App
2. Enter your username and password
3. Click “Login”
4. Select the Serial Connection method
5 Serial support only available on Windows
9

5. Select a port
6. Enter the baud rate
7. Select a Botlink XRD to connect to
8. Click the start button
[Optional] Configure GoPro Video Streaming
1. Open the Botlink XRD Tray App
2. Enter your username and password
3. Click “Login”
4. Click “Add Stream”
5. Enter “video” for the stream name
6. Select “udp” for the type
7. Select a Listen Port (currently unused)
8. Select a Write Port to receive video
a. This is the UDP port that the video will be broadcast to. You’ll need to configure
your video playback software (e.g. VLC) to listen for UDP video from the port you
selected
4 Configure your Ground Control Station
Now that you’ve configured the Botlink Relay application, you’ll need to make sure that your
application is configured to communicate with your drone through the Botlink Relay software.
This process varies depending on the software, but the following example of configuring
QGroundControl should help you get started.
To configure QGroundControl to use the Botlink Relay software to connect to your drone, do the
following.
QGroundControl - TCP
1. Open QGroundControl
2. Click on the “Q” in the upper left corner
3. Click on “Comm Links”
4. Click “Add”
5. Select “TCP” as the type
6. Enter a name for your connection
7. Enter 127.0.0.1 in the Host Address field
8. Enter the port number from the Botlink Tray app in the TCP port field
9. Click “OK”
10. Click “Connect”
10

QGroundControl - UDP
1. Open QGroundControl
2. Click on the “Q” in the upper left corner
3. Click on “Comm Links”
4. Click “Add”
5. Select “UDP” as the type
6. Enter a name for your connection
7. Enter the “Write Port” number from the Botlink Tray App in the Listening Port field
8. Under Target Hosts, click Add
9. Enter 127.0.0.1: followed by the “Listen Port” number from the Botlink Tray App
a. Ex: 127.0.0.1:1024
10. Click “OK”
11. Click “Connect”
5 Install the Botlink XRD on your drone
Once the application and Botlink Relay have been configured, it’s time to install the Botlink XRD
on your drone. This process varies depending on the drone, but generally speaking you’ll need
to identify a mounting location on the drone for the Botlink XRD (either with or without
enclosure) and attach the unit, connect the serial cable, connect the power cable, and connect
the antennas.
5.1 Mounting the XRD
Mounting the Botlink XRD is a straightforward process. Customers have used everything from
rubber bands to Velcro to physically attach the Botlink XRD to their drone. When mounting the
Botlink XRD, keep in mind that it requires a connection to the autopilot and power in order to
function. The included power cable is approximately 12 inches long, and the included serial
cable is about 9 inches long. If you’re planning on using your Botlink XRD without the enclosure,
make sure that the unit is protected from dust and moisture. This is most easily accomplished by
mounting the enclosureless unit inside the drone fuselage.
5.2 Connect the serial cable
The serial cable included with the Botlink XRD is a 6-pin DFU cable that is suitable to use when
connecting to a Pixhawk autopilot. Either end of the cable can be connected to either the
autopilot or the XRD.
11

5.3 Connect the power cable
The power cable included with the Botlink XRD is suitable to use when connecting directly to a
3S to 7S battery LiPo battery.
5.4 Connect the antennas
The TAOglass antennas included with the Botlink XRD have an adhesive backing that makes
them easy to mount to most drone airframes.
6 Configure the Botlink XRD
Configuring the Botlink XRD can be accomplished using a MicroSD card. In order for the XRD to
successfully connect to the autopilot and cellular network, you’ll need to give the unit some
basic information about your drone’s autopilot and your cellular service.
6.1 Configuring the cellular service
To enable the XRD to connect to the cellular service and send and receive drone data, it needs
to know the Access Point Name (APN) used by your cellular service provider. This is a short
string of letters and numbers that is provided by a cellular service provider that lets your device
know where to look for service.
Generally speaking, the Botlink XRD ships with a pre-configured APN that is suitable for use
with consumer cellular plans provided by the major US cellular service providers. The following
table lists the default APNs used by the Botlink XRD.
Modem
Default APN
LTE-TSVG
VZWINTERNET
LTE-TNAG
phone
LTE-EU
N/A; Depends on carrier
If you have a business or enterprise account and have a custom APN, or have instructions from
your wireless provider to use a custom APN, the APN used by the Botlink XRD can be
configured as required.
NOTE
The APNs supported by the Botlink XRD depend on the installed
modem, sim card, and your wireless plan. Contact your wireless provider
for details on which APN to use with your Botlink XRD.
12

WARNING
Incorrectly changing the APN on your Botlink XRD may result in
● Loss of network connectivity
● Degradation or loss of all Botlink XRD functionality requiring a
network connection
● Roaming charges from your wireless provider
The APN is configured using the XRD_APN file on the microSD Card filesystem root.
To update the APN used by the Botlink XRD
1. Power down the drone
2. Remove the microSD card from the microSD card reader in the XRD
3. Insert the microSD card into your device’s microSD card reader
4. Open or create the XRD_APN file
NOTE
Ensure the XRD_APN file does not have a file extension such as .txt. A
file extension will cause the APN settings to be ignored.
5. On the first line of the file, enter the desired APN name
6. Save the file
7. Remove the microSD card from your device’s microSD card reader
8. Insert the microSD card into your Botlink XRD’s microSD card reader
9. Power on the drone
NOTE
Depending on the software version, the XRD_APN file is deleted from
the SDCard when the APN is successfully changed.
At this point, the Botlink XRD will update the internal APN configuration to use the APN
contained in the XRD_APN file.
6.2 Configuring the autopilot connection
The Botlink XRD can be configured to connect to a variety of different autopilots. Configuration
can be accomplished either using a configuration file on the Botlink XRD SDCard, or the legacy
configuration method can be used.
Each configuration method is described in the following sections.
13

With a configuration file
WARNING
If you configure your autopilot connection using the following steps, and
then subsequently remove the SDCard from your drone, the Botlink XRD
will attempt to connect to the autopilot using legacy MAVLink v1 settings,
as described in the “Without a configuration file (legacy)” section.
To configure your XRD’s autopilot connection, do the following:
1. Power down the drone
2. Remove the microSD card from the Botlink XRD, if installed
3. Insert the microSD card into your computer
4. Open or create the config.toml file on the SDCard
5. Add content to the file as shown, substituting either “mavlink” or “micropilot” and the
correct baud rate for your serial port as required
6. Save the file
7. Remove the microSD card from your computer
8. Insert the microSD card into the microSD card reader on your Botlink XRD
9. After the system is powered on, your device will attempt to connect to the autopilot using
your specified settings
Without a configuration file (legacy)
Depending on the model and firmware version of the MAVLink compatible autopilot on your
drone, you may have to update configuration settings to enable the autopilot and Botlink XRD to
communicate seamlessly.
NOTE
Autopilot configuration should be accomplished using the USB radio or
hardwire GCS connection provided with your drone
To configure your MAVLink compatible autopilot for use with the Botlink XRD
1. Determine which autopilot telemetry port the Botlink XRD uses for communication
2. Configure the autopilot telemetry port to send serial data with a 115200 baud rate, 8 data
bits, no parity bits, and 1 stop bit
14

3. Configure the autopilot telemetry port to send data using MAVLink V1 format
Autopilots from different manufacturers may have different names for the configuration settings,
and the process for changing the settings for specific autopilots is outside the scope of this
document. Consult the documentation provided by your autopilot manufacturer to determine the
method for changing the required settings.
After changing the settings on your autopilot, make sure to power cycle the autopilot and Botlink
XRD to ensure the new settings are applied.
6.3 [Optional] Configuring Video Streaming
The Botlink XRD supports streaming video from a GoPro Video Camera.
WARNING
Botlink XRD Video Streaming is currently in beta. While efforts have
been made to test and validate video streaming functionality, no
reliability guarantees can be made at this time. Configuration files
formats, supported cameras, and software version requirements may
change at any time.
Video streaming functionality is not a substitute for a ground
observer or visual line of sight requirements for drone operations.
Before you begin, make sure that your Botlink XRD is configured to connect to your GoPro’s
WiFi network.
To configure your drone to stream video
1. Power down the drone
2. Remove the microSD card from the Botlink XRD, if installed
3. Insert the microSD card into your computer
4. Open or create the config.toml file on the SDCard
5. Add content to the file as shown
6. Save the file
15

7. Remove the microSD card from your computer
8. Insert the microSD card into the microSD card reader on your Botlink XRD
6.4 [Optional] Configuring cell network metrics logging
The Botlink XRD supports logging various cell network metrics, such as RSSI, RSSQ,
connected tower, etc. A metrics file will be created on the SDCard and available post-flight.
To configure your XRD to log cell network metrics
9. Power down the drone
10. Remove the microSD card from the Botlink XRD, if installed
11. Insert the microSD card into your computer
12. Open or create the config.toml file on the SDCard
13. Add content to the file as shown
14. Save the file
15. Remove the microSD card from your computer
16. Insert the microSD card into the microSD card reader on your Botlink XRD
7 Connect to your drone
Now that you’ve installed your XRD on your drone, configured the Botlink Relay software, and
setup your GCS, you’re ready to connect to your drone.
To connect to your drone
1. Open the Botlink Relay software
2. Click start
3. Open QGroundControl
4. Select the connection you created
5. Click Connect
16

7.1 [Optional] Start video streaming
Once the drone is connected via the Botlink Relay application, you can start the video stream.
1. Click on the Status button
2. Click the Start Button located underneath the “Payload streams” heading
Additional & optional tasks
WiFi Configuration
The Botlink XRD can be configured to connect to a WiFi network to provide connectivity in areas
where cellular connections are poor, such as the inside of certain office buildings.
Configuration is handled by placing a file named config.toml on the SDCard.
NOTE
The contents of the config.toml file are case sensitive, and require
quotes around the wifi network name and password.
To configure your XRD to connect to a WiFi network, do the following:
1. Power down the drone
2. Remove the microSD card from the Botlink XRD, if installed
3. Insert the microSD card into your computer
4. Open or create the config.toml file on the SDCard
5. Add content to the file as shown, substituting your network name and password for the
placeholder values
6. Save the file
7. Remove the microSD card from your computer
8. Insert the microSD card into the microSD card reader on your Botlink XRD
9. After the system is powered on, your device should be connected to the WiFi network
17

Determining the XRD Hardware ID
The Botlink XRD’s Hardware ID is needed to register a Botlink XRD to an account. This is
written to a file at the root of the SDCard file system every power cycle.
To view the Hardware ID, do the following:
1. Insert a microSD card into the microSD card reader in your Botlink XRD
2. Power on your XRD
3. Wait 1 minute
4. Power down your XRD
5. Remove the microSD card from the microSD card reader in your Botlink XRD
6. Insert the microSD card from your Botlink XRD into the microSD card reader on your
device
7. View the contents of your micro SD card on your device
8. Open the file named XRD_HARDWARE_ID using Notepad
9. The contents of the file will be the Hardware ID of your Botlink XRD
Determining Software Version
The software version of the Botlink XRD is written to a file at the root of the SDCard file system
every power cycle.
To view the software version of the software installed on your Botlink XRD, do the following:
1. Insert a microSD card into the microSD card reader in your Botlink XRD
2. Power on your XRD
3. Wait 1 minute
4. Power down your XRD
5. Remove the microSD card from the microSD card reader in your Botlink XRD
6. Insert the microSD card from your Botlink XRD into the microSD card reader on your
device
7. View the contents of your micro SD card on your device
8. Open the file named XRD_OS_VERSION using Notepad
9. The contents of the file will be the software version of the software on your Botlink XRD
Software Updates
The Botlink XRD software can be updated using an SDCard. The update process should take
about 5 minutes.
18

WARNING
Ensure the UAV has fully charged batteries or is connected to external
power before starting the update process. Do not disconnect power
during the update process.
1. Download the latest XRD upgrade.tar.gz file to your computer
2. Power down the drone
3. Remove the microSD card from the Botlink XRD
4. Insert the microSD from the Botlink XRD card into your computer.
a. Your microSD card should be FAT32 formatted. Most should default to this. The
optimum microSD card Botlink suggests is the SanDisk Ultra PLUS UHS-1, no
larger than 32GB Remove all images/files from the XRD's microSD card.
5. Move the upgrade.tar.gz file to the XRD's microSD card
6. Eject the SDCard from your computer
7. Insert the card into the Botlink XRD
8. Power on the UAV
9. Once the update begins installing, the LED will stay either ON or OFF
10. After installation is complete the Status LED will illuminate
NOTE
The upgrade.tar.gz file is deleted from the SDCard when the upgrade is
successfully installed. If you are upgrading multiple XRDs, you will need
to copy the upgrade.tar.gz file to the SDCard again for each device that
will be upgraded.
Force re-installation
If the preceding steps do not result in a successful version upgrade, it may be necessary to
force a system update.
To force a system upgrade, do the following:
1. Power down the drone
2. Remove the microSD card from the reader on the Botlink XRD
3. Insert the microSD card into the microSD card reader on your device
4. Create a file named XRD_FORCE_UPGRADE
a. Ensure there is no file extension
5. Remove the microSD card from the reader on your device
6. Follow the normal installation instructions starting from step 7
19