SILICON LABS Wi-SUN SDK Network Performance Measurement User Manual

SILICON LABS Wi-SUN SDK Network Performance Measurement

Product Information

Specifications

• Wi-SUN SDK Version: 1.9.0.0 GA
• Gecko SDK Suite Version: 4.4 February 14, 2024
• Certified by Wi-SUN Alliance
• Supports LPWAN connectivity
• Built for industrial applications and smart cities
• Supports long-range capabilities, high data throughput, and IPv6
• Compatible with GCC version 12.2.1 provided with Simplicity Studio

Product Usage Instructions

1. Getting Started

To begin using the Wi-SUN SDK, follow these steps:

1. Download the SDK from https://www.silabs.com/developers/wi-sun-protocol-stack.
2. Install the SDK on your development environment.
3. Refer to the Gecko Platform Release notes for security updates and notices.
4. Subscribe to Security Advisories for up-to-date information.

2. Key Features

SoC (CoAP) Collector improvements.

3. Compatibility and Use Notices

Verify that the correct files are being used.

4. Known Issues

Packets sent when FSK FEC is enabled can infringe ARIB regulation. – Packets sent using a PHY with a bandwidth larger than the base PHY’s bandwidth can infringe ARIB regulation. – Workaround: Limit communications when using mode switch with ARIB enforcement enabled.

Frequently Asked Questions

Q: How do I address the issue of UDP sockets being closed when receiving packets with an empty payload?

A: This issue has been fixed in release 1.9.0.0. Make sure to update to this version to resolve the problem.

Q: What compilers are compatible with the Wi-SUN SDK?

A: The Wi-SUN SDK is compatible with GCC version 12.2.1 provided with Simplicity Studio.

Wireless Smart Ubiquitous Network (Wi-SUN) is the leading IPv6 sub-GHz mesh technology for smart city and smart utility applications. Wi-SUN brings Smart Ubiq-uitous Networks to service providers, utilities, municipalities/local government, and other enterprises, by enabling interoperable, multi-service, and secure wireless mesh networks. Wi-SUN can be used for large-scale outdoor IoT wireless commu-nication networks in a wide range of applications covering both line-powered and battery-powered nodes. Silicon Labs’ Wi-SUN hardware is certified by the Wi-SUN Alliance, a global indus-try association devoted to seamless LPWAN connectivity. Wi-SUN builds upon open standard internet protocols (IP) and APIs, enabling developers to extend existing infrastructure platforms to add new capabilities. Built to scale with long-range capabilities, high-data throughput and IPv6 support, Wi-SUN simplifies wire- less infrastructure for industrial applications and the evolution of smart cities.

These release notes cover SDK versions:

• 1.9.0.0 released February 14, 2024.
• 1.8.0.0 released December 13, 2023.

KEY FEATURES

Wi-SUN Stack

• Added support for LFN multicast reception
• Added support for non-standard PHY configurations
• Added support for blocking sockets
• Wi-SUN Applications
• Wi-SUN – SoC Network Measurement improvements
• Wi-SUN – SoC (CoAP) Meter and Wi-SUN – SoC (CoAP) Collector improvements

Compatibility and Use Notices

For information about security updates and notices, see the Security chapter of the Gecko Platform Release notes installed with this SDK or on the TECH DOCS tab on https://www.silabs.com/developers/wi-sun-protocol-stack. Silicon Labs also strongly recommends that you subscribe to Security Advisories for up-to-date information. For instructions, or if you are new to the Silicon Labs Wi-SUN SDK, Using This Release.

Compatible Compilers:

IAR Embedded Workbench for ARM (IAR-EWARM) version 9.40.1

• Using wine to build with the IarBuild.exe command line utility or IAR Embedded Workbench GUI on macOS or Linux could result in incorrect files being used due to collisions in wine’s hashing algorithm for generating short file names.
• Customers on macOS or Linux are advised not to build with IAR outside of Simplicity Studio. Customers who do should carefully verify that the correct files are being used.

GCC (The GNU Compiler Collection) version 12.2.1, provided with Simplicity Studio

Wi-SUN Stack

This release of the Gecko SDK (GSDK) will be the last with combined support for all EFM and EFR devices, except for patches to this version as needed. Starting in mid-2024 we will introduce separate SDKs:

