Skip to main content
X

RAK3272-SiP Quick Start Guide

Prerequisites​

What Do You Need?​

Before going through the step in the installation guide of the RAK3272-SiP Breakout Board, make sure to prepare the necessary items listed below:

Hardware​

Software​

warning

If you are using Windows 10:
Do NOT install the Arduino IDE from the Microsoft App Store. Instead, install the original Arduino IDE from the Arduino official website. The Arduino app from the Microsoft App Store has problems using third-party Board Support Packages.

List of Acronyms​

AcronymDefinition
DFUDevice Firmware Upgrade
JTAGJoint Test Action Group
LoRaLong Range
OTAAOver-The-Air-Activation (OTAA)
ABPActivation-By-Personalization (ABP)
TTNThe Things Network
DEVEUIDevice EUI (Extended Unique Identification)
APPEUIApplication EUI (Extended Unique Identification)
APPKEYApplication Key
DEVADDRDevice Address
NWKSKEYNetwork Session Key
APPSKEYApplication Session Key
P2PPoint-to-Point

Product Configuration​

RAK3272-SiP Breakout Board as a Stand-Alone Device Using RUI3​

Hardware Setup​

The RAK3272-SiP requires a few hardware connections before you can make it work. The bare minimum requirement is to have the power section properly configured, reset button, antenna, and USB connection.

warning

Firmware update is done via UART2 pins. If you will connect the module to an external device that will be interfacing with UART2, take extra precaution in your board design to ensure you can still perform FW update to it. There should be a way in your board design that can disconnect the external device to RAK3272-SiP UART2 before connecting the module to the PC (via USB-UART converter) for the FW update process.

An alternative option to update firmware aside from UART2 is to use SWD pins (SWCLK & SWDIO). This method will require you to use external tools like ST-LINK or RAKDAP1.

Figure 6827: RAK3272-SiP Schematic

Ensure that the antenna is properly connected to have a good LoRa signal. Also, note that you can damage the RF section of the chip if you power the module without an antenna connected to the RP-SMA connector.

Figure 6828: LoRa Antenna

RAK3272-SiP breakout board has an RP-SMA connector compatible with the included LoRa antenna, as shown in Figure 3.

Figure 6829: RP-SMA Connector of RAK3272-SiP for LoRa Antenna
NOTE

Detailed information about the RAK3272-SiP LoRa antenna can be found on the antenna datasheet.

warning

When using the LoRa transceiver, make sure that an antenna is always connected. Using this transceiver without an antenna can damage the module.

Software Setup​

The default firmware of RAK3272-SiP is based on RUI3, which allows you to develop your custom firmware to connect sensors and other peripherals to it. To develop your custom firmware using Arduino IDE, first, you need to add RAKwireless RUI STM32 Boards in the Arduino board manager, which will be discussed in this guide. You can then use RUI3 APIs for your intended application and upload also the custom firmware via UART. The AT commands of RAK3272-SiP are still available even if you compile custom firmware via RUI3. You can send AT commands via UART2 connection.

RAK3272-SiP RUI3 Board Support Package in Arduino IDE​

If you don't have an Arduino IDE yet, you can download it on the Arduino official website and follow the installation procedure in the miscellaneous section of this document.

NOTE

For Windows 10 and up users: If your Arduino IDE is installed from the Microsoft App Store, you need to reinstall your Arduino IDE by getting it from the Arduino official website. The Arduino app from the Microsoft App Store has problems using third-party Board Support Packages.

Once the Arduino IDE has been installed successfully, you can now configure the IDE to add the RAK3272-SiP to its board selection by following these steps.

  1. Open Arduino IDE and go to File > Preferences.
Figure 6830: Arduino preferences
  1. To add the RAK3272-SiP to your Arduino Boards list, edit the Additional Board Manager URLs and click the icon, as shown in Figure 5.
Figure 6831: Modifying Additional Board Manager URLs
  1. Copy the URL https://raw.githubusercontent.com/RAKWireless/RAKwireless-Arduino-BSP-Index/main/package_rakwireless.com_rui_index.json and paste it on the field, as shown in Figure 6. If there are other URLs already there, just add them on the next line. After adding the URL, click OK.
Figure 6832: Add additional board manager URLs
  1. Restart the Arduino IDE.
  2. Open the Boards Manager from the Tools Menu.
Figure 6833: Opening Arduino boards manager
  1. Write RAK in the search bar, as shown in Figure 8. This will show the available RAKwireless module boards that you can add to your Arduino Board list. Select and install the latest version of the RAKwireless RUI STM32 Boards.
Figure 6834: Installing RAKwireless RUI STM32 boards
  1. Once the BSP is installed, select Tools > Boards Manager > RAKWireless RUI STM32 Modules > WisDuo RAK3272-SiP Board. The RAK3272-SiP breakout board uses the RAK3172-SiP WisDuo module.
Figure 6835: Selecting RAK3272-SiP Board
Compile an Example with Arduino Serial​
  1. After completing the steps on adding your RAK3272-SiP to the Arduino IDE, you can now try to run a simple program to test your setup. You need to add a USB connection to the schematic of the RAK3272-SiP breakout board, as shown in Figure 10.
Figure 6836: RAK3272-SiP with USB to Serial Schematic
  1. Connect the RAK3272-SiP via UART and check RAK3272-SiP COM Port using Windows Device Manager. Double-click the reset button if the module is not detected.
Figure 6837: Device manager ports (COM & LPT)
  1. Choose RAK3272-SiP on board selection select via Tools > Boards Manager > RAKWireless RUI STM32 Modules > WisDuo RAK3272-SiP Board.
Figure 6838: Selecting RAK3272-SiP Breakout Board
  1. Open the Tools menu and select a COM port. COM28 is currently used.
Figure 6839: Select COM port
  1. You can see the serial monitor icon and click it to connect the COM port.
Figure 6840: Open Arduino serial monitor
  1. If the connection is successful, you can send AT Commands to RAK3272-SiP. For example: To check the RUI version, type AT+VER=? on the text area, then click on the Send button, as shown in Figure 15.
Figure 6841: Send AT command
Figure 6842: Arduino serial monitor COM28
  1. Open the Arduino_Serial example code.
Figure 6843: Arduino Serial example
  1. Click on the Verify icon to check if you have successfully compiled the example code.
Figure 6844: Verify the example code
  1. Click the Upload icon to send the compiled firmware to your RAK3272-SiP.
Figure 6845: Upload the example code
  1. If the upload is successful, you will see the Device programmed message.
Figure 6846: Device programmed successfully
  1. After the Device Programmed is completed, you will see the working Arduino_Serial example.
RAK3272-SiP Breakout Board I/O Pins and Peripherals​

This section discusses how to use and access RAK3272-SiP pins using RUI3 API. It shows basic code using digital I/O, analog input, UART, and I2C.

Figure 6847: Available Peripherals and Digital I/O pins in RAK3272-SiP Breakout Board
How to Use Digital I/O​

You can use any of the pins below as Digital Pin.

Pin NameAlternative Pin Usage
PA4SPI1_NSS
PA5SPI1_CLK
PA6SPI1_MISO
PA7SPI1_MOSI
PA8
PA9
PA10
PA11I2C_SCL
PA12I2C_SDA
PA15
PB1
PB2
PB3ADC0
PB4ADC1
PB5
PB6UART1_TX
PB7UART1_RX
PB8
PB9
PB10
PB11
PB12
PB13
PB14
PB15
PC0
PC1
PC2
PC3
PC4
PC5
PC6
PC13
Figure 6848: Available Digital I/O pins in RAK3172-SiP Breakout Board

The pins listed below must not be used.

