Wurth Elektronik PROTEUS-III User manual

PROTEUS-III REFERENCE MANUAL
2611011024000
VERSION 1.3
AUGUST 6, 2020

Revision history
Manual
version
FW
version
HW
version Notes Date
1.0 1.1.0 1.2 • Initial release February
2020
1.1 1.1.0 1.2
• Limitation of the RF_DeviceName to a
maximum of 31 bytes
• Added Annex Additional CRC8
Information and Example codes for
host integration
June 2020
1.2 1.1.0 1.2 • corrected capacitor number. C28 changed
to C26 in section Trace design
July 2020
1.3 1.1.0 1.2
• Updated section Trace design .
• Included figure On-board PCB antenna
and External antenna connection .
August 2020
?For firmware history see chapter Firmware history
Proteus-III reference manual version 1.3 © August 2020
www.we-online.com/wireless-connectivity 1

Abbreviations and abstract
Abbreviation Name Description
BTMAC Bluetooth®conform MAC address of the module used
on the RF-interface.
CS Checksum Byte wise XOR combination of the preceding fields.
DSSS Direct sequence
spread spectrum Technique to spread a message on the radio
DTM Direct test mode Mode to test Bluetooth®specific RF settings.
EV (Board) Evaluation (Board) Proteus-III populated on motherboard with USB
interface for test and evaluation purpose.
FEC Forward error
correction
Technique to correct received erroneous radio
messages
GAP Generic Access
Profile
The GAP provides a basic level of functionality that all
Bluetooth®devices must implement.
I/O Input/output Pinout description.
LESC Low energy
secure connection
Elliptic curve encryption method for Bluetooth®LE
encryption and authentication
LPM Low power mode Mode for efficient power consumption.
LRM Long range mode Radio mode with higher range and lower throughput.
MAC MAC address of the module.
MTU Maximum
transmission unit Maximum packet size of the Bluetooth®connection.
Payload The intended message in a frame / package.
RF Radio frequency Describes wireless transmission.
RSSI Receive Signal
Strength Indicator
The RSSI indicates the strength of the RF signal. Its
value is always printed in two’s complement notation.
Soft device Operating system used by the nRF52 chip.
User settings
Settings to configure the module. Any relation to a
specific entry in the user settings is marked in a
special font and can be found in chapter 8 .
UART
Universal
Asynchronous
Receiver
Transmitter
Allows the serial communication with the module.
[HEX] 0xhh Hexadecimal
All numbers beginning with 0x are hexadecimal
numbers. All other numbers are decimal, unless
stated otherwise.
Proteus-III reference manual version 1.3 © August 2020
www.we-online.com/wireless-connectivity 2

Contents
1. Introduction 10
1.1. Operational description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.1.1. Keyfeatures............................... 11
1.1.2. Connectivity............................... 12
1.2. Blockdiagram................................... 13
1.3. Orderinginformation............................... 13
2. Electrical specifications 14
2.1. Recommended operating conditions . . . . . . . . . . . . . . . . . . . . . . 14
2.2. Absolute maximum ratings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.3. Powerconsumption................................ 15
2.3.1. Static................................... 15
2.3.2. Dynamic................................. 16
2.4. Radiocharacteristics............................... 18
2.5. Pincharacteristics ................................ 19
3. Pinout 20
4. Quick start 23
4.1. Minimal pin connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.2. Antennaconnection ............................... 25
4.2.1. On-board PCB antenna . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.2.2. Externalantenna ............................ 25
4.3. Powerup ..................................... 26
4.4. Quickstartexample................................ 27
5. Functional description 31
5.1. State indication using the LED pins . . . . . . . . . . . . . . . . . . . . . . . 33
5.2. Sleepmode.................................... 33
5.3. Identification of a Proteus-III device on the radio . . . . . . . . . . . . . . . . 34
5.4. Connection based data transmission, with or without security . . . . . . . . 34
5.4.1. Further information for a secure connection setup . . . . . . . . . . 35
5.4.1.1. Just works mode . . . . . . . . . . . . . . . . . . . . . . . . . . 35
5.4.1.2. StaticPasskey mode . . . . . . . . . . . . . . . . . . . . . . . . 38
5.4.1.3. LescPasskey mode . . . . . . . . . . . . . . . . . . . . . . . . . 41
5.4.1.4. LescNumComp mode . . . . . . . . . . . . . . . . . . . . . . . 45
5.4.1.5. Bonding............................... 50
5.5. Unidirectional connectionless data transmission using Beacons . . . . . . . 53
5.6. Energy-efficient distance estimation solutions . . . . . . . . . . . . . . . . . 54
5.7. Configure the module for low power consumption . . . . . . . . . . . . . . . 55
5.8. Start the direct test mode (DTM) . . . . . . . . . . . . . . . . . . . . . . . . 55
5.9. Using the 2 MBit and LE Coded phy . . . . . . . . . . . . . . . . . . . . . . 57
5.10. Connection setup using LE Coded phy . . . . . . . . . . . . . . . . . . . . . 58
6. Host connection 61
6.1. Serial interface: UART . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
6.1.1. Resetbehaviour............................. 61
Proteus-III reference manual version 1.3 © August 2020
www.we-online.com/wireless-connectivity 3

