BLE mesh sample application User Manual - YUDEN · 2020. 6. 23. · 18-Jun.2020 Ver.1.0 TAIYOYUDEN...

18-Jun.2020 Ver.1.0

TAIYO YUDEN CO., LTD.

1

TAIYO YUDEN CO., LTD

BLE mesh sample application


User Manual

18-Jun.2020 Ver.1.0


2



Contents

1. Introduction ......................................................................................... 3

2. Requirement ........................................................................................ 4

2.1. List of preparations .......................................................................... 4

2.2. Install “nrfjprog” ............................................................................. 4

2.3. Install “nRF Mesh” mobile application ................................................. 4

2.4. Writing the sample application ........................................................... 5

3. Sourcecode .......................................................................................... 7

3.1. Build Method .................................................................................. 7

3.2. source code changes ........................................................................ 9

3.2.1. Common Files ........................................................................... 9

3.2.2. Client ..................................................................................... 10

3.2.3. Server .................................................................................... 10

4. Setting up BLE mesh Network (Android) ................................................. 12

5. Stting of BLE mesh Network (iOS) ......................................................... 33

6. Evaluation board operation ................................................................... 47

Change History

Version Date Description

1.00 2020/06/18 First edition

18-Jun.2020 Ver.1.0


3



1. Introduction

This document describes how to use a sample application of BLE mesh using

the Evaluation Board of EBSHSNZWZ. This sample application is an application

that operates the Status of a specific GPIO PIN on the server side by GPIO

operation from the evaluation board on the client side.

The following is a summary diagram of the sample application.

Figure 1 sample application_ summary diagram

18-Jun.2020 Ver.1.0


4



2. Requirement

2.1. List of preparations

・EBSHSNZWZ Evaluation Board 3 unit

・J-Link Lite (J-Link Lite is included in the EBSHSNZWZ Evaluation Kit)

・PC (Windows 10)

・nrfjprog

・nRF Mesh mobile application (Android/iOS)

・ble_mesh_client_nrf52832_sample_application.hex

・ble_mesh_server_nrf52832_sample_application.hex

・s132_nrf52_7.0.1_softdevice.hex

[For debug]

・nRF5 SDK(ver16.0.0)

・nRF5 SDK for Mesh(ver4.0.0)

・set of modified source files

2.2. Install “nrfjprog”

Download "nrfjprog" from the following URL and install it on your PC.

https://www.nordicsemi.com/Software-and-tools/Development-Tools/nRF-

Command-Line-Tools/Download

2.3. Install “nRF Mesh” mobile application

Install the "nRF Mesh" mobile application from the following URL

https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-

Mesh/GetStarted

https://www.nordicsemi.com/Software-and-tools/Development-Tools/nRF-Command-Line-Tools/Download

https://www.nordicsemi.com/Software-and-tools/Development-Tools/nRF-Command-Line-Tools/Download

https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Mesh/GetStarted

https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Mesh/GetStarted

18-Jun.2020 Ver.1.0


5



2.4. Writing the sample application

Connect the Evaluation Board and J-Link Lite, and run the command prompt in

the "windows key"-->"windows security tools" folder. Use the "cd" command to

move to the folder where the sample application is stored. Run the following

commands to write each hex file (softdevice, sample application).

■client sample application

・writing softdevice

“nrfjprog -f nrf52 --program s132_nrf52_7.0.1_softdevice.hex --chiperase –verify”

・writing sample application

“nrfjprog -f nrf52 --program ble_mesh_client_nrf52832_sample_application.hex -r”

※The application on the client side should be written to one of the evaluation boards

only.

※Please refer to the "Device Firmware UpdateSample application manual" on the

following URL for detailed information on how to connect the Evaluation Board and

J-Link Lite.

https://www-yuden.co.jp/jp/product/category/module/lineup/eyshsnzwz/

Figure 2: Example of sample application(client) writing

https://www-yuden.co.jp/jp/product/category/module/lineup/eyshsnzwz/