Pin namePin LocationPin Usage
PA2J3 pin 7UART2_TX
PA3J3 pin 8UART2_RX
PA13J3 pin 5SWDIO
PA14J3 pin 6SWCLK
NOTE

The GPIO Pin Name is the one to be used on the digitalRead and digitalWrite and NOT the pin numbers.

  • Use Arduino digitalRead to read the value from a specified Digital I/O pin, either HIGH or LOW.
  • Use Arduino digitalWrite to write a HIGH or a LOW value to a Digital I/O pin.

Example code

void setup()
{
  pinMode(PA9, OUTPUT); //Change the PA9 to any digital pin you want. Also, you can set this to INPUT or OUTPUT
}

void loop()
{
  digitalWrite(PA9,HIGH); //Change the PA9 to any digital pin you want. Also, you can set this to HIGH or LOW state.
  delay(1000); // delay for 1 second
  digitalWrite(PA9,LOW); //Change the PA9 to any digital pin you want. Also, you can set this to HIGH or LOW state.
  delay(1000); // delay for 1 second
}
How to Use Analog Input​

You can use any of the pins below as Analog Input.

Pin LocationAnalog PortPin Name
J8 pin 2ADC0PB3
J8 pin 3ADC1PB4
  • Use Arduino analogRead to read the value from the specified Analog Input pin.
Figure 6849: Available Analog pins in RAK3272-SiP Breakout Board

Example code

#define analogPin PB3

int val = 0;  // variable to store the value read

void setup()
{
  Serial.begin(115200);
}

void loop()
{
  val = analogRead(analogPin);  // read the input pin
  Serial.println(val);          // debug value
  delay(100);
}
How to Use Serial Interfaces​

UART

There are two UART peripherals available on the RAK3172 module. There are also different Serial Operating Modes possible in RUI3, namely Binary Mode, AT Mode, and Custom Mode.

UART Pin map table

Pin LocationSerial PortSerial Instance AssignmentDefault Mode
J4 pin 5UART1_RXSerial1Custom Mode
J4 pin 6UART1_TXSerial1Custom Mode
J3 pin 8UART2_RXSerialAT Command
J3 pin 7UART2_TXSerialAT Command
Figure 6850: Available UART pins in RAK3272-SiP Breakout Board

Example Code

void setup()
{
  Serial1.begin(115200); // use Serial1 for UART1 and Serial for UART2
                         // you can designate separate baudrate for each.
  Serial.begin(115200);
}

void loop()
{
  Serial1.println("RAK3272-SiP UART1 TEST!");
  Serial.println("RAK3272-SiP UART2 TEST!");
  delay(1000); // delay for 1 second
}

I2C

There is one I2C peripheral available on RAK3272-SiP.

Pin LocationI2C PortPin Name
J3 pin 1I2C_SCLPA11
J3 pin 2I2C_SDAPA12
  • Use Arduino Wire library to communicate with I2C devices.
Figure 6851: Available I2C pins in RAK3272-SiP Breakout Board

Example Code

Make sure you have an I2C device connected to specified I2C pins to run the I2C scanner code below:

#include <Wire.h>

void setup()
{
  Wire.begin();

  Serial.begin(115200);
  while (!Serial);
  Serial.println("\nI2C Scanner");
}


void loop()
{
  byte error, address;
  int nDevices;

  Serial.println("Scanning...");

  nDevices = 0;
  for(address = 1; address < 127; address++ )
  {
    // The i2c_scanner uses the return value of
    // the Write.endTransmission to see if
    // a device did acknowledge to the address.
    Wire.beginTransmission(address);
    error = Wire.endTransmission();

    if (error == 0)
    {
      Serial.print("I2C device found at address 0x");
      if (address<16)
        Serial.print("0");
      Serial.print(address,HEX);
      Serial.println("  !");

      nDevices++;
    }
    else if (error==4)
    {
      Serial.print("Unknown error at address 0x");
      if (address<16)
        Serial.print("0");
      Serial.println(address,HEX);
    }
  }
  if (nDevices == 0)
    Serial.println("No I2C devices found\n");
  else
    Serial.println("done\n");

  delay(5000);           // wait 5 seconds for next scan
}

The Arduino Serial Monitor shows the I2C device found.

17:29:15.690 -> Scanning...
17:29:15.738 -> I2C device found at address 0x28  !
17:29:15.831 -> done
17:29:15.831 ->
17:29:20.686 -> Scanning...
17:29:20.733 -> I2C device found at address 0x28  !
17:29:20.814 -> done
17:29:20.814 ->

SPI

If your RUI3 project uses SPI, then J4 pins 1 to 4 are reserved for the RUI3 SPI interface.

Figure 6852: Available SPI pins in RAK3272-SiP Breakout Board

RAK3272-SiP Breakout Board as a LoRa/LoRaWAN Modem via AT Command​

AT Command via UART2​

RAK3272-SiP Breakout Board can be configured using AT commands via the UART2 interface. You need a USB to UART TTL adapter to connect the RAK3272-SiP to your computer's USB port and a serial terminal tool. You can use the RAK Serial Port Tool so you can easily send AT commands and view the replies from the console output. The RAK Serial Port Tool commands still use the RUI V2 AT commands by default, you can modify it to have RUI3 AT commands and save.

warning

Firmware update and AT command functionality are done via UART2 pins. If you will connect the module to an external host MCU that will send AT commands via UART2, take extra precaution in your board design to ensure you can still perform FW update to it. There should be a way in your board design that can disconnect the host MCU UART to connect to RAK3272-SiP UART2 before connecting the module to the PC (via USB-UART converter) for the FW update process.

An alternative option to update firmware aside from UART2 is to use SWD pins (SWCLK & SWDIO). This method will require you to use external tools like ST-LINK or RAKDAP1.

Connect to the RAK3272-SiP Breakout Board​

  1. Connect the RAK3272-SiP Breakout Board to the RAKDAP1 or any USB-Serial adapter with 3.3 V voltage supply, as shown in Figure 27.
Figure 6853: RAK3272-SiP Breakout Board to USB-Serial connection

  1. Any serial communication tool can be used; but, it is recommended to use the RAK Serial Port Tool.

  2. Configure the serial communication tool by selecting the proper port detected by the computer and configure the link as follows:

  • Baud Rate: 115200 baud
  • Data Bits: 8 bits
  • Stop Bits: 1 stop bit
  • Parity: NONE
RAK3272-SiP Breakout Board Configuration for LoRaWAN or LoRa P2P​

To enable the RAK3272-SiP breakout board as a LoRa P2P module or a LoRaWAN end-device, the module must be configured and parameters must be set by sending AT commands. You can configure the RAK3272-SiP breakout board in two ways:

  • LoRaWAN End-Device - RAK3272-SiP as LoRaWAN IoT device.
  • LoRa P2P - Point to point communication between two RAK3272-SiP Breakout Boards.

Configuring RAK3272-SiP Breakout Board as LoRaWAN End-Device​

To enable the RAK3272-SiP breakout board as a LoRaWAN end-device, a device must be registered first in the LoRaWAN network server. This guide will cover both TTN and Chirpstack LoRaWAN network servers and the associated AT commands for the RAK3272-SiP breakout board.

This guide covers the following topics:

Connecting to The Things Network (TTN)​

This section shows how to connect the RAK3272-SiP Breakout Board to the TTN platform.

NOTE

In this guide, you need to have a working gateway that is connected to TTN or coverage of the TTN community network.

Figure 6854: RAK3272-SiP in the context of the TTN

As shown in Figure 28, The Things Stack (TTN V3) is an open-source LoRaWAN Network Server suitable for global, geo-distributed public and private deployments, as well as for small, local networks. The architecture follows the LoRaWAN Network Reference Model for standards compliance and interoperability. This project is actively maintained by The Things Industries.