7. The command interface 62
7.1. Scan for other modules in range . . . . . . . . . . . . . . . . . . . . . . . . 64
7.1.1. CMD_SCANSTART_REQ . . . . . . . . . . . . . . . . . . . . . . . 64
7.1.2. CMD_SCANSTOP_REQ . . . . . . . . . . . . . . . . . . . . . . . . 64
7.1.3. CMD_GETDEVICES_REQ . . . . . . . . . . . . . . . . . . . . . . . 65
7.1.3.1. Example1.............................. 66
7.1.4. CMD_RSSI_IND ............................ 66
7.1.5. CMD_BEACON_RSP . . . . . . . . . . . . . . . . . . . . . . . . . . 67
7.2. Setupconnections ................................ 68
7.2.1. CMD_CONNECT_REQ . . . . . . . . . . . . . . . . . . . . . . . . 68
7.2.2. CMD_CONNECT_IND . . . . . . . . . . . . . . . . . . . . . . . . . 68
7.2.3. CMD_SECURITY_IND . . . . . . . . . . . . . . . . . . . . . . . . . 68
7.2.4. CMD_CHANNELOPEN_RSP . . . . . . . . . . . . . . . . . . . . . 69
7.2.5. CMD_DISCONNECT_REQ . . . . . . . . . . . . . . . . . . . . . . 69
7.2.6. CMD_DISCONNECT_IND . . . . . . . . . . . . . . . . . . . . . . . 70
7.2.7. CMD_PHYUPDATE_REQ . . . . . . . . . . . . . . . . . . . . . . . 70
7.2.8. CMD_PHYUPDATE_IND . . . . . . . . . . . . . . . . . . . . . . . . 71
7.2.9. CMD_PASSKEY_REQ . . . . . . . . . . . . . . . . . . . . . . . . . 71
7.2.10. CMD_PASSKEY_IND . . . . . . . . . . . . . . . . . . . . . . . . . . 72
7.2.11. CMD_DISPLAY_PASSKEY_IND . . . . . . . . . . . . . . . . . . . . 72
7.2.12. CMD_NUMERIC_COMP_REQ . . . . . . . . . . . . . . . . . . . . 72
7.2.13. CMD_GETBONDS_REQ . . . . . . . . . . . . . . . . . . . . . . . . 73
7.2.13.1. Example1.............................. 73
7.2.14. CMD_DELETEBONDS_REQ . . . . . . . . . . . . . . . . . . . . . 74
7.2.14.1. Example1.............................. 74
7.2.14.2. Example2.............................. 75
7.3. Transmit and receive data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
7.3.1. CMD_DATA_REQ............................ 76
7.3.2. CMD_TXCOMPLETE_RSP . . . . . . . . . . . . . . . . . . . . . . 76
7.3.3. CMD_DATA_IND ............................ 77
7.3.4. CMD_SETBEACON_REQ . . . . . . . . . . . . . . . . . . . . . . . 77
7.3.5. CMD_BEACON_IND . . . . . . . . . . . . . . . . . . . . . . . . . . 77
7.4. Configuring the module and modifying the device settings . . . . . . . . . . 79
7.4.1. CMD_SET_REQ ............................ 79
7.4.1.1. Example1.............................. 80
7.4.1.2. Example2.............................. 80
7.4.2. CMD_GET_REQ ............................ 81
7.4.2.1. Example1.............................. 81
7.5. Manage the device state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
7.5.1. CMD_GETSTATE_REQ . . . . . . . . . . . . . . . . . . . . . . . . 82
7.5.1.1. Example1.............................. 82
7.5.2. CMD_RESET_REQ........................... 83
7.5.3. CMD_SLEEP_REQ........................... 83
7.5.4. CMD_SLEEP_IND ........................... 84
7.5.5. CMD_FACTORYRESET_REQ . . . . . . . . . . . . . . . . . . . . . 84
7.5.6. CMD_UARTDISABLE_REQ . . . . . . . . . . . . . . . . . . . . . . 85
7.5.7. CMD_UARTENABLE_IND . . . . . . . . . . . . . . . . . . . . . . . 86
7.5.8. CMD_BOOTLOADER_REQ . . . . . . . . . . . . . . . . . . . . . . 86
Proteus-III reference manual version 1.3 © August 2020
www.we-online.com/wireless-connectivity 4

