Canary MLBase User manual

MLBase®
User's Guide
Revision A
December 2021

2 MLBase User's Guide
Canary Systems, Inc.
5 Gould Road
New London, NH 03257
USA
603-526-9800
www.canarysystems.com
Copyright and
Trademark
© 2021 Canary Systems, Inc. All rights
reserved. No part of the contents of this
book may be transmitted or reproduced in
any form or by any means without the
written permission of Canary Systems.
MLWeb®, Canary Systems®,
MultiLogger®, MLRemote®, MLBase®,
MLSuite®, and MLField® are Registered
Trademarks of Canary Systems, Inc.
Microsoft Edge®, Windows®, Windows
Server®, Excel®, and Microsoft Teams®
are registered trademarks of the Microsoft
group of companies. Chrome™ is a
trademark of Google, Inc. All other
trademarks and trade names are property
of their respective owners. All rights
reserved.
Disclaimer
The following document is provided to
assist users with the installation, operation,
and training in the use of our products. This
document and our products are intended to
be used by technically qualified personnel.
Contained herein is information that is
proprietary to Canary Systems® and may
not be reproduced or copied in any form,
nor disclosed to outside parties by any
means whether directly or indirectly,
without the written consent of Canary
Systems. This document is subject to
change without notice and Canary Systems
assumes no responsibility for errors,
omissions, or misinterpretation.
Furthermore, Canary Systems makes no
warranty as to the suitability of this
information and/or products for any given
application or use.
Warranty Policy
Canary Systems® warrants products
manufactured by Canary Systems,
excepting software products, to be free
from defects in materials and workmanship
under normal use and service for twelve
(12) months from date of shipment unless
specified otherwise. This warranty does not
apply to any Canary Systems products
which have been subjected to conditions
beyond the definition of “normal use”,
conditions including misuse, modification,
neglect, accidents of nature or shipping
damage. Accidents of nature include, but
are not limited to, damage due to lightning
or other electrical transients, damage due
to water or water vapor, damage due to
corrosive environments, damage due to
extreme weather conditions, or damage
due to vibration or seismic activity.
Batteries are not covered by warranty. Our
sole obligation under this warranty shall be
to repair or replace the defective product, at
our option. Under no circumstances shall
we be liable for special, incidental, or
consequential damages, including loss of
profits, regardless of whether we have
been advised that such damages may be
incurred. This warranty, and Canary
Systems® obligation here under, is in lieu
of all other warranties, expressed or
implied, including warranties of suitability
and fitness for a particular purpose.
Warranty Remedies
If the Canary Systems® Product fails
during the warranty period for reasons
covered by this Limited Warranty and you
notify Canary Systems of such failure
during the warranty period, Canary
Systems at its option will repair OR replace
the nonconforming Product, OR refund the
purchase price paid by you for the Product,
upon your return of the Product to Canary
Systems in accordance with Canary
Systems’ standard return material
authorization procedures.

MLBase User's Guide 3
High-Risk Activities
Products of Canary Systems® are not fault-
tolerant and are not designed,
manufactured or intended for use as on-line
control equipment in hazardous
environments requiring fail-safe
performance, such as in the operation of
nuclear facilities, aircraft navigation or
communication systems, air traffic control,
direct life support machines, or weapons
systems, in which the failure of the products
could lead directly to death, personal injury,
or severe physical or environmental
damage ("High Risk Activities"). Canary
Systems, Inc. and its suppliers specifically
disclaim any express or implied warranty of
fitness for High Risk Activities.
Documentation and
Release Notes
To obtain the most recent version of all
Canary Systems® technical
documentation, visit the User Guide
section of our website at
https://canarysystems.com/support/users-guides/.
Additionally, Canary Systems provides
additional information beyond the scope of
the technical documentation in the form of
Application Notes, Training Videos and
White Papers. Visit the Support section of
our website at
https://canarysystems.com/support/ to
view Application Notes, FAQ’s and videos,
and the Papers section of our website at
https://canarysystems.com/projects/papers/
to view a collection of Papers.
Revision History
Date
Rev.
Comments
12/23/2021
A
Initial Release

