Microchip Technology SAMR34 Xplained PRO User manual

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

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.

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]

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

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

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.

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:

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.

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.

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.

Table of contents

Other Microchip Technology Microcontroller manuals

Microchip Technology

Microchip Technology PD-96G Series User manual

Microchip Technology

Microchip Technology TCP 17051 User manual

Microchip Technology

Microchip Technology XLP User manual

Microchip Technology

Microchip Technology Digital Power Starter Kit User manual

Microchip Technology

Microchip Technology ATMEGA168PB-XMINI User manual

Microchip Technology

Microchip Technology PIC18C 8 Series User manual

Microchip Technology

Microchip Technology PIC16F87XA User manual

Microchip Technology

Microchip Technology PIC16F18076 User manual

Microchip Technology

Microchip Technology Microsemi Hello FPGA Libero Design User manual

Microchip Technology

Microchip Technology MCP1630 NiMH User manual

Microchip Technology

Microchip Technology dsPIC33E/PIC24E Series User manual

Microchip Technology

Microchip Technology PLECS User manual

Microchip Technology

Microchip Technology ATmega328PB Xplained Mini User manual

Microchip Technology

Microchip Technology ATSAMR30M18A User manual

Microchip Technology

Microchip Technology PIC32MZ User manual

Microchip Technology

Microchip Technology DM164120-1 User manual

Microchip Technology

Microchip Technology STK600 User manual

Microchip Technology

Microchip Technology DM182017-4 User manual

Microchip Technology

Microchip Technology PIC12F1501 User manual

Microchip Technology

Microchip Technology MCP2120 User manual

Microchip Technology

Microchip Technology PIC32MZ User manual

Microchip Technology

Microchip Technology PIC16C62B User manual

Microchip Technology

Microchip Technology DM182017-1 User manual

Microchip Technology

Microchip Technology SAMA5D27 User manual

Popular Microcontroller manuals by other brands

AMS

AMS AS7261 Demo Kit user guide

Novatek

Novatek NT6861 manual

Espressif Systems

Espressif Systems ESP8266 SDK AT Instruction Set

Nuvoton

Nuvoton ISD61S00 ChipCorder Design guide

STMicrolectronics

STMicrolectronics ST7 Assembler Linker user manual

Texas Instruments

Texas Instruments Chipcon CC2420DK user manual

Lantronix

Lantronix Intrinsyc Open-Q 865XR SOM user guide

NEC

NEC 78GK0S/K 1+ Series Application note

Mikroe

Mikroe SEMITECH N-PLC Click Application note

Intel

Intel Agilex user guide

Cypress

Cypress CY4607 HX2VL quick start guide

DIGITAL-LOGIC

DIGITAL-LOGIC MICROSPACE manual

Texas Instruments

Texas Instruments TMS320F2837 D Series Workshop Guide and Lab Manual

CYPRES

CYPRES CY14NVSRAMKIT-001 user guide

Texas Instruments

Texas Instruments INA-DUAL-2AMP-EVM user guide

Espressif Systems

Espressif Systems ESP8266EX Programming guide

Abov

Abov AC33M8128L user manual

Laird

Laird BL654PA user guide