Kerlink base stations

The supported Kerlink base station models are:

• iFemtoCell
• iFemtoCell Evolution
• iStation
• iBTS (both standard and compact models)
• Wirnet SOP4 (end of life)

Kerlink base station models might have different firmware versions. The LRR installation procedure slightly differs depending on the model and firmware version.

Software pre-requisites and compatibility matrix

Base Station Model	LRR Version	Firmware Version	FPGA Version
Kerlink iFemtoCell	2.8.96	6.4.0	31, 33
	2.8.73_8	5.11.0	31, 33
Kerlink iFemtoCell Evolution	2.8.96	6.4.0	31, 33
	2.8.73_8	5.11.0	31, 33
Kerlink iStation	2.8.96	6.4.0	31, 33
	2.8.73_8	5.11.0	31, 33
Kerlink iBTS	2.8.73_8	5.11.0	61
Kerlink SOP4	2.4.77	3.3	31, 33

note

Live-burner from KerOS 5.11.0 to KerOS 6.4.0 is now available. It can be done only if an electrical reboot is not needed which is the case for most of the Kerlink base stations where the Secure Store has never been activated. To check if your base station needs an electrical reboot, you can run the following command:

ELECTRICAL_REBOOT_NEEDED=$(cat /proc/cmdline | grep -c "sb_lock=1")

The liveburner from KerOS 5.11.0 to KerOS 6.4.0 will fail if an electrical reboot is needed.

If LRR already exists, the upgrade will keep the configuration. In case you do not want to keep the existing configuration, you should remove $ROOTACT.

tip

The hardware design of the iBTS compact model supports a single radio board. Hence, it is neither compatible with tri-sector deployments nor 72-channels RF Regions.

The hardware design of the iBTS standard model may be used in various ways:

• For single-sector deployments with one omni-directional antenna and up to 72 channels, choose the ThingPark model Wirnet iBTS standard 72-channels.

• For tri-sector deployments, with three directional antennas and up to 16 RF channels per sector, choose the ThingPark model Wirnet iBTS multi-sector.

Checking the firmware version

To check the current Kerlink firmware version of your base station:

# On KerOS 4.3.3 and KerOS 5.11.0
cat /tmp/sys_startup_status.json | grep sw_version
# On KerOS 6
cat /etc/os-release

caution

For the base stations (excluding SOP4) that were initially installed with a firmware version different from 4.3.3, 5.11.0 or 6.4.0, the base station should be flashed with the corresponding live burner of the firmware before installing the new base station image.

Installing LRR on KerOS 6.4.0

Refer to Kerlink documentation and support for details on how to flash the 6.4.0 version of the firmware.

After downloading the base station image as described in Retrieving the base station image, follow the steps provided below to flash your base station with the new image.

Prerequisites

Important: Set an admin password before installing the LRR.

On a new KerOS 6.4.0 an admin password is needed after the upgrade. A root password will also be needed but it will be reset by the LRR installation. And finally ssh access will be needed.

# prompt asking for login
admin
# You are required to change your password immediately (administrator enforced).
# New password
<enter your admin password>
# Retype new password
<enter your admin password>
# try to enter root
sudo su
<enter your root password>

# Update the system
apt update
apt dist-upgrade -y
apt upgrade -y

# Allow password authentication for SSH
sed -i 's/PasswordAuthentication no/PasswordAuthentication yes/g' /etc/ssh/sshd_config
# Going back to admin user
exit

Factory reset

Doing a factory reset on KerOS 6 will delete all user data and configurations. You'll need to enter a new password for the admin user.

# Factory reset for KerOS6
reboot factory-reset

Installing the LRR

# On your local machine
scp TP_Enterprise_BS_Image_kerlink.KERL_<GW_MODEL>_any<PLATFORM>_<LRR_version>_v<IMG_VERSION> admin@<base_station_IP>:/

ssh admin@<base_station_IP>

# On the base station
sudo su
<enter your root password>
chmod 755 /TP_Enterprise_BS_Image_kerlink.KERL_<GW_MODEL>_any<PLATFORM>_<LRR_version>_v<IMG_VERSION>
/TP_Enterprise_BS_Image_kerlink.KERL_<GW_MODEL>_any<PLATFORM>_<LRR_version>_v<IMG_VERSION>
reboot

Upgrading from KerOS 5.11.0 to KerOS 6.4.0

Refer to Kerlink documentation and support for details on how to flash the 5.11.0 version of the firmware.

The liveburner is already included in the LRR image for KerOS 6.4.0. Running it on a KerOS 5.11.0 will upgrade the firmware to KerOS 6.4.0 and install the LRR in one step.

Installing the LRR is straightforward using Direct SSH.

Download the LRR image (e.g. TP_Enterprise_BS_Image_kerlink.KERL_ISTA.1_any_TPCP_SAAS_2.8.96_v1.0) as described in Retrieving the base station image. Then transfer it to the base station (not in /tmp which is too small) and just run it.

Important: Set an admin password before upgrading the KerOS.

