Radiocrafts RIIM Series User manual

User Manual
RIIM – Radiocrafts Industrial IP Mesh
Rev. 1.2

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 1 of 23
TABLE OF TABLES .................................................................................................................................................. 1
TABLE OF FIGURES ................................................................................................................................................. 2
TABLE OF EXAMPLES ............................................................................................................................................. 2
ABBREVIATIONS ...................................................................................................................................................... 2
1 INTRODUCTION RIIM ..................................................................................................................................... 3
2 INTRODUCTION .............................................................................................................................................. 4
3 SDK STRUCTURE ........................................................................................................................................... 5
4 HOW TO USE ICI, THE EVENT DRIVEN PLATFORM ................................................................................... 6
5 AN EXAMPLE .................................................................................................................................................. 7
6 SDK SETUP ..................................................................................................................................................... 9
7 BUILDING APPLICATIONS ............................................................................................................................ 9
7.1. USING MAKEFILES .............................................................................................................................................. 9
7.2. CREATING AND UPLOADING THE USER APPLICATION ................................................................................ 11
7.3. ENCRYPTING THE USER APPLICATION .......................................................................................................... 11
7.4. LOCKING THE MODULE .................................................................................................................................... 11
7.5. NETWORK KEY .................................................................................................................................................. 11
8 API USAGE ....................................................................................................................................................12
8.1. RIIM_UAPI ........................................................................................................................................................... 12
8.2. ADC ..................................................................................................................................................................... 12
8.3. COAP ................................................................................................................................................................... 13
8.4. DEBUG ................................................................................................................................................................ 14
8.5. ETHERNET .......................................................................................................................................................... 14
8.6. GPIO .................................................................................................................................................................... 15
8.7. I2C ....................................................................................................................................................................... 16
8.8. NETWORK ........................................................................................................................................................... 17
8.9. NODE .................................................................................................................................................................. 18
8.10. NVS ................................................................................................................................................................. 18
8.11. SPI ................................................................................................................................................................... 19
8.12. TIMER ............................................................................................................................................................. 20
8.13. UART ............................................................................................................................................................... 21
8.14. UTIL ................................................................................................................................................................. 21
DOCUMENT REVISION HISTORY ..........................................................................................................................23
DISCLAIMER............................................................................................................................................................23
TRADEMARKS ........................................................................................................................................................23
LIFE SUPPORT POLICY .........................................................................................................................................23
RADIOCRAFTS SUPPORT: ....................................................................................................................................23
CONTACT RADIOCRAFTS .....................................................................................................................................23
Table of Tables
Table 1 - Makefile variables ......................................................................................................................10
Table 2 - ADC functions ............................................................................................................................12
Table 3 - Coap functions ...........................................................................................................................13
Table 4 - Debug functions .........................................................................................................................14
Table 5 - Ethernet functions ......................................................................................................................14
Table 6 - GPIO functions ...........................................................................................................................15
Table 7 - I2C functions ..............................................................................................................................16
Table 8 - Network functions .......................................................................................................................17
Table 9 - Node functions ...........................................................................................................................18
Table 10 - NVS functions ..........................................................................................................................18
Table 11 - SPI functions ............................................................................................................................19
Table 12 - Timer functions .........................................................................................................................20
Table 13 - UART functions ........................................................................................................................21
Table 14 - UTIL functions ..........................................................................................................................22

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 2 of 23
Table of Figures
Figure 1. RIIM network – system and documentation overview ................................................................. 3
Figure 2. System overview .......................................................................................................................... 4
Figure 3. Workflow using RIIM SDK ............................................................................................................ 9
Table of Examples
Example 1 - ADC sensor example .............................................................................................................. 8
Example 2 - ADC example code ...............................................................................................................12
Example 3 - CoAP example code .............................................................................................................13
Example 4 - Debug example code ............................................................................................................14
Example 5 - Ethernet example code .........................................................................................................14
Example 6 - GPIO example code ..............................................................................................................15
Example 7 - I2C example code .................................................................................................................16
Example 8 - Network example code..........................................................................................................17
Example 9 - Node example code ..............................................................................................................18
Example 10 - NVS example code .............................................................................................................18
Example 11 - SPI example code ..............................................................................................................19
Example 12 - Timer example code............................................................................................................20
Example 13 - UART example code ...........................................................................................................21
Example 14 - UTIL example code .............................................................................................................21
Abbreviations
Abbreviation Description
ADC Analog-to-Digital Converter
API Application Programming Interface
CoAP Constrained Application Protocol
DTLS Datagram Transport Layer Security
GPIO General Purpose Input/Output
I2C Inter-Integrated Circuit
ICI Intelligent C-Programmable I/O
LQI Link Quality Indicator
MAC Media Access Control
OSI Open Systems Interconnection
PAN Personal Area Network
PHY Physical Layer of the OSI model
RF Radio Frequency
RIIM Radiocrafts Industrial IP Mesh
RSSI Received Signal Strength Indicator
SDK Software Development Kit
SPI Serial Peripheral Interface
UART Universal Asynchronous Receiver Transmitter
UDP User Datagram Protocol
WSN Wireless Sensor Network

