Dialog Semiconductor DA14681 User manual

User Manual
DA14681 Wearable Development
Kit API
UM-B-085
Abstract
This document describes the API specifications of software modules of the application running on the
Dialog DA14681 Wearable Development Kit. This manual intends to assist software developers who
implement applications using the DA14681 Wearable Development Kit.

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
2 of 330
© 2017 Dialog Semiconductor
Contents
Abstract................................................................................................................................................ 1
Contents............................................................................................................................................... 2
Figures.................................................................................................................................................. 6
Tables ................................................................................................................................................... 7
1 Terms and Definitions................................................................................................................... 7
2 References..................................................................................................................................... 9
3 Introduction.................................................................................................................................. 10
4 Software Architecture Overview................................................................................................ 10
5 Wearable Task ............................................................................................................................. 12
5.1 BLE...................................................................................................................................... 12
5.1.1 CTS...................................................................................................................... 12
5.1.1.1 Functions ......................................................................................... 13
5.1.2 DWS..................................................................................................................... 13
5.1.2.1 Functions ......................................................................................... 14
5.1.3 HCS ..................................................................................................................... 15
5.1.3.1 Functions ......................................................................................... 16
SUOTA................................................................................................................. 17
5.1.4 17
5.1.4.1 Functions ......................................................................................... 18
5.2 Interface .............................................................................................................................. 18
5.2.1 Touch Pad ........................................................................................................... 18
5.2.1.1 Data Structures and Types.............................................................. 18
5.2.1.2 Functions ......................................................................................... 19
5.2.1.3 Callback Functions .......................................................................... 19
5.2.2 Push Button ......................................................................................................... 19
5.2.2.1 Data Structures and Types.............................................................. 20
5.2.2.2 Functions ......................................................................................... 20
5.2.2.3 Callback Functions .......................................................................... 20
5.3 System ................................................................................................................................ 20
5.3.1 Application Data Storage in NVM........................................................................ 20
5.3.1.1 Data Structures and Types.............................................................. 21
5.3.1.2 Functions ......................................................................................... 22
5.3.2 Battery.................................................................................................................. 25
5.3.2.1 Functions ......................................................................................... 25
5.3.3 Clock manager..................................................................................................... 25
5.3.3.1 Functions ......................................................................................... 26
Real Time Clock .................................................................................................. 26
5.3.4 26
5.3.4.1 Data Structures and Types.............................................................. 26
5.3.4.2 Functions ......................................................................................... 27
5.3.4.3 Callback Functions .......................................................................... 27
5.4 Wearable Health Toolbox Control....................................................................................... 27
5.4.1 Data Structures and Types.................................................................................. 28
5.4.2 Functions ............................................................................................................. 31

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
3 of 330
© 2017 Dialog Semiconductor
6 BLE Services ............................................................................................................................... 35
6.1 Dialog Wearable Service..................................................................................................... 35
6.1.1 DWS Data Structures and Types ........................................................................ 35
6.1.2 IoT Data Structures and Types............................................................................ 36
6.1.3 Functions ............................................................................................................. 42
6.1.4 Callback Functions .............................................................................................. 43
6.2 Health Care Service............................................................................................................ 44
6.2.1 Data Structures and Types.................................................................................. 44
6.2.2 Functions ............................................................................................................. 48
6.2.3 Callback Functions .............................................................................................. 50
6.3 SUOTA Service................................................................................................................... 52
6.4 Current Time Service.......................................................................................................... 52
6.5 Heart Rate Service.............................................................................................................. 52
6.6 Battery Service.................................................................................................................... 52
7 User Interface .............................................................................................................................. 53
7.1 UI Task................................................................................................................................ 53
7.1.1 Data Structures and Types.................................................................................. 54
7.1.2 Functions ............................................................................................................. 56
7.1.2.2 Callbacks ......................................................................................... 60
7.2 GUI...................................................................................................................................... 60
7.2.1 GDI....................................................................................................................... 60
7.2.1.1 Data Structures and Types.............................................................. 60
7.2.1.2 Functions ......................................................................................... 62
7.2.2 Widgets................................................................................................................ 65
7.2.2.1 Data Structures and Types.............................................................. 66
7.2.2.2 Battery Widget Functions ................................................................ 68
7.2.2.3 Circle Progress Bar Functions......................................................... 68
7.2.2.4 Common Functions.......................................................................... 69
7.2.2.5 Image Functions.............................................................................. 69
7.2.2.6 Screen Functions............................................................................. 70
7.2.2.7 Static Label Functions ..................................................................... 71
7.2.2.8 Status Bar Functions ....................................................................... 71
7.2.2.9 Text Box Functions.......................................................................... 72
8 Health Toolbox ............................................................................................................................ 72
8.1 Health Toolbox Task........................................................................................................... 74
8.1.1 Data Structures and Types.................................................................................. 76
8.1.2 Dependency Functions........................................................................................ 87
8.1.3 Initialization and Control Functions...................................................................... 90
8.1.3.2 Configuration Functions................................................................... 92
8.1.3.3 State Functions................................................................................ 96
8.1.3.4 Data Acquisition Functions............................................................ 101
8.1.3.5 Data-Reset Functions.................................................................... 104
8.2 Health Toolbox Implementations ...................................................................................... 105
8.2.2 Inertial Sensors HT-Implementation –API Specification................................... 106
8.2.2.1 Data Structures and Types............................................................ 106
8.2.2.2 Dependency Functions.................................................................. 112
8.2.2.3 Functions ....................................................................................... 112

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
4 of 330
© 2017 Dialog Semiconductor
8.2.3 Environmental Sensors HT-Implementation –API Specification ...................... 117
8.2.3.1 Data Structures and Types............................................................ 118
8.2.3.2 Dependency Functions.................................................................. 123
8.2.3.3 Functions ....................................................................................... 123
8.2.4 Health Care Sensors HT-Implementation –API Specification.......................... 129
8.2.4.1 Data Structures and Types............................................................ 130
8.2.4.2 Dependency Functions.................................................................. 134
8.2.4.3 Functions ....................................................................................... 134
8.2.5 Sensor Fusion Service HT-Implementation –API Specification ....................... 139
8.2.5.1 Data Structures and Types............................................................ 140
8.2.5.2 Dependency Functions.................................................................. 142
8.2.5.3 Functions ....................................................................................... 142
8.2.6 Heart Rate Estimation Service HT-Implementation –API Specification ........... 144
8.2.6.1 Data Structures and Types............................................................ 144
8.2.6.2 Dependency Functions.................................................................. 146
8.2.6.3 Functions ....................................................................................... 146
8.2.7 Step Counting Service HT-Implementation –API Specification........................ 149
8.2.7.1 Data Structures and Types............................................................ 150
8.2.7.2 Dependency Functions.................................................................. 151
8.2.7.3 Functions ....................................................................................... 151
8.2.8 Calories Counting Service HT-Implementation –API Specification.................. 154
8.2.8.1 Data Structures and Types............................................................ 155
8.2.8.2 Dependency Functions.................................................................. 157
8.2.8.3 Functions ....................................................................................... 157
8.2.9 Sleep Quality Monitoring Service HT-Implementation –API Specification ....... 159
8.2.9.1 Data Structures and Types............................................................ 160
8.2.9.2 Dependency Functions.................................................................. 162
8.2.9.3 Functions ....................................................................................... 162
8.3 Timer Component ............................................................................................................. 165
8.3.1 Data Structures and Types................................................................................ 166
8.3.2 Dependency Functions...................................................................................... 167
8.3.3 Functions ........................................................................................................... 167
8.4 Sensor Control Component .............................................................................................. 170
8.4.1 Data Structures and Types................................................................................ 171
8.4.2 Dependency Functions...................................................................................... 180
8.4.3 Functions ........................................................................................................... 181
8.5 Health Care Services Task ............................................................................................... 191
8.5.1 Data Structures and Types................................................................................ 192
8.5.2 Dependency Functions...................................................................................... 200
8.5.3 Initialization and Control Functions.................................................................... 202
8.5.4 Configuration Functions..................................................................................... 204
8.5.5 State Functions.................................................................................................. 205
8.5.6 Data Acquisition Functions................................................................................ 206
8.5.7 Data Push Functions ......................................................................................... 207
8.6 KIWI Services Task........................................................................................................... 210
8.6.1 Data Structures and Types................................................................................ 211
8.6.2 Dependency Functions...................................................................................... 218

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
5 of 330
© 2017 Dialog Semiconductor
8.6.3 Initialization and Control Functions.................................................................... 221
8.6.4 Configuration Functions..................................................................................... 222
8.6.5 State Functions.................................................................................................. 223
8.6.6 Data Acquisition Functions................................................................................ 225
8.6.7 Data Reset Functions........................................................................................ 226
8.6.8 Data Push Functions ......................................................................................... 226
9 Health Toolbox Libraries .......................................................................................................... 228
9.1 Heart Rate Estimation Library........................................................................................... 228
9.1.1 Initialization Functions ....................................................................................... 229
9.1.2 Main Process Functions .................................................................................... 229
9.1.3 Configuration Functions..................................................................................... 229
9.2 Sleep Quality Monitoring Library....................................................................................... 230
9.2.1 Data Structures and Types................................................................................ 230
9.2.2 Dependency Functions...................................................................................... 232
9.2.3 Initialization and Basic Configuration Functions................................................ 233
9.2.4 Main Process Functions .................................................................................... 234
9.2.5 Service Data Acquisition Functions................................................................... 234
9.2.6 State Functions.................................................................................................. 235
9.3 Calories Counting Library.................................................................................................. 235
9.3.1 Data Structures and Types................................................................................ 236
9.3.2 Dependency Functions...................................................................................... 238
9.3.3 Initialization and Basic Configuration Functions................................................ 239
9.3.4 Main Process Functions .................................................................................... 239
9.3.5 Service Data Acquisition Functions................................................................... 240
9.3.6 Command Functions.......................................................................................... 240
9.3.7 State Functions.................................................................................................. 240
9.4 KIWI Basic Activity Tracking ............................................................................................. 241
10 Peripheral Device Drivers......................................................................................................... 244
10.1.1 BMI160 Sensor Driver ....................................................................................... 245
10.1.1.1 Data Structures and Types............................................................ 248
10.1.1.2 Dependency Functions.................................................................. 248
10.1.1.3 Initialization and Basic Configuration Functions............................ 249
10.1.1.4 Sensor Data Acquisition Functions................................................ 250
10.1.1.5 Command Functions...................................................................... 252
10.1.1.6 State Functions.............................................................................. 253
10.1.1.7 Configuration Functions................................................................. 256
10.1.1.8 Low Level Register Access Functions........................................... 277
10.1.1.9 Magnetometer Control and Configuration Functions (Indirect
Access).......................................................................................... 278
10.1.2 BMM150 Sensor Driver ..................................................................................... 280
10.1.2.1 Data Structures and Types............................................................ 281
10.1.2.2 Dependency Functions.................................................................. 282
10.1.2.3 Initialization and Basic Configuration Functions............................ 282
10.1.2.4 Sensor Data Acquisition Functions................................................ 283
10.1.2.5 Command Functions...................................................................... 284
10.1.2.6 State Functions.............................................................................. 284
10.1.2.7 Configuration Functions................................................................. 285

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
6 of 330
© 2017 Dialog Semiconductor
10.1.2.8 Low Level Register Access Functions........................................... 289
10.1.3 BME280 Sensor Driver...................................................................................... 290
10.1.3.1 Data Structures and Types............................................................ 291
10.1.3.2 Dependency Functions.................................................................. 291
10.1.3.3 Initialization and Basic Configuration Functions............................ 292
10.1.3.4 Sensor Data Acquisition Functions................................................ 292
10.1.3.5 Command Functions...................................................................... 293
10.1.3.6 State Functions.............................................................................. 293
10.1.3.7 Configuration Functions................................................................. 294
10.1.3.8 Low Level Register Access Functions........................................... 296
10.1.4 DI5115 Sensor Driver........................................................................................ 297
10.1.4.1 Data Structures and Types............................................................ 298
10.1.4.2 Dependency Functions.................................................................. 299
10.1.4.3 Initialization and Basic Configuration Functions............................ 300
10.1.4.4 Sensor Data Acquisition Functions................................................ 301
10.1.4.5 Command Functions...................................................................... 301
10.1.4.6 Configuration Functions................................................................. 301
10.1.5 SX9300 Sensor Driver....................................................................................... 302
10.1.5.1 Data Structures and Types............................................................ 302
10.1.5.2 Functions ....................................................................................... 306
10.1.5.3 Dependency Functions.................................................................. 308
10.1.6 AB08X5 Real Time Clock Driver ....................................................................... 310
10.1.6.1 Data Structures and Types............................................................ 310
10.1.6.2 Functions ....................................................................................... 312
10.1.7 LS013B7DH03 Display Driver ........................................................................... 318
10.1.7.1 Functions ....................................................................................... 319
10.1.7.2 Callback Functions ........................................................................ 319
10.1.8 FXL6408 GPIO Expander Driver....................................................................... 320
10.1.8.1 Data Structures and Types............................................................ 321
10.1.8.2 Dependency Functions.................................................................. 322
10.1.8.3 Initialization and Basic Configuration Functions............................ 323
10.1.8.4 Command Functions...................................................................... 324
10.1.8.5 State Functions.............................................................................. 324
10.1.8.6 Configuration Functions................................................................. 325
10.1.8.7 Low Level Register Access Functions........................................... 328
Revision History .............................................................................................................................. 329
Figures
Figure 1: The Wearable Development Kit........................................................................................... 10
Figure 2: Software Architecture........................................................................................................... 11
Figure 3: Main Application Components ............................................................................................. 12
Figure 4: UI Task Block Diagram ........................................................................................................ 53
Figure 5: Health Toolbox Component Software Architecture.............................................................. 73
Figure 6: Peripheral Device Driver Architecture................................................................................ 244

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
7 of 330
© 2017 Dialog Semiconductor
Tables
Table 1: Wearable CTS API................................................................................................................ 12
Table 2: Wearable DWS API............................................................................................................... 13
Table 3: Wearable HCS API................................................................................................................ 15
Table 4: Wearable SUOTA API........................................................................................................... 17
Table 5: Wearable touch pad API ....................................................................................................... 18
Table 6: Wearable push button API .................................................................................................... 19
Table 7: Data Storage API................................................................................................................... 20
Table 8: Wearable battery API ............................................................................................................ 25
Table 9: Wearable clock manager API................................................................................................ 25
Table 10: Wearable RTC API.............................................................................................................. 26
Table 11: Wearable Health Toolbox Control API ................................................................................ 28
Table 12: Calibration Control Flags (byte 1)........................................................................................ 40
Table 13: Calibration control flags (byte 2).......................................................................................... 40
Table 14: User Interface Task API ...................................................................................................... 54
Table 15: GDI API ............................................................................................................................... 60
Table 16: Widgets API......................................................................................................................... 65
Table 17: Basic Health Toolbox API Sensors/Services Configuration Functions ............................... 74
Table 18: Health Toolbox Task API..................................................................................................... 75
Table 19: Inertial Sensors HT-Implementation API........................................................................... 106
Table 20: Environmental Sensors HT-Implementation API............................................................... 118
Table 21: Health Care Sensors HT-Implementation API .................................................................. 129
Table 22: Sensor Fusion Service HT-Implementation API................................................................ 139
Table 23: Heart Rate Estimation Service HT-Implementation API.................................................... 144
Table 24: Step Counting Service HT-Implementation API................................................................ 149
Table 25: Calories Counting Service HT-Implementation API.......................................................... 154
Table 26: Sleep Quality Monitoring Service HT-Implementation API ............................................... 160
Table 27: Timer Component API....................................................................................................... 165
Table 28: Sensor Control API............................................................................................................ 170
Table 29: Health Care Services Task API......................................................................................... 191
Table 30: KIWI Services Task API .................................................................................................... 210
Table 31: Heart Rate Estimation Library API .................................................................................... 228
Table 32: Sleep Quality Monitoring Library API ................................................................................ 230
Table 33: Calories Counting Library API........................................................................................... 235
Table 34: BMI160 Driver API............................................................................................................. 245
Table 35: BMM150 Driver API........................................................................................................... 280
Table 36: BME280 Driver API ........................................................................................................... 290
Table 37: DI5115 Driver API.............................................................................................................. 297
Table 38: SX9300 Driver API ............................................................................................................ 302
Table 39: AB08X5 Driver API............................................................................................................ 310
Table 40: LS013B7DH03 driver API.................................................................................................. 318
Table 41: FXL6408 Driver API........................................................................................................... 320
1 Terms and Definitions
AHRS Attitude and Heading Reference System
API Application Programming Interface
BAS Battery Service
BD Bluetooth Device (address)
BLE Bluetooth low energy
BMR Basal Metabolic Rate
CAS Custom Alarm Service
CC Constant Current (charging)
CIB Connection Interface Board
CV Constant Voltage (charging)

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
8 of 330
© 2017 Dialog Semiconductor
DK Development Kit
DWS Dialog Wearable Service
epoch time slot of a constant duration (wearables: 1 min)
FW Firmware
GAP Generic Access Profile
GATT Generic ATTribute profile
GDI Graphical Device Interface
GUI Graphical User Interface
HCS Health Care Service
HT Health Toolbox
KBSCN Keyboard Scanner
MEMS Micro Electro-Mechanical Systems
MTU Maximum Transmission Unit
NED North East Down (coordinate system)
NVDS Non-Volatile Data Storage
NVMS Non Volatile Memory Storage
RAM Random Access Memory
REM Rapid Eye Movement
Report Notification of sensor data and control
RTC Real Time Clock
SF Sensor Fusion
SFL Sensor Fusion Library
SOC State Of Charge
SUOTA Software Update Over The Air
UI User Interface

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
9 of 330
© 2017 Dialog Semiconductor
2 References
[1] UM-B-076_DA14681 Wearable Development Kit Software Manual.
[2] UM-B-044, DA1468x Software Platform reference, User Manual, Dialog Semiconductor.
[3] UM-B-056, DA1468x Software Developer's guide, User Manual, Dialog Semiconductor.
[4] AN-B-003, DA14580 Software Patching over the Air (SPotA), Application Note, Dialog
Semiconductor.
[5] HRS_SPEC, HEART RATE SERVICE SPECIFICATION v1.0, Bluetooth SIG.
[6] CTS_SPEC, CURRENT TIME SERVICE SPECIFICATION V1.1, Bluetooth SIG.
[7] BAS_SPEC, BATTERY SERVICE SPECIFICATION V1.1, Bluetooth SIG.
[8] LS013B7DH03, Datasheet, Sharp Microelectronics.
[9] UM-B-077, DA14681 Wearable Development Kit Hardware Manual, User Manual, Dialog
Semiconductor.
[10] BMI160, Datasheet, Bosch Sensortec.
[11] BMM150, Datasheet, Bosch Sensortec.
[12] BME280, Datasheet, Bosch Sensortec.
[13] FXL6408, Datasheet, Fairchild Semiconductor.

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
10 of 330
© 2017 Dialog Semiconductor
3 Introduction
The Wearable Development Kit is a platform for development of wearables applications using
Dialog's DA14681 System on Chip solution combining an application processor, memories,
cryptography engine, power management unit, digital and analog peripherals and a Bluetooth®
Smart MAC engine and radio transceiver.
Figure 1: The Wearable Development Kit
The purpose of this user manual is to provide a brief overview of the architecture of the reference
software for Wearable Development Kit, provide the specification of the software modules and the
corresponding APIs.A more detailed description of the architecture, the set of necessary hardware
and software components for development on Wearable Development Kit and guidelines to install
and use the reference Smartphone/Tablet apps can be found in the user manual of the DA14681
wearable development kit [1].
4 Software Architecture Overview
The software architecture of the wearable application is outlined in the following image.

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
11 of 330
© 2017 Dialog Semiconductor
Figure 2: Software Architecture
The application software is organized in FreeRTOS tasks running on the top of the DA1468x SDK.
All the details of DA1468x SDK can be found in [2] and [3].
The main software modules and tasks of the wearable application are the following:
●WRBL Task. This is the main task of the application and is responsible for the control and the
coordination of the other application tasks and transferring data from/to the BLE Services. It is
also responsible for controlling and handling events coming from the RTC, capacitive touchpads
and mechanical button. Finally, it is responsible for writing/reading application and configuration
data to/from the Flash memory.
●Health Toolbox. The health toolbox software module consists of two tasks.
○Health Toolbox task. This task is responsible for controlling and accessing the peripheral
sensors for movement and HR monitoring. Health toolbox gets commands from WRBL task
regarding the configuration of sensors and health care services, it accesses sensors via the
Sensor Control software component, and provides the sensor data to WRBL task and Health
Care Services task. Finally it processes the output of Health Care Services task to send the
required health care data to Wearable task for further manipulation (storage in Flash memory,
displayed on TFT Display or transmitted over BLE via the corresponding service)
○Health Care Services task. This task consists of the algorithms for health care (Sleep
Quality Monitoring, Calories Counting and Heart Rate Monitoring), sensor fusion and
magneto calibration. It gets input sensor and configuration data from the Health toolbox task
and sends back the output of the algorithms.
●UI Task. This task is responsible for the graphical user interface of the wearable device display. It
gets commands from the WRBL task regarding the screen and the data to be displayed, the
status bar information, and other graphic effects such as blinking.

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
12 of 330
© 2017 Dialog Semiconductor
5 Wearable Task
Figure 3: Main Application Components
The wearable main task (WRBL) handles the data transfers between other tasks (e.g. step counter
data generated in the Health Toolbox task transferred to the UI task to be displayed and/or to the
BLE Manager task to be sent to a peer device). At a high level it controls the data flow to/from the
Health Toolbox, User Interface and BLE Manager tasks by sending the appropriate messages using
the corresponding API function calls.
It controls the data stored in the SPI Flash memory with the use of the data storage functions, which
provide a structured storage of the required data. Data types that are stored are the heart rate, steps,
calories and sleep quality, using minimum space in Flash memory. The lower level Flash operations
are performed by the SDK's NVMS adapter, which handles all necessary signaling.
5.1 BLE
Wearable task is using BLE profiles to communicate the produced data and receive commands from
a connected peer device. The task - profile interaction of the following profiles, due to their
complexity, are implemented in separate files andtheir API is described below.
5.1.1 CTS
Table 1: Wearable CTS API
Functions
wrbl_cts_init()
wrbl_cts_notify_time_all()

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
13 of 330
© 2017 Dialog Semiconductor
5.1.1.1 Functions
wrbl_cts_init()
Function Name
void wrbl_cts_init(void);
Function Description
Initialize the CTS component of the wearable task
Parameters
None
Return Values
None
Notes
wrbl_cts_notify_time_all()
Function Name
void wrbl_cts_notify_time_all(bool update_time);
Function Description
Notifies all connected peer devices of the (current) time/date.
Parameters
update_time Set true to force the update of the current time
Return Values
None
Notes
Current time is received directly by the RTC module.
5.1.2 DWS
Table 2: Wearable DWS API
Functions
wrbl_dws_init()
wrbl_dws_send_cmd_report()
wrbl_dws_send_data_report()

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
14 of 330
© 2017 Dialog Semiconductor
5.1.2.1 Functions
wrbl_dws_init()
Function Name
void wrbl_dws_init(void);
Function Description
Initialize the DWS component of the wearable task.
Parameters
None
Return Values
None
Notes
wrbl_dws_send_data_report()
Function Name
void wrbl_dws_send_data_report(iot_report_id_t type, void * const data);
Function Description
Send data reports to the connected peer device.
Parameters
type Report type
data Data to be included in the report
Return Values
None
Notes
Depending on the type the following data MUST be provided:
Type
Data type
IOT_ACCELEROMETER_REPORT_ID
ht_data_acc_t
IOT_GYROSCOPE_REPORT_ID
ht_data_gyr_t
IOT_MAGNETOMETER_REPORT_ID
ht_data_mag_t
IOT_PRESSURE_REPORT_ID
ht_data_env_t
IOT_HUMIDITY_REPORT_ID
ht_data_env_t
IOT_TEMPERATURE_REPORT_ID
ht_data_env_t
IOT_SENSOR_FUSION_REPORT_ID
ht_data_sfl_t
wrbl_dws_send_cmd_report()
Function Name
void wrbl_dws_send_cmd_report(iot_control_byte_t type, void * const data);
Function Description
Send data reports to the connected peer device.
Parameters
type Report type
data Data to be included in the report
Return Values
None
Notes
Depending on the type the following data MUST be provided:
Type
Data type
IOT_STOP_CMD
uint8_t
IOT_START_CMD
uint8_t
IOT_GET_RUNNING_STATUS_CMD
uint8_t
IOT_BASIC_CONFIG_RD_REQ
iot_basic_setup_t
IOT_SFL_COEFF_RD_REQ
iot_sfl_coeffs_t
IOT_CAL_COEFF_RD_REQ
iot_calibr_coeffs_t
IOT_CAL_CTRL_RD_REQ
iot_calibr_ctrl_t
IOT_START_ACC_ALLIGN
uint8_t

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
15 of 330
© 2017 Dialog Semiconductor
5.1.3 HCS
Table 3: Wearable HCS API
Functions
wrbl_hcs_init()
hcs_update_remote_db()
wrbl_hcs_send_epoch()
handle_hcs_msg()
handle_connected_hcs()
wrbl_hcs_send_acc_counter()
wrbl_hcs_send_status()

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
16 of 330
© 2017 Dialog Semiconductor
5.1.3.1 Functions
wrbl_hcs_init()
Function Name
void wrbl_hcs_init(void);
Function Description
Initialize the HCS component of the wearable task.
Parameters
None
Return Values
None
Notes
handle_connected_hcs()
Function Name
void handle_connected_hcs(void);
Function Description
Function to inform the component of the new connection.
Parameters
None
Return Values
None
Notes
hcs_update_remote_db()
Function Name
bool hcs_update_remote_db(uint16_t conn_idx, uint32_t time,
hcs_op_code_t type);
Function Description
Function to initiate a database update to the peer device when there is an update in
the stored values.
Parameters
conn_idx Connection index
time Time of the oldest updated sample
type Type of the samples the update occurred
Return Values
True if the update was performed successfully, false if the update is scheduled to be
performed when the peer device connects and synchronizes database.
Notes
wrbl_hcs_send_acc_counter()
Function Name
void wrbl_hcs_send_acc_counter(hcs_op_code_t op_code, uint32_t value);
Function Description
Send accumulated counter to connected peer device
Parameters
op_code Type of the accumulated counter
value Value of the accumulated counter
Return Values
None
Notes
Valid types (op_codes) are:
HCS_OP_CODE_STEP
HCS_OP_CODE_LIGHT_SLEEP
HCS_OP_CODE_DEEP_SLEEP
HCS_OP_CODE_CALORIES
wrbl_hcs_send_epoch()
Function Name
void wrbl_hcs_send_epoch(hcs_op_code_t op_code, uint32_t value,
uint32_t timestamp);
Function Description
Send accumulated counter to connected peer device

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
17 of 330
© 2017 Dialog Semiconductor
Parameters
op_code Type of the accumulated counter
value Value of the accumulated counter
timestamp Timestamp of the epoch
Return Values
None
Notes
Valid types (op_codes) are:
HCS_OP_CODE_STEP
HCS_OP_CODE_HEART_RATE
HCS_OP_CODE_SLEEP_QUALITY
HCS_OP_CODE_CALORIES
HCS_OP_CODE_BODY_STATE
wrbl_hcs_send_status()
Function Name
void wrbl_hcs_send_status(hcs_op_code_t op_code, bool status);
Function Description
Send service status to connected peer device
Parameters
op_code Type of the accumulated counter
status Status of the service
Return Values
None
Notes
Valid types (op_codes) are:
HCS_OP_CODE_STEP
HCS_OP_CODE_HEART_RATE
HCS_OP_CODE_SLEEP_QUALITY
HCS_OP_CODE_CALORIES
HCS_OP_CODE_BODY_STATE
handle_hcs_msg()
Function Name
void handle_hcs_msg(msg *wrbl_msg);
Function Description
Function handles all the HCS messages
Parameters
type Report type
wrbl_msg Message to be handled
Return Values
None
Notes
5.1.4 SUOTA
Table 4: Wearable SUOTA API
Functions
wrbl_suota_init()

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
18 of 330
© 2017 Dialog Semiconductor
5.1.4.1 Functions
wrbl_suota_init()
Function Name
void wrbl_suota_init(void);
Function Description
Initialize the SUOTA module.
Parameters
None
Return Values
None
Notes
5.2 Interface
The wearable device's user inputs are the push button and two touch buttons. The two touch buttons
are used together to create a slide detection mechanism. Depending on what is displayed on the
screen the user can set time, date and alarm, and also control various states of the sensors and
services.
5.2.1 Touch Pad
Table 5: Wearable touch pad API
Structures
wrbl_touch_event_t
Functions
wrbl_touch_init()
handle_touch_event()
wrbl_touch_set_enable()
Callback functions
wrbl_touch_event_callback()
5.2.1.1 Data Structures and Types
wrbl_touch_event_t
Type Definition Name
Description
wrbl_touch_event_t
Touch event enumeration type defined as:
WRBL_TOUCH_SWIPE_RIGHT,
WRBL_TOUCH_SWIPE_UP,
WRBL_TOUCH_SWIPE_LEFT,
WRBL_TOUCH_SWIPE_DOWN,

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
19 of 330
© 2017 Dialog Semiconductor
5.2.1.2 Functions
wrbl_touch_init()
Function Name
void wrbl_touch_init(wrbl_touch_event_callback event_cb);
Function Description
Initialize the touch module.
Parameters
event_cb Callback function to be called when a touch event is
detected
Return Values
None
Notes
wrbl_touch_set_enable()
Function Name
void wrbl_touch_set_enable(bool enable);
Function Description
Change the operation state of the touch sensor module.
Parameters
enable Enable/disable the touch module
Return Values
None
Notes
handle_touch_event()
Function Name
void handle_touch_event(void);
Function Description
Function handles the touch events of the wearable task.
Parameters
None
Return Values
None
Notes
5.2.1.3 Callback Functions
wrbl_touch_event_callback()
Function Name
void wrbl_touch_event_callback(wrbl_touch_event_t evt);
Function Description
Callback function to be called when a new event is detected.
Parameters
evt Event type
Return Values
None
Notes
5.2.2 Push Button
Table 6: Wearable push button API
Structures
btn_press_t
Functions
wrbl_button_init()
handle_button_event()
Callback functions
handle_button_callback()