# On your local machine
scp TP_Enterprise_BS_Image_kerlink.KERL_<GW_MODEL>_any<PLATFORM>_<LRR_version>_v<IMG_VERSION> admin@<base_station_IP>:/

ssh root@<base_station_IP>

# On the base station
chmod 755 /TP_Enterprise_BS_Image_kerlink.KERL_<GW_MODEL>_any<PLATFORM>_<LRR_version>_v<IMG_VERSION>
/TP_Enterprise_BS_Image_kerlink.KERL_<GW_MODEL>_any<PLATFORM>_<LRR_version>_v<IMG_VERSION>
reboot

Installing LRR on KerOS 4.3.3 or 5.11.0

Important: If the gateway cannot be upgraded to KerOS 6.4.0, the LRR can still be installed on KerOS 5.11.0.

note

The latest LRR image compatible with KerOS 4.3.3 embeds a custom live burner, making it possible to remotely upgrade the LRR from KerOS 4.3.3 with LRR 2.6.27 to KerOS 5.11.0 with LRR 2.8.73.

For all Kerlink models except SOP4, installing the LRR software may use one of the following methods:

1. Direct SSH access to the base station and transfer the respective LRR software on it. To use this method, follow the steps described in Installing Kerlink Base Station with Direct SSH.

2. Install with a USB install key. To use this method, following the steps described in Installing Kerlink Base Station with USB stick.

Retrieving the LRR image

Use one of the following links to download the LRR image according to your model:

• For iStation: Latest wirista Image for KerOS 5.11.0.
• For iFemtoCell: Latest wirmana Image for KerOS 5.11.0.
• For iFemtoCell Evolution: Latest wirfevo Image for KerOS 5.11.0.
• For iBTS: Latest wirmaar Image for KerOS 5.11.0.

Factory reset

If ThingPark LRR software has already been installed on the base station, follow these steps to reset it:

1. Connect to your base station as root user.

2. Use the following commands to trigger a factory reset:

   kerosd -s
   reboot

At this stage, your base station will reboot and restore stock settings. This may take few minutes.

You may also perform factory reset with the USB install key prepared in Installing Kerlink Base Station with USB stick, proceed as below:

1. Insert USB install key into the base station.

2. Wait around 20 seconds until all 4 LEDs (2 on debug port + 2 on local port) blink very quickly, 3 LEDs only in the case of iFemtoCell.

3. Once the LEDs are blinking, unplug the USB install key. This will trigger a reboot of the base station and will restore the factory settings. This may take few minutes.

Installing with Direct SSH

This method is valid for all Kerlink models except SOP4.

Follow the steps provided below to flash your base station with the new image.

1. Connect to the base station via SSH.  See Connecting to the base station via SSH for more details.

2. Transfer to the base station the ThingPark image file you downloaded previously using a wget command, or with a tool like WinSCP. Destination directory should be /home/root

3. Move to this directory under your SSH connection:

   cd /home/root

4. Extract all documents in the package:

   tar -xf [KERLINK image file name]

   where [KERLINK image file name] is the file name of the image (.tar.gz file) you previously downloaded and transferred in /home/root

5. Create /user/.updates directory on the base station if not already created:

   mkdir /user/.updates

6. Copy all ipk packages from the extracted from the package to /user/.updates directory:

   cp *.ipk /user/.updates/

7. To trigger a fresh installation, remove the existing $ROOTACT folder if exist using the following command:

   rm -rf ${ROOTACT}

8. Initiate LRR package installation by executing the following commands, followed by a reboot of the base station:

   sync
   kerosd -u
   reboot

   After running the command, the base station will be flashed with the ThingPark image. This process will take a couple of minutes.

9. Once the base station has rebooted, and is up and running, verify that the ThingPark image is successfully installed with the following command.  The status shall show "OK" for the ipk packages installed.

   cat /user/.update

If the installation was performed successfully, verify that the LRR version installed on the base station is the expected one (refer to the compatibility matrix above). The LRR version can be verified via the SUPLOG menu (see Connecting to SUPLOG). You may also verify on the base station with the following command:

cat ${ROOTACT}/usr/etc/lrr/versions.ini

Installing with USB stick

Kerlink base stations offer an easy installation way relying on a USB stick. To proceed with the LRR software installation, you must prepare the USB install key with the files obtained from the LRR software package downloaded previously.

This method is valid for all Kerlink models (including SOP4).

Preparing the USB install key

1. Format FAT32 the USB stick.

2. Unzip the LRR software package downloaded previously at the root of the USB install key file system.

3. Add the usbkey.txt file into the USB stick if an LRR software has already been installed on the base station.

The LRR software package contains:

• Image .ipk file: the packages to be installed

• usb.autorun: the script which installs the ipk packages inside Kerlink base station

• usbkey.txt: contains passphrase which allows usb.autorun to be executed.

The list of files is given for information - actual file names may change depending on the firmware and LRR version:

• TP_Enterprise_BS_Image_kerlink.KERL_<GW_MODEL>_any<PLATFORM>_<LRR_version>_v<IMG_VERSION>.ipk