7.6. Run the Bluetooth test modes . . . . . . . . . . . . . . . . . . . . . . . . . . 88
7.6.1. CMD_DTMSTART_REQ . . . . . . . . . . . . . . . . . . . . . . . . 88
7.6.2. CMD_DTM_REQ ............................ 88
7.6.2.1. Example: Transmission, 16 times 0x0F, channel 0 . . . . . . . 90
7.6.2.2. Example: Receiver, channel 0 . . . . . . . . . . . . . . . . . . . 91
7.6.2.3. Example: Transmission, carrier test, channel 0 . . . . . . . . . 92
7.6.2.4. Example: Set TX power to -4 dBm . . . . . . . . . . . . . . . . 92
7.6.2.5. Example: Set PHY to 2MBit mode . . . . . . . . . . . . . . . . 92
7.7. Switching GPIOs by remote control . . . . . . . . . . . . . . . . . . . . . . . 94
7.7.1. CMD_GPIO_LOCAL_WRITECONFIG_REQ . . . . . . . . . . . . . 94
7.7.1.1. Example: Configure two GPIOs to output high . . . . . . . . . . 95
7.7.2. CMD_GPIO_LOCAL_READCONFIG_REQ . . . . . . . . . . . . . 96
7.7.2.1. Example: Read the current GPIO configuration . . . . . . . . . 97
7.7.3. CMD_GPIO_REMOTE_WRITECONFIG_REQ . . . . . . . . . . . . 98
7.7.3.1. Example: Configure two GPIOs of the connected remote device
tooutputhigh............................ 99
7.7.4. CMD_GPIO_REMOTE_READCONFIG_REQ . . . . . . . . . . . . 100
7.7.4.1. Example: Read the current GPIO configuration of the connect-
edremotedevice.......................... 101
7.7.5. CMD_GPIO_REMOTE_WRITE_REQ . . . . . . . . . . . . . . . . . 102
7.7.5.1. Example: Set a remote output GPIO to low . . . . . . . . . . . 103
7.7.6. CMD_GPIO_REMOTE_READ_REQ . . . . . . . . . . . . . . . . . 104
7.7.6.1. Example: Read the values of remote GPIOs . . . . . . . . . . . 105
7.7.7. CMD_GPIO_LOCAL_WRITE_REQ . . . . . . . . . . . . . . . . . . 106
7.7.7.1. Example: Set a local output GPIO to low . . . . . . . . . . . . . 107
7.7.8. CMD_GPIO_LOCAL_READ_REQ . . . . . . . . . . . . . . . . . . 108
7.7.8.1. Example: Read the values of local GPIOs . . . . . . . . . . . . 109
7.7.9. CMD_GPIO_REMOTE_WRITECONFIG_IND . . . . . . . . . . . . 110
7.7.9.1. Example: Two GPIOs have been configured by the connected
remote device to output high . . . . . . . . . . . . . . . . . . . 110
7.7.10. CMD_GPIO_REMOTE_WRITE_IND . . . . . . . . . . . . . . . . . 111
7.7.10.1. Example: GPIOs have been written via remote access . . . . . 111
7.7.11. CMD_GPIO_LOCAL_WRITE_IND . . . . . . . . . . . . . . . . . . 112
7.7.11.1. Example: GPIOs of the remote device have been written by its
localhost .............................. 112
7.8. Othermessages ................................. 113
7.8.1. CMD_ERROR_IND........................... 113
7.9. Messageoverview ................................ 114
8. UserSettings - Module configuration values 118
8.1. FS_DeviceInfo: Read the chip type and OS version . . . . . . . . . . . . . . 118
8.1.1. Example1................................ 119
8.2. FS_FWVersion: Read the firmware version . . . . . . . . . . . . . . . . . . 120
8.2.1. Example1................................ 120
8.3. FS_MAC: Read the MAC address . . . . . . . . . . . . . . . . . . . . . . . . 121
8.3.1. Example1................................ 121
8.4. FS_BTMAC: Read the Bluetooth conform MAC address . . . . . . . . . . . 122
8.4.1. Example1................................ 122
Proteus-III reference manual version 1.3 © August 2020
www.we-online.com/wireless-connectivity 5

