Microchip Technology SAMR34 Xplained PRO User manual

1
SAMR34 Getting Started LoRaWAN OLED1 [ Button] Quick Start Guide
Introduction
This document is intended as a guide to help you understand the features, and to describe how to use the example
project: SAMR34 Getting Started LoRaWAN OLED1 [ Button ]
Table of Contents
Contents
SAMR34 Getting Started LoRaWAN OLED1 [ Button] Quick Start Guide..................................................1
Table of Contents..................................................................................................................................1
1. Overview....................................................................................................................................2
1.1 Supported hardware platforms and IDEs...................................................................................3
2. Development environment.........................................................................................................4
2.1. Atmel Studio 7 ...........................................................................................................................4
2.2. SAMR34 Xplained Pro [DM320111] .........................................................................................4
2.3. OLED1 XPRO extension [ATOLED1-XPRO]............................................................................5
3. Stack Configurations..................................................................................................................6
4. Building applications in Atmel Studio.........................................................................................7
4.1. Setting Project / Properties........................................................................................................7
5. Hardware environment setup.....................................................................................................8
5.1. Supported platform and eval board............................................................................................8
6. LoRaWAN OLED1 [Button] example project .............................................................................9
6.1 Changing Data Rate / Spreading factor in the field..................................................................13
6.2 Changing TX power index .......................................................................................................14
6.3Restoring to default (initial) Data Rate and TX power levels....................................................15
6.4Manual PushButton sensor transmission.................................................................................16
6.5 Restarting / Restoring configuration upon power cycle/reset...................................................17

