STMicroelectronics ST25DV64KC User manual

Introduction
This demonstration is a joint development between STMicroelectronics and the ISCA Laboratory, Hellenic Mediterranean
University (refer to [1] for more information).
LoRa® is a long-range, low data rate, and lower-power wireless communication system used in industrial IoT applications
including, for example, smart metering, sensor monitoring, alarm, etc.
Each device requires provisioning with cryptographic keys and also registration on a LoRaWAN® network.
The current demonstration shows how a ST25DV64KC NFC tag is used to:
• Facilitate the provisioning of a LoRa® device with keys
• Register the device on a LoRaWAN® network
This demonstration uses The Things Network LoRaWAN® infrastructure.
When the registration is complete, a dashboard, displayed in a web browser, is available for monitoring the data coming from
the LoRa® device.
Figure 1. Example of LoRa® dashboard display
The following packages are available on http://www.st.com for this demonstration:
•STSW-ST25DV010 STM32WL55 firmware
•STSW-ST25010 Android application
Demonstration of ST25DV64KC LoRa® provisioning
UM3146
User manual
UM3146 - Rev 1 - March 2023
For further information contact your local STMicroelectronics sales office.
www.st.com

1General information
For additional information, refer to the following websites.
Table 1. References
Reference URL
[1] ISCA Laboratory web site: https://isca.hmu.gr/
[2] https://developer.android.com/studio
[3] https://console.cloud.thethings.network
[4] https//play.google.com/store/apps/details?id=com.st.st25loraprovisioning
[5] https://developer.android.com/training/app-links
[6] https://eu1.cloud.thethings.network/oauth/authorize
[7] https://www.thethingsnetwork.org/docs/lorawan/frequencies-by-country
[8] www.influxdata.com/time-series-platform/telegraf/
[9] www.influxdata.com
[10] www.grafana.com
[11] https://jsonformatter.curiousconcept.com/
[12] https://play.google.com/store/apps/details?id=com.st.st25mqttclient
[13] https://www.thethingsindustries.com/docs/integrations/mqtt
Note: The information provided is from third-party URL addresses, active at the time of document publication.
However, STMicroelectronics shall not be liable for any change, move, or inactivation of the URL or the
referenced material mentioned above.
UM3146
General information
UM3146 - Rev 1 page 2/33

2Glossary
Table 2. Acronyms and abbreviations
Acronyms Definition
AppEUI In LoRaWAN® specifications before 1.1, JoinEUI was called AppEUI. See JoinEUI.
AppKey A device specific encryption key used during OTAA to derive both the Network Session Key and
Application Session Key.
Application Session
Key (AppSKey) Key is used to encrypt the messages to ensure confidentiality.
Device Address
(DevAddr) A 32 bit non-unique identifier, assigned by the network server during device activation
Device EUI (DevEUI) A 64 bit unique identifier for your device, set by the manufacturer.
End Device (Device)
(Node) A device with LoRaWAN® low power communication module
FTM Mailbox ST25DV’s RAM mailbox used to accelerate the communication speed during the host MCU and the
NFC reader.
Gateway
Gateways form the bridge between end devices and network servers. Devices use low power
networks like LoRa® to connect to the Gateway, while the Gateway uses high bandwidth networks
like WiFi, Ethernet or cellular to connect to a network server.
Grafana Online dashboard.
InfluxDB InfluxDB is a high-speed read and write database used to store the LoRa® data.
IoT Internet of Things
JoinEUI The JoinEUI (formerly called AppEUI) is a 64 bit extended unique identifier used to identify the join
server during activation.
Join Server
A join server is a component of the LoRaWAN® server defined in the LoRaWAN® back-end interfaces
that is used to store root keys, generate session keys, and to send those securely to the network
server and application server.
LoRa®A modulation technology for long range wireless communication https://en.wikipedia.org/wiki/LoRa.
LoRaWAN®
LoRaWAN® is a media access control (MAC) protocol for wide area networks. It is designed to allow
low-powered devices to communicate with internet connected applications over long range wireless
connections.
MQTT MQTT (Message Queuing Telemetry Transport) is a lightweight, publish-subscribe, machine to
machine network protocol for message queuing service.
Network Session Key
(NwkSKey) Key used to ensure data integrity and authenticity.
Over-the-air
Activation (OTAA)
This is the preferred and most secure way to connect a device to a LoRa® network. Devices perform
a join-procedure with the network, during which a dynamic Device Address is assigned and security
keys are negotiated with the device.
Telegraf Open source server agent used to copy the LoRa® data from The Things Network to an InfluxDB
database.
The Things Network
(TTN)
The Things Network is a global collaborative Internet of Things ecosystem that creates networks,
devices, and solutions using LoRaWAN®
UM3146
Glossary
UM3146 - Rev 1 page 3/33