USER MANUAL RC188x
-
GPR
2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 3 of 23
1 Introduction RIIM
The RIIM network consists of these key elements
- The RIIM SDK
o Software development kit with application frameworks and tools for creating and uploading end
applications to the RC1882-IPM
- The RC1882-IPM module
o The RC1882-IPM module can be configured as root, router or leaf node.
 As a root node it acts as the base of the mesh network. It can connect to an external
network via ethernet or custom user application on other interfaces such as UART
 As a router node, it will be able to transport packets in the RIIM mesh network
 As a leaf node, it is not able to transport packets to other nodes except its parent. This
mode uses the least amount of energy.
o All modes supports customer ICI applications and external connections. Applications use the same
RIIM Software Development Kit (SDK) for all node types.
Below is an illustration of the different elements and the documentation available
Figure 1. RIIM network – system and documentation overview
Ethernet
MAC/PHY
SPI Ethernet
RC1882-IPM
RC1882-IPM
RC1882-IPM
RC1882-IPM Data sheet RC1882-IPM Data sheet
Sub 1 GHz
IEEE
802.15.4g/e
IPv6
UDP
CoAP
RC1882-IPM
Network:
- Internet or local
network
RIIM User Manual
RIIM SOFTWARE DEVELOPMENT KIT (SDK)
RIIM SDK User Manual
RIIM SDK Quick Start Guide
RIIM SDK API reference
RIIM DEVELOPMENT KIT(DK)
RIIM Development Kit User Manual
TOOLS
SYSTEM

USER MANUAL RC188x
-
GPR
2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 4 of 23
2 Introduction
This user manual shows how a custom application for wireless sensors or actuators can be quickly and easily
developed on the Radiocrafts RIIM (Radiocrafts Industrial IP Mesh). The programming is done by using
the Intelligent C-programmable I/O (ICI) concept. ICI presents the user with an event-driven application framework
with high-level C APIs that allows the application to interface any sensor/actuator and to implement any data
processing and edge intelligence. A full sensor application with networking and sensor interface can be written in
as little as 20 lines of code. For more complex applications, several KB of space is available.
Prerequisite is a basic knowledge of C programming, but no expertise. No expertise in wireless networking or
device specific knowledge is required. The goal of this guide is to reduce the complexity and confusion of
embedded wireless to something simple and easy for everybody.
The guide covers the following topics:
 how to quickly develop your application on ICI, the event-driven platform
 how to interface to sensors or actuators using APIs for I2C, ADC, GPIO, UART, SPI
 how to create events based on timers, GPIO and UART
 how to join networks, send and receive messages
 how to choose trade-offs between responsiveness and power consumption
 how to compile and load your application using our free development tools