• usb.autorun

• usbkey.txt  (optional, only needed if LRR is already installed on the base station)

Installing iFemtoCell or iFemtoCell Evolution

If your base station does not have any LRR software installed and is already with its factory configuration, you may proceed with the LRR software installation.

1. Insert the USB install key into the IFEMTOCELL or IFEMTOCELL EVO gateway.

2. Wait around 25 seconds, until the ethernet port blinks.

3. Once the ethernet port blinks, unplug the USB key. It will trigger the reboot to perform the installation (all packages from the USB key will be installed on the gateway). This may take few minutes.

4. Once the base station has rebooted, and is up and running, verify that the LRR version installed on the base station is the expected one (refer to the compatibility matrix above). The LRR version can be verified via the SUPLOG menu (see Connecting to SUPLOG). You may also verify on the base station with the following command:

   cat ${ROOTACT}/usr/etc/lrr/versions.ini

Installing iBTS, iBTS Compact or iStation

If the current state of your iBTS or iStation is unknown, observe the behavior of the unit: an IBTS or iStation gateway with factory settings reboots every 5 minutes.

If your base station does not have any LRR software installed and is already with its factory configuration, you may proceed with the LRR software installation.

1. Check that the IBTS or iStation is not rebooting: by default, IBTS or iStation reboots every 5 minutes. You can wait 3 minutes after the last reboot.

2. Insert USB install key.  For Kerlink iStation, a USB Type C to USB-A adaptor would be required.

3. Wait around 25 seconds until the yellow LED on the debug port blinks very quickly.

4. Once the LED is blinking, unplug the USB key. This will trigger the reboot to perform the LRR software installation. This may take few minutes.

5. Once the base station has rebooted, and is up and running, verify that the LRR version installed on the base station is the expected one (refer to the compatibility matrix above). The LRR version can be verified via the SUPLOG menu (see Connecting to SUPLOG). You may also verify on the base station with the following command:

   cat ${ROOTACT}/usr/etc/lrr/versions.ini

Installing Kerlink Wirnet SOP4

If your base station does not have any LRR software installed and is already with its factory configuration, proceed with the following steps to install the LRR software:

1. Make sure the base station has been off for at least 10 minutes to ensure internal battery is completely discharged.

2. Plug the USB stick into the base station.

3. Power up the base station. This will trigger the LRR software installation, then the base station will reboot. This may take few minutes.

4. Once the base station has rebooted, and is up and running, verify that the LRR version installed on the base station is the expected one (refer to the compatibility matrix above). The LRR version can be verified via the SUPLOG menu (see Connecting to SUPLOG). You may also verify on the base station with the following command:

   cat ${ROOTACT}/usr/etc/lrr/versions.ini

Upgrading LRR from KerOS 4.3.3 to KerOS 5.11.0

Upgrading with Direct SSH

This method is valid for all Kerlink models except SOP4.

Follow the steps provided below to upgrade your base station from Keros 4.3.3 + LRR 2.6.x:

1. Connect to the base station via SSH.  See Connecting to the base station via SSH for more details.

2. Transfer to the base station the ThingPark image file you downloaded previously using a wget command, or with a tool like WinSCP. Destination directory should be /home/root

3. Move to this directory under your SSH connection:

   cd /home/root

4. Extract all documents in the package:

   tar -xf [KERLINK image file name]

   where [KERLINK image file name] is the file name of the image (.tar.gz file) you previously downloaded and transferred in /home/root

5. Create /user/.updates directory on the base station if not already created:

   mkdir /user/.updates

6. Copy all ipk packages from the extracted from the package to /user/.updates directory:

   cp *.ipk /user/.updates/

7. Initiate Keros and LRR package upgrade by executing the following commands, followed by a reboot of the base station:

   sync
   kerosd -u
   reboot

   After running the command, the base station will be flashed with the ThingPark image. This process will take a couple of minutes.

8. While the gateway is restarting, log into your account on the ThingPark portal. Navigate to the Base Station's detailed page, go to the Advanced tab, and under the Security widget, click Regenerate.

   This step regenerates the security certificate for the base station, which is required to correctly re-establish a secure backhaul link between the gateway and the ThingPark Core Network after the LRR upgraded.

9. Once the base station has rebooted, and is up and running, verify that the ThingPark image is successfully installed with the following command.  The status shall show "OK" for the ipk packages installed.

   cat /user/.update
   cat /user/.upgrade.log

If the installation was performed successfully, verify that the LRR version installed on the base station is the expected one (refer to the compatibility matrix above). The LRR version can be verified via the SUPLOG menu (see Connecting to SUPLOG). You may also verify on the base station with the following command:

cat ${ROOTACT}/usr/etc/lrr/versions.ini

Upgrading the customlrrini*.ipk

If you need to upgrade the customlrrini*.ipk package and still have the old setvpn package installed, you must first remove setvpn:

opkg remove setvpn
kerosd -u && sync && reboot

cp customlrrini.ipk /user/.updates/
kerosd -u && sync && reboot