RIIM User Manual

This document shows how a custom ICI application for wireless sensors or actuators can be quickly and easily developed on the Radiocrafts RIIM (Radiocrafts Industrial IP Mesh).

Quick links:

• Introduction to RIIM: Introduction

• Setup and installation: SDK Setup

• Quick start: Quickstart

• RIIM detailed documentation: The RIIM Network

• SDK detailed documentation: The SDK and Its Tools

• ICI detailed documentation: ICI Description

---

Full table of contents:

• Terms and abbreviations
• Introduction
  • RIIM description
    • RIIM mesh network
      • Border routers
  • SDK and platform versioning
• SDK - Software Development Kit
  • Quickstart
    • Building, uploading and running ICI applications
      • Building and Uploading Using VSCode
      • Building and Uploading Using Scripts
      • Compile Using CMake
      • Observing the Output
      • The way forward
  • SDK Setup
    • Windows setup
      • Installing the SDK
      • Installing GNU Embedded Toolchain for ARM
      • Installing CMake
      • Installing Python
      • Installing Ninja
      • Installing a terminal program
      • Installing the MAKE Tool
    • Linux setup
      • Installing the SDK
      • Installing GNU Embedded Toolchain for ARM
      • Installing Python
      • Installing Ninja
      • Installing a terminal program
    • SDK Directory Structure
    • Example Structure and Naming Conventions
  • The SDK and Its Tools
    • Building ICI Applications
    • Creating a new project
    • Using CMake
    • Using tools
    • Encrypting the ICI User Application
    • Locking the module
    • Read out the module serial number
    • Selecting and Updating the Platform
• RIIM - Radiocrafts Industrial IP Mesh
  • The RIIM Network
    • RIIM Network Attributes
    • Joining
      • Join All using PAN ID 0xFFFF
    • Border Router Connection
      • SLIP
      • External Node Addressing Using Ethernet and IPv4
    • Frequency and output power
    • Connection to the Internet and Cloud/Server Solutions
      • Hardcoding the server address using ICI
      • Using a PC/SBC on the LAN
      • Custom ICI sequence
      • Protocol gateway
    • Out of the box solution
    • Accessing RIIM Nodes Directly From Outside Using IPv4
    • Border Router External IP Address Assignment
    • RIIM Network Address Assignment
    • Security
    • Multicasts
      • Regular Multicast
      • One-hop Multicast
    • Network Data Packets
    • Data packet overhead
    • Link/transmission robustness
  • Medium Access Technologies
    • Single Channel
      • Limitations
    • TSCH
      • Joining and Beacons
        • Beacon Broadcast Rate
        • Number of Connected Nodes Within the Range of the Joining Node
        • The Number of Radio Channels
        • Active or Passive Mode
      • Listen Before Talk
      • Adaptive Frequency Agility
      • Time Synchronous Events
      • Limitations
    • Single Channel or TSCH?
  • Network Timing and Latency
    • Single channel latency
    • TSCH latency
    • Network Throughput
    • Single channel throughput
    • TSCH throughput
    • Network Congestion
    • Unicast data to the border router
    • Unicast data from the border router
    • Multicast data from the border router
  • Network Tuning
    • TSCH parameters
      • Active or Passive Mode
      • Unicast Slotframe Length
      • Root Slotframe Length
      • Shared Slotframe Length
      • Enhanced Beacon (EB) Slotframe Length
      • How Time slot operation works
      • TSCH example network low power
      • TSCH example network balanced system
    • Auto update TSCH parameters
    • Control Packets and Join Times
      • Optimizing join time
      • DIO Interval
      • DAO Delay
      • JoinChannels
    • Multicast
      • Principle
      • Tuning for differnet use cases
      • Duplicate packets and guard time
      • MPL Data Messages
      • MPL Control Messages
  • Managing RIIM platforms
    • Platform versions
    • 150kbps platforms
    • Upgrading or changing the Platform image using scripts
    • Upgrading or changing the Platform image using MAKE
  • Power Consumption
    • Single Channel Node Current Consumption
    • Stopped Network - Deep Sleep
    • TSCH Network
  • Selection Guide
    • Q&A
  • Over-The-Air (OTA) FW Updates
    • Standard OTA
    • Flooding OTA
      • Using Flooding OTA to update your ICI application
    • Using RIIM OTA to update your microcontroller
      • Connecting the module to the microcontroller
      • Image header
      • Procedure for OTA
  • CoAP resources
    • OTA Resource
      • Start new OTA transfer
      • Transfer image
      • Switch image
      • Reset
      • CoAP OTA response message
      • OTA Sequence
    • Node Resource
      • GET
    • Network Resource
      • Get own IP addresses
      • Get neighbour nodes
      • Get the RIIM Network Topology
    • Clock Resource
• ICI - Intelligent C-programmable I/O
  • ICI Description
    • An example ICI application
    • ICI limitations and differences to “regular” C programming
    • Programming the Border Router
  • API Usage
    • Multicast
    • One-hop Multicast
    • RIIM_UAPI
  • API Descriptions
    • ADC
    • Clock
    • CoAP
    • Debug
    • Ethernet
    • GPIO
    • I2C
    • Network
    • Node
    • SECUART
    • SPI
    • Timer
    • UART
    • UDP
    • Util
    • OTA
  • Programming Resources
    • Bootloader
    • Configuring and Programming the Module
    • Connecting Peripherals
    • GPIO
    • SPI
    • I2C
    • ADC
    • UART
    • Internal module resources
    • EEPROM
    • OTA (Over the Air Download)
    • Border Router Functions
• Troubleshooting
  • I am not able to install Ninja on Windows
  • How Do I Find My UART Port on Windows?
  • How do I connect the USB UART to my Linux Virtual Machine
  • I get a permission denied on my ttyUSB port
  • How do I find my UART Port on Linux
  • I am not able to use make on Windows
  • My make behaves strange