3Hardware requirements
The following hardware is needed to run this demonstration:
• A NUCLEO-WL55JC board. There are two versions of this board. Depending on your location, you need to
choose the board suitable for the LoRaWAN® frequencies used in your region and configure the firmware
accordingly (see Section 7.1 Firmware personalization):
– NUCLEO-WL55JC1: high-frequency band, tuned for frequency between 865 MHz and 930 MHz. This
is the board used in Europe, North America, India, and Australia.
– NUCLEO-WL55JC2: low-frequency band, tuned for frequency between 470 MHz and 520 MHz. This
is the board used in China.
Figure 2. NUCLEO-WL55JC2
• X-NUCLEO-NFC07A1 Nucleo shield. This Nucleo shield contains a ST25DV64KC NFC tag. This dynamic
NFC tag is connected to the STM32WL55 MCU to provide it NFC bidirectional connectivity.
Figure 3. X-NUCLEO-NFC07A1 Nucleo shield
The ST1 jumper must be placed on the 3.3 V side.
UM3146
Hardware requirements
UM3146 - Rev 1 page 4/33

Note: Alternatively, it is also possible to use a board ANT7-T-25DV64KC that has a smaller foot print and NFC
antenna, but some soldering is needed to connect it to the Nucleo_WL55 board.
Figure 4. Nucleo_WL55 board
Use either the board X-NUCLEO-NFC07A1 or the board ANT7-T-25DV64KC, both are not necessary.
Table 3. Ant7 pin
Name Ant7 pin Arduino CN5 pin (name)
I2C clock SCL 10 (SCL/D15)
I2C data SDA 9 (SDA/D14)
Interrupt RF 6 (SCK/D13)
Voltage VCC 8 (AVDD)
Ground GND 7 (GND)
• An Android smartphone (with Android 6.0 or later) with internet connection and NFC capability.
• If there is no public LoRaWAN® Gateway registered to The Things Network community edition close to
your location, it may be necessary to use your own LoRa® gateway with an internet connection. Choose a
LoRaWAN® gateway adapted to the frequencies used.
Figure 5. Example of LoRaWAN® gateway provided by The Things Industry
UM3146
Hardware requirements
UM3146 - Rev 1 page 5/33

4Software requirements
In order to use this demonstration, the following software is required:
•STM32CubeIDE
•STM32CubeProgrammer
• Optional: To rebuild the Android application, refer to the Android Studio website ([2]).
UM3146
Software requirements
UM3146 - Rev 1 page 6/33

5Prerequisites
The current demo relies on a LoRaWAN® infrastructure provided by The Things Network. This chapter explains
how to create an account and create an application to The Things Network, which is necessary before using it.
This registration is free and does not require a subscription.
5.1 Creation of a user account on The Things Network console
• Connect to The Things network (refer to [3]) and select a region close to your location.
• Click the Sign up for free button and follow the instructions.
Figure 6. The Things Network - Sign in
5.2 Creation of an application on The Things Network
Once logged in, create an application on The Things Network.
Click the Applications tab and then the Create application button.
Figure 7. The Things Network - Create application.
In this demonstration, an application with the name ST25 LoRA Demo is used with the id st25lorademo. This
demonstration shows how to add a LoRa® device to this application and how to see the data coming from this
device.
Note: A LoRa® device can belong to only one application at a time.
UM3146
Prerequisites
UM3146 - Rev 1 page 7/33

