====== Wanesy™ SPN firmware installation from KerOS firmware ======

By default, Wanesy SPN firmware is not installed on Kerlink gateways. Therefore, to install the Wanesy SPN the following steps are required:
  - Check the firmware version of the gateway
  - If the firmware is not the expected one, upgrade it
  - Upgrade SPN firmware via Web Interface, SSH or by USB

<note important>
Once Wanesy SPN firmware installed, gateway can be configured with web user interface (recommended) or other [[.:..:interfaces:interfaces|interfaces]]
</note>


===== Firmware version check =====

Gateway has no default IP address. It is recommended to connect the gateway to a network using a DHCP server. 

==== With web interface "recommended" ====

  * Connect to the web interface of your gateway: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:systeme_mana:webui#connect_to_the_web_interface|click here]]

<note important>For iFemtoCell, web interface password changed between version 3.3.3 and 3.4.3. Products leaving the warehouses could be in different versions. If the default password ''pwd4admin'' does not worked, try ''admin''.</note> 

  * Once connected to the web interface, go in the overview panel and check the firmware version in the "Information" section.

  * Wanesy SPN can be installed from these versions of KerOS:

^ Gateway model                   ^ KerOS version    ^
| **Wirnet iFemtoCell**           | 3.1.14 and above |
| **Wirnet iStation**             | 4.1.6 and above  |
| **Wirnet iFemtoCell-evolution** | 4.2.1 and above  |