Figure 2. System overview
MCU / Wireless Tranceiver (HW)
Real Time Operating System (RTOS)
Low level drivers
High level drivers
IEEE 802.15.4 g/e
PHY/MAC
Application framework
ICI application code
Bootloader(BSL)
Platform image
Application image
IP/6LoWPAN
RPL
UPD
DTLS (security)
CoAP
API

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 5 of 23
3 SDK structure
The SDK directory contains the following:
 docs/
o The documentation
 Framework/
o The SDK internals. Do not modify the content unless you know what you are doing.
 Framework/Linker/
o Files used during linking.
 Framework/Makefile
o Used by the build process.
 Framework/Tools/
o Containing the command line tools and scripts. These are described in detail later.
 Framework/User_API/
o Containing the API header files
 User_Applications/
o Your code as well as example code. This is where most users will work.

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 6 of 23
4 How to use ICI, the Event Driven Platform
Everything in ICI is event-driven. It is up to the user application to define the events and the handlers for these
events.
Think of the user application as a list of event handlers — if-this-then-that. If this event occurs, then do that in this
handler.
As an example, a simple wireless sensor application could be defined by the following event behaviors.
 if network state is offline then turn off the LED
 if network state is joining then blink the LED
 if network state is online then turn on the LED
 after powering up, automatically join or rejoin a network
 every 20 seconds, read data from the sensors on I2C
 after every sensor reading, send sensor data as CoAP message to a given IP address
Of course, a lot more is possible. Sensors and actuators can be accessed using different interfaces (I2C, ADC,
GPIO, SPI, UART..). Periodic or one-shot timer events can be created. Custom actions can be triggered by network
commands from the root node. Global variables can be used to track internal states. Data can be saved to non-
volatile memory to preserve them across power resets. Algorithms can be implemented to process or filter data.
Underneath, ICI silently takes care of the security and reliability of the network, any over-the-air updates, and the
powerful real-time operating system (RTOS) that schedules the events.
The user code is is composed of RIIM_SETUP() and a list of event handlers. RIIM_SETUP() is the only function
that must be implemented, and it is called from the application framwork when the node starts up. From within
RIIM_SETUP(), you can define events and register handlers for these events — e.g. when you receive a
message, or when a timer expires.
You can also chain events based on other events by defining an event within another event handler. For example,
you can start a timer when a GPIO edge triggers.

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 7 of 23
5 An example
We will show you an example of a wireless voltage sensor using the built in ADC.
This sensor will have the following behaviors:
 Finds and joins a network automatically
 Every 10 seconds, read data from the ADC
 Periodically, send a CoAP PUT message to a CoAP server – in this case the root node
Take a look at the code implementation below. Only basic C knowledge is required. And keep in mind that the
entire code is composed of RIIM_SETUP() and a list of event handlers.
Example : ICI code
#include "RIIM_UAPI.h"
static const uint32_t TimerPeriod=10;
static uint8_t CoAP_timer_handler, Sensor_timer_handler;
static const uint8_t Resource_Name[]="data";
static uint32_t milliVolts;
static void ReadSensor()
{
ADC.convertToMicroVolts(ADC0, &milliVolts);
milliVolts /= 1000;
return;
}
static void SendCoAP()
{
ipAddr RootNodeIPAddr;
// We first check if we are part of a network and the address of the root node
if(Network.getRootNodeAddress(&RootNodeIPAddr)!=UAPI_OK){
return;
}
CoAP.connectToServer(&RootNodeIPAddr, false);
// Send temperature and humidity to root node. The URI is "coap://[root-node-
ip]/data"
// For this demo, we'll use JSON formatting. JSON is not size efficient,
// but easy to read and parse
uint8_t payload[100];
int payload_length;
payload_length=Util.sprintf((char*)payload,"{\"mV\": %i}", milliVolts);
CoAP.send(CoAP_PUT, false, Resource_Name, payload, payload_length);
return;
}
void ResponseHandler(const uint8_t *payload, uint8_t payload_size)
{
Util.printf("# Got CoAP Response. Doing nothing with it...\n");
return;
}

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 8 of 23
RIIM_SETUP()
{
Util.printf("# Starting RIIM Sensor Board Node\n");
// Initialize variables.
// This MUST be done explicitly in RIIM_SETUP(), except if they are
// declared const
milliVolts=0;
// Set up interface towards the SHT35-sensor
ADC.init(ADC0, ADC_FIXED_REFERENCE, ADC_SAMPLING_DURATION_10_6_US);
// Create CoAP resource
CoAP.init(ResponseHandler);
// Create timer that sends the CoAP PUT message
Sensor_timer_handler=Timer.create(PERIODIC, TimerPeriod, ReadSensor);
CoAP_timer_handler=Timer.create(PERIODIC, TimerPeriod, SendCoAP);
Timer.start(Sensor_timer_handler);
Timer.start(CoAP_timer_handler);
// Start the node
Network.startLeafNode();
// Return UAPI_OK to indicate setup went well
return UAPI_OK;
}
Example 1 - ADC sensor example
Hopefully you get an idea of how easy it is to define and register a handler for an event. In a little more than 30
lines of actual code you have created a full CoAP and Mesh-enabled ADC sensor.