4 MLBase User's Guide
How To Use This Guide
Notes and Hints appear in boxes like this. Notes contain information you need to know to ensure that you use certain
features correctly, minimizing any errors. Hints indicate tips on how to use certain features more effectively, such as any
shortcuts to certain functions.
When you see a keyboard key’s name in bold angle brackets (< >), this indicates a particular keystroke you must
make in order to perform certain functions.
When you see two bolded locations separated by a vertical bar character (Location 1 | Location 2), this indicates
that the second location can be accessed only after the first. For example, an Import option that is available in a File
drop-down menu in a toolbar would be denoted with File | Import.
References to other Canary Systemsuser guides, third-party documentation or other external sources will appear
bolder and italicized. For example: For more information, see the MLWebHardware User's Guide.
Related Documentation
Visit the User's Guide page on the Canary Systems website to view and download the most current versions of our
technical documentation and user's guides at (https://canarysystems.com/support/users-guides/).
The following documents contain information that may be useful throughout the course of this manual:
▪MLWebHardware User's Guide for additional information on data collection and import.
▪MLWeb User's Guide for additional information on data visualization and presentation.
▪MLRemote User's Guide for additional information on configuring the MLRemote devices.
Technical Support
Canary Systems may be contacted directly via phone or email. Ongoing support via phone, email, and virtual
meeting platforms such as Microsoft Teamsand Zoom is available through the purchase of a support contract.
Please contact Canary Systems directly for more information.
Canary Systems, Inc.
5 Gould Road
New London, NH 03257
Phone: [phone]
Email: [e-mail]
Our website also provides numerous Application Notes, the latest versions of our software components, and all the
latest User's Guides. Click the Support menu at www.canarysystems.com to access these resources.

MLBase User's Guide 5
Table of Contents
Section 1 ‒ Introduction ................................................................................................................................................................6
1.1 Overview......................................................................................................................................................................................................6
1.2 Specifications...............................................................................................................................................................................................9
1.3 Connections...............................................................................................................................................................................................11
1.4 Items List ...................................................................................................................................................................................................12
Section 2 - MLBase Installation ..................................................................................................................................................13
2.1 Enclosure Installation.................................................................................................................................................................................13
2.2 Solar Panel Installation ..............................................................................................................................................................................15
2.3 AC Adaptor Installation ..............................................................................................................................................................................17
2.4 Antenna Installation....................................................................................................................................................................................18
Omnidirectional Antenna ....................................................................................................................................................................18
Wideband Yagi Antenna .....................................................................................................................................................................18
2.5 Battery Installation .....................................................................................................................................................................................20
Section 3 - xPico Configuration..................................................................................................................................................21
3.1 Overview....................................................................................................................................................................................................21
3.2 Connecting the xPico.................................................................................................................................................................................22
3.3 Configuring the xPico.................................................................................................................................................................................23
XML Programming..............................................................................................................................................................................23
CLI Configuration...............................................................................................................................................................................27
Common CLI Commands ...............................................................................................................................................................29
Section 4 ‒ MLWebHardware Configuration..............................................................................................................................31
4.1 MLBase Configuration................................................................................................................................................................................31
Information .......................................................................................................................................................................................31
Connection ........................................................................................................................................................................................32
Physical MLBase Connection Configuration ....................................................................................................................................33
Virtual Base Connection Configuration ............................................................................................................................................33
4.2 Collection Configuration.............................................................................................................................................................................35
4.3 Station Status.............................................................................................................................................................................................36
Appendix A - xPico Connection Via Browser............................................................................................................................37
Appendix B - Updating the MLBase XBee Network ID..............................................................................................................44