2
1.Overview
The “SAMR34 Getting Started LoRaWAN OLED1 [ Button ]”example application is an ASF based project that is
intended to be used with the SAMR34 XPRO evaluation kit, and OLED1 XPRO extension.
The goal of this application is to allow a user to create a LoRaWAN end node application that supports the following
capabilities:
•Configuration of parameters required to join a LoRawan Network ( thru #defines at build time)
•Selection of the operational region, thru an OLED menu, or serial console menu at power up or reset.
•Report operational configurations thru the OLED1 display, or the serial console connection. (EDBG
connector)
•Periodically sends temperature sensor data to the network using unconfirmed transmission frames
•Allows manual transmission of temperature sensor data using confirmed transmission frames, by way of a
short press of the USER SW0 pushbutton, available on the SAMR34 XPRO eval board.
•Allows modifying the selected Data Rate used for transmission, by a Long Press of the SW0 button.
•Allows modifying of the selected TX Power Index used for transmission, by an Extended Long press of the
SW0 button.
•Green and Amber leds to signify various operational states, and parameter settings.
•Provides serial console information, thru the EDBG usb serial connection, available on the SAMR34 XPRO
evaluation board.
•Implements Standby sleep mode after network join, and in-between periodic or manual sensor
transmissions.
•Use pushbuttons on the OLED1 extension to make OLED menu selections
NOTE! The OLED1 extension is plugged into the EXT1 header on the SAMR34 XPRO board, and it is important to know
that there are some conflicts, and overlapping connections between the SAMR34 XPRO and the OLED1 board on EXT1.
•SW0 of SAMR34 XPRO is also connected to LED3 of OLED1 board
•GREEN LED of SAMR34 XPRO is also connected to LED 1 of the OLED1 board
•AMBER LED of the SAMR34 XPRO is also connected to LED 2 of the OLED1 board
•The DISPLAY_RESET signal line of the OLED1 board does not have a connection to the SAMR34 due to an
unpopulated zero ohm resistor on the SAMR34 board.

3
1.1 Supported hardware platforms and IDEs
Microcontroller
Supported Evaluation Kit
Supported IDE’s
SAMR34J18B(SIP)
SAMR34 Xplained PRO [ DM320111]
Atmel Studio 7
OLED1 Xplained PRO [ATOLED1-XPRO]

4
2.Development environment
This section provides information on the required tools needed to setup and build the example project ,
and the platform to run it on.
2.1. Atmel Studio 7
Atmel Studio 7 can be used to develop and debug applications for MIcrochip ARM-based platforms. Atmel
Studio 7 is equipped with the GCC compiler, and does not require any additional external software tools
to compile and debug SAMR34 LoRaWAN applications.
Below are a few reference links to documents that will help you get started with Studio 7.
https://www.microchip.com/mplab/avr-support/atmel-studio-7
http://ww1.microchip.com/downloads/en/DeviceDoc/Getting-Started-with-Atmel-Studio7.pdf
http://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-Studio-7-User-Guide.pdf
Here are additional links to detailed documents to help you understand the SAMR34/35 LoRaWAN stack
http://ww1.microchip.com/downloads/en/DeviceDoc/SAM-R34-R35-Microchip-LoRaWAN-Stack-
Software-API-Reference-Manual-DS70005382A.pdf
http://ww1.microchip.com/downloads/en/DeviceDoc/SAM-R34-MLS-Getting-Started-Guide-User-Guide-
DS50002812A.pdf
2.2. SAMR34 Xplained Pro [DM320111]
Full information regarding the SAMR34 Xplained Pro evaluation kit can be found at the links provided:
https://www.microchip.com/DevelopmentTools/ProductDetails/DM320111
https://www.microchip.com/wwwproducts/en/ATSAMR34J18
http://ww1.microchip.com/downloads/en/DeviceDoc/ATSAMR34-Xplained-Pro-User-Guide-DS50002803A.pdf

5
2.3. OLED1 XPRO extension [ATOLED1-XPRO]
Full information for the ATOLED1-XPRO can be found at the following link:
https://www.microchip.com/developmenttools/ProductDetails/ATOLED1-XPRO

6
3.Stack Configurations
This project takes advantage of configuration .h files to define and configure the behavior of the stack.
The configuration file that is important to the initial operation of this example project is:
▪..\src\config\conf_app.h
Within the file conf_app.h you must initially configure the defines listed below:
The data for each of these defines must be modified to reflect the EUI’s and Keys required by your selected Network
Server.
/*Define the Sub band (where required) of Channels to be enabled by default for the application*/
#define SUBBAND 2
/* OTAA Join Parameters */
#define DEMO_DEVICE_EUI {0x00, 0x00, 0x00, 0x00, 0x00,0x00,0xFA, 0xFC}
#define DEMO_APPLICATION_EUI {0x70, 0xB3, 0x00,0x00,0xD0, 0x00, 0x00,0x00}
#define DEMO_APPLICATION_KEY {0x00,0x00,0x00,0x00,0xE7, 0xB0, 0x83, 0xBD, 0x79,0x5E, 0xF4, 0xB4,
0x00,0x00,0x00,0x00}
/* ABP Join Parameters */
#define DEMO_DEVICE_ADDRESS 0xdeafface
#define DEMO_APPLICATION_SESSION_KEY {0x00,0x00,0x74, 0x69, 0x6C, 0x69, 0x74, 0x79, 0x00, 0x04,
0xA3, 0x0B, 0x00, 0x04, 0xA3, 0x0B}
#define DEMO_NETWORK_SESSION_KEY {0x00,0x00,0x00,0x69, 0x6C, 0x69, 0x74, 0x79, 0x00, 0x04,
0xA3, 0x0B, 0x00, 0x04, 0x00,0x00}
By default, the example uses OTAA Join and Unconfirmed periodic transmissions at an interval of 30 seconds.
Each SAMR34 XPRO board comes pre programmed with a unique device EUI. If during your development cycle you
would like to use your own Device EUI, you can accomplish this by modifying a project setting as described below.
The DEMO APPLICATION EUI and DEMO APPLICATION KEY are provided by the Network Service you are attempting to
work with . For Example, For TTN ( The Things Network ) these parameters are provided thru the TTN console.