LoRaWAN is a protocol for low-power wide-area networks. It allows for large-scale Internet of Things deployments where low-powered devices efficiently communicate with Internet-connected applications over long-range wireless connections.

The RAK3272-SiP Breakout Board can be part of this ecosystem as a device, and the objective of this section is to demonstrate how simple it is to send data to The Things Stack using the LoRaWAN protocol. To achieve this, the RAK3272-SiP Breakout Board must be located inside the coverage of a LoRaWAN gateway connected to The Things Stack server.

Registration to TTN and Creating LoRaWAN Applications​
  1. The first step is to go to The Things Network and sign up for an account shown in Figure 29. Then select a cluster as shown in Figure 31.
Figure 6855: Signing up an account in TTN
Figure 6856: Signing up an account in TTN
Figure 6857: Selecting Cluster in TTN
Figure 6858: Signing up through the Things ID
Figure 6859: Creation of an account through the Things ID
Figure 6860: Creation of an account through the Things ID

You can use the same login credentials on the TTN V2 if you have one. If you have no account yet, you need to create one.

  1. Now that you are logged in to the platform, the next step is to create an application. Click Create an application.
Figure 6861: The Things Stack Platform
Figure 6862: Creating TTN application for your LoRaWAN devices
  1. To have an application registered, input first the specific details and necessary information about your application then click Create application.
Figure 6863: Details of the TTN application
Figure 6864: Details of the TTN application
  1. If you have no error on the previous step, you should now be on the application console page. The next step is to add end-devices to your TTN application.

LoRaWAN specifications enforce that each end-device has to be personalized and activated. There are two options in registering devices depending on the activation mode selected. Activation can be done either via Over-The-Air-Activation (OTAA) or Activation-By-Personalization (ABP).

TTN OTAA Device Registration​
  1. Go to your application console to register a device. To start adding an OTAA end-device, click + Register end device, as shown in Figure 39.
Figure 6865: Register end device
  1. To register the board, click the Enter end device specifics manually.
Figure 6866: Enter end device specifics manually
  1. Next step is to set up Frequency plan, compatible LoRaWAN version, and Regional Parameters version supported. Then provide the JoinEUI credentials by entering zeroes into it.
Figure 6867: Setting up for your device
Figure 6868: Setting up for your device
Figure 6869: Setting up for your device
Figure 6870: Setting up for your device
  1. Then click Show advanced activation, LoRaWAN class and cluster settings. Configure the activation mode by selecting Over the air activation (OTAA) and Additional LoRaWAN class capabilities to class A only. Then click Confirm.
Figure 6871: Setting up for your device
Figure 6872: Setting up for your device
  1. Once done, provide the DevEUI credentials of your device into the DevEUI portion. This will automatically generate the specific End device ID of your board. Then click Generate under AppKey under the Provisioning information section. Then click Register end device.
NOTE
  • The AppEUI, DevEUI, and AppKey are hidden in this section as these are unique from a specific device. The DevEUI credential is unique to every RAK3272-SiP device. Also, you should generate your own AppEUI and AppKey credentials for your specific device and application.
  • The AppEUI is the same as JoinEUI.
Figure 6873: Setting up for your device
Figure 6874: Setting up for your device
Figure 6875: Register end device
  1. You should now be able to see the device on the TTN console after you fully register your device, as shown in Figure 50.
NOTE
  • The AppEUI, DevEUI, and AppKey are the parameters that you will need to activate your LoRaWAN end-device via OTAA. The AppKey is hidden by default for security reasons, but you can easily show it by clicking the show button. You can also copy the parameters quickly using the copy button.
  • The three OTAA parameters on the TTN device console are MSB by default.
  • These parameters are always accessible on the device console page, as shown in Figure 36.
Figure 6876: OTAA device successfully registered to TTN
OTAA Configuration for TTN​

The RAK3272-SiP Breakout Board which has a RAK3172-SiP module in it can be configured using WisToolBox to do the OTAA configuration. WisToolBox is a software tool that supports RAK3172-SiP module. It automatically detects the RAK3172-SiP module once connected to the PC. Below are the options in WisToolBox that the OTAA configuration can be done.

OTAA Configuration for TTN via WisToolBox UI​

The RAK3172-SiP should have the correct OTAA credentials to connect to TTN. This can be done using WisToolBox UI. Below are the steps on setting up your RAK3172-SiP using WisToolBox.

  1. Connect your RAK3172-SiP with your chosen WisBlock base board to the PC via USB cable and open the WisToolBox application.
  2. Click the CONNECT DEVICE button to launch the WisToolBox Dashboard.
Figure 6877: CONNECT DEVICE button
  1. Then select your target port where your RAK3172-SiP is connected. Once recognized, click CONNECT as shown in Figure 53.
Figure 6878: Setting up your device
Figure 6879: Setting up your device
  1. Once done, RAK3172-SiP will appear in the dashboard then select it.
Figure 6880: Device seen from WisToolBox dashboard
  1. Then click PARAMETERS to do the configuration in your RAK3172-SiP.
Figure 6881: Setting up your device
  1. Click Global settings to set the network mode into LoRaWAN and join mode to OTAA. Make sure that the active region is using EU868 for this configuration. If you wish to work on other regional bands, you can choose among active regions based on your location.
  • LoRa network mode: LoRaWAN
  • LoRaWAN join mode: OTAA
  • LoRaWAN region: EU868
Figure 6882: Global settings
Figure 6883: Global settings
  1. Then click LoRaWAN keys, ID, EUI to configure the Application EUI (AppEUI), Application key (AppKey) and Device EUI (DevEUI).
Figure 6884: LoRaWAN keys, ID, EUI
Figure 6885: Setting up your device
  1. Then go back to the console where your RAK3172-SiP End device is created previously. Then copy all the credentials from there. Those will be the ones to be used also in the WisToolBox dashboard. Once encoded into the dashboard, click APPLY COMMAND to update your device as shown in Figure 67.
NOTE

The AppEUI, DevEUI, and AppKey are hidden in this section as these are unique from a specific device.

Figure 6886: You created an OTAA device from your console
  • For Application EUI (AppEUI)
Figure 6887: Copying the AppEUI credential from TTN to WisToolBox
Figure 6888: Copying the AppEUI credential from TTN to WisToolBox
  • For Application key (AppKey)
Figure 6889: Copying the AppKey credential from TTN to WisToolBox
Figure 6890: Copying the AppKey credential from TTN to WisToolBox
  • For Device EUI (DevEUI)
Figure 6891: Copying the DevEUI credential from TTN to WisToolBox
Figure 6892: Copying the DevEUI credential from TTN to WisToolBox
  • WisToolBox Dashboard
Figure 6893: Used credentials from your console in WisToolBox dashboard
  1. Once done, you will see the summary of commands that is applied to your device. Then click CLOSE.
Figure 6894: Summary of commands
  1. Now you will see it returns to the dashboard with updated credentials of your device.
Figure 6895: Successfully configured OTAA device via WisToolBox dashboard
  1. After your device's credentials update, it can now join the network. To do this, you need to go to Data on LoRa network under PARAMETERS. Then click the JOIN NETWORK under LoRaWAN join settings. After a few seconds, it will notify you that your OTAA device already joined the TTN server. You can also to your TTN console if your device has successfully joined the TTN.
Figure 6896: Joining mode of your OTAA device
Figure 6897: OTAA device successfully joined the TTN server
Figure 6898: OTAA device successfully joined the TTN server
OTAA Configuration for TTN via WisToolBox Console​

Here's another way of OTAA configuration using WisToolBox Console. Below are the steps on setting up your RAK3172-SiP using WisToolBox Console.

  1. Connect your RAK3172-SiP with your chosen WisBlock base board to the PC via USB cable and open the WisToolBox application.

  2. Click CONNECT DEVICE button to launch the WisToolBox Dashboard.