Section 1 ‒ Introduction
6 MLBase User's Guide
Section 1 ‒ Introduction
1.1 Overview
The Canary Systems®MLBase®is the communication station for the point-to-multipoint, programmable wireless
MLRemote®systems. This system consists of two components, a base communications station (CAN-MLBase) and
one or more wireless remotes (CAN-MLRemote).
Each network of MLRemotes communicate with a single MLBase. Multiple networks, each with their own MLBase
can be deployed.
A view of the MLBase enclosure is shown below:
Offline Mode and SD Card
The MLBase ships with a 32GB SD card already inserted into the MLBase module. The SD card allows the MLBase
to collect and store raw data from all MLRemotes on the network, as well as to store program updates prior to being
sent to the MLRemote stations.
This is ideal for units in remote locations with unreliable Wi-Fi connectivity, improving data collection with virtually no
gaps. The 32GB SD card can hold months to years’ worth of raw data, depending on the number of MLRemotes on
the network and program size of each MLRemote.
System Measurements
The MLBase is capable of reading its own panel temperature, humidity using a built-in digital humidity sensor, solar
and battery current, and recording the status of a switch closure input.

Section 1 ‒ Introduction
MLBase User's Guide 7
MLRemote Network Communication
Standard MLRemote devices communicate with their MLBase using an integrated Digi XBee 900Mz radio module.
Two versions of the 900MHz XBee are offered, the standard xBee SX Module and the XBee-Pro SX which uses a
higher power output, depending on the required transmission distance.
Note –An optional 2.4GHz Digi XBee module is also available. Contact Canary Systems for more information on these
models.
The integrated XBee modules allow for the MLBase to communicate with MLRemote devices easily at a distance of
up to 15km (9 miles) in most topographies using the standard antenna. A distance of up to 100km (60 miles) may be
achieved using an optional directional antenna with excellent topography.
Server Network Communication
The MLBase is also equipped with an integrated xPico 2.4/5 GHz module used for connecting the MLBase to a
site's network. The MLBase module has a built in Ethernet port for situations where a wired network is available.
The xPico module is used to receive program updates form MLWebHardware and to send data back to the server
where MLSuite is installed.
Note - In areas where a 2.4GHz signal is not available, an MLBase can be shipped with a cellular daughter board. Contact
Canary Systems for more information on these models.
Power
A 50AHr lead-acid battery provides power. Recharging is provided through a solar panel or AC power connection.
LED Status Lights
Several status LEDs are used for reporting basic system operation. All LEDs are controlled by the microcontroller to
allow for reduced power consumption by supporting "blinking" operation. Blink modes are specified for different
reporting conditions. LED status lights are available for the following:
GREEN (POWER LED) - A flashing green light indicates the system is powered and operating. A fixed green
light displays when the system is loading.
RED (CHARGE LED) - A flashing red light indicates the battery charging current:
▪Inactive - the current is less then 20mA
▪Flashing (single flash) - the current is up to 150mA
▪Fast Flashing (double flash) - the current is above 150mA
BLUE (Radio Link Active) - A flashing blue light indicates RF activity and whether the radio module is receiving
or transmitting.
YELLOW #1 (Local Area Network (LAN) Link) - A flashing yellow light indicates a valid LAN/WLAN link is
detected.
YELLOW #2 (Local Area Network (LAN) Active) - A second flashing yellow light indicates if there is any
LAN/WLAN link activity.

