Dialog Semiconductor DA1468 series User manual

Company confidential
User manual
DA1468x Mesh SDK
UM-B-098
Abstract
This document provides basic guidelines for developers and kit users, in order to get familiar with the
DA1468x Mesh SDK and modify or create a BLE Mesh application based on it.

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
2 of 48
© 2018 Dialog Semiconductor
Contents
Abstract.......................................................................................................................................... 1
Contents......................................................................................................................................... 2
Figures............................................................................................................................................ 3
Tables ............................................................................................................................................. 4
1 Terms and definitions............................................................................................................. 5
2 References............................................................................................................................... 5
3 Introduction.............................................................................................................................. 6
4 Features and Highlights ......................................................................................................... 6
5 Getting Started –Running the Demo Application ............................................................... 7
Description ...................................................................................................................... 7
Connecting Hardware and Powering On ........................................................................ 9
Button and LED Usage ................................................................................................... 9
Buttons and Switches...................................................................................... 9
LEDs................................................................................................................ 9
Mesh SDK Demo examples bring up.............................................................................. 9
Mobile application instructions....................................................................... 11
Notes regarding the SDK examples demonstration...................................................... 19
Generic ON/OFF model demonstration......................................................... 19
Generic Level model demonstration.............................................................. 19
Light HSL model demonstration .................................................................... 19
Generic ON/OFF model multiple elements demonstration............................ 19
Vendor specific model demonstration ........................................................... 20
Provisioner example demonstration .............................................................. 20
Proxy example demonstration....................................................................... 21
Relay example demonstration....................................................................... 21
Friend –Low Power Node example demonstration ...................................... 22
SW Upgrade Over The Air (SUOTA) support................................................ 22
Microbus devices example demonstration .................................................... 23
6 Development Environment Setup........................................................................................ 24
Installing the Environment............................................................................................. 24
Importing and Building the BLE Mesh Project .............................................................. 24
Flashing the New SW into the SDK .............................................................................. 25
Modify the Bluetooth Address and Mesh device UUID................................................. 27
Specify the role of the device (eg lightbulb or switch)................................................... 27
Debugging the Application............................................................................................ 27
Obtaining Logging Information...................................................................................... 29
UART Logging Window ................................................................................. 29
Developing on Linux Host OS....................................................................................... 30
Developing on Mac OS................................................................................................. 30
Understanding Serial Terminal Options........................................................................ 30
Reset the Accessory...................................................................................... 31

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
3 of 48
© 2018 Dialog Semiconductor
Reset to Factory Default State ...................................................................... 32
Enabling or disabling Mesh features (proxy/relay/friendship)........................ 32
Security Keys Dump Function ....................................................................... 32
Monitor FreeRTOS Heap Usage and Task Stack Usage.............................. 33
Change log level............................................................................................ 33
Change default TTL value used when sending messages............................ 33
Change maximum BLE RF range to maximum of ~2 meters........................ 33
Commands related to Friendship and Low Power Node (LPN) .................... 34
Modify the subscription address list of a server model.................................. 34
Modify the publish address of a client model ................................................ 35
Change client model state using the UART console..................................... 35
Using the SEGGER RTT SystemView.......................................................................... 37
7 Software Architecture........................................................................................................... 40
BLE Mesh specification................................................................................................. 40
DA14683 Mesh SW Architecture .................................................................................. 41
Overview........................................................................................................ 41
Mesh DK SW Architecture............................................................................. 42
7.2.2.1 Folder and file structure............................................................. 42
7.2.2.2 The user_<onoff/level/hsl>_<server/client>_example files ....... 43
7.2.2.3 The appl_proxy.c file.................................................................. 43
7.2.2.4 The appl_provision.c file............................................................ 44
7.2.2.5 The appl_conf.c file.................................................................... 44
7.2.2.6 The demo_hw.c file.................................................................... 44
7.2.2.7 The appl_storage.c file .............................................................. 44
7.2.2.8 The mesh_console.c file............................................................ 45
Revision history........................................................................................................................... 46
Figures
Figure 1: DA14683 USB Development Kit ............................................................................................ 7
Figure 2: PRO Development Kit, Motherboard and Daughterboard ..................................................... 7
Figure 3: DA1468x Basic Development Kit ........................................................................................... 8
Figure 4: Microbus 7-segment display and slider modules................................................................. 23
Figure 5: BLE Mesh App - Build Configurations.................................................................................. 24
Figure 5: Mesh App - Build Log........................................................................................................... 25
Figure 6: Programming the Flash Image............................................................................................. 25
Figure 7: Programming Flash –Log Output........................................................................................ 26
Figure 8: Debug Configurations .......................................................................................................... 27
Figure 9: Debug Perspective............................................................................................................... 28
Figure 10: UART Logging Window...................................................................................................... 29
Figure 11: Verifying the Correct J-Link Version................................................................................... 37
Figure 12: SEGGER SystemView Capture Settings........................................................................... 38
Figure 13: SEGGER SystemView Trace Capture............................................................................... 39
Figure 14 SystemView Trace - Task Switching................................................................................... 41
Figure 15: Mesh DK SW Architecture ................................................................................................. 42
Figure 17: SW stack and file location.................................................................................................. 43

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
4 of 48
© 2018 Dialog Semiconductor
Tables
No table of figures entries found.

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
5 of 48
© 2018 Dialog Semiconductor
1 Terms and definitions
ATT ATTribute Protocol
BLE Bluetooth low energy
CPU Central Processing Unit
DIS Device Information Service
DK Development Kit
FW firmware
GATT Generic ATTribute profile
GDB GNU Debugger
HW hardware
iOS iPhone Operating System (Apple)
UILED Light Emitting Diode
LTK Long Term Key
MACOS Macintosh Operating System (Apple)
NVM Non-Volatile Memory
PCB Printed Circuit Board
SDK Software Development Kit
SIG (Bluetooth) Special Interest Group
SRP Secure Remote Password (protocol)
SUOTA Software Upgrade Over The Air
SW software
SWD Serial Wire Debug
USB Universal Serial Bus
UUID Universally Unique Identifier
PTS Profile Tuning Suite
CLI Command Line Interface
2 References
[1] Mesh_Model_Specification v1.0.pdf
[2] Mesh Device Properties v1.0.pdf
[3] Mesh_v1.0.pdf
[4] Mesh Technology Overview.pdf
[5] WGS17_Group Updates Main Deck.pdf
[6] Dialog-BLE-Mesh-Training.ppt
[7] UM-B-060, DA1468x/DA1510x Development kit - Pro, User Manual, Dialog Semiconductor
[8] UM-B-057, SmartSnippets™ Studio user guide, User Manual, Dialog Semiconductor
[9] UM-B-066, DA1468x Development Kit - Basic, User Manual, Dialog Semiconductor
[10] UM-B-047, DA1468x Getting Started with the Development Kit, User Manual, Dialog
Semiconductor.
[11] UM-B-056, DA1468x Software Developer's Guide, User Manual, Dialog Semiconductor.
[12] AN-B-037, DA1468x Power Measurements, Application Note, Dialog Semiconductor
[13] UM-B-094, DA14683 USB Kit Rev 1.0, User Manual, Dialog Semiconductor

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
6 of 48
© 2018 Dialog Semiconductor
3 Introduction
This document provides basic guidelines for developers and kit users, in order to get familiar with the
DA1468x Mesh SDK and modify or create a BLE Mesh application based on it.
The reference implementation is tested against the latest PTS tool from Bluetooth SIG and is under
certification for BLE Mesh ver1.0 specification.
The user is expected to have some basic understanding about the BLE Mesh protocol
(http://blog.bluetooth.com/introducing-bluetooth-mesh-networking).
4 Features and Highlights
■Supports Bluetooth BLE Mesh ver1.0 specification
□Provisioning over GATT and ADV bearer
□Support for all Mesh SIG defined models except sensor and time model
□Support for Vendor Specific Mesh models
□Support for Relay, Proxy, Friend and Low Power Node features
■Qualified Bluetooth subsystem (QDID)
□Tested as part of UnPlugFest UPF-53, (Jan 2016), UPF54 (June 2016) and UPF55 (Oct
2016), UPF56 (Jan 2017), UPF57 (June 2016), UPF58 (Oct 2017), UPF59 (Jan 2018),
UPF60 (May 2018)
■Single-chip solution with HW acceleration for all Mesh security operations
■Bluetooth low energy 4.2 wireless connectivity
■Easy scalable SW architecture to integrate other smart home protocols in a single design
■User application memory resources:
□Application size only limited by size of external Flash memory
□~64 kB RAM remaining after existing reference app / BLE stack / Mesh library usage
■Compatible with DA1468x Basic, Pro, and USB HW development boards
■Debug features: Segger J-Link debugger/RTT/Systemview and print to console
■Sample iOS and Android application demonstrating many of the BLE Mesh features

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
7 of 48
© 2018 Dialog Semiconductor
5 Getting Started –Running the Demo Application
Description
The Mesh SDK is compatible with both Pro, Basic and USB DK HW. The HW boards are described
at reference documents [7] [13] and [9]. For all Mesh reference applications the same HW can be
used. The DK can be reprogrammed to run a single instance of an application. In order to switch
between different applications, boards can be upgraded over JTAG using the development process
as explained in section 6.3.
Note: The preferred DK HW to get started using the Mesh SDK is the USB DA14683 development
kit. It has a much smaller form factor, is more affordable and is easier to create and test large Mesh
networks with multiple nodes.
Figure 1: DA14683 USB Development Kit
Figure 2: PRO Development Kit, Motherboard and Daughterboard

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
8 of 48
© 2018 Dialog Semiconductor
Figure 3: DA1468x Basic Development Kit

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
9 of 48
© 2018 Dialog Semiconductor
Connecting Hardware and Powering On
The DK HW boards are pre-assembled and no extra rework is needed. There is no need to change
any jumper positions in order to get a functional demo application run.
The development boards are shipped unprogrammed, so in order to flash the demo image please
first follow the instructions in sections 6.1, 6.2 and 6.3. The boards will then be in factory reset state
and their node database will be empty (start from un-provisioned state).
The boards are USB powered. Use the provided USB cable to power on the accessory by connecting
to any laptop, desktop or power adapter.
The board should then enter the unprovisioned Beacon Advertising mode and be ready to interact
with any Mesh enabled provisioner. The default provisioning bearer is GATT.
Button and LED Usage
The buttons and LEDs that are used in the reference implementation are the following. This guide
assumes that the DA14683 USB DKs are used:
Buttons and Switches
●RESET: HW resets the DA14683.
●SW1 short press: Toggles Mesh model state (represents the behaviour of manually switching
ON or OFF a fan, a lock, a light bulb, etc).
●SW1 long press (~5 sec): Factory reset device (start from un-provisioned state).
●SW2: Used only in the multiple elements example to represent operation of the second element
LEDs
●D10: Represents Mesh model state (ON–Lightbulb is turned on, OFF–Lightbulb is turned off).
●D8:Represents the provisioning and configuration state.
Fast blinking: Device is unprovisioned and waits to be provisioned
Slow blinking: Device is provisioned (belongs to a network) but not configured yet (no publish
or subscription address is assigned yet)
Turned off: Device is both provisioned and configured. It can interact with other devices in the
network.
Its intensity level represents the state of the level server model in the corresponding example.
Its colour represents the HSL settings of the HSL server model in the corresponding
example.
●D9: Used only in the multiple elements example to represent operation of the second element
Mesh SDK Demo examples bring up
The device can be tested against any iOS or Android smartphone application which supports the
Mesh protocol.
Make sure that the Dialog Mesh application is used - found under
DA14683_MESH_vXXX\projects\host_apps\ethermind-mobile directory.
The Dialog USB DK should be programmed with the default ble_mesh application
DA14683_MESH_vXXX\projects\dk_apps\demos\ble_mesh. The default application code
enables provisioning over GATT and expects the devices to be provisioned over GATT.

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
10 of 48
© 2018 Dialog Semiconductor
At least two different nodes are needed to be programmed. Both of them should have a
unique node ID and different roles (one lightbulb and one switch). One of them should get
configured as the server role of the model and the other one as the client. The available
model examples in this release are:
oGeneric ON/OFF
oGeneric Level
oGeneric ON/OFF with multiple elements
oLight HSL
oVendor specific
For every node after factory reset a random BLE address and Mesh UUID is getting assigned to
the node. There is no need for any further user action to assign unique UUIDs per node as it
used to be in previous release (eg program NVPARAM partition).
Note: The release contains support for all the SIG models defined in the Mesh specification. The
examples can be used as guideline of how models can be initialized and used.
Note: The provisioner example in the release is not meant to be tested with the mobile app. This
example demonstrates provisioning over the ADV bearer with the other examples in the SDK,
while the mobile app demonstrates provisioning over the GATT bearer. For more information
regarding the provisioner example refer to section 5.5.6.

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
11 of 48
© 2018 Dialog Semiconductor
Mobile application instructions
The section describes how the mobile app can be used to provision and configure a new device to
the network. Any of the SDK examples can be used but the new user is recommended to start with
the Generic ON/OFF example, which provides a simple demo of how turn ON/OFF a LED from the
server (eg lightbulb) side by using a button from the client (eg switch) side.
Note: The mobile application is able to provision and configure all the examples in the SDK, but in its
current version only the generic ON/OFF example can be remotely controlled by the application.
1. Start BLE Mesh Application
2. Select the Mesh Tab
3. Create a Group by pressing the Add Group button
4. Enter a name for the Group and press the Add button
5. Verify Group has been added
6. Power-on the board programmed as a Switch

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
12 of 48
© 2018 Dialog Semiconductor
7. Select the Unprovisioned Tab and start a Scan
8. Select the device to be provisioned
9. Device will be added to the network
10. Select the Nodes Tab and the Node to be configured
11. Device information will be read out and displayed
12. Select the Configuration Tab

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
13 of 48
© 2018 Dialog Semiconductor
13. Select the Name field and enter a name for the device. The Proxy feature must be enabled for
the switch (needed later for the demo). The Relay feature can be optionally enabled for the
node.
14. Select the Function field and set to On/Off. This option may de deprecated depending on the
mobile version you use. It should not affect demo operation.
15. Select the Group field, set to previously created group

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
14 of 48
© 2018 Dialog Semiconductor
16. Press the Apply button to send configuration to Device
17. Device information will be read out and displayed
18. Select the Configuration Tab
19. Power-on the board programmed as a Light Bulb
20. Select the Unprovisioned Tab and start a Scan
21. Select the device to be provisioned

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
15 of 48
© 2018 Dialog Semiconductor
22. Device will be added to the network
23. Select the Nodes Tab and the Node to be configured
24. Device information will be read out and displayed
25. Select the Configuration Tab
26. Select the Name field and enter a name for the device. This option may de deprecated
depending on the mobile version you use. It should not affect demo operation.
27. Select the Function field and set to On/Off

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
16 of 48
© 2018 Dialog Semiconductor
28. Select the Group field, set to previously created group
29. Press the Apply button to send configuration to Device
30. Press the Back button
31. Light Bulb device is now provisioned and configured
32. Select the Mesh Tab and Scan for Nodes
33. Proxy nodes (the Switch) will be highlighted green. If this is not the case make sure step 13 was
executed properly.

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
17 of 48
© 2018 Dialog Semiconductor
34. Select the Switch Node to connect to the proxy
35. Switch will be highlighted blue when connected
36. Turn single Light Bulb on using the Node Slider
37. Red LED on Light Bulb board will turn on
38. Turn all Light Bulbs on and off using the Group Slider
39. Toggle state of Light Bulbs by using SW1 on Switch board

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
18 of 48
© 2018 Dialog Semiconductor

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
19 of 48
© 2018 Dialog Semiconductor
Notes regarding the SDK examples demonstration
Generic ON/OFF model demonstration
The instructions mentioned at the previous section should end up in a complete demo set up
between a server (the lightbulb) and a client (the switch). At this point any button press SW1 of the
switch, should toggle the lightbulb D9 LED.
It is possible to extend the network with more nodes of the same model. For example by following the
same instructions multiple lightbulbs can be added to the same group which can be toggled at the
same time by a single switch! A different demo setup can be setup by creating two different groups in
the mobile application (refer to step 2-5 in previous section) for example “Office” and “Kitchen”. Then
two different switches can be configured to control two different group of lights at the same network!
Generic Level model demonstration
The same instructions as before can be applied to provision and configure 2 client/server node with
the Generic Level model enabled. The only difference in this example compared to Generic ON/OFF
is that the mobile application does not support the control of the level server from the smartphone.
The user can still use the SW1 button of the client side to control the intensity of the D8 LED of the
level server. Alternatively this can be done by the UART console (refer to section 6.10.12)
Similar to the Generic ON/OFF case multiple groups of nodes can be created (eg multiple clients can
control multiple server nodes at the same or different group)
Light HSL model demonstration
The same instructions as before can be applied to provision and configure 2 client/server node with
the Lighting HSL model enabled. The only difference in this example compared to Generic ON/OFF
is that the mobile application does not support the control of the HSL server state values from the
smartphone. The user can still use the SW1 button of the client side to control the colour of the D8
LED of the HSL server by cycling through a set of predefined colours. Alternatively this can be done
by the UART console (refer to section 6.10.12)
Similar to the Generic ON/OFF case multiple groups of nodes can be created (eg multiple clients can
control multiple server nodes in the same or different group)
Generic ON/OFF model multiple elements demonstration
The same instructions as before can be applied to provision and configure 2 client/server node with
the Generic ON/OFF multiple elements enabled. The only difference in this example compared to
Generic ON/OFF is that the mobile application does not support the configuration and control of the
second element. This has to be done manually using the UART console.
At the client side the user needs to enter:
publish set 1 49454
At the server side the user needs to enter:
subscribe add 1 49454
At this point by toggling the SW2 in client side, the D10 LED which represents the second element in
server side should toggle.

UM-B-098
DA1468x Mesh SDK
Company confidential
User manual
Revision 0.1 - DRAFT
17 - July - 2018
CFR0012-00 Rev 2
20 of 48
© 2018 Dialog Semiconductor
Note another demo setup could be to add the same address in the first element of the server.
subscribe add 0 49454
Now LED D9 responds to both SW1/SW2 toggling, but D10 only to SW2!
For more information regarding these commands refer to sections 6.10.10 and 6.10.11.
Vendor specific model demonstration
The vendor specific model is an example that defines a custom model that represents two states in
the same model. The first is an ON/OFF state and the second is a Level state. Note the difference
compared to the Generic ON/OFF and Level models which are defined from Bluetooth SIG is that 2
different states are now defined in a single model. Moreover, this setup is also different than defining
two separate elements at the same node, one as a Generic ON/OFF and the other one as Generic
Level.
The same instructions as before can be applied to provision and configure 2 client/server node with
the Vendor specific model enabled. The only difference in this example compared to Generic
ON/OFF is that the mobile application does not support the control of the ON/OFF and level server
from the smartphone. The user can still use the SW1 and SW2 button at the client side to control the
ON/OFF state of D9 and intensity of the D8 LED at the level server.
Provisioner example demonstration
The target of this example is to demonstrate the provisioning and configuration of a new node to the
network by using a different node that has the role of the provisioner and the configuration client. In
this demo the smartphone is not needed at all. The provisioner node and the smartphone are
creating two completely different networks (network/device keys), therefore the nodes that are
provisioned with one network cannot communicate with the other.
Another big difference between those two is that the provisioner node is doing provisioning over the
advertising (ADV) bearer while the smartphone is doing provisioning over the GATT layer. All the
examples in the code are configured to do provisioning over the GATT layer by default, therefore in
order to test with the provisioner example this has to be changed in the code.
At the user_application_main_task of each example you need to change:
mesh_client.cfg.bearer
from
APPL_PROV_BEARER_GATT
to
APPL_PROV_BEARER_ADV
Note: Due to a known bug in the SDK which is planned to be fixed at the next release, only one node
at a time can be provisioned and configured successfully. Before adding a new node to the network
you need to factory reset both the provisioner and the new node. After the new node is added, it can
communicate with the others as described in the previous sections of this chapter.