Figure 6899: CONNECT DEVICE
  1. Then select your target port where your RAK3172-SiP is connected. Once recognized, click CONNECT as shown in Figure 75.
Figure 6900: Setting up your device
Figure 6901: Setting up your device
  1. Once done, RAK3172-SiP will appear in the dashboard then select it.
Figure 6902: Device seen from WisToolBox dashboard
  1. Then click ADVANCED.
Figure 6903: Setting up your device
  1. Once done, click OPEN CONSOLE to do the configuration.
Figure 6904: OPEN CONSOLE
Figure 6905: Opening the Console terminal of WisToolBox
Figure 6906: Opening the Console terminal of WisToolBox
  1. To start the configuration, type ATE so you can echo the commands you input during your configuration. Then press Enter.

It is recommended to start by testing the console and verify that the current configuration is working by sending these two AT commands:

AT
ATE

ATE is useful for tracking the commands and troubleshooting.

You will receive OK when you input the two commands. After setting ATE, you can now see all the commands you input together with the replies.

NOTE

If there is no OK or any reply, check if the device is powered correctly. If you are getting power from a USB port, ensure that you have a good USB cable.

Figure 6907: Setting up your Console
Figure 6908: Setting up your Console
Figure 6909: Setting up your Console
  1. Then configure the LoRaWAN join mode to OTAA. You can check what parameter you will input by typing AT+NJM? then Enter into the console terminal. For OTAA, you should input AT+NJM=1 then press Enter as shown in Figure 84.
Figure 6910: Setting up your Console
Figure 6911: Setting up your Console
Figure 6912: Setting up your Console
  1. Once done, set-up your LoRaWAN region to EU868. You can check what parameter you will input by typing AT+BAND? then Enter into the console terminal. For EU868, you should input AT+BAND=4 then press Enter. If you wish to work on other regional band, you may check the list of band parameter options below.

Set the frequency/region to EU868.

AT+BAND=4
NOTE

Depending on the Regional Band you selected, you might need to configure the sub-band of your RAK3172 to match the gateway and LoRaWAN network server. This is especially important for Regional Bands like US915, AU915, and CN470.
To configure the masking of channels for the sub-bands, you can use the AT+MASK command that can be found on the AT Command Manual.
To illustrate, you can use sub-band 2 by sending the command AT+MASK=0002.

List of band parameter options

CodeRegional Band
0EU433
1CN470
2RU864
3IN865
4EU868
5US915
6AU915
7KR920
8AS923-1
9AS923-2
10AS923-3
11AS923-4
Figure 6913: Setting up your Console
Figure 6914: Setting up your Console
Figure 6915: Setting up your Console
  1. Then next to this will be updating the OTAA credentials of your device. First to this will be the Application EUI (AppEUI). Go back to your console where your RAK3172-SiP End device was created to copy the AppEUI credential then paste it to the WisToolBox Console then press Enter.
Figure 6916: Your created OTAA device from your TTN console
Figure 6917: Setting up your Console
Figure 6918: Setting up your Console
Figure 6919: Setting up your Console
Figure 6920: Copying the AppEUI credential from TTN to WisToolBox
Figure 6921: Setting up your Console
  1. Once done, do the same procedure to Application key (AppKey) and Device EUI (DevEUI).
  • For Application key (AppKey)
Figure 6922: Setting up your Console
Figure 6923: Setting up your Console
Figure 6924: Setting up your Console
Figure 6925: Copying the AppKey credential from TTN to WisToolBox
Figure 6926: Setting up your Console
  • For Device EUI (DevEUI)
Figure 6927: Setting up your Console
Figure 6928: Setting up your Console
Figure 6929: Copying the DevEUI credential from TTN to WisToolBox
Figure 6930: Setting up your Console
  1. Once done, click Dashboard to check the updated credentials of your OTAA device. Click PARAMETERS to open the Global Settings and LoRaWAN keys, ID, EUI and check whether these portions are updated.
Figure 6931: Setting up your Console
Figure 6932: Setting up your Console
Figure 6933: PARAMETERS
Figure 6934: Global settings and LoRaWAN keys, ID, EUI
Figure 6935: Global settings and LoRaWAN keys, ID, EUI details

  1. Now you have a configured OTAA device using WisToolBox Console. You can now join the network using the WisToolBox console.

  2. To do this, you need to go again to WisToolBox console and type AT+JOIN. Then edit it to AT+JOIN=1 then press Enter to join the network.

NOTE

AT+JOIN command parameters are optional. You can configure the settings for auto-join, reattempt interval, and the number of join attempts if your application needs it. If not configured, it will use the default parameter values.
AT+JOIN and AT+JOIN=1 also share the common functionality of trying to join the network.

Join command format: AT+JOIN=w:x:y:z

ParameterDescription
wJoin command - 1: joining, 0: stop joining.
xAuto-join config - 1: auto-join on power-up, 0: no auto-join
yReattempt interval in seconds (7-255) - 8 is the default.
zNumber of join attempts (0-255) - 0 is default.

After 5 or 6 seconds, if the request is successfully received by a LoRa gateway, you should see +EVT:JOINED status reply, as shown in the figure below:

NOTE

If the OTAA device failed to join, you need to check if your device is within reach of a working LoRaWAN gateway that is configured to connect to TTN. It is also important to check that all your OTAA parameters (DEVEUI, APPEUI, and APPKEY) are correct using the AT+DEVEUI=?, AT+APPEUI=?, and AT+APPKEY=? commands. Lastly, ensure that the antenna of your device is properly connected.
After checking all the things above, try to join again.

Figure 6936: Joining mode using WisToolBox Console
Figure 6937: Joining mode using WisToolBox Console
Figure 6938: Joining mode using WisToolBox Console
Figure 6939: Joining mode using WisToolBox Console
Figure 6940: OTAA device successfully joined the network
Figure 6941: OTAA device successfully joined the network
  1. With the end-device properly joined the TTN, you can now try to send some payload after a successful join. Send command format: AT+SEND=<port>:<payload>
AT+SEND=2:12345678
Figure 6942: OTAA device sending payload to the network
Figure 6943: OTAA device sending payload to the network
Figure 6944: OTAA device sending payload to the network
Figure 6945: OTAA device sending payload to the network
  1. You can see the data sent by the RAK3172-SiP module on the TTN device console Live data section. Also, the Last seen info should be a few seconds or minutes ago.
Figure 6946: OTAA Test Sample Data Sent Viewed in TTN
TTN ABP Device Registration​
  1. To register an ABP device, go to your application console and select the application where you want your device to be added. Then click + Register end device, as shown in Figure 121.
Figure 6947: Adding ABP Device
  1. To register the board, click the Enter end device specifics manually.
Figure 6948: Enter end device specifics manually
  1. Next step is to set up Frequency plan, compatible LoRaWAN version, and Regional Parameters version supported.
Figure 6949: Setting up for your device
Figure 6950: Setting up for your device
Figure 6951: Setting up for your device
  1. Then click Show advanced activation, LoRaWAN class and cluster settings. Configure the activation mode by selecting Activation by personalization (abp) and Additional LoRaWAN class capabilities to class A only.
Figure 6952: Setting up for your device
Figure 6953: Setting up for your device
  1. Once done, provide the DevEUI credentials of your device into the DevEUI portion. This will automatically generate the specific End device ID of your board. Then click Generate under Device address, AppSKey and NwkSKey under Provisioning information section. Then click Register end device.
NOTE