Section 1 ‒ Introduction
8 MLBase User's Guide
Firmware and SD Card LED Status Lights
Additional LED status indicators are active when loading firmware or inserting a SD card.
For the operations described below, retries are provided, it may be OK if there are a few failed attempts. But a
continuous error indication means failed operation. When the maximum number of retries is reached, the Bootloader
will reboot.
A single flash of all LEDs simultaneously means a system reboot and the Bootloader is initialized.
GREEN - Fast blinking of the Power LED occurs when the SD card is inserted but the File System is not
mounted.
▪If a SD card could not be mounted after insertion or if the card does not have the proper formatting
(FAT32) the Power LED will continue to fast blink.
▪In the case of a valid SD card, the Power LEDs will fast blink for a couple of seconds while the File
System is mounting, then will resume normal blinking.
RED - Each flash indicates a failed attempt to initialize the SD card. This means the SD card is not inserted or it
is corrupted.
BLUE - This blinking of this light means the Bootloader is working properly.
▪If the blue LED is blinking along with any other LED, this indicates the retry logic (see note below) when
initializing the SD card, mounting the File System and opening the Firmware file to update the NVM
memory.
▪If only the blue LED is blinking, each flash indicates the next 20KB from the Firmware file was stored to
Non Volatile Memory (NVM).
YELLOW #1 - Each flash indicates a failed attempt to perform an operation with the File System on the SD. This
may mean the Bootloader cannot find Firmware or Backup file on the microSD, but it can also mean any File
System corruption.
YELLOW #2 - Each flash indicates a failed attempt to perform an operation with the NVM when storing
Firmware blocks.
Warranty
The warranty for the MLBase is applicable for one year from the date of shipment. The warranty does not cover the
battery or failure by misuse or by nature including lightning, flood or other catastrophe.
Should you encounter problems with your MLBase, contact Canary Systems at the address listed in the front of this
manual.

Section 1 ‒ Introduction
MLBase User's Guide 9
1.2 Specifications
XPico Wired/Wireless Ethernet (used for communication with the Server Network)
Ports: RS-232 (DE-9), Ethernet (RJ-45)
Speed: 300 - 921.6kbps
Interface: Ethernet 10Base-T or 100Base-TX (Auto-sensing)
Standards: WPA, WEP, ARP, UDP/IP, TCP/IP, ICMP, SNMP, AutoIP, DHCP, TFTP, Telenet, HTTP
Security: 256-bit AES Encryption
Range (line-of-sight): 1 mile (1.31km) with directional antenna
Digi XBee (used for communication with MLRemotes)
RF Module: 900MHz
Standard Range with the XBee SX 900: Up to 15km (9miles)
Extended Range with the XBee-PRO®900: Up to 100km (60 miles) with directional antenna
RF Module: 2.4GHz (optional)
Range with the 2.4GHz XBee: Up to 3.2km (2miles)
Status LEDs
Power (green): Status of battery voltage
Charge (red): Status of charger output voltage
Activity (blue): Activity on radio link (from XBee)
LAN Link (yellow): Network link status (from Wi-Fi)
LAN Active (yellow): Network activity (from Wi-Fi)
System Measurements
Internal Temperature Measurement Range: -40 to +60 C (-40 to +140 F)
Internal Temperature Measurement Accuracy: 0.5 C (1 F)
Temperature Output: Degrees C or F
Internal Humidity Measurements Range: 0-100 % RH
Internal Humidity Measurements Accuracy: +/- 4.5%
Internal Voltage Measurement (Solar Panel): 0-20 VDC
Internal Voltage Measurement (Battery Input/Output): 0-16 VDC
Internal Voltage Measurement Accuracy: +/- 0.1 VDC accuracy (over temperature range)
Memory
Size: 32GB SD Card (~31 GB effective size)
System Power
Battery: 12V 50Ah sealed lead-acid
Solar Panel
Output Voltage: 18VDC maximum (loaded)
Output Power: 2.25A maximum (40W)
AC Adaptor
Output Voltage: 18VDC
Output Power: 1A maximum
Physical
Operating Temperature: -40 to +60° C (-40 to +140° F)
Enclosure Size (L x W x H): 61 x 51 x 25 cm (24 x 20 x 10 in)
Enclosure Mounting (L x W): 64 x 35.5 cm (25.25 x 14 in)
Weight: 20 kg (44 lbs)

Section 1 ‒ Introduction
10 MLBase User's Guide
Models
Model
Battery
Solar
Server Network
Communication
Antennas
(server
communication)
Antennas
(communication with
MLRemote Network)
MLBase-W-50S
50Ah
40W
Wi-Fi
2.4GHz to 5.8GHz
Wideband
Directional Antenna
800/900MHz dBi
Omnidirectional
Antenna
MLBase-M-50S
50Ah
40W
Cellular
900MHz dBi
Omnidirectional
DAS Antenna
800/900MHz dBi
Omnidirectional
Antenna