7
4.Building applications in Atmel Studio
Atmel Studio 7 is used to develop and build SAMR34 applications.
To configure or review the project settings before building your project, follow the instructions below.
4.1. Setting Project / Properties
Project settings and properties can be configured thru the Project/Properties menu Tabs
To select which device EUI you will be using, select the Toolchain item under project properties.
Then select Symbols in the list of ARM/GNU C compiler options as shown below.
In the list of Defined symbols shown , edit the symbol EDBG_EUI_READ to either
EDBG_EUI_READ=0 to use your own device EUI entered in file conf_app.h or
EDBG_EUI_READ=1 to use the pre-programmed Microchip assigned device EUI that is pre-programmed into the
SAMR34 Xplained PRO evaluation board.
You will see a Properties page similar to what is shown below:

8
5.Hardware environment setup
5.1. Supported platform and eval board
The following board is used/supported in this release.
SAMR34 Xplained Pro Part# DM320111
This board can be powered from the Debug USB port located at the top right of the image shown above, or by
way of the 5v Power Header shown at the top right-hand edge of the above image.
Other methods are available, but not used for this example application.
Note! The small battery located at the top left is only for battery backup of the battery backup memory section
and is NOT used to actually power the board or SAMR34 device. This battery is not required for this example
application.

9
6.LoRaWAN OLED1 [Button] example project
The OLED1 example application code focuses on the elements required to provide support for an oled display,
that can be attached to the SAMR34 XPRO board.
The following features of the SAMR34 LoRaWAN solution are demonstrated:
•Establish a LoRaWAN connection automatically between the SAMR34 end node and available Gateways
that are within radio range.
•Periodically transmit an unconfirmed data frame ( every 30 seconds )
•Manually transmit a confirmed data frame upon the press of a pushbutton
•Allow adjustment , of Data Rate (spreading factor) and Tx Power Levels without the need of a terminal (
laptop etc ). This is accomplished by using various duration button presses of the SW0 user button on
the XPRO board.
To run the example application, follow the instructions given below
1. Connect the OLED1 extension to the SAMR34 XPRO evaluation board thru header EXT1.
2. Connect the XPRO board to your computer using a USB cable connected to the EDBG connector on the XPRO
board.
3. Later we can power the board from a 5v battery pack connected to the the 5v pwr header of the SAMR34 XPRO
board, for mobile field measurements. Or use a USB rechargeable 5v battery pack connected to the EDBG Debug
connector.
4. Program the SAMR34 XPRO board with the OLED1 [Button ] application firmware using Atmel Studio 7.
5. For the initial setup, connect a terminal application like Teraterm to the EDBG Debug port of the XPRO board.
This will be used for serial console input and output during the setup phase.
6. Setup the terminal Application for 115200 baud N 8 1
7. After resetting the board or powering up the board, all the leds on the SAMR34 XPRO along with the leds on the
OLED1 extension board will turn on. The Amber XPRO led and LED2 of the OLED1 board will turn on slightly after
all the other LEDS.
Look for the OLED start up splash screen as shown below on the left.
After a short period of time the OLED screen will switch to the button mapping screen as shown above right.

10
This button mapping screen shows you the functions of the OLED1 buttons during menu operations.
Use the down button to move the menu selection down, the up button to move menu selection up, and the center
select button to make a menu choice.
At this point, if you have the cosole connected ,you will see a screen as shown below and to the left.
The OLED screen will apear as shown below and to the right.
Either method can be used to select the band of operation. If the console is not connected use the OLED menu’s.
If it is the first time execution of the application after initial programming , then with a terminal
program connected, you will see the startup screen shown above.
If using the serial console, then enter a number between 1 and 7 to select the rf band or region that you intend to
operate within.
Menu Selection 8 will allow you to clear the persistent data storage memory, to start again.
Menu Selection 9 performs a reset to the application and stack.
If using the OLED display menu’s then use the up and down buttons to find the rf band / region, and then use the select
button to make your choice
You can perform the same commands of clear persistent memory or reset the board using the oled menu’s as shown
below. ( use up and down to make your selection and then press the select button to perform the command)
Generally, to start over ( and remove all previous settings ) you would select 8, and then 9 on the console or use the
OLED board menu’s and buttons to Clear PDS and then Reset Board.