The DevEUI, Device address, AppSKey, and NwkSKey are hidden in this section as these are unique from a specific device. The DevEUI credential is unique to every RAK3272-SiP device. Also, you should generate your own Device address, AppSKey, and NwkSKey credentials for your specific device and application.

Figure 6954: Setting up for your device
Figure 6955: Setting up for your device
Figure 6956: Setting up for your device
Figure 6957: Setting up for your device
Figure 6958: Setting up for your device
Figure 6959: Register end device
  1. You should now be able to see the device on the TTN console after you fully register your device, as shown in Figure 134.
Figure 6960: ABP device successfully registered to TTN
ABP Configuration for TTN​

The RAK3272-SiP Breakout Board which has a RAK3172-SiP module in it can be configured using WisToolBox to do the ABP configuration. WisToolBox is a software tool that supports RAK3172-SiP module. It automatically detects RAK3172-SiP module once connected to PC. Below are the options in WisToolBox that the ABP configuration can be done.

ABP Configuration for TTN via WisToolBox UI​

The RAK3172-SiP should have correct ABP credentials to connect to TTN. This can be done using WisToolBox. Below are the steps on setting up your RAK3172-SiP using WisToolBox.

  1. Connect your RAK3172-SiP with your chosen WisBlock base board to the PC via USB cable and open the WisToolBox application.

  2. Click CONNECT DEVICE button to launch the WisToolBox Dashboard.

Figure 6961: CONNECT DEVICE
  1. Then select your target port where your RAK3172-SiP is connected. Once recognized, click CONNECT as shown in Figure 137.
Figure 6962: Setting up your device
Figure 6963: Setting up your device
  1. Once done, RAK3172-SiP will appear in the dashboard then select it.
Figure 6964: Device seen from WisToolBox dashboard
  1. Then click PARAMETERS to do the configuration in your RAK3172-SiP.
NOTE

The AppSKey, Device address, and NwkSKey are hidden in this section as these are unique from a specific device.

Figure 6965: Setting up your device
  1. Click Global settings to set the network mode into LoRaWAN and join mode to ABP. Make sure that the active region is using EU868 for this configuration. If you wish to work on other regional band, you can choose among active regions based on your location.
  • LoRa network mode: LoRaWAN
  • LoRaWAN join mode: ABP
  • LoRaWAN region: EU868
Figure 6966: Global settings
Figure 6967: Global settings
  1. Then click LoRaWAN keys, ID, EUI to configure the Application session key (AppSKey), Device address and Network session key (NwkSKey).
Figure 6968: LoRaWAN keys, ID, EUI
Figure 6969: Setting up your device
  1. Then go back to console where your RAK3172-SiP End device is created previously. Then copy all the credentials from there. Those will be the ones to be used also in the WisToolBox dashboard. Once encoded into the dashboard, click APPLY COMMANDS to update your device as shown in Figure 151.
NOTE

The AppSKey, Device address, and NwkSKey are hidden in this section as these are unique from a specific device.

Figure 6970: Your created ABP device from your console
  • For Application session key (AppSKey)
Figure 6971: Copying the AppSKey credential from TTN to WisToolBox
Figure 6972: Copying the AppSKey credential from TTN to WisToolBox
  • For Device address
Figure 6973: Copying the Device address credential from TTN to WisToolBox
Figure 6974: Copying the Device address credential from TTN to WisToolBox
  • For Network session key (NwkSKey)
Figure 6975: Copying the NwkSKey credential from TTN to WisToolBox
Figure 6976: Copying the NwkSKey credential from TTN to WisToolBox
  • WisToolBox Dashboard
Figure 6977: Used credentials from your console in WisToolBox dashboard
  1. Once done, you will see the summary of commands that is applied to your device. Then click CLOSE.
Figure 6978: Summary of commands
  1. Now you will see it returns back to the dashboard with updated credentials of your device.
Figure 6979: Successfully configured ABP device via WisToolBox dashboard
ABP Configuration for TTN via WisToolBox Console​

Here's another way of ABP configuration using WisToolBox Console. Below are the steps on setting up your RAK3172-SiP using WisToolBox Console.

  1. Connect your RAK3172-SiP with your chosen WisBlock base board to the PC via USB cable and open the WisToolBox application.

  2. Click CONNECT DEVICE button to launch the WisToolBox Dashboard.

Figure 6980: CONNECT DEVICE
  1. Then select your target port where your RAK3172-SiP is connected. Once recognized, click CONNECT as shown in Figure 156.
Figure 6981: Setting up your device
Figure 6982: Setting up your device
  1. Once done, RAK3172-SiP will appear in the dashboard then select it.
Figure 6983: Device seen from WisToolBox dashboard
  1. Then click ADVANCED.
Figure 6984: Setting up your device
  1. Once done, click OPEN CONSOLE to do the configuration.
Figure 6985: OPEN CONSOLE
Figure 6986: Opening the Console terminal of WisToolBox
Figure 6987: Opening the Console terminal of WisToolBox
  1. To start the configuration, type ATE so you can echo the commands you input during your configuration. Then press Enter.

It is recommended to start by testing the console and verify that the current configuration is working by sending these two AT commands:

AT
ATE

ATE is useful for tracking the commands and troubleshooting.

You will receive OK when you input the two commands. After setting ATE, you can now see all the commands you input together with the replies.

NOTE

If there is no OK or any reply, check if the device is powered correctly. If you are getting power from a USB port, ensure that you have a good USB cable.

Figure 6988: Setting up your Console
Figure 6989: Setting up your Console
Figure 6990: Setting up your Console
  1. Then configure the LoRaWAN join mode to ABP. You can check what parameter you will input by typing AT+NJM? then Enter into the console terminal. For ABP, you should input AT+NJM=0 then press Enter as shown in Figure 165.
Figure 6991: Setting up your Console
Figure 6992: Setting up your Console
Figure 6993: Setting up your Console
  1. Once done, set up your LoRaWAN region to EU868. You can check what parameter you will input by typing AT+BAND? and then Enter into the console terminal. For EU868, you should input AT+BAND=4 then press Enter. If you wish to work on other regional bands, you may check the list of band parameter options below.

Set the frequency/region to EU868.

AT+BAND=4
NOTE

Depending on the Regional Band you selected, you might need to configure the sub-band of your RAK3172 to match the gateway and LoRaWAN network server. This is especially important for Regional Bands like US915, AU915, and CN470.
To configure the masking of channels for the sub-bands, you can use the AT+MASK command that can be found on the AT Command Manual.
To illustrate, you can use sub-band 2 by sending the command AT+MASK=0002.

List of band parameter options

CodeRegional Band
0EU433
1CN470
2RU864
3IN865
4EU868
5US915
6AU915
7KR920
8AS923-1
9AS923-2
10AS923-3
11AS923-4
Figure 6994: Setting up your Console
Figure 6995: Setting up your Console
Figure 6996: Setting up your Console
  1. Then next to this will be updating the ABP credentials of your device. First to this will be the Application session key (AppSKey). Go back to your console where your RAK3172 End device was created to copy the AppSKey credential then paste it to the WisToolBox Console then press Enter.
Figure 6997: Your created ABP device from your TTN console
Figure 6998: Setting up your Console
Figure 6999: Setting up your Console
Figure 7000: Setting up your Console
Figure 7001: Copying the AppSKey credential from TTN to WisToolBox
Figure 7002: Setting up your Console
  1. Once done, do the same procedure to Device address and Network session key (NwkSKey).
  • For Device address
Figure 7003: Setting up your Console
Figure 7004: Setting up your Console
Figure 7005: Setting up your Console
Figure 7006: Copying the Device address credential from TTN to WisToolBox
Figure 7007: Setting up your Console
  • For Network session key (NwkSKey)