8.5. FS_SerialNumber: Read the serial number of the module . . . . . . . . . . 123
8.5.1. Example1................................ 123
8.6. RF_DeviceName: Modify the device name . . . . . . . . . . . . . . . . . . . 124
8.6.1. Example1................................ 124
8.6.2. Example2................................ 124
8.7. RF_StaticPasskey: Modify the static passkey . . . . . . . . . . . . . . . . . 126
8.7.1. Example1................................ 126
8.7.2. Example2................................ 126
8.8. RF_SecFlags: Modify the security settings . . . . . . . . . . . . . . . . . . . 127
8.8.1. Example1................................ 128
8.8.2. Example2................................ 129
8.9. RF_SecFlagsPerOnly: Modify the security settings (Peripheral only mode) . 130
8.9.1. Example1................................ 130
8.9.2. Example2................................ 130
8.10. RF_ScanFlags: Modify the scan behavior . . . . . . . . . . . . . . . . . . . 131
8.10.1.Example1................................ 131
8.10.2.Example2................................ 131
8.11. RF_BeaconFlags: Interprete the advertising data . . . . . . . . . . . . . . . 133
8.11.1.Example1................................ 133
8.11.2.Example2................................ 134
8.12. RF_AdvertisingTimeout: Modify the advertising timeout . . . . . . . . . . . 135
8.12.1.Example1................................ 135
8.12.2.Example2................................ 135
8.13. RF_AdvertisingFlags: Configure the advertising packet . . . . . . . . . . . . 136
8.13.1.Example1................................ 136
8.13.2.Example2................................ 136
8.14. RF_ScanFactor: Modify the scan factor . . . . . . . . . . . . . . . . . . . . 138
8.14.1.Example1................................ 138
8.14.2.Example2................................ 138
8.15. RF_ScanTiming: Modify the scan timing . . . . . . . . . . . . . . . . . . . . 139
8.15.1.Example1................................ 140
8.15.2.Example2................................ 140
8.16. RF_ConnectionTiming: Modify the connection timing . . . . . . . . . . . . . 141
8.16.1.Example1................................ 142
8.16.2.Example2................................ 142
8.17. RF_TXPower: Modify the output power . . . . . . . . . . . . . . . . . . . . . 143
8.17.1.Example1................................ 143
8.17.2.Example2................................ 143
8.18. RF_SPPBaseUUID: Configure the SPP base UUID . . . . . . . . . . . . . . 145
8.18.1.Example1................................ 145
8.18.2.Example2................................ 145
8.19. RF_Appearance: Configure the appearance of the device . . . . . . . . . . 147
8.19.1.Example1................................ 147
8.19.2.Example2................................ 147
8.20. UART_ConfigIndex: Modify the UART speed . . . . . . . . . . . . . . . . . 148
8.20.1.Example1................................ 150
8.20.2.Example2................................ 150
8.21. CFG_Flags: Configure the module . . . . . . . . . . . . . . . . . . . . . . . 151
8.21.1.Example1................................ 151
Proteus-III reference manual version 1.3 © August 2020
www.we-online.com/wireless-connectivity 6