11
Having selected the region of operation, the parameters that will be used for joining the network will be displayed.
The console will show the screen on the left, and the OLED display will show something similar to that on the right.
The OLED will show the DevEUI on line3 and the
APPEUI on line 4
The DevEUI is read from the preprogrammed NVM (non volatile memory) of the XPRO board.
This is a unique EUI supplied by Microchip. Or from the setting in conf_app.h depending upon project settings.
The AppEUI and AppKey were the parameter’s that you configured in the conf_app.h file, before you built the
Program, as described in section 3.0 of this document.
NOTE! The network being joined as shown in the console image on the left, and that shown in the oled image on the
right, are not the same network. ( Notice AppEUI is different )
The console provides additional info with respect to other join parameters, which are not available on the OLED display
due to display size restrictions.
Following the display of the above screens, a join request is sent using the displayed parameters/attributes
If the Join operation is not successful, you will be shown a screen similar to the one shown below
In this case, a join attempt on Channel 8 (North America band ) has failed.
A delay is performed before the next Join attempt.
If the Join attempt is successful, you will be presented with a screen similar to those shown below:

12
The successful Join, shown above, occurred on channel 9.
The DevAddr assigned by the Network Server ( during an OTAA join ) is displayed.
The remainder of the console display reports the current application configuration.
This information is useful when trying to confirm that the settings of the end node are proper, and match the
configuration used when registering a node with your LoRaWAN network service provider.
Once you have joined the network successfully, the end node application will periodically send a data frame containing
temperature sensor data.
The screen below illustrates two periodic transmissions that occur 30 seconds apart.
The first transmission occurred on channel 11 and the second on channel 14
The TX power index of 05 represents the highest SAMR34 TX power level available for North America.
DR0 represents SF10BW125 for North America, and is the lowest data rate available in North America. This is also the
configuration that will provide the highest link budget ( highest TX power and best RX sensitivity ) to achieve the longest
range .

13
6.1 Changing Data Rate / Spreading factor in the field
When not connected to a serial console, it is still possible to adjust the Data Rate/spreading factor by way of the SW0
pushbutton, on the SAMR34 XPRO evaluation board. Changing of the Data Rate can be performed by a long press of the
SW0 pushbutton. Press and hold the pushbutton until you see the green led turn on. Then release the button.
This action will increment the Data Rate by one step, moving from a lower data rate to a higher data rate.
The new data rate will be indicated by the blinking of the green led after you stop pressing the pushbutton.
The chart at the end of this section lists the number of blinks to expect for the various Data Rates available.
If the serial console was connected, then a message as shown below is displayed on the console.
In this case the Data Rate was changed from DR0 to the new setting of DR1
As you can see from the screens shown below, the next transmission was made using DR1
Region Data Rate Spreading factor Bandwidth bps LED blink count
North America
DR0
SF10
125Khz
980
1
DR1
SF9
125Khz
1760
2
DR2
SF8
125Khz
3125
3
DR3
SF7
125Khz
5470
4
Region DataRate Spreading factor Bandwidth bit/s LED blink count
Europe 868
DR0
SF12
125Khz
250
1
DR1
SF11
125Khz
440
2
DR2
SF10
125Khz
980
3
DR3
SF9
125Khz
1760
4
DR4
SF8
125Khz
3125
5
DR5
SF7
125Khz
5470
6
NOTE: Only 125Khz channels are used in this application