Section 1 ‒ Introduction
MLBase User's Guide 11
1.3 Connections
Connections to the MLBase are provided at the bottom of the enclosure.

Section 1 ‒ Introduction
12 MLBase User's Guide
1.4 Items List
The accessories delivered along with the MLBase are included in table below. Contact Canary Systems for more
information on these items and optional equipment.
Quantity
Item
MLBase
1
MLBase Enclosure
Included
1
12V 50Ah Lead-Acid Battery and Mounting Hardware
Included
1
40W Solar Panel with 9’ Integrated Power Cable
Included
1
Solar Panel Mounting Kit (Bracket and U-Bolts)
Included
1
1.5" Pole Mounting Kit (2 Unistrut, 4 Screws, 2 U-bolts)
Included
1
2.4GHz to 5.8GHz Ultra-Wideband Directional Antenna
Included
1
900MHz Omnidirectional DAS Antenna with Mounting Brackets
Optional
1
800/900MHz Omnidirectional Antenna with Mounting Brackets
Included
2
Antenna Cables (10')
Included
1
Ethernet RJ45 Connector
Included
1
Universal AC Adaptor (110-240VAC)
Included
1
Standard 110VAC Power Cable
Included
1
Screwdriver
Included

Section 2 - MLBase Installation
MLBase User's Guide 13
Section 2 - MLBase Installation
The steps required for installation include:
▪Install enclosure ‒ See Section 2.1
▪Install and orient the solar panel ‒ See Section 2.2
▪Install the AC adaptor ‒ See Section 2.3
▪Install and orient antennas ‒ See Section 2.4
▪Install battery ‒ See Section 2.5
2.1 Enclosure Installation
Proper site selection and installation of the MLBase®station is important for best radio communication results.
The enclosure can be mounted to a pole or the side of a building. Typical pole mount deployment is shown below:

Section 2 - MLBase Installation
14 MLBase User's Guide
Typical pole installation requires the following materials:
▪3m (10’) length of schedule 80 PVC (do not use schedule 40) or galvanized steel pipe
▪(2) 80lb bags of QUIKRETEpre-mixed concrete
▪(1) 5-gallon bucket
▪2m (6’) copper ground stake
▪2m (6’) of #10 copper ground wire and clamp
General installation steps are as follows:
▪Position the station where best southern exposure is provided for maximum solar exposure. If necessary,
extend the sensor cables to get out from behind berms, high-walls or embankments.
▪Excavate to a minimum of 1.2m (4’), deeper if possible. Install the bucket, locate the pipe in the bucket and
fill with mixed concrete. Follow the directions on the bag for concrete mixing. Use a level to adjust the
position of the pipe before it sets. Use lumber or other suitable props to hold the pipe in position overnight.
See the manufacturer's instructions for the precise curing time.
▪Drive the ground stake as close as possible to the bucket.
▪Attach the unistrut to the enclosure. Be sure to install the U-bolt pipe clamps on the unistrut prior to
attaching to the enclosure.
▪Hold the enclosure against the pipe and affix the pipe clamp hardware to the pipe to secure the enclosure.
▪Use the copper ground wire and clamp to secure the ground wire between the ground rod and enclosure.
See the following sections on installing the solar panel, antennas, and battery.
QUIKRETE

is a registered trademark of QUIKRETE INTERNATIONAL, INC.

Section 2 - MLBase Installation
MLBase User's Guide 15
2.2 Solar Panel Installation
See the included instruction sheet for the bracket and solar panel supplied.
The solar panel should be positioned for maximum sun exposure. In the Northern hemisphere this means aligning
the panel with a southward exposure. In the Southern hemisphere, align the panel in a northward direction. Use a
compass to derive the correct angle. Remember to correct compass headings for declination.
Once installed, route the supplied cable down the pole and secure with tie-wraps, where it can be plugged in to the
bottom of the enclosure.
Note –The solar panel should be plugged in after the battery has been connected.

Section 2 - MLBase Installation
16 MLBase User's Guide
The other key criteria for solar panel installation is the tilt angle. The following chart illustrates the variability between
summer and winter and latitude. Insolation is a measure of solar radiation energy received on a given surface and
recorded during a given time.
(Insolation throughout the year at differing latitudes)
The chart depicts northern hemisphere solar energy, reverse the months for the southern hemisphere. As can be
seen, solar energy varies considerably over the course of the year so the tilt angle should be adjusted to capture the
maximum radiation during the worst month of the year. In the Northern Hemisphere this is December. In the
Southern Hemisphere this is June.
Northern
Hemisphere
December
Southern
Hemisphere
June
70
0
0
70
60
10
10
60
50
20
20
50
40
30
30
40
30
40
40
30
20
50
50
20
10
60
60
10
0
70
70
0
(Northern solar energy versus southern solar energy)

Section 2 - MLBase Installation
MLBase User's Guide 17
2.3 AC Adaptor Installation
An AC adaptor may be used in place of the solar panel for AC powered applications.
Installation is simple. The adaptor includes a robust connector to connect to the bottom of the enclosure. Use the
appropriate AC power cord for connecting to a standard AC receptacle.

Section 2 - MLBase Installation
18 MLBase User's Guide
2.4 Antenna Installation
The MLBase comes with connectors for two antennas.
•The 900 MHz omnidirectional antenna is used to communicate with the MLRemote network.
•The wideband 2.4 GHz Yagi antenna is used to provide a connection to the Wi-Fi network the server is on.
The MLBase module has both an integrated Radio and Wi-Fi connection. Additionally, an Ethernet cable can be
used for sites where a dedicated networks are available.
This section outlines installation instructions for both antennas.
Omnidirectional Antenna
The L-com 900 MHz 6 dBi Omnidirectional Antenna includes a right-angle bracket for side of pole mounting.
The antenna kit includes cables to connect the antenna to the bottom of the MLBase enclosure. The connector on
the antenna is Type-N female.
The antenna's attached mount bracket is secured to the side of pole using the included U-bolts.
Connect one end of the provided cable to the antenna and the other to the connector labeled Antenna on the
bottom of the MLBase station. See section 1.3 Connections of this guide for reference.

Section 2 - MLBase Installation
MLBase User's Guide 19
Wideband Yagi Antenna
The Wi-Fi antenna shipped with the MLBase is the L-com Ultra-Wideband directional Antenna.
The antenna includes a right-angle bracket for side of pole mounting.
The antenna kit includes a cable to connect the antenna to the bottom MLBase enclosure. The connector on the
antenna is Type-N female.
The antenna mounts to the side of pole using the included pipe clamps for 1.5” (50.8mm).
The following illustration depicts assembly of the bracket and pipe clamps.
The mounting bracket allows the antenna to adjust the angle of elevation. In most cases, horizontal orientation is
best.
Connect one end of the provided cable to the antenna and the other to the connector labeled Wi-Fi on the bottom of
the MLBase station. See section 1.3 Connections of this guide for reference.

Section 2 - MLBase Installation
20 MLBase User's Guide
2.5 Battery Installation
The battery is a 12V 50Ah sealed lead-acid battery. It is packaged separately from the MLBase enclosure.
Note ‒ Battery installation should only be completed after the MLBase has been installed in its field location.
Tools Required: 3/8” socket wrench and 3/8” open-end wrench.
1. Remove the battery from the packaging, locate the terminal attachment hardware.
2. Open the MLBase enclosure and locate the bracket at the bottom of the enclosure. Move the battery terminal
leads away from the back of the bracket.
3. Position the battery with the terminals facing forward and lift the battery over the bracket to be placed into the
back of the panel, as shown below. Bring the terminal leads up over the battery.
4. Attach the leads using the hardware supplied. The red (positive) lead is installed on the right terminal, the black
(negative) lead is installed on the left terminal. Note the battery terminal colors match the lead colors.
Note ‒ Attach the red lead first to prevent short circuits.
(A correctly wired battery installed in an MLBase enclosure)
Once the battery terminals are installed the 3-pin solar connector can be plugged in.