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.104_4 | 6.5.1 | 31, 33 |
| Kerlink iFemtoCell | 2.8.73_15 | 5.11.0 | 31, 33 |
| Kerlink iFemtoCell Evolution | 2.8.104_4 | 6.5.1 | 31, 33 |
| Kerlink iFemtoCell Evolution | 2.8.73_15 | 5.11.0 | 31, 33 |
| Kerlink iStation | 2.8.104_4 | 6.5.1 | 31, 33 |
| Kerlink iStation | 2.8.73_16 | 5.11.0 | 31, 33 |
| Kerlink iBTS | 2.8.109 | 6.5.1 | 61 |
| Kerlink SOP4 | 2.4.77 | 3.3 | 31, 33 |
Live-burner from KerOS 5.11.0 to KerOS 6.5.1 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.5.1 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.
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
For the base stations (excluding SOP4) that were initially installed with a firmware version different from 4.3.3, 5.11.0 or 6.5.1, 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.5.1
Refer to Kerlink documentation and support for details on how to flash the 6.5.1 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.5.1 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>
Factory reset
Doing a factory reset on KerOS 6.5.1 will delete all user data and configurations. You'll need to enter a new password for the admin user.
# Factory reset for KerOS 6
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>:/home/admin/TP_Enterprise_BS_Image
ssh admin@<base_station_IP>
# On the base station
sudo chmod 755 /home/admin/TP_Enterprise_BS_Image
<enter your admin password>
sudo mv /home/admin/TP_Enterprise_BS_Image /TP_Enterprise_BS_Image
sudo /TP_Enterprise_BS_Image
reboot
Upgrading from KerOS 5.11.0 to KerOS 6.5.1
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.5.1. Running it on a KerOS 5.11.0 will upgrade the firmware to KerOS 6.5.1 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.104_1_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> root@<base_station_IP>:/TP_Enterprise_BS_Image
ssh root@<base_station_IP>
# On the base station
chmod 755 /TP_Enterprise_BS_Image
/TP_Enterprise_BS_Image
reboot
Installing / Upgrading LRR from KerOS 4.3.3 to KerOS 5.11.0
Important: If the gateway cannot be upgraded to KerOS 6.4.3, the LRR can still be installed on KerOS 5.11.0.
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 or fresh install the LRR from KerOS 4.3.3 to KerOS 5.11.0 with LRR 2.8.73.
Retrieving the LRR image
Kindly raise a support ticket to request the TPE images bundled with KerOS 5.11.0. Please specify the target platform and gateway model so that we can provide the appropriate images.
Installing / Upgrading with Direct SSH
This method is valid for all Kerlink models except SOP4.
Follow the steps provided below to install or upgrade your base station from Keros 4.3.3 :
-
Connect to the base station via SSH. See Connecting to the base station via SSH for more details.
-
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
-
Move to this directory under your SSH connection:
cd /home/root -
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
-
Create /user/.updates directory on the base station if not already created:
mkdir /user/.updates -
Copy all ipk packages from the extracted from the package to /user/.updates directory:
cp *.ipk /user/.updates/ -
To trigger a fresh installation, remove the existing $ROOTACT folder if exist using the following command:
rm -rf ${ROOTACT}To upgrade the base station only while preserving the existing configuration, leave the
${ROOTACT}directory unchanged. -
Initiate Keros and LRR package upgrade by executing the following commands, followed by a reboot of the base station:
synckerosd -urebootAfter running the command, the base station will be flashed with the ThingPark image. This process will take a couple of minutes.
-
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.
-
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/.updatecat /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
Installing LRR on Kerlink Wirnet SOP4
The following procedures apply only to the Kerlink Wirnet SOP4.
Factory reset
If ThingPark LRR software has already been installed on the base station, follow these steps to reset it:
-
Connect to your base station as root user.
-
Use the following commands to trigger a factory reset:
kerosd -sreboot
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:
-
Insert USB install key into the base station.
-
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.
-
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 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 Kerlink SOP4.
Preparing the USB install key
-
Format FAT32 the USB stick.
-
Unzip the LRR software package downloaded previously at the root of the USB install key file system.
-
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 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:
-
Make sure the base station has been off for at least 10 minutes to ensure internal battery is completely discharged.
-
Plug the USB stick into the base station.
-
Power up the base station. This will trigger the LRR software installation, then the base station will reboot. This may take few minutes.
-
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