14
6.2 Changing TX power index
The initial Tx power index setting is set to the maximum TX output power allowed for the region selected.
For North America this would be a Tx power Index of 5. The SW0 user button on the SAMR34 XPRO can be used to
modify this parameter while making field range measurements.
An Extended Long press of the SW0 pushbutton will increment the TX power index and thus reduce the TX output power
used for future transmissions.
Press the SW0 button until the amber LED turns on. (Note! First the green LED will turn on, and you must continue to
hold/press the button until the amber led also turns on.
Release the button when you see both the green and amber LED’s on.
When you release the SW0 button, the amber led will blink a specific number of times to indicate which Tx power index
setting you adjusted to. See table below for relationship between the number of blinks and the Tx power index that you
have set.
If you happen to have the console connected at this point in program operation, you will see screens like the following.
In this example, the Tx power index was changed to 6
The next screens illustrate that on the next sensor transmission, a Tx power index of 6 was actually used.
Region Tx Power Index Tx Power dBm [30-(2*PwrIndex)] LED blink count
North America
5
+20
6
6
+18
5
7
+16
4
8
+14
3
9
+12
2
10
+10
1
Note! Tx power dBm is related to output pins of SAMR34 and does not include any loss in output matching or
interface circuitry.

15
Region Tx Power Index Tx Power dBm LED blink count
Europe 868
0
+16 max
8
1
+14max -2
7
2
+12max -4
6
3
+10max -6
5
4
+8 max -8
4
5
+6 max -10
3
6
+4 max -12
2
7
+2 max -14
1
Note! Tx power in dBm is related to output pins of SAMR34 and does not include any loss in output matching
or interface circuitry.
6.3 Restoring to default (initial) Data Rate and TX power levels
After making changes to either the Data rate, Tx power index or both while making range measurements,
there may be a need to quickly reset both parameters to their original default settings ( lowest data rate and
higher Tx power level ).
This can be achieved by performing an extra long SW0 pushbutton press allowing a reset to default operation.
Press and hold the SW0 pushbutton as you watch the leds. The green led comes on first, (continue holding )
while the amber led also turns on, and again continue holding until both leds turn off. You may then release
the SW0 pushbutton and both Data Rate and Tx power level will be set back to the initial default values for the
region you had selected initially.

16
6.4 Manual PushButton sensor transmission
Although the application will periodically transmit a frame containing temperature sensor data, there are
times when one would want to manually initiate a sensor transmission by pressing the SW0 pushbutton.
A short press of the pushbutton will initiate a sensor transmission using the confirmed message format.
Upon short pressing the button, the green led will start blinking, and it will remain blinking until the
transaction has completed successfully or fails.
If all went well, the green led will stop blinking and the amber led will be off.
If there is a failure or no acknowledgement is obtained, then the amber led will remain on to indicate a failure.
The amber led will be cleared on the next successful transmission attempt.
NOTE! The SW0 pushbutton is right next to the RESET pushbutton .. Be very careful that you do not press
the RESET pushbutton by mistake! This will easily happen if you are not paying attention to which
pushbutton you are pressing.
If the console is connected when initiating a manual message transmission, the following will be shown on the
screen
This screen illustrates that the device had been asleep for 9576 ms at the time the pushbutton was pressed.
The pressing of the pushbutton woke up the device from standby sleep, and initiated a manual sensor
transmission.
NOTE! When operating in the European 868mhz band or other bands that incorporate duty cycle
restrictions, you may see a NO CHANNEL FOUND message indicating that previous transmissions have used
the available time, and you will have to wait and try again later when duty cycle allows.
If the manual transmission did not result in an acknowledgement, then you will see a screen as shown below.

17
6.5 Restarting / Restoring configuration upon power cycle/reset
The initial selecting of Region is only necessary during the initial setup.
Once the application has been run once, the required parameters and attributes are stored in non volatile
memory ( persistent storage )
Upon a power cycle or reset of the device, a check is made to determine if there is previously stored
information that can be used to restore operation to settings that were in use before the reset or power cycle.
The screen’s shown below illustrates what occurs upon a restoration from a power cycle or reset.
Operation will occur on the same band that was used the last time the application executed.
There will be a count down of approximately 5 seconds to allow the user to press a console key ( or OLED button) to
abort the restoration process and go back to the main menu , where a new region can be selected if needed.
For field testing, all one needs to do Is initially configure the application, and from that time on, the settings last used
will be applied.