18-Jun.2020 Ver.1.0


6



■server sample application

・writing softdevice

“nrfjprog -f nrf52 --program s132_nrf52_7.0.1_softdevice.hex --chiperase –verify”

・writing sample application

“nrfjprog -f nrf52 --program ble_mesh_server_nrf52832_sample_application.hex -

r”

Figure 3: Example of sample application(server) writing

※The application on the server side can be written to multiple evaluation boards

(e.g., if you have 3 boards, you can write to 2 boards)

18-Jun.2020 Ver.1.0


7



3. Sourcecode

This sample application is made by using "light_switch" of nRF5 SDK for

Mesh(ver4.0.0) and nRF5 SDK(ver16.0.0). In this chapter, we describe the SDK

change source code.

You can download each SDK from the following link.

・nRF5 SDK

https://www.nordicsemi.com/Software-and-tools/Software/nRF5-

SDK/Download

・nRF5 SDK for Mesh

https://www.nordicsemi.com/Software-and-tools/Software/nRF5-SDK-for-

Mesh/Download

3.1. Build Method

This document describes how to build using SES (Segger Embedded Studio).

(Please refer to "SES NRF52 Quickstart Guide 1.01 JP.pdf" of NRF of Segger

Embedded Studio for the installation and setup procedure of SES(Segger

Embedded Studio).

You can download it from the following site.

https://www.yuden.co.jp/wireless_module/login

① Extract the downloaded compressed files of nRF5 SDK and nRF5 SDK

for Mesh to a folder of your choice.

② Open<SDK_ROOT>/example/light_switch/client/

light_switch_client_nrf52832_xxAA_s132_7_0_1.emProject,

<SDK_ROOT>/example/light_switch/client/

light_switch_server_nrf52832_xxAA_s132_7_0_1.emProject of nRF5

SDK for Mesh and launch SES.

③ Open the "Tools" tab "Options".

④ Open the "Building" tab.

⑤ Specify the contents of "Global Macros" to "SDK_ROOT=< folder path

created by unzipping the nRF5 SDK>" and click OK to save the settings.

https://www.nordicsemi.com/Software-and-tools/Software/nRF5-SDK/Download

https://www.nordicsemi.com/Software-and-tools/Software/nRF5-SDK/Download

https://www.nordicsemi.com/Software-and-tools/Software/nRF5-SDK-for-Mesh/Download

https://www.nordicsemi.com/Software-and-tools/Software/nRF5-SDK-for-Mesh/Download

https://www.yuden.co.jp/wireless_module/login

18-Jun.2020 Ver.1.0


8



Figure 4: Set up Global Macros

⑥ "Build" tab --> "Build

light_switch_client(server)_nrf52832_xxAA_s132_7_0_1" is clicked,

and build is started.

※This work should be done in both client and server emProject files.

※If you want to build with Cmake, please refer to the following URL.

18-Jun.2020 Ver.1.0


9



3.2. source code changes

The changes in the source code are described.

3.2.1. Common Files

■pca10040.h (../<nRF5 SDK_root>/components/boards)

・Changed GPIO input layout.

■simple_hal.c (../<nRF5 SDK for Mesh_root>/examples/common/src)

・Added nrf_gpiote.h

・Changed processing to enable GPIO input

18-Jun.2020 Ver.1.0


10



3.2.2. Client

■ sdk_config.h(../<nRF5 SDK for

Mesh_root>/examples/light_switch/client/include)

・The clock setting is changed to use the Evaluation Board of EBSHSNZWZ.

3.2.3. Server

■ sdk_config.h(../<nRF5 SDK for

Mesh_root>/examples/light_switch/client/include)

・The clock setting is changed to use the Evaluation Board of EBSHSNZWZ.

18-Jun.2020 Ver.1.0


11



■main.c(../<nRF5 SDK for Mesh_root>/examples/light_switch/server/src)

・Change the Pin placement settings to change the state of GPIO.

18-Jun.2020 Ver.1.0


12



4. Setting up BLE mesh Network (Android)

This chapter describes how to configure (provisioning) the BLE mesh Network

using "nRF Mesh" for Android.

① Make sure that the Evaluation Board you wrote in chapter 2 is powered on,

and run the "nRF Mesh" for Android. Press "ADD NODE" at the bottom right of

the screen after startup.

Figure 5 Android nRF mesh 1

② After pressing the button, the screen moves to the screen shown below. First

of all, configure the Client side. After moving, press the "nRF5x Mesh Switch".

18-Jun.2020 Ver.1.0


13




18-Jun.2020 Ver.1.0


14



③ After pressing the button, the display moves to the screen shown below. After

moving, press the "IDENTIFY" button at the bottom right of the screen.


18-Jun.2020 Ver.1.0


15



④ After pressing the button, the display moves to the screen shown below. At

this time, if you want to change the name of the device, you can change it to

any name you want after pressing "Name". Then, press "PROVISION" at the

bottom right of the screen.


⑤ To move to the OOB Type selection screen after pressing the button, select

"No OOB" and press OK.

18-Jun.2020 Ver.1.0


16




18-Jun.2020 Ver.1.0


17



⑥ After pressing the button, provisioning is executed, so wait until the process is

completed. When the process is completed, the following screen will be

displayed. When it is displayed, press "OK".


18-Jun.2020 Ver.1.0


18



⑦ Next, the setting of the server side is done. Press the "ADD NODE" button at

the bottom right of the screen in the same way as in ①. Then click on "nRF5x

Mesh Light".


18-Jun.2020 Ver.1.0


19



⑧ After pressing the button, the screen moves to the following screen. After

moving, press the "IDENTIFY" button at the bottom right of the screen.


18-Jun.2020 Ver.1.0


20



⑨ Moves to the screen as shown below. At this time, if you want to change the

name of the device, you can change it to any name you want after pressing

"Name". Then, press "PROVISION" at the bottom right of the screen.


18-Jun.2020 Ver.1.0


21



⑩ Select "No OOB" and click OK, as in the client side.


18-Jun.2020 Ver.1.0


22



⑪ Wait for the provisioning to complete after the button is pressed. Because the

following screens are displayed when processing is completed, "OK" is pushed

down when it is displayed.

If you have more than one evaluation board on the server side, complete

provisioning at all evaluation boards by following steps ⑦ to ⑪.


18-Jun.2020 Ver.1.0


23



⑫ When all provisioning is complete, the name of the device you just configured

will appear on the Network tab. Next, click on "nRF5x Mesh Switch" to

configure the settings for each Node.


18-Jun.2020 Ver.1.0


24



⑬ After pressing the button, the screen moves to the following screen. After

moving, click "Element:0x0003" and click "Generic On Off Client".


18-Jun.2020 Ver.1.0


25



⑭ After pressing the button, the display will move to the screen shown below.

After moving, press the BIND KEY button.


18-Jun.2020 Ver.1.0


26



⑮ After pressing the button, the screen appears as shown below. After moving,

select "Application Key 1".


⑯ After pressing the button, Application Key 1 is registered as shown below.

Then, click SET PUBLICATION.

18-Jun.2020 Ver.1.0


27




⑰ After pressing the button, the screen appears as shown below. After moving,

click the "Publish Address" button.

18-Jun.2020 Ver.1.0


28




18-Jun.2020 Ver.1.0


29



⑱ After pressing this button, the screen is moved to the following screen. After

moving, set "All Nodes 0xFFFF" and click OK.


18-Jun.2020 Ver.1.0


30



⑲ After pressing the button, it moves to the following screen. Make sure that the

settings are reflected and click "APPLY" on the bottom right.


18-Jun.2020 Ver.1.0


31



⑳ Next, go back to the screen of the ⑫ and click on the "nRF5x Mesh Light" to

move to the following screen. After moving, click "Element:0x0005" and click

"Generic On Off Server".


18-Jun.2020 Ver.1.0


32



㉑ After pressing the button, it moves to the following screen. After the move,

click on "BIND KEY" and select "Application Key 1" to register the Application Key

as in the client side.

If there are multiple evaluation boards on the server side, follow steps ⑳～to

complete the configuration of all the Nodes.


18-Jun.2020 Ver.1.0


33



5. Stting of BLE mesh Network (iOS)

This chapter describes how to configure (provisioning) the BLE mesh Network

using "nRF Mesh" for iOS

① Make sure that the Evaluation Board you wrote in chapter 2 is powered on,

and run "nRF Mesh" for iOS. After launching, open the Network tab and press

the "+" button on the upper right.

Figure 26 iOS nRF mesh 1

② The list of device names is displayed, and then click "nRF5x Mesh Switch".

18-Jun.2020 Ver.1.0


34




18-Jun.2020 Ver.1.0


35



③ After pressing the button, the display moves to the screen shown below. If you

want to change the name of the device after the move, press the "Name"

button to change it to the desired name. After that, press "Provision" on the

upper right. After pressing the button, the selection screen of OOB Type is

displayed. If you select "No OOB", the provisioning is completed and the name

of the device that has completed the provisioning will be displayed in the

Network tab.


18-Jun.2020 Ver.1.0


36




18-Jun.2020 Ver.1.0


37



④ Complete the provisioning of "nRF5x Mesh Light" in the same way as ② to ③.


18-Jun.2020 Ver.1.0


38



⑤ Open the Setting tab and click on "Application Keys. After pressing the button,

you will move to the following screen. Press the "+" in the upper right after

moving. After pressing the button, after pressing the button, it moves to the

screen shown in Figure 31. After moving, press the "Done" button in the upper

right.


18-Jun.2020 Ver.1.0


39




18-Jun.2020 Ver.1.0


40



⑥ Return to the Network tab, click the nRF5x Mesh Switch, and then click the

Application Keys button. After pressing the button, it moves to the following

screen. After moving, press "+" on the upper right to select "App Key 1", then

press "Done" on the upper right to register the Application Key.

After registration is complete, do the same for other devices.


18-Jun.2020 Ver.1.0


41




18-Jun.2020 Ver.1.0


42



⑦ Return to the Network tab, click on "nRF5x Mesh Light" and then click on

"Element 1". After clicking the button, click Generic OnOff Server and then click

Bind Application. After pressing the button, select "App Key 1" and press

"Done" on the upper right.

After completion, if there are multiple devices on the server side, do the same

setting for the number of devices.


18-Jun.2020 Ver.1.0


43




18-Jun.2020 Ver.1.0


44



⑧ Go back to the Network tab, click on "nRF5x Mesh Switch", and then click on

"Element 2". After clicking the "Bind Application Key" button, click the "Generic

OnOFF Client" button. After pressing the button, select "App Key 1" and press

"Done" on the upper right. Then, click "Set Publication" and click "App Key 1"

on the following screen. After pressing the button, select "All Nodes" at the

bottom of the screen, return to the "Set Publication" screen, and press "Done"

at the top right.

⑨


18-Jun.2020 Ver.1.0


45





18-Jun.2020 Ver.1.0


46




18-Jun.2020 Ver.1.0


47



6. Evaluation board operation

After setting up Chapter 3 or 4, you can switch P.20 of all server-side evaluation

boards from low to high by setting P.04 of the client-side evaluation board to low.

Figure 41 The server side_P.20_low

Figure 42 Client side _GPIO operation_low

18-Jun.2020 Ver.1.0


48



Figure 43 server_P.20_Confirmation

Figure 44 The server side_P.20_high

BLE mesh sample application User Manual - YUDEN · 2020. 6. 23. · 18-Jun.2020 Ver.1.0 TAIYOYUDEN...

Documents

Transcript of BLE mesh sample application User Manual - YUDEN · 2020. 6. 23. · 18-Jun.2020 Ver.1.0 TAIYOYUDEN...