Kirale Technologies KTBRN1 User manual

KTBRN1 Border Router
Quick Start Guide
Introduction
Installation and setup of the KTBRN1 Thread Backbone
Border Router.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
2
Disclaimer
INFORMATION IN THIS DOCUMENT IS SUBJECT TO CHANGE
WITHOUT NOTICE AND DOES NOT REPRESENT A
COMMITMENT ON THE PART OF KIRALE TECHNOLOGIES.
KIRALE TECHNOLOGIES PROVIDES THIS DOCUMENT “AS IS,”
WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF FITNESS OR MERCHANTABILITY FOR A PARTICULAR
PURPOSE. KIRALE MAY MAKE IMPROVEMENTS AND/OR
CHANGES IN THIS MANUAL OR IN THE PRODUCT(S) AND/OR
THE PROGRAM(S) DESCRIBED IN THIS MANUAL AT ANY TIME.
Trademarks and Copyright
© 2020 Copyright - Kirale Technologies S.L.
All Rights Reserved. No part of this document may be
photocopied, reproduced, stored in a retrieval system, or
transmitted, in any form or by any means whether, electronic,
mechanical, or otherwise without the prior written permission of
KiraleTechnologies.
Kirale® and Kirale Technologies logos are registered trademarks
of Kirale Technologies S.L. Other trademarks are the property of
their respective owners.
Contact Information
Kirale Technologies S.L.
General Vara de Rey 9, 5B
26001 –Logroño (SPAIN)
[phone]
[email protected]
https://www.kirale.com

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
3
Contents
Introduction................................................................................................................................................................1
Disclaimer ..................................................................................................................................................................2
Trademarks and Copyright .....................................................................................................................................2
Contact Information .................................................................................................................................................2
Contents..............................................................................................................................................................................3
Revision History.................................................................................................................................................................4
1. Required Components................................................................................................................................................5
2. Installation Guide ........................................................................................................................................................6
2.1. Download required software..........................................................................................................................6
2.2. Flash image to SD card...................................................................................................................................6
2.3. First time installation ......................................................................................................................................7
3. Web Administration Panel .......................................................................................................................................11
3.1. Change network configuration ....................................................................................................................12
3.2. Update KiBRA .................................................................................................................................................13
3.3. Configure Border Router...............................................................................................................................14
3.4. Start-up Border Router .................................................................................................................................17
3.5. Services............................................................................................................................................................21
3.6. Visual Network................................................................................................................................................25
3.7. Logs...................................................................................................................................................................26
4. A brief insight .............................................................................................................................................................27
4.1. Advanced filesystem......................................................................................................................................27
4.2. Critical services ..............................................................................................................................................27
4.3. Inter-process communication......................................................................................................................28

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
4
Revision History
Date
Revision
Changes
08/2019
1.0
Initial release.
10/2019
1.1
Updated content with more explanations and screenshots.
02/2020
2.0
New version 2.0
04/2020
2.1
New features and contents added

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
5
1. Required Components
Before beginning with KTBRN1 installation, it is recommended to have the following list
of components in place:
A KTBRN1 device.
A micro SD card, recommended class 10 A1-rated and at least 2 GB of capacity.
A USB Type-A male to micro USB Type-B cable.
An Ethernet cable.
A personal computer.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
6
2. Installation Guide
2.1. Download required software
Make sure you get the latest release of our Debian-based image for KTBRN1 that includes
KiBRA software, which you will can find on our website, in the following URL.
KTBRN1 + KiBRA image file
Likewise, download the file KiBRA-v2.x.x.zip for later use.
The following software is needed in order to update the image stored in your SD card or
to flash a new one.
Balena Etcher
A Serial terminal or/and SSH client will be required for connecting to KTBRN1 device.
MobaXterm free (Any other software can be used)
Zadig (in case of needing to install USB Serial drivers)
2.2. Flash image to SD card
In case it is needed to update or flash an image to SD card, please follow the instructions
bellow:
1) Install and launch Balena Etcher.
2) Select the file with extension .gz in Etcher.
3) Put the micro SD card in a card reader in the computer and select it in Etcher. It is
recommended to use micro SD card class 10 A1-rated and at least 2 GB of
capacity.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
7
4) Press Flash and wait to finish.
5) Eject the SD card from the computer and place it in the KTBRN1 card holder.
2.3. First time installation
Connect a USB cable to the KTBRN1 and to PC or USB hub. The first time you turn on
the KTBRN1 device, it will take about a couple of minutes to be ready to accept
connections. Please do not turn off the system until the first-time installation process
has completely finished.
After that, you can access KTBRN1 through USB Serial port by following the instructions
bellow.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
8
2.3.1. Connecting via USB Serial port
A new serial device should be listed ( Pi USB to Serial ) depending on your OS. It may be
required to install the driver for the USB Serial port, so check if the device has been
recognized by your PC.
If such is the case, install the driver by means of Zadig tool.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
9
Once you have got access to KTBRN1 via USB serial, launch MobaXterm and open a new
Serial session with the new listed port and speed 115200, then a login console should
appear after clicking enter. Login with user root, password kirale123.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
10
The welcome screen will show you information about IP addresses configured in
KTBRN1 and what KiBRA version is running.
By default, the provided image comes configured with a static IPv4 address for Ethernet
interface:
IPv4 address: 192.168.75.84/24
Furthermore, it comes with IPv6 protocol enabled for Ethernet interface so that it is
possible to access Web Administration as well as SSH port by means of IPv4 and IPv6
(link-local) addressing.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
11
3. Web Administration Panel
The access to the Web Administration Panel is available in port 8000 of KTBRN1. Type
http://192.168.75.84:8000 or http://[IPv6]:8000 in your browser (preferably Chrome or
Firefox for compatibility reasons) and the login page should be shown.
Note: Your PC must be connected to the same network as KTBRN1.
Credentials are the same as before. Login with user root, password kirale123.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
12
3.1. Change network configuration
The administrator may want to allow DHCPv4 auto-configuration or change the default
IPv4 address by other one. This can be done by accessing the “Network” menu in the Web
Admin.
In the picture above, the new IPv4 address acquired by DHCP is 10.1.1.163. It is now
possible to connect to KTBRN1 through SSH client to this IPv4 address or also to IPv6
link-local address if the PC is connected to the same network. Besides KiBRA will use
this exterior IPv4 address for its NAT64 function.
Note: A reboot may be required to make sure that new settings are correctly applied.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
13
3.2. Update KiBRA
This can be done by going to “KiBRA” menu and clicking the “Upgrade” icon which is
located next to the KTBRN1 picture in “System” section.
Then select the KiBRA-v2.x.x.zip file from the PC, click the “Install” bottom and follow the
instructions that will appear on the screen.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
14
3.3. Configure Border Router
Click the “Settings” sub-menu under the “KiBRA” menu to access the configuration page.
If an input field is shown in red colour, a right value will be required to be set before saving
changes.
3.3.1 Joining or Forming a Thread Network
This section outlines the configuration of how a device will join a network and the
parameters which are needed during this process.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
15
•Autostart: if this option is checked, Border Router will try to automatically join to
Thread network after the next reboot.
•Out-of-band Commissioning: it allows selecting the kind of attaching that Border
Router will make when it starts up.
3.3.2 Backbone Router Server
It gives the possibility of enabling or disabling the BBR function. Likewise, the
administrator can set up specific parameters used by Border Router Server.
3.3.3 Network Prefix
It enables manual configuration of the network prefix which will be used in Thread
network. User can decide throughout different options how IPv6 addressing will be
acquired by nodes within network, i.e. DHCP or SLAAC. If BBR function is turned on, then
DUA prefix will be enabled.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
16
Once Border Router has been configured with desired parameters, save the changes.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
17
3.4. Start-up Border Router
Go to “KiBRA” menu in order to start Border Router Engine.
After clicking the start button, the device either will join the selected network or form a
new one, depending on settings configured by the administrator.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
18
If you go back to the “Settings” sub-menu, it is possible to see the rest of Thread network
configuration parameters that have been configured either by the administrator or by the
system itself on startup.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
19
Here you can gather the information needed to attach other devices to the same network.
There is a button below called “Export Settings” which allows copying commissioning
information, required to provision a new device into the network, by means of KiNOS
commands.

KTBRN1 Quick Start Guide
April 2020, v2.1
© Kirale Technologies
20