Figure 7008: Setting up your Console
Figure 7009: Setting up your Console
Figure 7010: Setting up your Console
Figure 7011: Copying the NwkSKey credential from TTN to WisToolBox
Figure 7012: Setting up your Console
  1. Once done, click Dashboard to check the updated credentials of your ABP device. Click PARAMETERS to open the Global Settings and LoRaWAN keys, ID, EUI and check whether these portions are updated.
Figure 7013: Setting up your Console
Figure 7014: Setting up your Console
Figure 7015: PARAMETERS
Figure 7016: Global settings and LoRaWAN keys, ID, EUI
Figure 7017: Global settings and LoRaWAN keys, ID, EUI details

  1. Now you have a configured ABP device using WisToolBox Console. ABP-configured devices are directly tied to the network once done with the above procedures so the joining procedure is not needed.

  2. Now you can try sending the payload to TTN. Open again the terminal console of WisToolBox to send some payload using it. Send command format: AT+SEND=<port>:<payload>

AT+SEND=2:12345678
Figure 7018: ABP device sending payload to the network
Figure 7019: ABP device sending payload to the network
Figure 7020: ABP device sending payload to the network
Figure 7021: ABP device sending payload to the network
  1. You can see the data sent by the RAK3172 module on the TTN device console Live data section. Also, the Last seen info should be a few seconds or minutes ago.
Figure 7022: ABP Test Sample Data Sent Viewed in TTN
Connecting with ChirpStack​

This section shows how to connect the RAK3272-SiP Breakout Board to the ChirpStack platform.

Figure 7023: RAK3272-SiP Module in the context of the ChirpStack platform

The ChirpStack or previously known as the LoRaServer project provides open-source components for building LoRaWAN networks. Like the case of TTN, the RAK3272-SiP Breakout Board is located in the periphery and will transmit the data to the backend servers through a LoRaWAN gateway. Learn more about ChirpStack.

NOTE

It is assumed that you are using RAK Gateway and its built-in ChirpStack. Also, the gateway with the ChirpStack must be configured successfully. For further information, check the RAK documents.

  • In summary, these are the requirements:

    1. Have a ChirpStack online gateway, the frequency band of the nodes should be consistent with the frequency band of the gateway in use.
    2. RAK Serial Port Tool provided by RAK
    3. RAK3272-SiP Breakout Board
NOTE

The frequency band used in the demonstration is EU868.

Create a New Application​

  1. Log in to the ChirpStack server using your account and password.

  2. Go to the Application section, as shown in Figure 198.

Figure 7024: Application section
  1. By default, you should create a new application, although you can reuse the existing ones. For this setup, create a new Application by clicking on the CREATE button, and filling in the required parameters, as shown in Figure 199 and Figure 200.
Figure 7025: Creating a new application
  • For this setup, create an Application named rak_node_test.

ChirpStack LoraServer supports multiple system configurations, with only one by default.

  • Service profile: Field is to select the system profile.
  • Payload codec: It is the parsing method for selecting load data such as parsing LPP format data.
Figure 7026: Filling in the parameters of an application
Register a New Device

  1. Choose the Application created in the previous step, then select the DEVICES tab, as shown in Figure 201 and Figure 202.

  2. Once done, click “+ CREATE”.

Figure 7027: List of applications created
Figure 7028: Device tab of an application
  1. Once inside the DEVICE tab, create a new device (LoRaWAN node) by clicking on the “+ CREATE” button.
Figure 7029: Add a new device
Figure 7030: Chirpstack Adding Node into the RAK3272-SiP Breakout
  1. Once the node is created, fill in the necessary data. You can generate a Device EUI automatically by clicking the following icon, or you can write a correct Device EUI in the edit box.

Fill in the parameters requested:

  • Device name and Device description: These are descriptive texts about your device.

  • Device EUI: This interface allows you to generate a Device EUI automatically by clicking the generate icon. You can also add a specific Device EUI directly in the form.

  • Device Profile:

    • If you want to join in OTAA mode, select DeviceProfile_OTAA.
    • If you want to join in ABP mode, select DeviceProfile_ABP.
NOTE
  • Device profiles DeviceProfile_OTAA and DeviceProfile_ABP are only available if you are using the built-in Chirpstack LoRaWAN Server of RAK Gateways.
  • If you have your own Chirpstack installation, you can set up the device profile with LoRaWAN MAC version 1.0.3 and LoRaWAN Regional Parameters revision B to make it compatible with RAK3272-SiP.

Figure 7031: Generate a new device EUI
Chirpstack OTAA Device Registration​
  1. If you have selected DeviceProfile_OTAA, as shown in Figure 206, then after the device is created, an Application Key must be also created for this device.
Figure 7032: Chirpstack OTAA activation
  1. A previously created Application Key can be entered here, or a new one can be generated automatically by clicking the icon highlighted in red in Figure 207.
Figure 7033: Chirpstack OTAA set application keys
  1. Once the Application Key is added to the form, the process can be finalized by clicking on the SET DEVICE-KEYS button.
  • As shown in Figure 208, a new device should be listed in the DEVICES tab. The most important parameters, such as the Device EUI are shown in the summary.
Figure 7034: Chirpstack OTAA list of the device in the device tab
  1. To end the process, it is a good practice to review that the Application Key is properly associated with this device. The Application Key can be verified in the KEYS(OTAA) tab, as shown in Figure 209.
Figure 7035: Application key associated with the new device
NOTE

Standard OTAA mode requires the Device EUI, Application Key, and Application EUI, but in ChirpStack’s implementation, only the Device EUI and the Application Key are mandatory. The Application EUI is not required and not recorded in the Application tab. Nevertheless, you can reuse the Device EUI as the Application EUI during the configuration on the side of the node.

OTAA Configuration for Chirpstack​

The RAK3272-SiP Breakout Board supports a series of AT commands to configure its internal parameters and control the functionalities of the board.

  1. To set up the RAK3272-SiP Breakout Board to join the Chirpstack using OTAA, start by connecting the RAK3272-SiP Breakout Board to the computer (see Figure 27) and open the RAK Serial Port Tool. Select the right COM port and set the baud rate to 115200.

It is recommended to start by testing the serial communication and verify that the current configuration is working by sending these two AT commands:

AT
ATE

ATE will echo the commands you input to the board which is useful for tracking the commands and troubleshooting.

You will receive OK when you input the two commands. After setting ATE, you can now see all the commands you input together with the replies. Try again AT and you should see it on the terminal followed by OK, as shown in Figure 210.

NOTE

If haven't received an OK or any reply, you need to check if the wiring of your UART2 lines is correct and if the baud is correctly configured to 115200. Also, you can check if the device is powered correctly. If you are getting power from a USB port, ensure that you have a good USB cable.


Figure 7036: at+version command response
  1. The next step is to configure the OTAA LoRaWAN parameters in RAK3272-SiP:
  • LoRa work mode: LoRaWAN
  • LoRaWAN join mode: OTAA
  • LoRaWAN class: Class A
  • LoRaWAN region: EU868

Set the work mode to LoRaWAN.

AT+NWM=1

Set the LoRaWAN activation to OTAA.

AT+NJM=1

Set the LoRaWAN class to Class A.

AT+CLASS=A

Set the frequency/region to EU868.

AT+BAND=4
NOTE
  • Depending on the Regional Band you selected, you might need to configure the sub-band of your RAK3272-SiP to match the gateway and LoRaWAN network server. This is especially important on Regional Bands like US915, AU915, and CN470.
  • To configure the masking of channels for the sub-bands, you can use the AT+MASK command that can be found on the AT Command Manual.
  • To illustrate, you can use sub-band 2 by sending the command AT+MASK=0002.

List of band parameter options