5.3 Registration of a gateway on The Things Network
If using your own LoRa® gateway, register it on The Things Network by clicking the Gateways tab and then the
Register gateway button:
Figure 8. The Things Network – Register gateway
UM3146
Registration of a gateway on The Things Network
UM3146 - Rev 1 page 8/33

6Android application installation
Install the Android application from Google Play (refer to [4]).
Android APK and source code can be downloaded from STSW-ST25010. To open and rebuild the source code,
use Android Studio (refer to [2]).
6.1 Personalization of the Android application
For the Android application, no change is needed in the source code. The personalization is done at runtime by
clicking the gear in the top right corner of the home page, then selecting The Things Network’s region. There is a
choice between Europe, US, and Australia. Select the region closest to your location:
Figure 9. The Things Network – Region selection
The selected The Things Network region is then indicated at the bottom right of the main page.
The user identification is always done through The Things Network servers located in Europe, independently
of the region selected for using the application. The Android application automatically manages the user
identification.
6.2 Authentication in the Android application
To authenticate the account on The Things Network servers (with the login and password created for The Things
Network user account), use the Login button of the Android application. This authentication is based on OAuth 2.0
protocol and Android App links (refer to [5]).
Clicking the Login button launches the Android application URL to start a login session on The Things Network
server. This URL opens in the default web browser used by the smartphone. The use of Chrome is recommended
for this operation.
UM3146
Android application installation
UM3146 - Rev 1 page 9/33

