1*042d53a7SEvalZeroGAP API for btshell 2*042d53a7SEvalZero=================== 3*042d53a7SEvalZero 4*042d53a7SEvalZeroGeneric Access Profile (GAP) defines the generic procedures related to discovery of Bluetooth devices (idle mode 5*042d53a7SEvalZeroprocedures) and link management aspects of connecting to Bluetooth devices (connecting mode procedures). It also defines 6*042d53a7SEvalZeroprocedures related to use of different security levels. 7*042d53a7SEvalZero 8*042d53a7SEvalZeroSeveral different modes and procedures may be performed simultaneously over an LE physical transport. The following 9*042d53a7SEvalZeromodes and procedures are defined for use over an LE physical transport: 10*042d53a7SEvalZero 11*042d53a7SEvalZero1. **Broadcast mode and observation procedure** 12*042d53a7SEvalZero 13*042d53a7SEvalZero - These allow two devices to communicate in a unidirectional connectionless manner using the advertising events. 14*042d53a7SEvalZero 15*042d53a7SEvalZero2. **Discovery modes and procedures** 16*042d53a7SEvalZero 17*042d53a7SEvalZero - All devices shall be in either non-discoverable mode or one of the discoverable modes. 18*042d53a7SEvalZero - A device in the discoverable mode shall be in either the general discoverable mode or the limited discoverable mode. 19*042d53a7SEvalZero - A device in non-discoverable mode will not be discovered by any device that is performing either the general 20*042d53a7SEvalZero discovery procedure or the limited discovery procedure. 21*042d53a7SEvalZero 22*042d53a7SEvalZero3. **Connection modes and procedures** 23*042d53a7SEvalZero 24*042d53a7SEvalZero - allow a device to establish a connection to another device. 25*042d53a7SEvalZero - allow updating of parameters of the connection 26*042d53a7SEvalZero - allow termination of the connection 27*042d53a7SEvalZero 28*042d53a7SEvalZero4. **Bonding modes and procedures** 29*042d53a7SEvalZero 30*042d53a7SEvalZero - Bonding allows two connected devices to exchange and store security and identity information to create a trusted 31*042d53a7SEvalZero relationship. 32*042d53a7SEvalZero - Bonding can occur only between two devices in bondable mode. 33*042d53a7SEvalZero 34*042d53a7SEvalZeroAvailable commands 35*042d53a7SEvalZero~~~~~~~~~~~~~~~~~~ 36*042d53a7SEvalZero 37*042d53a7SEvalZeroParameters default values are marked red. 38*042d53a7SEvalZero 39*042d53a7SEvalZeroConfiguration 40*042d53a7SEvalZero------------- 41*042d53a7SEvalZero 42*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 43*042d53a7SEvalZero| **Command** | **Parmeters** | \*\* Possible values\*\* | **Description** | 44*042d53a7SEvalZero+=====================+=================+============================+=========================================================================================================+ 45*042d53a7SEvalZero| **set** | | | Set configuration options | 46*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 47*042d53a7SEvalZero| | addr | XX:XX:XX:XX:XX:XX | Local device address | 48*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 49*042d53a7SEvalZero| | addr\_type | ``public`` | Local device address type | 50*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 51*042d53a7SEvalZero| | | random | Use random address for scan requests | 52*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 53*042d53a7SEvalZero| | mtu | [23-UINT16\_MAX] | GATT Maximum Transmission Unit (MTU) | 54*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 55*042d53a7SEvalZero| | irk | XX:XX:XX... | Local Identity Resolving Key (16 byte | 56*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 57*042d53a7SEvalZero| **set-priv-mode** | | | Set privacy mode for device | 58*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 59*042d53a7SEvalZero| | addr | XX:XX:XX:XX:XX:XX | Remote device address | 60*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 61*042d53a7SEvalZero| | addr\_type | ``public`` | Remote device public address type | 62*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 63*042d53a7SEvalZero| | | random | Remote device random address type | 64*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 65*042d53a7SEvalZero| | mode | [``0``-1] | 0 - use network privacy, 1 - use device privacy | 66*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 67*042d53a7SEvalZero| **white-list** | | | Add devices to white list (this command accepts multiple instances of addr and addr\_type parameters) | 68*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 69*042d53a7SEvalZero| | addr | XX:XX:XX:XX:XX:XX | Remote device address | 70*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 71*042d53a7SEvalZero| | addr\_type | ``public`` | Remote device public address type | 72*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 73*042d53a7SEvalZero| | | random | Remote device random address type | 74*042d53a7SEvalZero+---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+ 75*042d53a7SEvalZero 76*042d53a7SEvalZeroDevice discovery and connection 77*042d53a7SEvalZero------------------------------- 78*042d53a7SEvalZero 79*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 80*042d53a7SEvalZero| **Command** | **Parmeters** | \*\* Possible values\*\* | **Description** | 81*042d53a7SEvalZero+==========================+================================+============================+============================================================================================================+ 82*042d53a7SEvalZero| **scan** | | | Discover remote devices | 83*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 84*042d53a7SEvalZero| | cancel | | cancel ongoing scan procedure | 85*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 86*042d53a7SEvalZero| | extended | ``none`` | Start legacy scan | 87*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 88*042d53a7SEvalZero| | | 1M | Start extended scan on 1M PHY | 89*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 90*042d53a7SEvalZero| | | coded | Start extended scan on Coded PHY | 91*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 92*042d53a7SEvalZero| | | both | Start extended scan on both PHYs | 93*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 94*042d53a7SEvalZero| | duration | [1-``INT32_MAX``], | Duration of scan in milliseconds | 95*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 96*042d53a7SEvalZero| | limited | [``0``-1] | Use limited discovery procedure | 97*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 98*042d53a7SEvalZero| | passive | [``0``-1] | Use passive scan | 99*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 100*042d53a7SEvalZero| | interval | [``0``-UINT16\_MAX] | Scan interval, if 0 use stack's default | 101*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 102*042d53a7SEvalZero| | window | [``0``-UINT16\_MAX] | Scan window, if 0 use stack's default | 103*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 104*042d53a7SEvalZero| | filter | ``no_wl`` | Scan filter policy - Accept all advertising packets | 105*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 106*042d53a7SEvalZero| | | use\_wl | Accept only advertising packets from devices on White List | 107*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 108*042d53a7SEvalZero| | | no\_wl\_inita | Accept all advertising packets (including directed RPA) | 109*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 110*042d53a7SEvalZero| | | use\_wl\_inita | Accept only advertising packets from devices on White List (including directed RPA) | 111*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 112*042d53a7SEvalZero| | nodups | [``0``-1] | Disable duplicates filtering | 113*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 114*042d53a7SEvalZero| | own\_addr\_type | ``public`` | Use public address for scan requests | 115*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 116*042d53a7SEvalZero| | | random | Use random address for scan requests | 117*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 118*042d53a7SEvalZero| | | rpa\_pub | Use RPA address for scan requests (fallback to public if no IRK) | 119*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 120*042d53a7SEvalZero| | | rpa\_rnd | Use RPA address for scan requests (fallback to random if no IRK) | 121*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 122*042d53a7SEvalZero| | extended\_duration | [``0``-UINT16\_MAX] | Duration of extended scan in 10 milliseconds | 123*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 124*042d53a7SEvalZero| | extended\_period | [``0``-UINT16\_MAX] | Periodic scan interval in 1.28 seconds (0 disabled) | 125*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 126*042d53a7SEvalZero| | longrange\_interval | [``0``-UINT16\_MAX] | Scan interval for Coded Scan , if 0 use stack's default | 127*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 128*042d53a7SEvalZero| | longrange\_window | [``0``-UINT16\_MAX] | Scan window for Coded Scan , if 0 use stack's default | 129*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 130*042d53a7SEvalZero| | longrange\_passive | [``0``-1] | Use passive scan for Coded Scan | 131*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 132*042d53a7SEvalZero| **connect** | | | Initiate connection to remote device | 133*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 134*042d53a7SEvalZero| | cancel | | Cancel ongoing connection procedure | 135*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 136*042d53a7SEvalZero| | extended | ``none`` | Use legacy connection procedure | 137*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 138*042d53a7SEvalZero| | | 1M | Extended connect using 1M PHY scan parameters | 139*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 140*042d53a7SEvalZero| | | coded | Extended connect using Coded PHY scan parameters | 141*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 142*042d53a7SEvalZero| | | both | Extended connect using 1M and Coded PHYs scan parameters | 143*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 144*042d53a7SEvalZero| | | all | Extended connect using 1M and Coded PHYs scan parameters (Provide also connection parameters for 2M PHY) | 145*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 146*042d53a7SEvalZero| | peer\_addr\_type | ``public`` | Remote device public address type | 147*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 148*042d53a7SEvalZero| | | random | Remote device random address type | 149*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 150*042d53a7SEvalZero| | | public\_id | Remote device public address type (Identity) | 151*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 152*042d53a7SEvalZero| | | random\_id | Remote device random address type (Identity) | 153*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 154*042d53a7SEvalZero| | peer\_addr | XX:XX:XX:XX:XX:XX | Remote device address | 155*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 156*042d53a7SEvalZero| | own\_addr\_type | ``public`` | Use public address for scan requests | 157*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 158*042d53a7SEvalZero| | | random | Use random address for scan requests | 159*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 160*042d53a7SEvalZero| | | rpa\_pub | Use RPA address for scan requests (fallback to public if no IRK) | 161*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 162*042d53a7SEvalZero| | | rpa\_rnd | Use RPA address for scan requests (fallback to random if no IRK) | 163*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 164*042d53a7SEvalZero| | duration | [``0``-INT32\_MAX] | Connection attempt duration, if 0 use stack's default | 165*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 166*042d53a7SEvalZero| | scan\_interval | [0-UINT16\_MAX] | Scan interval, default: 0x0010 | 167*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 168*042d53a7SEvalZero| | scan\_window | [0-UINT16\_MAX] | Scan window, default: 0x0010 | 169*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 170*042d53a7SEvalZero| | interval\_min | [0-UINT16\_MAX] | Minimum connection interval, default: 30 | 171*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 172*042d53a7SEvalZero| | interval\_max | [0-UINT16\_MAX] | Maximum connection interval, default: 50 | 173*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 174*042d53a7SEvalZero| | latency | [UINT16] | Connection latency, default: 0 | 175*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 176*042d53a7SEvalZero| | timeout | [UINT16] | Connection timeout, default: 0x0100 | 177*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 178*042d53a7SEvalZero| | min\_conn\_event\_len | [UINT16] | Minimum length of connection event, default: 0x0010 | 179*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 180*042d53a7SEvalZero| | max\_conn\_event\_len | [UINT16] | Maximum length of connection event, default: 0x0300 | 181*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 182*042d53a7SEvalZero| | coded\_scan\_interval | [0-UINT16\_MAX] | Coded PHY Scan interval, default: 0x0010 | 183*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 184*042d53a7SEvalZero| | coded\_scan\_window | [0-UINT16\_MAX] | Coded PHY Scan window, default: 0x0010 | 185*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 186*042d53a7SEvalZero| | coded\_interval\_min | [0-UINT16\_MAX] | Coded PHY Minimum connection interval, default: 30 | 187*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 188*042d53a7SEvalZero| | coded\_interval\_max | [0-UINT16\_MAX] | Coded PHY Maximum connection interval, default: 50 | 189*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 190*042d53a7SEvalZero| | coded\_latency | [UINT16] | Coded PHY Connection latency, default: 0 | 191*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 192*042d53a7SEvalZero| | coded\_timeout | [UINT16] | Coded PHY Connection timeout, default: 0x0100 | 193*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 194*042d53a7SEvalZero| | coded\_min\_conn\_event\_len | [UINT16] | Coded PHY Minimum length of connection event, default: 0x0010 | 195*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 196*042d53a7SEvalZero| | coded\_max\_conn\_event\_len | [UINT16] | Coded PHY Maximum length of connection event, default: 0x0300 | 197*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 198*042d53a7SEvalZero| | 2M\_scan\_interval | [0-UINT16\_MAX] | 2M PHY Scan interval, default: 0x0010 | 199*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 200*042d53a7SEvalZero| | 2M\_scan\_window | [0-UINT16\_MAX] | 2M PHY Scan window, default: 0x0010 | 201*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 202*042d53a7SEvalZero| | 2M\_interval\_min | [0-UINT16\_MAX] | 2M PHY Minimum connection interval, default: 30 | 203*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 204*042d53a7SEvalZero| | 2M\_interval\_max | [0-UINT16\_MAX] | 2M PHY Maximum connection interval, default: 50 | 205*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 206*042d53a7SEvalZero| | 2M\_latency | [UINT16] | 2M PHY Connection latency, default: 0 | 207*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 208*042d53a7SEvalZero| | 2M\_timeout | [UINT16] | 2M PHY Connection timeout, default: 0x0100 | 209*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 210*042d53a7SEvalZero| | 2M\_min\_conn\_event\_len | [UINT16] | 2M PHY Minimum length of connection event, default: 0x0010 | 211*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 212*042d53a7SEvalZero| | 2M\_max\_conn\_event\_len | [UINT16] | 2M PHY Maximum length of connection event, default: 0x0300 | 213*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 214*042d53a7SEvalZero| **disconnect** | | | Disconnect exisiting connection | 215*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 216*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 217*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 218*042d53a7SEvalZero| | reason | [UINT8] | Disconnect reason | 219*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 220*042d53a7SEvalZero| **show-addr** | | | Show local public and random identity addresses | 221*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 222*042d53a7SEvalZero| **show-conn** | | | Show current connections | 223*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 224*042d53a7SEvalZero| **conn-rssi** | | | Obtain RSSI of specified connection | 225*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 226*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 227*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 228*042d53a7SEvalZero| **conn-update-params** | | | Update parameters of specified connection | 229*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 230*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 231*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 232*042d53a7SEvalZero| | interval\_min | [0-UINT16\_MAX] | Minimum connection interval, default: 30 | 233*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 234*042d53a7SEvalZero| | interval\_max | [0-UINT16\_MAX] | Maximum connection interval, default: 50 | 235*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 236*042d53a7SEvalZero| | latency | [UINT16] | Connection latency, default: 0 | 237*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 238*042d53a7SEvalZero| | timeout | [UINT16] | Connection timeout, default: 0x0100 | 239*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 240*042d53a7SEvalZero| | min\_conn\_event\_len | [UINT16] | Minimum length of connection event, default: 0x0010 | 241*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 242*042d53a7SEvalZero| | max\_conn\_event\_len | [UINT16] | Maximum length of connection event, default: 0x0300 | 243*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 244*042d53a7SEvalZero| **conn-datalen** | | | Set DLE parmaeters for connection | 245*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 246*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 247*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 248*042d53a7SEvalZero| | octets | [UINT16] | Maximum transmission packet size | 249*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 250*042d53a7SEvalZero| | time | [UINT16] | Maximum transmission packet time | 251*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 252*042d53a7SEvalZero| **phy-set** | | | Set prefered PHYs used for connection | 253*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 254*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 255*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 256*042d53a7SEvalZero| | tx\_phys\_mask | [UINT8] | Prefered PHYs on TX is mask of following bits0x00 - no preference0x01 - 1M, 0x02 - 2M, 0x04 - Coded | 257*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 258*042d53a7SEvalZero| | rx\_phys\_mask | [UINT8] | Prefered PHYs on RX is mask of following bits0x00 - no preference0x01 - 1M, 0x02 - 2M, 0x04 - Coded | 259*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 260*042d53a7SEvalZero| | phy\_opts | [UINT16] | Options for Coded PHY 0 - any coding, 1 - prefer S2, 2 - prefer S8 | 261*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 262*042d53a7SEvalZero| **phy-set-default** | | | Set default prefered PHYs used for new connection | 263*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 264*042d53a7SEvalZero| | tx\_phys\_mask | [UINT8] | Prefered PHYs on TX is mask of following bits0x00 - no preference0x01 - 1M, 0x02 - 2M, 0x04 - Coded | 265*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 266*042d53a7SEvalZero| | rx\_phys\_mask | [UINT8] | Prefered PHYs on RX is mask of following bits0x00 - no preference0x01 - 1M, 0x02 - 2M, 0x04 - Coded | 267*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 268*042d53a7SEvalZero| **phy-read** | | | Read connection current PHY | 269*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 270*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 271*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 272*042d53a7SEvalZero| **l2cap-update** | | | Update connection parameters | 273*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 274*042d53a7SEvalZero| | interval\_min | [0-UINT16\_MAX] | Minimum connection interval, default: 30 | 275*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 276*042d53a7SEvalZero| | interval\_max | [0-UINT16\_MAX] | Maximum connection interval, default: 50 | 277*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 278*042d53a7SEvalZero| | latency | [UINT16] | Connection latency, default: 0 | 279*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 280*042d53a7SEvalZero| | timeout | [UINT16] | Connection timeout, default: 0x0100 | 281*042d53a7SEvalZero+--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+ 282*042d53a7SEvalZero 283*042d53a7SEvalZeroSecurity 284*042d53a7SEvalZero-------- 285*042d53a7SEvalZero 286*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 287*042d53a7SEvalZero| **Command** | **Parmeters** | \*\* Possible values\*\* | **Description** | 288*042d53a7SEvalZero+===========================+====================+============================+============================================================================================================================+ 289*042d53a7SEvalZero| **security-set-data** | | | Set security configuration | 290*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 291*042d53a7SEvalZero| | oob-flag | [``0``-1] | Set Out-Of-Band (OOB) flag in Security Manager | 292*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 293*042d53a7SEvalZero| | mitm-flag | [``0``-1] | Set Man-In-The-Middle (MITM) flag in Security Manager | 294*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 295*042d53a7SEvalZero| | io\_capabilities | 0 | Set Input-Output Capabilities to "DisplayOnly" | 296*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 297*042d53a7SEvalZero| | | 1 | Set Input-Output Capabilities to "DisplayYesNo" | 298*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 299*042d53a7SEvalZero| | | 2 | Set Input-Output Capabilities to "KeyboardOnly" | 300*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 301*042d53a7SEvalZero| | | 3 | Set Input-Output Capabilities to "NoInputNoOutput" | 302*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 303*042d53a7SEvalZero| | | 4 | Set Input-Output Capabilities to "KeyboardDisplay" | 304*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 305*042d53a7SEvalZero| | our\_key\_dist | [UINT8] | Set Local Keys Distribution, this is a bit field of possible values: LTK (0x01), IRK (0x02), CSRK (0x04), LTK\_SC(0x08) | 306*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 307*042d53a7SEvalZero| | their\_key\_dist | [UINT8] | Set Remote Keys Distribution, this is a bit field of possible values: LTK (0x01), IRK (0x02), CSRK (0x04), LTK\_SC(0x08) | 308*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 309*042d53a7SEvalZero| | bonding-flag | [``0``-1] | Set Bonding flag in Security Manager | 310*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 311*042d53a7SEvalZero| | sc-flag | [``0``-1] | Set Secure Connections flag in Security Manager | 312*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 313*042d53a7SEvalZero| **security-pair** | | | Start pairing procedure | 314*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 315*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 316*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 317*042d53a7SEvalZero| **security-encryption** | | | Start encryption procedure | 318*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 319*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 320*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 321*042d53a7SEvalZero| | ediv | [UINT16] | EDIV for LTK to use (use storage if not provided) | 322*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 323*042d53a7SEvalZero| | rand | [UINT64] | Rand for LTK | 324*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 325*042d53a7SEvalZero| | ltk | XX:XX:XX... | LTK (16 bytes) | 326*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 327*042d53a7SEvalZero| **security-start** | | | Start security procedure (This starts either pairing or encryption depending if keys are stored) | 328*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 329*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 330*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 331*042d53a7SEvalZero| **auth-passkey** | | | Reply to Passkey request | 332*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 333*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 334*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 335*042d53a7SEvalZero| | action | [UINT16] | Action to reply (as received in event) | 336*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 337*042d53a7SEvalZero| | key | [0-999999] | Passkey to reply (Input or Display action) | 338*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 339*042d53a7SEvalZero| | oob | XX:XX:XX:... | Out-Of-Band secret (16 bytes) (OOB action) | 340*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 341*042d53a7SEvalZero| | yesno | Yy-Ny | Confirm passkey (for Passkey Confirm action) | 342*042d53a7SEvalZero+---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ 343*042d53a7SEvalZero 344*042d53a7SEvalZeroAdvertising with Extended Advertising enabled 345*042d53a7SEvalZero--------------------------------------------- 346*042d53a7SEvalZero 347*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 348*042d53a7SEvalZero| **Command** | **Parmeters** | \*\* Possible values\*\* | **Description** | 349*042d53a7SEvalZero+==============================+==========================+============================+=====================================================================================+ 350*042d53a7SEvalZero| **advertise-configure** | | | Configure new advertising instance | 351*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 352*042d53a7SEvalZero| | instance | [``0``-UINT8\_MAX] | Advertising instance | 353*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 354*042d53a7SEvalZero| | connectable | [``0``-1] | Use connectable advertising | 355*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 356*042d53a7SEvalZero| | scannable | [``0``-1] | Use scannable advertising | 357*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 358*042d53a7SEvalZero| | peer\_addr\_type | ``public`` | Remote device public address type | 359*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 360*042d53a7SEvalZero| | | random | Remote device random address type | 361*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 362*042d53a7SEvalZero| | | public\_id | Remote device public address type (Identity) | 363*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 364*042d53a7SEvalZero| | | random\_id | Remote device random address type (Identity) | 365*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 366*042d53a7SEvalZero| | peer\_addr | XX:XX:XX:XX:XX:XX | Remote device address - if provided perform directed advertising | 367*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 368*042d53a7SEvalZero| | own\_addr\_type | ``public`` | Use public address for scan requests | 369*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 370*042d53a7SEvalZero| | | random | Use random address for scan requests | 371*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 372*042d53a7SEvalZero| | | rpa\_pub | Use RPA address for scan requests (fallback to public if no IRK) | 373*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 374*042d53a7SEvalZero| | | rpa\_rnd | Use RPA address for scan requests (fallback to random if no IRK) | 375*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 376*042d53a7SEvalZero| | channel\_map | [``0``-UINT8\_MAX} | Primary advertising channels map. If 0 use all channels. | 377*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 378*042d53a7SEvalZero| | filter | ``none`` | Advertising filter policy - no filtering, no whitelist used | 379*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 380*042d53a7SEvalZero| | | scan | process all connection requests but only scans from white list | 381*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 382*042d53a7SEvalZero| | | conn | process all scan request but only connection requests from white list | 383*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 384*042d53a7SEvalZero| | | both | ignore all scan and connection requests unless in white list | 385*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 386*042d53a7SEvalZero| | interval\_min | [``0``-UINT32\_MAX] | Minimum advertising interval in 0.625 miliseconds If 0 use stack default. | 387*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 388*042d53a7SEvalZero| | interval\_max | [``0``-UINT32\_MAX] | Maximum advertising interval in 0.625 miliseconds If 0 use stack default. | 389*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 390*042d53a7SEvalZero| | rx\_power | [-127 - ``127``] | Advertising TX power in dBm | 391*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 392*042d53a7SEvalZero| | primary\_phy | ``1M`` | Use 1M PHY on primary advertising channels | 393*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 394*042d53a7SEvalZero| | | ``coded`` | Use Coded PHY on primary advertising channels | 395*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 396*042d53a7SEvalZero| | secondary\_phy | ``1M`` | Use 1M PHY on secondary advertising channels | 397*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 398*042d53a7SEvalZero| | | ``coded`` | Use coded PHY on primary advertising channels | 399*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 400*042d53a7SEvalZero| | | ``2M`` | Use 2M PHY on primary advertising channels | 401*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 402*042d53a7SEvalZero| | sid | [``0``-16] | Adsertising instance SID | 403*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 404*042d53a7SEvalZero| | high\_duty | [``0``-1] | Use high\_duty advertising | 405*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 406*042d53a7SEvalZero| | anonymous | [``0``-1] | Use anonymous advertising | 407*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 408*042d53a7SEvalZero| | legacy | [``0``-1] | Use legacy PDUs for advertising | 409*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 410*042d53a7SEvalZero| | include\_tx\_power | [``0``-1] | Include TX power information in advertising PDUs | 411*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 412*042d53a7SEvalZero| | scan\_req\_notif | [``0``-1] | Enable SCAN\_REQ notifications | 413*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 414*042d53a7SEvalZero| **advertise-set-addr** | | | Configure *random* adress for instance | 415*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 416*042d53a7SEvalZero| | instance | [``0``-UINT8\_MAX] | Advertising instance | 417*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 418*042d53a7SEvalZero| | addr | XX:XX:XX:XX:XX:XX | Random address | 419*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 420*042d53a7SEvalZero| **advertise-set-adv-data** | | | Configure advertising instance ADV\_DATA. This allow to configure following TLVs: | 421*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 422*042d53a7SEvalZero| **advertise-set-scan-rsp** | | | Configure advertising instance SCAN\_RSP. This allow to configure following TLVs: | 423*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 424*042d53a7SEvalZero| | instance | [``0``-UINT8\_MAX] | Advertising instance | 425*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 426*042d53a7SEvalZero| | flags | [``0``-UINT8\_MAX] | Flags value | 427*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 428*042d53a7SEvalZero| | uuid16 | [UINT16] | 16-bit UUID value (can be passed multiple times) | 429*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 430*042d53a7SEvalZero| | uuid16\_is\_complete | [``0``-1] | I 16-bit UUID list is complete | 431*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 432*042d53a7SEvalZero| | uuid32 | [UINT32] | 32-bit UUID value (can be passed multiple times) | 433*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 434*042d53a7SEvalZero| | uuid32\_is\_complete | [``0``-1] | I 32-bit UUID list is complete | 435*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 436*042d53a7SEvalZero| | uuid128 | XX:XX:XX:... | 128-bit UUID value (16 bytes) (can be passed multiple times) | 437*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 438*042d53a7SEvalZero| | uuid128\_is\_complete | [``0``-1] | I 128-bit UUID list is complete | 439*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 440*042d53a7SEvalZero| | tx\_power\_level | [-127 - 127] | TX Power level to include | 441*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 442*042d53a7SEvalZero| | appearance | [UINT16] | Appearance | 443*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 444*042d53a7SEvalZero| | name | string | Name | 445*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 446*042d53a7SEvalZero| | advertising\_interval | [UINT16] | Advertising interval | 447*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 448*042d53a7SEvalZero| | service\_data\_uuid32 | XX:XX:XX:... | 32-bit UUID service data | 449*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 450*042d53a7SEvalZero| | service\_data\_uuid128 | XX:XX:XX:... | 128-bit UUID service data | 451*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 452*042d53a7SEvalZero| | uri | XX:XX:XX:... | URI | 453*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 454*042d53a7SEvalZero| | msg\_data | XX:XX:XX:... | Manufacturer data | 455*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 456*042d53a7SEvalZero| | eddystone\_url | string | Eddystone with specified URL | 457*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 458*042d53a7SEvalZero| **advertise-start** | | | Start advertising with configured instance | 459*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 460*042d53a7SEvalZero| | instance | [``0``-UINT8\_MAX] | Advertising instance | 461*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 462*042d53a7SEvalZero| | duration | [``0``-UINT16\_MAX] | Advertising duration in 10ms units. 0 - forver | 463*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 464*042d53a7SEvalZero| | max\_events | [``0``-UINT8\_MAX] | Maximum number of advertising events. 0 - no limit | 465*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 466*042d53a7SEvalZero| **advertise-stop** | | | Stop advertising | 467*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 468*042d53a7SEvalZero| | instance | [``0``-UINT8\_MAX] | Advertising instance | 469*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 470*042d53a7SEvalZero| **advertise-remove** | | | Remove configured advertising instance | 471*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 472*042d53a7SEvalZero| | instance | [``0``-UINT8\_MAX] | Advertising instance | 473*042d53a7SEvalZero+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 474*042d53a7SEvalZero 475*042d53a7SEvalZeroLegacy Advertising with Extended Advertising disabled 476*042d53a7SEvalZero----------------------------------------------------- 477*042d53a7SEvalZero 478*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 479*042d53a7SEvalZero| **Command** | **Parmeters** | \*\* Possible values\*\* | **Description** | 480*042d53a7SEvalZero+====================+==========================+============================+=====================================================================================+ 481*042d53a7SEvalZero| **advertise** | | | Enable advertising | 482*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 483*042d53a7SEvalZero| | stop | | Stop enabled advertising | 484*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 485*042d53a7SEvalZero| | conn | ``und`` | Connectable mode: undirected | 486*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 487*042d53a7SEvalZero| | | non | non-connectable | 488*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 489*042d53a7SEvalZero| | | dir | directed | 490*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 491*042d53a7SEvalZero| | discov | ``gen`` | Discoverable mode: general discoverable | 492*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 493*042d53a7SEvalZero| | | ltd | limited discoverable | 494*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 495*042d53a7SEvalZero| | | non | non-discoverable | 496*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 497*042d53a7SEvalZero| | scannable | [``0``-1] | Use scannable advertising | 498*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 499*042d53a7SEvalZero| | peer\_addr\_type | ``public`` | Remote device public address type | 500*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 501*042d53a7SEvalZero| | | random | Remote device random address type | 502*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 503*042d53a7SEvalZero| | | public\_id | Remote device public address type (Identity) | 504*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 505*042d53a7SEvalZero| | | random\_id | Remote device random address type (Identity) | 506*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 507*042d53a7SEvalZero| | peer\_addr | XX:XX:XX:XX:XX:XX | Remote device address - if provided perform directed advertising | 508*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 509*042d53a7SEvalZero| | own\_addr\_type | ``public`` | Use public address for scan requests | 510*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 511*042d53a7SEvalZero| | | random | Use random address for scan requests | 512*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 513*042d53a7SEvalZero| | | rpa\_pub | Use RPA address for scan requests (fallback to public if no IRK) | 514*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 515*042d53a7SEvalZero| | | rpa\_rnd | Use RPA address for scan requests (fallback to random if no IRK) | 516*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 517*042d53a7SEvalZero| | channel\_map | [``0``-UINT8\_MAX} | Primary advertising channels map. If 0 use all channels. | 518*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 519*042d53a7SEvalZero| | filter | ``none`` | Advertising filter policy - no filtering, no whitelist used | 520*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 521*042d53a7SEvalZero| | | scan | process all connection requests but only scans from white list | 522*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 523*042d53a7SEvalZero| | | conn | process all scan request but only connection requests from white list | 524*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 525*042d53a7SEvalZero| | | both | ignore all scan and connection requests unless in white list | 526*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 527*042d53a7SEvalZero| | interval\_min | [``0``-UINT32\_MAX] | Minimum advertising interval in 0.625 miliseconds If 0 use stack default. | 528*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 529*042d53a7SEvalZero| | interval\_max | [``0``-UINT32\_MAX] | Maximum advertising interval in 0.625 miliseconds If 0 use stack default. | 530*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 531*042d53a7SEvalZero| | high\_duty | [``0``-1] | Use high\_duty advertising | 532*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 533*042d53a7SEvalZero| | duration | [``1``-INT32\_MAX] | Advertising duration in ms | 534*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 535*042d53a7SEvalZero| **set-adv-data** | | | Configure advertising instance ADV\_DATA. This allow to configure following TLVs: | 536*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 537*042d53a7SEvalZero| **set-scan-rsp** | | | Configure advertising instance SCAN\_RSP. This allow to configure following TLVs: | 538*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 539*042d53a7SEvalZero| | flags | [``0``-UINT8\_MAX] | Flags value | 540*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 541*042d53a7SEvalZero| | uuid16 | [UINT16] | 16-bit UUID value (can be passed multiple times) | 542*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 543*042d53a7SEvalZero| | uuid16\_is\_complete | [``0``-1] | I 16-bit UUID list is complete | 544*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 545*042d53a7SEvalZero| | uuid32 | [UINT32] | 32-bit UUID value (can be passed multiple times) | 546*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 547*042d53a7SEvalZero| | uuid32\_is\_complete | [``0``-1] | I 32-bit UUID list is complete | 548*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 549*042d53a7SEvalZero| | uuid128 | XX:XX:XX:... | 128-bit UUID value (16 bytes) (can be passed multiple times) | 550*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 551*042d53a7SEvalZero| | uuid128\_is\_complete | [``0``-1] | I 128-bit UUID list is complete | 552*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 553*042d53a7SEvalZero| | tx\_power\_level | [-127 - 127] | TX Power level to include | 554*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 555*042d53a7SEvalZero| | appearance | [UINT16] | Appearance | 556*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 557*042d53a7SEvalZero| | name | string | Name | 558*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 559*042d53a7SEvalZero| | advertising\_interval | [UINT16] | Advertising interval | 560*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 561*042d53a7SEvalZero| | service\_data\_uuid32 | XX:XX:XX:... | 32-bit UUID service data | 562*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 563*042d53a7SEvalZero| | service\_data\_uuid128 | XX:XX:XX:... | 128-bit UUID service data | 564*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 565*042d53a7SEvalZero| | uri | XX:XX:XX:... | URI | 566*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 567*042d53a7SEvalZero| | msg\_data | XX:XX:XX:... | Manufacturer data | 568*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 569*042d53a7SEvalZero| | eddystone\_url | string | Eddystone with specified URL | 570*042d53a7SEvalZero+--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+ 571*042d53a7SEvalZero 572*042d53a7SEvalZeroL2CAP Connection Oriented Channels 573*042d53a7SEvalZero---------------------------------- 574*042d53a7SEvalZero 575*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 576*042d53a7SEvalZero| **Command** | **Parmeters** | \*\* Possible values\*\* | **Description** | 577*042d53a7SEvalZero+===========================+=================+============================+====================================================+ 578*042d53a7SEvalZero| **l2cap-create-server** | | | Create L2CAP server | 579*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 580*042d53a7SEvalZero| | psm | [UINT16] | PSM | 581*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 582*042d53a7SEvalZero| **l2cap-connect** | | | Connect to remote L2CAP server | 583*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 584*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 585*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 586*042d53a7SEvalZero| | psm | [UINT16] | PSM | 587*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 588*042d53a7SEvalZero| **l2cap-disconnect** | | | Disconnec from L2CAP server | 589*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 590*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 591*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 592*042d53a7SEvalZero| | idx | [UINT16] | L2CAP connection oriented channel identifier | 593*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 594*042d53a7SEvalZero| **l2cap-send** | | | Send data over connected L2CAP channel | 595*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 596*042d53a7SEvalZero| | conn | [UINT16] | Connection handle | 597*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 598*042d53a7SEvalZero| | idx | [UINT16] | L2CAP connection oriented channel identifier | 599*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 600*042d53a7SEvalZero| | bytes | [UINT16] | Number of bytes to send (hardcoded data pattern) | 601*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 602*042d53a7SEvalZero| **l2cap-show-coc** | | | Show connected L2CAP channels | 603*042d53a7SEvalZero+---------------------------+-----------------+----------------------------+----------------------------------------------------+ 604*042d53a7SEvalZero 605*042d53a7SEvalZeroKeys storage 606*042d53a7SEvalZero------------ 607*042d53a7SEvalZero 608*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 609*042d53a7SEvalZero| **Command** | **Parmeters** | \*\* Possible values\*\* | **Description** | 610*042d53a7SEvalZero+=====================+=================+============================+====================================================+ 611*042d53a7SEvalZero| **keystore-add** | | | Add keys to storage | 612*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 613*042d53a7SEvalZero| | type | msec | Master Key | 614*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 615*042d53a7SEvalZero| | | ssec | Slave Key | 616*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 617*042d53a7SEvalZero| | | cccd | Client Characteristic Configuration Descriptor | 618*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 619*042d53a7SEvalZero| | addr | XX:XX:XX:XX:XX:XX | Device address | 620*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 621*042d53a7SEvalZero| | addr\_type | ``public`` | Device address type | 622*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 623*042d53a7SEvalZero| | | random | Use random address for scan requests | 624*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 625*042d53a7SEvalZero| | ediv | [UINT16] | EDIV for LTK to add | 626*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 627*042d53a7SEvalZero| | rand | [UINT64] | Rand for LTK | 628*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 629*042d53a7SEvalZero| | ltk | XX:XX:XX... | LTK (16 bytes) | 630*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 631*042d53a7SEvalZero| | irk | XX:XX:XX... | Identity Resolving Key (16 bytes) | 632*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 633*042d53a7SEvalZero| | csrk | XX:XX:XX... | Connection Signature Resolving Key (16 bytes) | 634*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 635*042d53a7SEvalZero| **keystore-del** | | | Delete keys from storage | 636*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 637*042d53a7SEvalZero| | type | msec | Master Key | 638*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 639*042d53a7SEvalZero| | | ssec | Slave Key | 640*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 641*042d53a7SEvalZero| | | cccd | Client Characteristic Configuration Descriptor | 642*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 643*042d53a7SEvalZero| | addr | XX:XX:XX:XX:XX:XX | Device address | 644*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 645*042d53a7SEvalZero| | addr\_type | ``public`` | Device address type | 646*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 647*042d53a7SEvalZero| | | random | Use random address for scan requests | 648*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 649*042d53a7SEvalZero| | ediv | [UINT16] | EDIV for LTK to remove | 650*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 651*042d53a7SEvalZero| | rand | [UINT64] | Rand for LTK | 652*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 653*042d53a7SEvalZero| **keystore-show** | | | Show stored keys | 654*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 655*042d53a7SEvalZero| | type | msec | Master Keys | 656*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 657*042d53a7SEvalZero| | | ssec | Slave Keys | 658*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 659*042d53a7SEvalZero| | | cccd | Client Characteristic Configuration Descriptor s | 660*042d53a7SEvalZero+---------------------+-----------------+----------------------------+----------------------------------------------------+ 661