• The existing Gecko SDK will continue with support for Series 0 and 1 devices.
• A new SDK will cater specifically to Series 2 and 3 devices.

The Gecko SDK will continue to support all Series 0 and 1 devices with no change to the long-term support, maintenance, quality, and responsiveness provided under our software policy. The new SDK will branch from Gecko SDK and begin to offer new features that help developers take advantage of the advanced capa-bilities of our Series 2 and 3 products. This decision aligns with customer feedback, reflecting our commitment to elevate quality, ensure stability, and enhance performance for an exceptional user experience across our software SDKs.

New Items

Added in release 1.9.0.0

• Added support for ETSI Adaptive Power Control. It is required to comply with Indian regional regulations.
• Improved LFNs clock drift compensation. It reduces the power consumption and the connection stability.
• Dropped the high-reliability transmission mechanism. Its use was not recommended, and it was causing a significant increase of all communication latency

Added in release 1.8.0.0

• Added a new API sl_wisun_get_stack_version() that returns the stack version.
• Updated sl_wisun_join() to support the customization of PHY configurations. Extended sl_wisun_phy_config_type_t and sl_wisun_phy_config_t to allow the customization of OFDM, FSK and O-QPSK entries.
• Added support for LFN Timing Offset (LTO). Avoid LFN broadcast and unicast overlaps.
• Added support for LFN multicast reception.
• Added support for SUN DSSS-OQPSK.
• Added support for blocking sockets.
•  Added support for the new Indian PHY configurations.

Improvements

Changed in release 1.8.0.0

• Refactored the socket API. The POSIX socket API is used to call Silicon Labs socket API. The logic is now reversed. Silicon Labs socket API became a wrapper around the POSIX socket API that is now exposed by the stack.
• Removed the RTOS dependencies from the libraries.

Fixed Issues

• Fixed in release 1.9.0.0

packets with an empty payload.
1225947| Fixed an error causing the frequency hopping to be blocked on rare occasions.
ID #| Description
---|---
1234624| Fixed an error causing LLC messaging allocation to fail. It was caused by an invalid logic in the mac TX queue.
1252174| Fixed an error causing LFNs to use an invalid broadcast schedule after a reconnection.
1246610| Fixed an error causing LFNs reconnection to a router to fail.
1234620| Fixed an error preventing LFNs to send NS(EARO) and thus to reconnect after a given number of non- consecutive unsuccessful connection attempts.
1244154| Fixed an error causing an invalid memory access in dense topologies.
1235265| LUS-IE were sent in all LFN data frames, even when the Listen Interval did not change.
1252134

1235277

| Improved the overall stability when disconnecting LFNs.

Fixed in release 1.8.0.0

and then later re-join with a different device type.
1220872| Fixed an error causing an LFN parent to hard fault on an LFN disconnection.
1213289| Fixed an invalid variable initialization that could cause a device frame counter to be set to 0 when using IAR.
1205266| Fixed an invalid configuration preventing LFN to connect when using the Balanced or Eco modes.
1204471| Fixed an invalid initialization in MPL that was causing a multicast packet to be considered as old after a router re- connection.
1194355| Fixed an invalid time synchronization between an LFN and his FFN parent. It was causing significant drifts making downstream communications instable after a while.
1187012| The Join Metric IE was not forwarded when the join state 1 was skipped.
1168410| Fixed an error causing a LFN to be out-of-sync when no packet is exchanged for more than 1h10 (uint32 max us)
1132165| Fixed an error causing MAC retries to be skipped on rare occasions.
1014210| Fixed an error causing routers to stay on the wrong channel after performing asynchronous transmissions.
1104667| LFN are now send a Neighbor Solicitation with an EARO with a zero lifetime when disconnecting.
1182578| Wi-SUN OUI was coded with the wrong byte ordering.
1199108| Maintained and restored the DHCP Identity Association ID (IAID) across reboots.
1205932| That stack performed a CSMA/CA on asynchronous frame transmissions. This behavior is specifically forbidden in the FAN TPS.
1223417| The stack occasionally tried to send a Neighbor Advertisement (NA) as a reply to a received Neighbor Solicitation (NS) used for Neighbor Unreachability Detection (NUD). This behavior is specifically forbidden in the FAN TPS.

Known Issues in the Current Release

Issues in bold were added since the previous release.

