Release Notes for the Cisco LoRaWAN Gateway, Release 2.2.0
These release notes include important information about Cisco LoRaWAN Gateway Software Release 2.2.0 and the limitations, restrictions, and caveats, if any, that apply to this release.
Note |
The Cisco LoRaWAN Gateway was previously named Cisco LoRaWAN Interface Module. |
Note |
The documentation set for this product strives to use bias-free language. For purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. |
Note |
On IXM LoRaWAN Release 2.2.0, Actility LRR users must install the LRR 2.6.53 or above as LRR version. Previous LRR versions are not supported on Release 2.2.0. LRR 2.6.53 is available to download from Thingpark Enterprise dashboard. |
Introduction
The Cisco LoRaWAN Gateway is one of the Cisco Internet of Things (IoT) extension module series. It can be connected to the Cisco 809 and 829 Industrial Integrated Services Routers (IR800 series) for virtual mode or standalone for low-power wide-area (LPWA) access and is positioned as a carrier-grade gateway for outdoor deployment, including harsh environments. It adds a ruggedized remote LoRaWAN radio modem interface to create a gateway between the Cisco Field Network Director and a partner’s LoRa network server.
Note |
Currently, Cisco LoRa IXM only supports Actility Thingpark Packet Forwarder or long range relay (LRR), in production, or the Common Packet Forwarder (CPF). CPF enables LoRaWAN gateway as an open platform to operate with the open source LoRa Network Servers implementing Semtech Basic Station. |
There are two LoRaWAN gateway modes as below:
-
Virtual interface mode – IR800 series including the LoRaWAN module as a virtual interface
-
Standalone mode – The LoRaWAN module working alone as an Ethernet backhaul gateway
You can configure the LoRaWAN IXM running on virtual interface mode or standalone mode through CLI or IoT FND. For more information, see the Cisco Wireless Gateway for LoRaWAN Software Configuration Guide.
Note |
The Common Packet Forwarder (CPF) feature is only supported in standalone mode. |
System Requirements
Hardware Supported
Model No. |
Description |
---|---|
IXM-LPWA-800-16-K9 |
Cisco LoRaWAN Gateway, IoT extension module series, radio spectrum from 863–870 MHz, 16 LoRa channels, IP67 |
IXM-LPWA-900-16-K9 |
Cisco LoRaWAN Gateway, IoT extension module series, radio spectrum from 902–928 MHz, 16 LoRa channels, IP67 |
Software Images
Filename |
Description |
---|---|
ixm_mdm_i_k9-2.2.0.tar.gz |
Cisco LoRaWAN Gateway OS Image Version 2.2.0 with Semtech Basic Station Release Version 2.0.5 FPGA Version 61 HAL Version 5.1.0 |
Installation of a New Software Release
For both standalone mode and virtual mode, after you upgrade the LoRaWAN gateway to Release 2.0.30, you can only downgrade to Release 2.0.20. Downgrading to releases earlier than 2.0.20 is not supported. For example, from Release 2.0.30 to Release 2.0.11, or from Release 2.0.30 to Release 2.0.10, is not supported..
To upgrade to Release2.0.x, any older versions must first be upgraded to Release 1.0.20. For example, Release 1.0.4, 1.0.5, or 1.0.6 has to be upgraded to 1.0.20 first and then upgraded to Release 2.0.x. From 2.0.x, the gateway can be upgraded to 2.2.0.
Firmware Upgrade From Standalone Mode
Note |
We assume that you have the latest FPGA v61. If you have loaded any recent release on the IXM, use the show inventory command to check the FPGA status. If the FPGA version is not 61, upgrade first with an image that has FPGA v61. Refer to the release support matrix on various FPGA version and LRR version support. |
Follow these steps to install a new software image on the standalone mode LoRaWAN Gateway:
Procedure
Step 1 |
Log into the Cisco LoRaWAN Gateway through the console port, or SSH if configured.
|
||||||||
Step 2 |
Check the current version before upgrade. Example:
|
||||||||
Step 3 |
Download the image file to the Cisco LoRaWAN Gateway from a TFTP server or from a USB device, and install the image.
Use the following command to download and install the firmware.
Example:
|
||||||||
Step 4 |
After the image is installed successfully, verify the status. Example:
|
||||||||
Step 5 |
Check the FPGA status using the following command: Example:
|
Virtual Mode Installation
Note |
Before upgrading to Release 2.0.x from Release 1.0.x, make sure you have the FPGA v58 properly installed. The FPGA upgrade will be triggered once the IXM boots up with the image version 1.0.20. After 10 - 15 minutes, you can use the following command to check the FPGA version. Do not install the packet forwarder software or perform radio related configuration while the FPGA is upgrading or downgrading. |
IR829_1#show virtual-lpwa 3 modem info
Name : Virtual-LPWA 3
ModemImageVer : 2.2.0
BootloaderVer : 20180130_cisco
ModemAgentVer : 1.02
SerialNumber : FOC23126GDH
PID : IXM-LPWA-800-16-K9
UTCTime : 19:04:09.033 UTC Thu Mar 04 2021
IPv4Address : 192.168.100.2
IPv6Address : none
FPGAVersion : 61
TimeZone : PST
LocalTime : Thu Mar 4 11:04:09 PST 2021
ACT2 Authentication : PASS
ModemVersionID : V01
ProtocolVersion : 2
ChipID : LSB = 0x306b0a14 MSB = 0x00f14200
LoRaSerialNumber : FOC22433QLK
LoRaCalc : <135,122,114,106,98,94,90,86,77,69,60,52,43,39,35,31-142,130,122,114,106,102,98,94,85,77,69,60,52,48,44,40>
CalTempCelsius : 40
CalTempCodeAD9361 : 97
RSSIOffset : -202.16,-202.99
AESKey : Unknown
Follow this procedure to upgrade to Release 2.2.0:
Procedure
Step 1 |
Log in to the IR809 or IR829 system with terminal through SSH or Console. |
||||
Step 2 |
Copy the image file into IR809 or IR829 from your host, and the image will be stored in flash. Example:
|
||||
Step 3 |
(Optional) If you are upgrading from an older version to Release 1.0.20, the upgrade will result in updating the FPGA to version 61. After upgrading the image, no action should be taken while the FPGA is upgrading. You must wait until you get the upgrade status of Ready, as the following example shows. Example:
|
||||
Step 4 |
Upgrade the firmware to Release 2.2.0 using the following factory install CLI:
|
||||
Step 5 |
After the image is installed successfully, verify the status. As shown in the following output, ModemImageVer has been updated, but BootloaderVer remains the same. Example:
|
||||
Step 6 |
Upgrade the firmware to Release 2.2.0 using the same CLI with uboot or uboot-only option:
|
||||
Step 7 |
After the image is installed successfully, verify the status. You will find from the output that both ModemImageVer and BootloaderVer have been upgraded. Example:
|
Switching Between Standalone Mode and Virtual Mode
When the LoRaWAN gateway is in standalone mode, use the switchover EXEC command to switch to the virtual mode.
#switchover
You can switch the LoRaWAN gateway from virtual mode to standalone mode through IR8x9, using the following command.
IR800#virtual-lpwa 1 modem standalone mode enable
New Features In This Release
The following new features are introduced in this release:
-
Support Smart Licensing Using Policy for the subscription of Common Packet Forwarder (CPF).
For existing user with the CPF license purchased before, refer to the latest configuration guide to migrate to the new Smart Licensing based system.
-
The show version command now displays both "active" and "backup" OS software versions if applicable.
IXM uses dual OS partitions. One of them is upgraded to the new firmware with the archive download-sw firmware |normal command. In case of failing to boot from upgraded firmware, it can fall back to the backup one.
-
Add the option factory-reset in configuration mode to allow users to factory reset the IXM through CLI in addition to pressing the reset button.
-
Add the option container disable in configuration mode to stop the container completely to free up resources (network, CPU, memory, and etc).
-
Update the countries and their channel plans according to the latest LoRaWAN Regional Parameters, RP2-1.0.2.
-
Support SUDI 2099 (Secure Unique Device identifier) to provides alignment with Cisco Trustworthy Systems.
Only Release 2.2 firmware supports to display SUDI 2099 certificates on IXM, while older IXMs are not impacted if not managed by IoT FND. For the case of IXM managed by FND, see https://www.cisco.com/c/en/us/support/docs/field-notices/705/fn70573.html for more information.
Caveats
You can use the Bug Search Tool to find information about caveats, including a description of the problems and available workarounds. The Bug Search Tool lists both open and resolved caveats.
To use the Bug Search Tool:
-
Log in with your Cisco.com user ID and password.
-
Enter information in the Search For, Product, and Releases field as needed, then press Enter.
For more information about the Bug Search Tool, click Help on the main Bug Search Tool page.
Open Caveats
This section contains open caveats for this release.
-
CSCvx78136: Traffic destined for IPsec tunnel can escape outside the tunnel when the tunnel is "down".
Symptom: When the subnet command is used in conjunction with IPsec to route certain traffic over the IPsec tunnel, and if the tunnel is down, the traffic will be routed over the normal interface.
Conditions: Subnet command is used in conjunction with IPsec.
Workaround: Set up any network security tool to anticipate the issue so as not to cause alarm.
Related Documentation
These documents provide detailed information about the Cisco LoRaWAN Gateway and are available at: www.cisco.com/go/lorawanmodule