Introduction

The Morse Micro IoT SDK provides a framework for developing embedded applications that include connectivity provided by Morse Micro transceivers.

This SDK provides out of the box examples for the Morse Micro IoT Reference Platforms. The two main components of these platforms are a Morse Micro Wi-Fi HaLow transceiver and an MCU Host for running application firmware. Note that you can use your own platform but some additional work will be required.

Morse Micro IoT Reference Platform Overview

This SDK package contains the software components to build the application firmware for the STM32 processor. These components include:

• Real time operating system (FreeRTOS)
• Network stack (lwIP)
• Morse Micro host software (morselib)
• Platform-specific board support package (BSP)
• Crypto implementation for WPA Supplicant (MbedTLS)
  • This is only required when linking against libmorse_nocrypto.a or libmorse_nosupplicant.a or building morselib from source.

A high-level block diagram of the SDK software components is shown below.

High-level block diagram of the SDK software components

Morselib Overview

The Morse Micro host software included in morselib provides the driver interface for communicating with the transceiver and the upper layers of the Wireless LAN MAC, as well as additional application-layer network protocols. APIs provided by morselib include:

• Various control APIs that can be used by the application code to manage Wireless LAN operations, including:
  • WLAN Control API for Scan – API for performing WLAN Scan operations.
  • WLAN Control API for Station (STA) mode – API for configuration and control of Station (STA) mode.
  • WLAN Control API for Device Provisioning Protocol (DPP) – API for executing Device Provisioning Protocol (DPP), also known as Wi-Fi Easy Connect.
  • WLAN Control API for Access Point (AP) mode – API for configuration and control of Access Point (AP) mode.
  • WLAN General Control API – API for general control and configuration that is not linked to a specific operational mode.
• Morse Micro Embedded Test Engine (Emmet) API for test automation.
• A WLAN Datapath API, Morse Micro Operating System Abstraction Layer (mmosal) API, and Morse Micro Hardware Abstraction Layer (mmhal) API, which provide abstract interfaces to the IP stack, RTOS, and MCU BSP respectively. Shim layers provide the mapping between these morselib APIs and the corresponding lwIP/FreeRTOS/BSP API.

In addition to the APIs provided by morselib, supporting infrastructure includes:

• Morse Micro IP Stack Abstraction Layer (MMIPAL) API, which provides a layer of abstraction to simplify management of network stacks, with support included for the lwIP network stack.
• Application Layer Protocol APIs for Morse Micro implementations of protocols including ping and iperf.
• Morse Micro Persistent Configuration Store APIs for storing configuration data, etc.

The Getting Started Guide provides step-by-step instructions for getting up and running with this SDK using a Makefile-based workflow.

API production readiness annotations

When a morselib feature is under development, and is not yet ready for production deployment, the associated APIs will be annotated to indicate the level of feature maturity.

Alpha — Suitable for initial evaluation only, not for production use. The API is incomplete, likely to change, and bugs are expected.

Beta — Suitable for evaluation and prototyping, but not recommended for production. The API is feature complete but may still change. Known issues are documented.

In general, unmarked APIs can be considered production ready with a stable interface.