CodeRegional Band
0EU433 (Not Supported)
1CN470 (Not Supported)
2RU864
3IN865
4EU868
5US915
6AU915
7KR920
8AS923-1
9AS923-2
10AS923-3
11AS923-4
Figure 7037: Configuring LoRa parameters
  1. After the configuration of the LoRaWAN parameters, the next step is to set up the DevEUI and AppKey. You need the use the values from the Chirpstack device console.
NOTE

The Application EUI parameter is not required in the ChirpStack platform; therefore, it is possible to use the same id as the Device EUI.

  • Device EUI: 5E9D1E0857CF25F1
  • Application EUI: 5E9D1E0857CF25F1
  • Application Key: F921D50CD7D02EE3C5E6142154F274B2

Set the Device EUI.

AT+DEVEUI=5E9D1E0857CF25F1

Set the Application EUI.

AT+APPEUI=5E9D1E0857CF25F1

Set the Application Key.

AT+APPKEY=F921D50CD7D02EE3C5E6142154F274B2

Figure 7038: Configuring LoRapParameters
  1. After EUI and key configuration, the device can now join the network and send some payload.
AT+JOIN=1:0:10:8

Join command format: AT+JOIN=w:x:y:z

ParameterDescription
wJoin command - 1: joining, 0: stop joining.
xAuto-join config - 1: auto-join on powerup, 0: no auto-join
yReattempt interval in seconds (7-255) - 8 is the default.
zNumber of join attempts (0-255) - 0 is the default.
  1. After 5 or 6 seconds, if the request is successfully received by a LoRaWAN gateway, then you should see a JOINED status reply.
NOTE
  • If the OTAA device joins failed, you need to check if your device is within reach of a working LoRaWAN gateway that is configured to connect to Chirpstack. It is also important to check that all your OTAA parameters (DEVEUI and APPKEY) are correct by using the AT+DEVEUI=? and AT+APPKEY=? commands. Lastly, ensure that the antenna of your device is properly connected.
  • After checking all the things above, try to join again.
  1. With the end-device properly activated, you can now try to send some payload after a successful join.
AT+SEND=2:12345678

Send command format: AT+SEND=<port>:<payload>

Figure 7039: OTAA test sample data sent via RAK Serial Port Tool
  1. On the ChirpStack platform, you should see the join and uplink messages in the LORAWAN FRAMES tab, as shown in Figure 214. By convention, messages sent from nodes to gateways are considered as Uplinks while messages sent by gateways to nodes are considered as Downlinks.
Figure 7040: Chirpstack data received preview
Chirpstack ABP Device Registration​
  1. During the registration of a new device, if you select DeviceProfile_ABP, as shown in Figure 215, then the ChirpStack platform will assume that this device will join the LoRaWAN network using the ABP mode.
NOTE

Check Disable counting frame verification. During the test, when the board is restarted, the frame counting number will also be restarted from zero. This would cause a synchronization problem with the ChirpStack server treating it as a replay attack. For testing purposes, it is safe to disable this feature, but remember to activate it in a production environment.

Figure 7041: ChirpStack console, Configuring a device
  1. After selecting the ABP mode, the following parameters appear in the Activation tab, then you can see that there are some parameters for ABP in the ACTIVATION item:
  • Device Address
  • Network Session Key
  • Application Session Key
Figure 7042: Chirpstack ABP activation parameters needed
  1. The parameters can be generated as random numbers by the platform or can be set with user values. Once these parameters are filled in properly, the process is completed by clicking on the ACTIVATE DEVICE button.
ABP Configuration for Chirpstack​
  1. To set up the RAK3272-SiP Breakout Board to join the Chirpstack using ABP, start by connecting the RAK3272-SiP Breakout Board to the computer (see Figure 27 ) and open the RAK Serial Port Tool. Select the right COM port and set the baud rate to 115200.

It is recommended to start by testing the serial communication and verify that the current configuration is working by sending these two AT commands:

AT
ATE

ATE will echo the commands you input to the board which is useful for tracking the commands and troubleshooting.

You will receive OK when you input the two commands. After setting ATE, you can now see all the commands you input together with the replies. Try again AT and you should see it on the terminal followed by OK, as shown in Figure 217.

NOTE

If haven't received an OK or any reply, you need to check if the wiring of your UART2 lines is correct and if the baud is correctly configured to 115200. Also, you can check if the device is powered correctly. If you are getting power from a USB port, ensure that you have a good USB cable.

Figure 7043: at+version command response
  1. The next step is to configure the ABP LoRaWAN parameters in RAK3272-SiP:
  • LoRa work mode: LoRaWAN
  • LoRaWAN join mode: ABP
  • LoRaWAN class: Class A
  • LoRaWAN region: EU868

Set the work mode to LoRaWAN. It can be set to P2P as well, but by default, the device is in LoRaWAN mode.

AT+NWM=1

Set the LoRaWAN activation to ABP.

AT+NJM=0

Set the LoRaWAN class to Class A.

AT+CLASS=A

Set the frequency/region to EU868.

AT+BAND=4
NOTE

Depending on the Regional Band you selected, you might need to configure the sub-band of your RAK3272-SiP to match the gateway and LoRaWAN network server. This is especially important on Regional Bands like US915, AU915, and CN470.
To configure the masking of channels for the sub-bands, you can use the AT+MASK command that can be found on the AT Command Manual.
To illustrate, you can use sub-band 2 by sending the command AT+MASK=0002.

List of band parameter options

CodeRegional Band
0EU433 (Not Supported)
1CN470 (Not Supported)
2RU864
3IN865
4EU868
5US915
6AU915
7KR920
8AS923-1
9AS923-2
10AS923-3
11AS923-4
Figure 7044: Configuring LoRa parameters
  1. After the configuration of the LoRaWAN parameters, the next step is to set up the device address and session keys. You need to use the values from the TTN device console.
  • Device Address: 26011AF9
  • Application Session Key: 4D42EC5CAF97F03D833CDAf5003F69E1
  • Network Session Key: C280CB8D1DF688BC18601A97025C5488

Set the Device Address.

AT+DEVADDR=26011AF9

Set the Application Session Key.

AT+APPSKEY=4D42EC5CAF97F03D833CDAf5003F69E1

Set the Network Session Key.

AT+NWKSKEY=C280CB8D1DF688BC18601A97025C5488
Figure 7045: Configuring LoRa parameters
  1. After EUI and keys configuration, the device can now join the network and send some payload.
AT+JOIN=1:0:10:8

Join command format: AT+JOIN=w:x:y:z

ParameterDescription
wJoin command - 1: joining, 0: stop joining.
xAuto-join config - 1: auto-join on power-up, 0: no auto-join
yReattempt interval in seconds (7-255) - 8 is the default.
zNumber of join attempts (0-255) - 0 is the default.
  1. After 5 or 6  seconds, if the request is successfully received by a LoRaWAN gateway, then you should see a JOINED status reply.

You can now try to send some payload after a successful join.

AT+SEND=2:12341234

Send command format: AT+SEND=<port>:<payload>

Figure 7046: ABP test sample data sent via RAK Serial Port Tool

LoRa P2P Mode​

This section will show you how to set up and connect two RAK3272-SiP units to work in the LoRa P2P mode. The configuration of the RAK3272-SiP units is done by connecting the two modules to a general-purpose computer using a USB-UART converter. The setup of each RAK3272-SiP can be done separately, but testing the LoRa P2P mode will require having both units connected simultaneously. This could be done by having one computer with two USB ports or two computers with one USB port each.

It is recommended to start by testing the serial communication and verify the current configuration is working by sending these two AT commands:

AT
ATE

ATE will echo the commands you input to the module, which is useful for tracking the commands and troubleshooting.

You will receive OK when you input the two commands. After setting ATE, you can now see all the commands you input together with the replies.