8.21.2.Example2................................ 151
8.22. DIS_ManufacturerName: Configure the manufacturer name . . . . . . . . . 153
8.22.1.Example1................................ 153
8.22.2.Example2................................ 153
8.23. DIS_ModelNumber: Configure the model number . . . . . . . . . . . . . . . 155
8.23.1.Example1................................ 155
8.23.2.Example2................................ 155
8.24. DIS_SerialNumber: Configure the serial number . . . . . . . . . . . . . . . 156
8.24.1.Example1................................ 156
8.24.2.Example2................................ 156
8.25. DIS_HWVersion: Configure the HW version . . . . . . . . . . . . . . . . . . 157
8.25.1.Example1................................ 157
8.25.2.Example2................................ 157
8.26. DIS_SWVersion: Configure the SW version . . . . . . . . . . . . . . . . . . 158
8.26.1.Example1................................ 158
8.26.2.Example2................................ 158
8.27. DIS_Flags: Configure the device information service . . . . . . . . . . . . . 159
8.27.1.Example1................................ 159
8.27.2.Example2................................ 159
9. Timing parameters 163
9.1. Resetandsleep ................................. 163
9.2. Bluetooth LE timing parameters . . . . . . . . . . . . . . . . . . . . . . . . . 163
9.3. Connection establishment . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
9.4. Connection based data transmission . . . . . . . . . . . . . . . . . . . . . . 164
9.4.1. Maximum data throughput . . . . . . . . . . . . . . . . . . . . . . . 165
10.Peripheral only mode 166
10.1. Reasons to use the peripheral only mode . . . . . . . . . . . . . . . . . . . 166
10.2. Restrictions.................................... 166
10.3. How to use the peripheral only mode . . . . . . . . . . . . . . . . . . . . . . 167
10.4. Moreinformation ................................. 167
10.4.1.Radio................................... 167
10.4.2.UART................................... 167
11.Remote GPIO control 170
11.1. Supported GPIO_IDs for remote and local control . . . . . . . . . . . . . . . 175
12.Customizing the Proteus-III 176
12.1. DIS - Device information service . . . . . . . . . . . . . . . . . . . . . . . . 176
12.2. UUID........................................ 176
12.3. Appearance.................................... 176
13.Custom firmware 177
13.1. Custom configuration of standard firmware . . . . . . . . . . . . . . . . . . 177
13.2. Customer specific firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
13.3. Customerfirmware................................ 177
13.4. Contact for firmware requests . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Proteus-III reference manual version 1.3 © August 2020
www.we-online.com/wireless-connectivity 7