<note warning>Installation of SPN firmware from version 5.X is not possible. You will have to downgrade from 5.X to 4.3.3-2. You can download the firmware 4.3.3-2 on [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:firmware:lastversion#download|this page]]</note>

  * If the firmware is not the expected one, upgrade it. 
    *iFemtoCell: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:quickstart:quickstart_ifemto#firmware_update_and_configuration|click here]]
    *iFemtoCell-evolution: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:quickstart:quickstart_ifevo#firmware_update_and_configuration|click here]]
    *iStation: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:quickstart:quickstart_istation#firmware_update_and_configuration|click here]]


==== With SSH connection ====
++++ click here|

  * Start a ssh client (for example: TeraTerm or Putty on Windows)
  * Connect to the gateway with the following configuration:
     * address: IP of your gateway       
     * port: ''22''
     * login: ''root''
     * password: ''pdmk-XXXXXX''
Where ''XXXXXX'' are the last 6 digits of board id.

For example, if a gateway has **704BEc03002E** as board ID, root password is **pdmk-03002E** (case sensitive).
{{.:..:images:ifemtocell_label.jpg?400|Board ID can be retrieved on gateway case}}

  * Once connected to the gateway, use the command below to get your firmware version:
<code bash>
cat /tmp/sys_startup_status.json | grep "sw_version"
</code>

  * Wanesy SPN can be installed from these versions of KerOS:

^ Gateway model                   ^ KerOS version    ^
| **Wirnet iFemtoCell**           | 3.1.14 and above |
| **Wirnet iStation**             | 4.1.6 and above  |
| **Wirnet iFemtoCell-evolution** | 4.2.1 and above  |


  * If the firmware is not the expected one, upgrade it. 
    *iFemtoCell: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:quickstart:quickstart_ifemto#firmware_update_and_configuration|click here]]
    *iFemtoCell-evolution: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:quickstart:quickstart_ifevo#firmware_update_and_configuration|click here]]
    *iStation: [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:quickstart:quickstart_istation#firmware_update_and_configuration|click here]]

++++

===== Wanesy SPN firmware installation =====

The firmware update can be done by Web interface, SSH or USB

==== Software update over Web interface "recommended"====

  - Download the firmware from [[wiki:support:resources|Resources]] page. The firmware can be download in the download section of the firmware delivery note. The file is named liveburner_X.X.X-spn_klkgw-signed.ipk. 
  - Connect to your gateway web interface
  - Go in the "Administration" and "Update" Menu
  - Drag & drop your SPN ipk file and click on UPDATE GATEWAY. 
  - A reboot is required to finalize the update, click on REBOOT GATEWAY.
  - To use fix IP address check [[https://wikikerlink.fr/wanesy-spn/doku.php?id=wiki:webui:administration:network#ethernet_configuration_fixed_ip_address|Fixed IP]]

<note important>
Upgrade process will take a few minutes and reboot the gateway multiple times. Web user interface will be up and running when the left LED will be lit in green
</note>

==== With SSH connection ====
++++ click here|

  - Download the firmware from the [[.:..:support:resources|resources]] page
  - Create the directory ''/user/.updates'' (if it does not exist):<code bash>
mkdir /user/.updates</code>
  - Transfer ''liveburner_x.y.z-spn_klkgw-signed.ipk'' package previously downloaded in this directory:<code bash>
# From a computer:
scp liveburner_x.y.z-spn_klkgw-signed.ipk root@<ip_address>:/user/.updates/</code>
  - Trigger update on next reboot:<code bash>
kerosd -u</code>
  - Restart: <code bash>
reboot</code>

<note important>
Upgrade process will take a few minutes and reboot the gateway multiple times. Web user interface will be up and running when the left LED will be lit in green
</note>

++++

==== With USB ====
++++ click here|

**Overview**

  - Download the firmware from [[.:..:support:resources|resources]] page
  - Prepare a USB key with the following files (see next section to get the files):
    * ''usb.autorun'': Auto executable script
    * ''usbkey.txt'': USB password file
    * ''liveburner_x.y.z-spn_klkgw-signed.ipk'': Wanesy SPN firmware package
  - Plug USB key on the iFemtoCell. //After a few seconds a led will start blinking from green to red//
  - Unplug USB key

<note important>
Upgrade process will take a few minutes and reboot the gateway multiple times. Web user interface will be up and running when the left LED will be lit in green
</note>

**Specific files**


  * usbkey.txt

''usbkey.txt'' is a security file. It includes the password of **usbuser** user. \\
Default **usbuser** password is ''USBklkPassword''

To update multiple boards, ''usbkey.txt'' file can include multiple passwords (100 maximum, 1 password per line).

Here is an example of this file for 4 boards (010001 / 020056 / 040001 / 092356): \\
First board has a generic password and 3 others have a "serial-based" modified password ("<serial>_usbkey") \\

Link below to download usbkey.txt file 

<file text usbkey.txt>
USBklkPassword
# Support for modified passwords
020056_usbkey
040001_usbkey
092356_usbkey
</file>

  * usb.autorun

''usb.autorun'' is a script automatically executed by the board if the ''usbkey.txt'' file includes a correct password. 
The following script is used to deploy the Wanesy SPN firmware. Copy this script in a file named ''usb.autorun''.

Link below to download usb.autorun file

<file bash usb.autorun>
#!/bin/sh

USBDIR="`dirname $0`"

SYSLEDPATH_4_0_IBTS="/sys/class/leds/yellow:debug"
SYSLEDPATH_4_0_IFEMTO="/sys/class/leds/led1:red:power"
SYSLEDPATH="/sys/class/leds/status"

led_path="/do/not/exist"
if [ -e "${SYSLEDPATH}" ]; then
	led_path="${SYSLEDPATH}"
elif [ -e "${SYSLEDPATH_4_0_IBTS}" ]; then
	led_path="${SYSLEDPATH_4_0_IBTS}"
elif [ -e "${SYSLEDPATH_4_0_IFEMTO}" ]; then
	led_path="${SYSLEDPATH_4_0_IFEMTO}"
fi

#
# Set default led behavior
# $1: trigger
#
#    if trigger = timer : $2 = delay_on, $3 = delay_off
#
set_led() {
	trigger="${1}"
	on="$2"
	off="$3"

	if [ -e "${led_path}" ]; then
		echo $trigger > "${led_path}/trigger"
		case "$trigger" in
			"timer")
				echo ${on:=500} > "${led_path}/delay_on"
				echo ${off:=500} > "${led_path}/delay_off"
				;;
			"none")
				echo ${on:=0} > "${led_path}/brightness"
				;;
			*)
				# Nothing to do
				;;
		esac
	fi
}


deploy_packages()
{
	mkdir -p /user/.updates
	for pkg in ${USBDIR}/*.ipk
	do
		cp ${pkg} /user/.updates/
	done
	sync
}

#
# Force the system to put the packages immediately in backup
#
force_backup()
{
	touch /user/.updates/force_backup
	sync
}


#
# Trigger update and reboot in $1 minutes (or 'now')
#
trigger_update()
{
	REBOOT_TIMEOUT=$1

	kerosd -u
	[ ${REBOOT_TIMEOUT:=0} -ne 0 ] && shutdown -r ${REBOOT_TIMEOUT}
}


#####################
#     MAIN
#####################

# Set led On
set_led none 1

# Deploy packages
deploy_packages

# Trigger Update
trigger_update

# Optional: Force the system to put the packages immediately in backup
#force_backup

# Prepare reboot after USB unplug
cat > /tmp/usbkey_remove << EOF
# Switch off Led
echo "none" > ${led_path}/trigger

# Reboot Now to get Update
reboot
EOF

# All is right, make Led blinking fast to notify User
set_led "timer" 100 100
</file>

++++

===== Wanesy SPN License installation =====

Once the Wanesy SPN firmware is running, the license file needs to be installed in order to configure and use the SPN software. The [[.:..:introduction:quickstart|quick start]] page will guide you through these steps.