Try again AT and you should see it on the terminal followed by OK.

Figure 7047: at+version command response
  1. In setting up the RAK3272-SiP to work in LoRa P2P mode, you need to change the LoRa network work mode command on both RAK3272-SiP Breakout Boards.
AT+NWM=0

AT+NWM parameter mode can be either 0=LoRa P2P or 1=LoRaWAN.

Figure 7048: P2P Mode
NOTE
  • The device will start automatically if you change modes from LoRaWAN to LoRa P2P and vice-versa.
  • You might need to input the ATE command again to ensure that your succeeding commands on P2P mode echo on the terminal.
  1. You need to input the P2P setup on both RAK3272-SiP boards. The parameters should be exactly the same on the two boards.
AT+P2P=868000000:7:125:0:10:14

For this P2P setup, the LoRa parameters are the following:

  • Link frequency: 868000000 Hz
  • Spreading factor: 7
  • Bandwidth: 125 kHz
  • Coding Rate: 0 = 4/5
  • Preamble Length: 10
  • Power: 14 dBm
NOTE

Refer to the P2P Mode section of the AT command documentation to learn more about the definition of the parameters used and the individual commands if you want specific parameter changed.

Figure 7049: Configuring P2P in both RAK3272-SiP Module
  1. To set one module as the receiver (RX), you need to set the value of the P2P receive command.
NOTE

LoRa P2P default setting is Transmitter (TX) mode. This consumes lower power compared to Receiver (RX) mode where the radio is always listening for LoRa packets.

a. P2P LoRa RX configurable duration value is from 1 to 65533 ms. In this example, the device will listen and wait for LoRa P2P Packets for 30000 ms or 30 seconds. It will automatically disable RX mode and switch to TX mode after the timeout. If the device did not receive any packets within the time period, then the callback after timeout is +EVT:RXP2P RECEIVE TIMEOUT.

AT+PRECV=30000

b. If the AT+PRECV value is set to 65535, the device will listen to P2P LoRa packets without a timeout, but it will stop listening once a P2P LoRa packet is received. After receiving the packets, it will disable RX mode and automatically switch to TX mode again.

AT+PRECV=65535

c. If the AT+PRECV value is set to 65534, the device will continuously listen to P2P LoRa packets without any timeout. It will continuously stay in RX mode until AT+PRECV is set to 0.

AT+PRECV=65534

d. If the AT+PRECV value is set to 0, the device will stop listening to P2P LoRa packets. It disables LoRa P2P RX mode and switches to TX mode.

AT+PRECV=0
  1. With one module configured as Transmitter (TX) and the other device will be the Receiver (RX), you can now try to send or transmit P2P payload data.
AT+PSEND= <payload>
NOTE
  • AT_PARAM_ERROR is returned when setting the wrong or malformed value.
  • AT_BUSY_ERROR is returned if the device is still in RX mode and you try to send or reconfigure the RX period. If the AT+PRECV command is set to 65534, you need to execute first AT+PRECV=0 to be able to configure again the TX and RX state and avoid AT_BUSY_ERROR.
  • <payload>: 2~500 digit length, must be an even number of digits and character 0-9, a-f, A-F only, representing 1~256 hexadecimal numbers. For example, if the payload is like 0x03, 0xAA, 0x32, therefore the AT command should be AT+PSEND = 03AA32.
Figure 7050: Configuring P2P in both RAK3272-SiP Module

Miscellaneous​

Upgrading the Firmware​

If you want to upgrade to the latest version of the firmware of the module, you can follow this section. The latest firmware can be found in the software section of RAK3272-SiP Datasheet.

NOTE

What if the RAK3272-SiP stops responding to AT commands and firmware updates?
You can recover your device using the .hex file in the datasheet and upload it using STM32CubeProgrammer. The guide on updating STM32 firmware using STM32CubeProgrammer can be found on the Learn page.

Firmware Upgrade Through UART2​

Minimum Hardware and Software Requirements​

Refer to the table for the minimum hardware and software required to perform the firmware upgrade via UART2.

Hardware/SoftwareRequirement
ComputerA Windows/Ubuntu/Mac computer
Firmware FileBin firmware file downloaded from the website
OthersA USB to TTL module
Firmware Upgrade Procedure​

Execute the following procedure to upgrade the firmware in Device Firmware Upgrade (DFU) mode through the USB interface.

  1. Download the latest application firmware of the RAK3272-SiP.

  2. Download the RAK Device Firmware Upgrade (DFU) tool.

  3. Connect the RAK3272-SiP Breakout Board to the computer via a USB-Serial adapter. Refer to Figure 27.

  4. Open the Device Firmware Upgrade tool. Select the serial port and baud rate (115200) of the board and click the Select Port button.

Figure 7051: Device firmware upgrade tool
  1. Select the application firmware file of the board with the suffix .bin.
Figure 7052: Select firmware
  1. Click the Upgrade button to upgrade the device. After the upgrade is complete, the RAK3272-SiP Breakout Board will be ready to work with the new firmware.
Figure 7053: Firmware upgrading
Figure 7054: Upgrade successful

Arduino Installation​

Go to the Arduino official website and download the Arduino IDE. You can see the multiple versions available for Windows, Linux, and Mac OS X. Choose the correct version of Arduino IDE and download it.

Figure 7055: Arduino IDE latest version

For Windows​

NOTE

For Windows 10 users: Do NOT install the Arduino IDE from the Microsoft App store. Install the original Arduino IDE from the Arduino official website instead, since the Arduino app from the Microsoft App Store has problems using third-party Board Support Packages.

  1. Install the Arduino IDE, which you just downloaded, on your Windows PC.
  2. Click I Agree then Next to proceed.
Figure 7056: Arduino setup license agreement
Figure 7057: Arduino setup installation options
  1. Click Install.
Figure 7058: Installing Arduino IDE
Figure 7059: Ongoing installation

After 100% progress, the Arduino IDE has been installed successfully.

Figure 7060: Successful installation

For Linux​

First, you need the check the compatibility with your system and choose between the 32-bit, 64-bit, and ARM versions of the Arduino IDE for Linux.

Installing via a Tarball​

After downloading the correct Arduino version, open a terminal, then run ls to check the installation file on the download folder.

Figure 7061: Check the download folder

A tarball is a type of compressed folder, like a .zip file, commonly used to distribute software in Linux. To extract the files from the tarball, change the directory to where the downloaded tarball is, then run the following:

tar xvf arduino-version.xz
Figure 7062: Tarball extract command

When the tar command finishes, run ls again. A folder named arduino-version will be created.

Figure 7063: Arduino install folder created

Change the current directory and go to the newly created folder directory. There will be a file named install.sh in the folder. Execute sudo ./install.sh to install the Arduino IDE.

Figure 7064: Arduino install script running

The sudo command temporarily elevates privileges allowing the installer to complete sensitive tasks without logging in as the root user.

For Mac OS X​

In Mac OS X, the same as Linux, there is no installation process. It is just a process of decompression, then you can open Arduino IDE successfully.

Arduino IDE Parts Guide​

Figure 239 shows the five (5) parts of Arduino IDE.

Figure 7065: Arduino IDE
  1. IDE Option Menu

You can configure some general parameters such as the serial port, the board information, the libraries, the edit parameters, and so on.

  1. Operating Buttons

The operating buttons have five operations:

  • Verify/Compile the source code;
  • Upload the compiled code into WisBlock;
  • Open a New Arduino IDE window or existing application;
  • Save the current application.
Figure 7066: Operating buttons
  1. Code Area

You can edit the source code, which will be compiled and uploaded into WisBlock later in this area.

  1. State Area

  2. Output Message Area You can see the output message in this area, whether it's a failure or success information.