USER MANUAL RC188x
-
GPR
2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 9 of 23
6 SDK Setup
Please follow the RIIM SDK Quick Start Guide on how to install and setup RIIM SDK on your machine.
7 Building Applications
The user application is edited in your favorite text editor, and compiled by invoking a simple script. The compiler
used underneath is GCC, a very well known compiler. The user do not need to be familiar with compiler tools and
configurations, as everything is taken care of by the scripts provided from Radiocrafts.
The development tools runs on both Linux-like systems and Windows. Radiocrafts provides a complete
development environment with everything that is needed that the user can download for free. Please see RIIM SDK
Quick Start Guide on how to install the development environment. In the following examples, Linux is used. For
windows, substitute the “.sh” file ending with “.bat” and “dev/ttyUSB0” with your associated COM port (for example
“COM3”).
7.1. Using makefiles
The build system is using makefiles, but the user do not need to know how they work. If you are not familiar with
makefiles, the SDK provides a fully working and easy-to-edit makefile. You can copy it and use it in any new user
application project. It is located here: RIIM_SDK/User_Applications/User_App/Makefile
There are several default values in the makefile that can be overridden or edited, shown in the table below:
Figure 3. Workflow using RIIM SDK

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 10 of 23
Value Description
SOURCE_FILES The source files that is to be compiled
OUTPUT_FILENAME The output filename for your created application. A «.bin» will be appended
to the filename
PORT Which serial port to use. In windows, this will be COM1, COM2 ...., and in
linux it will be /dev/ttyUSB0, /dev/ttyUSB1...
AKEY Filename for the application encryption key
NKEY Filename for the network encryption key
Framework_Path The relative path to the framework
Table 1 - Makefile variables
The variables can be overridden as in these examples
$ make uploadImage PORT=COM3
$
make encrypted
AKEY=MyKey.key

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 11 of 23
7.2. Creating and Uploading the User Application
The following example shows how to create (compile) an unencrypted user application image and upload it to the
node using the bootloader over USB.
$
make
$ make uploadImage
<USER MUST RESET THE MODULE>
7.3. Encrypting the User Application
The user application can be encrypted to protect the users Intellectual Property and secure the product from
fraudulent software. To enable encryption of the user application, two criteria must be met:
 The encryption key must be programmed into the bootloader
 The user application image must be created with the same key