Figure 10. OAuth 2.0 authentication steps
1. Click the Login button. The Android application opens a URL to start a login session on The Things
Network server.
Note: Example URL:
https://eu1.cloud.thethings.network/oauth/authorize?client_id=st25-lora-
provisioning&redirect_uri=https://www.myst25.com/lora/login/&state=
0FEF55D9FD8AE3F492EED15E4B498F71&response_type=code
For The Things Network URL for user authentication, refer to [6].
The following parameters are passed to this URL:
– A client_id: (st25-lora-provisioning)
– A redirect_uri: (https://www.myst25.com/lora/login/). This URI is called if the login, done in
the web browser, is successful.
– A state value: This is a random value changed every time.
– A response_type: Signifies to the authorization server that the application is initiating the
authorization code flow.
2. Enter the login and password (with the login and password created for The Things Network user account).
3. The browser communicates with The Things Network identity server to check the user identity.
4. If the authentication is successful, the “redirect_uri” passed at step 1 is called. This URL starts with
https://www.myst25.com/lora/login/. If the authentication is not successful, an error message is displayed in
Chrome.
5. A mechanism called Android App links (see [5]) is used: When the redirect_uri (starting with https://
www.myst25.com/lora/login) is called, the ST25 LoRa provisioning demo is automatically called. The
AppLink configuration is done in the manifest file of the Android application. A notification indicating a
successful login session is displayed when the Android application is viewed in the foreground. In the
parameter of the URL used, the application finds a JSON message containing an access_token. The
access_token is an ApiKey that is used to communicate with The Things Network server during this
session. It is used to authenticate the user and to grant the access to the features allowed to the user.
6. The main screen of the LoRa® application is launched. Once the user is authenticated, the user has access
to The Things Network server to add or remove a LoRa® device. It is done from HTTPS requests using the
access_token as an API key.
UM3146
Authentication in the Android application
UM3146 - Rev 1 page 10/33

6.3 Troubleshooting
Depending on the smartphone and the browser used, the Android application link may not work as expected. For
example, the redirect_uri (https://www.myst25.com/lora/login/) may open in the browser without opening the
Android application.
The following example demonstrates how to resolve the problem on a Google Pixel 6:
1. Go to the Settings menu and search for Opening links.
Figure 11. Opening links
2. Click com.st.st25loraprovisioning to see the links associated to this application:
Figure 12. Viewing associated links
UM3146
Troubleshooting
UM3146 - Rev 1 page 11/33

3. Click the Add link button and tick the check box corresponding to www.myst25.com:
Figure 13. Adding links
The links pointing to www.myst25.com open in the LoRa® provisioning application.
However, each smartphone has its own organization for the Settings menu, so the wording and the location of the
settings may be different.
UM3146
Troubleshooting
UM3146 - Rev 1 page 12/33

7STM32WL firmware installation
Download the STM32WL firmware from STSW-ST25DV010.
This package contains the bootloader (source code and binary) and the firmware (source code and binaries for
the European region).
• For the bootloader, it is not necessary to recompile it, use directly as provided.
• For the STM32WL firmware: For the European region, the binaries are provided in the STSW-ST25DV010
package and can be used directly. For other regions, the firmware must be personalized and recompiled.
7.1 Firmware personalization
The current demonstration is by default configured for:
• European region (868 MHz frequency plan)
• ant7-t-25dv64kc board
Before compiling the firmware, customize the frequency plan and the hardware board used.
7.1.1 Change of frequency plan
Consult The Things Network web page for the frequency plans per region (see [7]).
The table below lists commonly used frequency plans.
Table 4. Example frequency plans
Frequency plan Base frequency Description Nucleo board
requirement
EU_863_870 868 Default frequency plan for Europe NUCLEO-WL55JC1
US_902_928_FSB_2 915 TTN Community Network frequency plan for the United
States and Canada, using sub-band 2 NUCLEO-WL55JC1
AU_915_928_FSB_2 915 TTN Community Network frequency plan for Australia,
using sub-band 2 NUCLEO-WL55JC1
CN_470_510_FSB_11 470 TTN Community Network frequency plan for China,
using sub-band 11 NUCLEO-WL55JC2
1. Click the file sw\WL55JC1\ .project to open the project in STM32CubeIDE.
2. Open the file lorawan_conf.h.
3. To change the region, comment the line containing REGION_EU868 and uncomment another region:
Figure 14. Region selection
4. Open the file lora_app.h.
UM3146
STM32WL firmware installation
UM3146 - Rev 1 page 13/33

5. Change define of ACTIVE_REGION:
Figure 15. Define the ACTIVE_REGION
The possible values are listed in the enum LoRaMacRegion_t of the file Middlewares/Third_Party/
LoRaWAN/Mac/LoRaMacInterfaces.h:
/*!
* LoRaMAC region enumeration
*/
typedef enum eLoRaMacRegion
{
/*!
* AS band on 923MHz
*/
LORAMAC_REGION_AS923,
/*!
* Australian band on 915MHz
*/
LORAMAC_REGION_AU915,
/*!
* Chinese band on 470MHz
*/
LORAMAC_REGION_CN470,
/*!
* Chinese band on 779MHz
*/
LORAMAC_REGION_CN779,
/*!
* European band on 433MHz
*/
LORAMAC_REGION_EU433,
/*!
* European band on 868MHz
*/
LORAMAC_REGION_EU868,
/*!
* South korean band on 920MHz
*/
LORAMAC_REGION_KR920,
/*!
* India band on 865MHz
*/
LORAMAC_REGION_IN865,
/*!
* North american band on 915MHz
*/
LORAMAC_REGION_US915,
/*!
* Russia band on 864MHz
*/
LORAMAC_REGION_RU864,
}LoRaMacRegion_t;
7.1.2 Hardware board selection
Configure the firmware to correspond to the hardware used.
This is done by opening the file isys_configuration.h.
Edit the line containing the #define NFC_TYPE:
UM3146
Firmware personalization
UM3146 - Rev 1 page 14/33

Figure 16. #define NFC_TYPE
7.2 Build of firmware binaries
The firmware is built with the STM32CubeIDE using the Build All entry in the project menu.
Figure 17. Build firmware binaries
7.3 Flashing
Use STM32CubeProgrammer to flash the bootloader and the firmware:
• Bootloader must be flashed to the address 0x08000000
• Firmware must be flashed to the address 0x08005800
Some binaries are available in the STSW-ST25DV010 package in \binaries directory. It contains:
• the bootloader binary
• the firmware for the board ANT7-T-25DV64KC and European region (EU868)
• the firmware for the board X-NUCLEO-NFC07A1 and European region (EU868)
Other declinations of firmware (according to board and region) must be recompiled as shown in
Section 7.1 Firmware personalization.
UM3146
Build of firmware binaries
UM3146 - Rev 1 page 15/33

8How to run the demonstration
8.1 Login on The Things Network
Launch the Android application and click the Login button. This opens a web browser to perform an OAuth
authentication. The page requires you to provide to log in and password of your account on The Things Network:
Figure 18. OAuth authentication login and sign in
DT72447
Note: It is recommended to use Chrome for the authentication phase.
Once the login is complete, the Android application opens and the main screen is available where it is possible to
add or remove a LoRa® device.
UM3146
How to run the demonstration
UM3146 - Rev 1 page 16/33

Figure 19. LoRa® main screen
At the top of the screen, select the application with the name chosen in Section 5.2 Creation of an application on
The Things Network. In this case, the application is named ST25 LoRa Demo.
8.2 Add a LoRa® device to The Things Network
Click the Add a device button and follow the instructions requesting to tap the NFC tag present on the LoRa®
device.
UM3146
Add a LoRa® device to The Things Network
UM3146 - Rev 1 page 17/33

Figure 20. Add a LoRa® device
DT72448
An NFC communication takes place between the smartphone and the LoRa® device. This NFC communication
uses the FTM mailbox of the ST25DV64KC to collect some information about the device.
A popup opens to confirm adding this device to the application on The Things Network. The popup displays some
information about the device, for example, its unique DevEUI. Here, provide a name to this device to facilitate its
recognition.
By default, the fields about the frequency plan, the LoRaWAN® version, and the regional parameters are filled
with the values recommended by the device. It is possible to modify them, but if the firmware has been properly
configured for the selected region (see Section 7.1 Firmware personalization), this should not be necessary.
Click continue. If the device add operation is successful, a Device added message is displayed at the bottom
of the screen. During this phase, the device is provisioned with some cryptographic keys that are used to obtain
access to a LoRa® gateway during an Over The Air Activation. It is important to keep the smartphone on the
device during the phases showing a Please wait message.
The application requests setting the GPS location of the device.
UM3146
Add a LoRa® device to The Things Network
UM3146 - Rev 1 page 18/33

Figure 21. Set the device GPS location
The GPS location is saved in the information associated to this device on The Things Network. LoRa® devices
are frequently used in isolated places, therefore knowing the exact GPS location is practical and may help to
locate the device as necessary.
A few seconds after the provisioning, the LoRa® device reboots and trys to contact an accessible LoRa® gateway
to perform an Over The Air Activation (OTAA). While the device is not connected, LED3 of X-NUCLEO-NFC07A1
blinks orange.
If this activation is successful, LED2 of the Nucleo shield turns blue during 1 second and the LED3 is switched
OFF. The device is then connected to The Things Network.
If LED3 keeps blinking, it means that the activation failed.
After a reset, the activation usually takes about 12 seconds.
8.3 Getting data from theLoRa® device
Once connected to The Things Network, the LoRa® device regularly sends data. Every 10 minutes the device
sends some fictive data (voltage, power, temperature, etc.) to The Things Network servers.
On the Nucleo board, pressing the second button (SW2), triggers a data transmission (user event).
UM3146
Getting data from theLoRa® device
UM3146 - Rev 1 page 19/33

Figure 22. User button SW2 on Nucleo board
On The Things Network console, click the application and then select the end device. Use the Live Data tab
to see all the data (join data, uplink, and downlink data) exchanged with this device. The uplink data message
contains the data sent by the device (“alt”, “ampr”, “bmehum”, etc.).
Figure 23. Selection of the end device
Each time the SW2 button is pressed, new live data appears. It indicates that the data is properly received by
TTN’s LoRaWAN® server.
8.4 Display of LoRa® data
The data collected on The Things Network’s LoRaWAN® server is used in multiple ways. In the left pane of the
TTN console, click Integrations to see all the possibilities to use the data coming from the TTN servers.
UM3146
Display of LoRa® data
UM3146 - Rev 1 page 20/33