Until this problem has been addressed correctly, the stack will refuse to start if both ARIB enforcement and FEC are enabled.
1067978| Packets sent using a PHY with a bandwidth larger than the base PHY’s bandwidth can infringe ARIB regulation.| Limit the communications when using mode switch with ARIB enforcement enabled.
ID #| Description| Workaround
---|---|---
1176014| FG25 asserts with a RAIL_ASSERT_FAILED_RTCC_SYNC_STALE_DATA error code when entering EM2.| Do not allow the power manager to go to EM2 by adding a requirement on EM1 in the application.

Applications

New Items
Added in release 1.9.0.0

Wi-SUN – RCP

• Released RCP v2.0: Must be used in pair with wsbrd v1.9 and more recent. It significantly reduces the memory footprint. The memory required to run the application no longer depends on the number of routers connected to the border router.

Wi-SUN – SoC CoAP Meter and Collector

• LFN Power Optimization: Application level actions (measure, print, RX/TX) are scheduled for the LFN wake-up events exclu-sively, without delay Added in release 1.8.0.0

Wi-SUN SoC CLI:

• The default values are now coming from the Wi-SUN Configurator
• FAN1.1 PHY nomenclature is now used by default.

Wi-SUN – SoC Network Measurement

• More robust iPerf client algorithm
• iPerf statistics improvement

Wi-SUN – SoC (CoAP) Meter and Wi-SUN – SoC (CoAP) Collector

• Meters now automatically send their measurements to the Collector. In the previous implantation, the Collector was polling the information on a regular basis.
• Meters advanced request modes
• Registration and remove request: set the destination of the meter measurements.
• LFN Profile-based measurement/report schedule.

Wi-SUN – SoC TCP Server

• The application is now using blocking sockets.

CoAP Notification Service

• App Status Component provides statistic notification about the application.

OTA DFU:

• Added a component option to enable or disable the automatic installation of the new firmware.

Configurable LFN Support for all the applications

• An application can be either LFN or FFN
• Documented the process to configure applications to be able to enter EM2 energy mode.

EFR32xG28 Explorer Kit Support

Fixed Issues

• Fixed in release 1.9.0.0

to decode a broadcast packet.

• Fixed in release 1.8.0.0

It was leading to a border router reboot and a collapse of the whole network.
ID #| Description
---|---
1225118| Border Router SoC: Fixed an error preventing the BR to stop when started was an invalid PHY configuration.
1210967| Border Router SoC: Fixed an error causing a hard fault when connecting more than 22 routers directly to the border router SoC.
1212392| LFN Sample Applications can’t enter into EM2.
1078443| iperf: Fixed an issue causing the throughput to collapse when targeting a UDP bandwidth greater than the theoretical maximum

Known Issues in the Current Release

Issues in bold were added since the previous release

is not recommended for the time being.
1255197| After a lost ping response no new ping requests can be issued since recvfrom() blocks until a ping response is received.

For all applications except:

·         Wi-SUN – CLI example

·         Wi-SUN – LFN CLI example

·         Wi-SUN – RCP

| Update the socket for non-blocking (SOCK_RAW | SOCK_NONBLOCK) in

_ping_task_fnc()

 | Simplicity Studio – Network Analyzer:

Wi-SUN Encrypted Packets are not supported

Undecoded frames (only after Ack) according to PTI issues on Series 2

|

Using This Release

This release contains the following:

• Wi-SUN stack library
• Wi-SUN sample applications
• Wi-SUN border router pre-compiled demos
• Documentation
  If you are a first time user, see https://docs.silabs.com/wisun/latest/wisun- getting-started-overview/

Installation and Use

The Wi-SUN SDK is provided as part of the Gecko SDK (GSDK), the suite of Silicon Labs SDKs. To quickly get started with the GSDK, install Simplicity Studio 5, which will set up your development environment and walk you through GSDK installation. Simplicity Studio 5 includes everything needed for IoT product development with Silicon Labs devices, including a resource and project launcher, software configuration tools, full IDE with GNU toolchain, and analysis tools. Installation instructions are provided in the online Simplicity Studio 5 User’s Guide. Alternatively, Gecko SDK may be installed manually by downloading or cloning the latest from GitHub. See https://github.com/SiliconLabs/gecko_sdk for more information.

Simplicity Studio installs the GSDK by default in:

• (Windows): C:\Users\\SimplicityStudio\SDKs\gecko_sdk
• (MacOS): /Users//SimplicityStudio/SDKs/gecko_sdk
• Documentation specific to the SDK version is installed with the SDK.

Security Information

Secure Vault Integration

This version of the stack does not integrate Secure Vault Key Management

Security Advisories

To subscribe to Security Advisories, log in to the Silicon Labs customer portal, then select Account Home. Click HOME to go to the portal home page and then click the Manage Notifications tile. Make sure that ‘Software/Security Advisory Notices & Product Change Notices (PCNs)’ is checked, and that you are subscribed at minimum for your platform and protocol. Click Save to save any changes

Support

Development Kit customers are eligible for training and technical support. Contact Silicon Laboratories support at

• http://www.silabs.com/support

Simplicity Studio

One-click access to MCU and wireless tools, documentation, software, source code libraries & more. Available for Windows, Mac and Linux

• IoT Portfolio
  • www.silabs.com/IoT
• SW/HW
  • www.silabs.com/simplicity
• Quality
  • www.silabs.com/quality
• Support & Community
  • www.silabs.com/community

Disclaimer

Silicon Labs intends to provide customers with the latest, accurate, and in- depth documentation of all peripherals and modules available for system and software implementers using or intending to use the Silicon Labs products. Characterization data, available modules and peripherals, memory sizes and memory addresses refer to each specific device, and “Typical” parameters provided can and do vary in different applications. Application examples described herein are for illustrative purposes only. Silicon Labs reserves the right to make changes without further notice to the product information, specifications, and descriptions herein, and does not give warranties as to the  accuracy or completeness of the included information. Without prior notification, Silicon Labs may update product firmware during the manufacturing process for security or reliability reasons. Such changes will not alter the specifications or the performance of the product. Silicon Labs shall have no liability for the consequences of use of the information supplied in this document. This document does not imply or expressly grant any license to design or fabricate any integrated circuits. The products are not designed or authorized to be used within any FDA Class III devices, applications for which FDA premarket approval is required or Life Support Systems without the specific written consentof Silicon Labs. A “Life Support System” is any product or system intended to support or sustain life and/or health, which, if it fails, can be reasonably expected to result in significant personal injury or death. Silicon Labs products are not designed or authorized for military applications. Silicon Labs products shall under no circumstances be used in weapons of mass destruction including (but not limited to) nuclear, biological or chemical weapons, or missiles capable of delivering such weapons. Silicon Labs disclaims all express and implied warranties and shall not be responsible or liable for any injuries or damages related to use of a Silicon Labs product in such unauthorized applications. Note: This content may contain offensive terminology that is now obsolete. Silicon Labs is replacing these terms with inclusive language wherever possible. For more information, visit www.silabs.com/about-us/inclusive- lexicon-project

Trademark Information

Silicon Laboratories Inc.®, Silicon Laboratories®, Silicon Labs®, SiLabs® and the Silicon Labs logo®, Bluegiga®, Bluegiga Logo®, EFM®, EFM32®, EFR, Ember®, Energy Micro, Energy Micro logo and combinations thereof, “the world’s most energy friendly microcontrollers”, Redpine Signals®, WiSeConnect , n-Link, ThreadArch®, EZLink®, EZRadio®, EZRadioPRO®, Gecko®, Gecko OS, Gecko OS Studio, Precision32®, Simplicity Studio®, Telegesis, the Telegesis Logo®, USBXpress® , Zentri, the Zentri logo and Zentri DMS, Z-Wave®, and others are trademarks or registered trademarks of Silicon Labs. ARM, CORTEX, Cortex-M3 and THUMB are trademarks or registered trademarks of ARM Holdings. Keil is a registered trademark of ARM Limited. Wi-Fi is a registered trademark of the Wi-Fi Alliance. All other products or brand names mentioned herein are trademarks of their respective holders

Silicon Laboratories Inc. 400 West Cesar Chavez Austin, TX 78701 USA

• www.silabs.com

References

• Silicon Labs
• Silicon Labs
• About Us - Silicon Labs
• Silicon Labs Community
• Internet of Things (IoT) - Silicon Labs
• Simplicity Studio - Silicon Labs
• Technical Support - Silicon Labs
• Introduction - latest - Wi-SUN Silicon Labs
• Wi-SUN Protocol Stack - Silicon Labs

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>