This is achieved using the scripts provided with the development environment from Radiocrafts. The example
assumes that there exist a key file called encryption.key in the same folder as the application. The following
sequence must be followed:
$ make encrypted
$ make uploadAppKey
<USER MUST RESET THE MODULE>
$
make uploadImage
7.4. Locking the module
Locking the module means that no one can upload unencrypted images to the module anymore. This feature helps
protect the application and is NOT reversible. It may be feasible to not lock the module if the user is actively
developing on the module. Locking should be done before shipping the product to disable possible tampering.
$ make lock
<USER MUST RESET THE MODULE>
7.5. Network Key
Network key can also be loaded into the bootloader. This key is used in the network so that only approved units
can join the network. All nodes in the network must have the same key to be able to use this feature. The key can
be distributed pre-shared via the bootloader or can be updated by the user application itself. The latter enables the
possibility of using key exchange algorithms. A file called network.key is assumed to be present in the same
directory.
$ make uploadNWKey
<USER MUST RESET THE MODULE>

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 12 of 23
8 API Usage
The following sections describes each of the API modules. The functions are presented in a simplified form here as
a quick reference; please see the RIIM SDK API Reference document for details.
8.1. RIIM_UAPI
This is basically an include file that includes everything you need to develop in ICI. It includes all User API
definitions and needed standard C header files.
Simply put this include line on top of your source file:
Example : ICI code
#include "RIIM_UAPI.h"
8.2. ADC
The ADC module lets you sample and convert the analog input of the module
RC1882-IPM supports 2 ADC channels, called ADC0 and ADC1.
The following example shows an example usage where the ADC is initialized, read, and the value is converted to
millivolts and printed on the console.
Example : ICI code
static uint32_t milliVolts;
void ADC_DemoFunc()
{
milliVolts=0;
// Set up interface
ADC.init(ADC0, ADC_FIXED_REFERENCE, ADC_SAMPLING_DURATION_10_6_US);
ADC.convertToMicroVolts(ADC0, &milliVolts);
milliVolts /= 1000;
// Print directly to console to show the latest values
Util.printf("ADC sensor read: Voltage(mV): %i\n",milliVolts);
return;
}
Example 2 - ADC example code
The following functions are part of the ADC module.
Function Description
init(Channel, Reference,
SamplingDuration)
Initializes the ADC module input (either ADC0 or ADC1). It specifies
which voltage reference to use and how long a sampling takes
convert(Channel, Value) Convert an input voltage to its raw ADC value
convertToMicroVolts(Channel, Value) Convert an input voltage to a integer representing the input voltage in
microvolts
Table 2 - ADC functions

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 13 of 23
8.3. CoAP
The CoAP module lets you start and run a CoAP server and lets you transmit CoAP messages to a server.
The following example demonstrates how you initialize the CoAP module, set up a response handler and a
resource access handler. When this node receives a PUT, POST, GET or DELETE CoAP message, it will call the
CoAP_Handler routine.
Example : ICI code
static const uint8_t Resource_Name[]="data";
static void CoAP_Handler(RequestType type, uint8_t *payload, uint8_t payloadSize,
uint8_t *response, uint8_t *responseSize)
{
// In this example we only print the payload directly to the UART
Debug.printPayload(payload, payloadSize);
Util.printf("\n"); // Add a newline for readability in console
return;
}
void ResponseHandler(const uint8_t *payload, uint8_t payload_size)
{
Util.printf("# Got CoAP Response. Doing nothing with it...\n");
return;
}
RIIM_SETUP()
{
Network.startBorderRouter(NULL, NULL, NULL, NULL);
// Setup coap resource
CoAP.init(ResponseHandler);
CoAP.registerResource(Resource_Name,1,CoAP_Handler);
return UAPI_OK;
}
Example 3 - CoAP example code
The following functions are part of the CoAP module.
Function Description
Init() Initializes the CoAP module
connectToServer(IPAddress, Secure) Connect to a CoAP server. This must be done before accessing it.
registerResource(Path, resourceID,
CoAP_Handler)
Register a new resource that will be accessible on the node
generateResponse(Payload,
PayloadSize, Response,
ResponseSize)
Generate a response message and send it back to the caller
send(RequestType, IPAddress,
Resource, Payload, PayloadSize)
Send a GET, PUT, POST or DELETE message to a CoAP server
Table 3 - Coap functions

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 14 of 23
8.4. Debug
The Debug module contains useful functions for debugging.
The following example shows how you can dump the configuration of the node by calling Debug.printSetup().
Example : ICI code
RIIM_SETUP()
{
Network.startBorderRouter(NULL, NULL, NULL, NULL);
// Print out the configuration
Debug.printSetup();
return UAPI_OK;
}
Example 4 - Debug example code
The following functions are part of the Debug module.
Function Description
printPayload(Payload, Payload_Size) Dump the payload to the UART
printSetup() Print the current node setup on the UART
printIPAddr(IPAddr) Nicely print IPAddr
Table 4 - Debug functions
8.5. Ethernet
The Ethernet module contains functions for the Ethernet physical connection.
The following example shows how to initialize the Ethernet controller. However, this is normally not necessary as
the Ethernet module is automatically initialized if the node is configured as a Border Router.
Example : ICI code
void DemoFunc()
{
Ethernet.init();
}
Example 5 - Ethernet example code
The following functions are part of the Ethernet module.
Function Description
Init() Initialize the Ethernet module. This is automatically called when user
starts the Border Router with Network.startBorderRouter, and it is
then not necessary to call this.
Table 5 - Ethernet functions

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 15 of 23
8.6. GPIO
The GPIO module is used to control the GPIOs. By default all GPIOs are tri-state inputs with no pullup or pulldown.
The following example shows how to configure GPIO 9 as output and setting it to logical ‘1’.
Example : ICI code
RIIM_SETUP()
{
// Set up GPIO 9
GPIO.setDirection(GPIO_9, OUTPUT);
GPIO.setValue(GPIO_9, HIGH);
return UAPI_OK;
}
Example 6 - GPIO example code
The following functions are part of the GPIO module.
Function Description
Init() Initialize the GPIO module
setDirection
(Pin, Direction) Set the GPIO direction to input or output
setPull(Pin,Pull) Set pullup, pulldown or no pull on an input pin
setHandler(Pin, InterruptEdge,
Handler)
Register a handler to be called when a specific transition happen on a
GPIO
setValue(Pin, Value) Set the value on an output GPIO to logical 0 or 1
toggle(Pin) Invert the output value on an GPIO
getValue(Pin) Read the value of a GPIO pin
Table 6 - GPIO functions

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 16 of 23
8.7. I2C
The I2C module has functions needed for interfacing the I2C bus. It always operates as master, and support clock
stretching. It supports two speeds: 100KHz and 400KHz.
The following example demonstrates how the module is initialized and an example transmission towards a
Sensirion SHT35 Temperature/Humidity sensor.
Example : ICI code
static void ReadSensor()
{
static uint8_t wbuf[2];
static uint8_t rbuf[10];
// The command 0x2C0D starts a Medium repeatibility measuring
// with clock stretching enabled. See Sensirion SHT35 datasheet.
wbuf[0]=0x2C;
wbuf[1]=0x0D;
I2C.transfer(0x44,wbuf,2,rbuf, 7);
.......
}
RIIM_SETUP()
{
// Set up interface towards the SHT35-sensor
I2C.init(I2C_400KHZ);
.........
return UAPI_OK;
}
Example 7 - I2C example code
The following functions are part of the I2C module.
Function Description
init(Speed) Initializes the I2C driver with the chosen Speed
transfer(SlaveAddress, WriteBuffer,
WriteLenth, ReadBuffer, ReadLength)
Transfers data both to and from the slave at bus address
SlaveAddress. Data is first written on bus, then read
read(SlaveAddress, ReadBuffer,
ReadLength)
Perform only read on the I2C bus
write(SlaveAddress, WriteBuffer,
WriteLength)
Perform only write on the I2C bus
Table 7 - I2C functions

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 17 of 23
8.8. Network
The Network module has the functions needed for network operations. Before the node can join any network, it
must be started by a call to either startBorderRouter, startRouterNode or startLeafNode.
The following example shows how to start a node as a Router:
Example : ICI code
RIIM_SETUP()
{
// Simply start as a router node. Nothing more is needed.
Network.startRouterNode();
return UAPI_OK;
}
Example 8 - Network example code
The following functions are part of the Network module.
Function Description
startBorderRouter(IPv6_Prefix,
IPv4_Address, IPv4_Netmask,
IPv4_Gateway)
Start the node as a Border Router. The arguments are optional, but
must be provided for your chosen technology (IPv4 or IPv6) if you
want to enable automatic connection to the outside world
startRouterNode() Start the node as a Router. This means that the node is capable of
routing packets through itself
startLeafNode() Start the node as a Leaf. This means that the node is NOT capabe of
forwarding packets to other nodes, but will use less energy
getRootNodeAddress(IPAddress) This function returns the address of the WSN root node. It will only do
so if the node is part of a WSN and the root is reachable.
getLastRSSI() Get the RSSI value of the last packet received
getLastLQI() The the LQI value of the last packet received
getNetworkState() Get the state of the network
join() RESERVED
leave() RESERVED
setFreqBand(FrequencyBand) Sets the frequency band. Only 868 MHz is available
getPanId() Get the PAN ID of the node
getAddress(IPAddress) Get the IP address of the node
setTxPower(TxPower) Set the output transmission power
ping(IPAddress) Perform a ping to any IP address
getNodeType() Return the type of node we are configured as
Set Channel(ChannelNumber) Sets the RF channel to use
Table 8 - Network functions

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 18 of 23
8.9. Node
The Node module contains functions for setting node power options.
Example TBD:
Example : ICI code
static void DemoFunc()
{
NodeInfo info;
Node.getNodeInfo(&info);
Util.printf("HW Revision is %i\n", NodeInfo.Hardware.Rev);
return;
}
Example 9 - Node example code
The following functions are part of the Node module:
Function Description
getNodeInfo(Node_Info) Return info about the node: Hardware ID+Revision, Platform
ID+Version, Application Version
Table 9 - Node functions
8.10. NVS
The NVS module contains functions for accessing the non-volatile memory. This must be used with caution, as it is
possible to erase or corrupt the module firmware. If that happens, it may need to be reprogrammed at Radiocrafts.
Example TBD
Example : ICI code
static void DemoFunc()
{
const uint8_t buffer="1234567890";
NVS.eraseSector(0x00001000);
NVS.write(0x00001000, 10, buffer);
return;
}
Example 10 - NVS example code
The following functions are part of the NVS module:
Function Description
init(void) Initialize the NVS module
eraseSector(Address) Erase a whole FLASH sector
read(Address, Length, Buffer) Read a part of FLASH
write(Address, Length, Buffer) Write a part of FLASH
Table 10 - NVS functions