UM-B-085
DA14681 Wearable Development Kit API
User Manual
Revision 1.0
08-Jul-2017
CFR0012
20 of 330
© 2017 Dialog Semiconductor
5.2.2.1 Data Structures and Types
btn_press_t
Type Definition Name
Description
btn_press_t
Button press enumeration type defined as:
BTN_SHORT_PRESS,
BTN_LONG_PRESS,
5.2.2.2 Functions
wrbl_button_init()
Function Name
void wrbl_button_init(handle_button_callback cb);
Function Description
Initialize button component of the wearable task.
Parameters
cb Callback function to be called when an event is produced
Return Values
None
Notes
handle_button_event()
Function Name
void handle_button_event();
Function Description
Function that handles the button notifications.
Parameters
None
Return Values
None
Notes
5.2.2.3 Callback Functions
handle_button_callback()
Function Name
void handle_button_callback(btn_press_t press);
Function Description
Callback function to be called when a new event is detected.
Parameters
press Event type
Return Values
None
Notes
5.3 System
5.3.1 Application Data Storage in NVM
Data Storage is an abstraction layer that provides the functionality for storing epoch data in Flash
memory using the Non-Volatile Memory Storage (NVMS) adapter of the SDK. A more detailed
description of the library can be found in the user manual of the DA14681 wearable development kit
[1].
Table 7: Data Storage API
Structures
ds_sample_size_t
ds_err_t
ds_data_type_t