14.Firmware updates 179
14.1. Firmware flashing using the production interface . . . . . . . . . . . . . . . 179
14.2. Firmware update using the Proteus-III OTA bootloader . . . . . . . . . . . . 179
14.2.1. Firmware update steps using the Nordic nRF Toolbox app . . . . . 181
15.Firmware history 183
16.Design in guide 184
16.1. Advice for schematic and layout . . . . . . . . . . . . . . . . . . . . . . . . . 184
16.2. Dimensioning of the micro strip antenna line . . . . . . . . . . . . . . . . . . 186
16.3. Antennasolutions ................................ 187
16.3.1.Wireantenna .............................. 188
16.3.2.Chipantenna .............................. 188
16.3.3.PCBantenna .............................. 188
16.3.4. Antennas provided by Würth Elektronik eiSos . . . . . . . . . . . . 189
16.3.4.1. 2600130021 - Himalia - 2.4 GHz dipole antenna . . . . . . . . 189
17.Reference design 190
17.1. EV-Board ..................................... 191
17.2. Tracedesign ................................... 194
18.Manufacturing information 197
18.1. Moisture sensitivity level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
18.2. Soldering ..................................... 197
18.2.1. Reflow soldering . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
18.2.2.Cleaning................................. 199
18.2.3.Othernotations ............................. 199
18.3. ESDhandling................................... 199
18.4. Safety recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
19.Physical dimensions 201
19.1. Dimensions.................................... 201
19.2. Weight....................................... 201
19.3. Moduledrawing.................................. 202
19.4. Footprint...................................... 203
19.5. Antennafreearea ................................ 203
20.Marking 204
20.1. Lotnumber .................................... 204
20.2. General labeling information . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
21.Information for Ex protection 206
22.Bluetooth SIG listing/qualification 207
22.1. Qualification steps when referencing the Proteus-III . . . . . . . . . . . . . . 207
23.Regulatory compliance information 209
23.1. ImportantnoticeEU ............................... 209
23.2. Important notice FCC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
23.3. Conformity assessment of the final product . . . . . . . . . . . . . . . . . . 209
Proteus-III reference manual version 1.3 © August 2020
www.we-online.com/wireless-connectivity 8

23.4. Exemptionclause................................. 209
23.5. EU Declaration of conformity . . . . . . . . . . . . . . . . . . . . . . . . . . 210
23.6. FCC Compliance Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
23.7. IC Compliance Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
23.8. FCC and IC requirements to OEM integrators . . . . . . . . . . . . . . . . . 211
23.8.1. Pre-certified antennas . . . . . . . . . . . . . . . . . . . . . . . . . 213
23.9. ARIB Declaration of conformity . . . . . . . . . . . . . . . . . . . . . . . . . 214
23.9.1.Label................................... 214
23.9.2. Certified antennas . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
24.Important notes 215
24.1. General customer responsibility . . . . . . . . . . . . . . . . . . . . . . . . . 215
24.2. Customer responsibility related to specific, in particular safety-relevant ap-
plications ..................................... 215
24.3. Best care and attention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
24.4. Customer support for product specifications . . . . . . . . . . . . . . . . . . 215
24.5. Product improvements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
24.6. Productlifecycle ................................. 216
24.7. Propertyrights .................................. 216
24.8. General terms and conditions . . . . . . . . . . . . . . . . . . . . . . . . . . 216
25.Legal notice 217
25.1. Exclusion of liability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
25.2. Suitability in customer applications . . . . . . . . . . . . . . . . . . . . . . . 217
25.3. Trademarks .................................... 217
25.4. Usagerestriction ................................. 217
26.License terms 219
26.1. Limitedlicense .................................. 219
26.2. Usage and obligations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
26.3. Ownership..................................... 220
26.4. Firmwareupdate(s)................................ 220
26.5. Disclaimer of warranty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
26.6. Limitation of liability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
26.7. Applicable law and jurisdiction . . . . . . . . . . . . . . . . . . . . . . . . . . 221
26.8. Severabilityclause ................................ 221
26.9. Miscellaneous................................... 221
A. Additional CRC8 Information 224
A.1. Example CRC8 Implementation . . . . . . . . . . . . . . . . . . . . . . . . . 224
A.1.1. CRC8 Test Vectors . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
B. Example codes for host integration 225
Proteus-III reference manual version 1.3 © August 2020
www.we-online.com/wireless-connectivity 9