USER MANUAL RC188x
-
GPR

2019 Radiocrafts AS RIIM User Manual (rev.1.2) Page 19 of 23
8.11. SPI
The SPI module has all the functions needed for accessing the SPI bus. For chip select control, the user must use
a GPIO. For all data transfer and initialization, the SPI module can be used. In the example below, usage of both
GPIO and SPI is demonstrated. Only 4-wire SPI is supported
The following example shows how to set up SPI and access the ST LIS3DE accelerometer:
Example : ICI code
RIIM_SETUP()
{
// Set up GPIO. We must use one GPIO for SPI chip select
GPIO.setDirection(GPIO_3, OUTPUT);
GPIO.setValue(GPIO_3, HIGH);
// Set up interface towards the LIS3DE-sensor
SPI.init(4000000,SPI_POL_0_PHA_0);
// Setup accelerometer to update every second
uint8_t wbuf[2];
wbuf[0]=0x20; // 0 (write), 0(do not increment), 0x20 (register address)
wbuf[1]=0x17; // 1 Hz, enable X,Y and Z axes
GPIO.setValue(GPIO_3, LOW);
SPI.transfer(2, wbuf, NULL);
GPIO.setValue(GPIO_3, HIGH);
return UAPI_OK;
}
Example 11 - SPI example code
The following functions are part of the SPI module:
Function Description
init(Speed, SPIClockMode) Initialize the SPI module. Speed and SPI mode must be specified
transfer(Count, txBuffer, rxBuffer) Transfer bytes over the SPI bus. Reading bytes is implicit, but any of
the buffers can be set to NULL to disable reading or writing (disable
writing means putting zero on the MOSI line)
Table 11 - SPI functions