Kerlink base stations

The Kerlink base station models supported are:

• iFemtoCell

• iFemtoCell Evolution

• iStation

• iBTS (both standard and compact models)

• Wirnet SOP4 (end of life)

All the Kerlink base station models share the same firmware version except for the Kerlink SOP4 model. However, the LRR installation procedure slightly differs depending on the model.

Software pre-requisites and compatibility matrix

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

Checking the firmware version

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

root@klk-wifc-030218:~ # cat /tmp/sys_startup_status.json | grep sw_version

Important For the Kerlink base stations, except SOP4 models, that were initially installed with a firmware version different from 5.11.0, the base station should be flashed with live burner of the firmware 5.11.0 before installing the new base station image.

caution

Due to a current Kerlink limitation, the remote upgrade from KerOS 4.3.3 to KerOS 5.11.0 using Kerlink's live-burner will reset the network configuration of the base station.

Accordingly, do not attempt to remotely upgrade the firmware from KerOS 4.3.3 to KerOS 5.11.0 if your base station does not use an ethernet connection in DHCP configuration.

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

Note Flashing of Kerlink firmware 5.11.0 requires:

• liveburner_5.11.0_klkgw-signed.ipk (erase everything)

• keros 5.11.0 + lrr.

LRR installation

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.

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 stic.

Important If ThingPark LRR software has already been installed on the base station, you must first reset your base station to its factory settings. To do so, you need to define the correct usbkey password inside a usbkey.txt file, to authorize the installation on your base station. The usbkey password is unique per base station and can be retrieved based on its LRR ID or UID (UUID). Contact Actility support team or your ThingPark distributor to obtain the usbkey password of your base station.

To learn more about factory reset, see the following section.

Factory-reset a Kerlink base station

Follow these steps to reset a Kerlink base station:

1. Connect to your base station as root user.

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

root@klk-wifc-030218:~ # kerosd -s            
root@klk-wifc-030218:~ # 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 stic, 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 Kerlink Base Station 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. 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.

8. 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 Kerlink Base Station 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:

• All .ipk files: 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:

• keros*.ipk

• lrr*.ipk

• customlrrini*.ipk

• setvpn.ipk

• interfacesvlan*.ipk

• hosts*.ipk

• settime*.ipk

• keygen*.ipk

• usb.autorun

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

Installing Kerlink 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 20 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 Kerlink 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 20 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