xref: /nrf52832-nimble/packages/NimBLE-latest/docs/btshell/btshell_advdata.rst (revision 042d53a763ad75cb1465103098bb88c245d95138)
1*042d53a7SEvalZeroAdvertisement Data Fields
2*042d53a7SEvalZero-------------------------
3*042d53a7SEvalZero
4*042d53a7SEvalZeroThis part defines the advertisement data fields used in the ``btshell`` app. For a complete list of all data types and
5*042d53a7SEvalZeroformats used for Extended Inquiry Response (EIR), Advertising Data (AD), and OOB data blocks, refer to the Supplement
6*042d53a7SEvalZeroto the Bluetooth Core Specification, CSSv6, available for download
7*042d53a7SEvalZero`here <https://www.bluetooth.org/DocMan/handlers/DownloadDoc.ashx?doc_id=302735&_ga=1.133090766.1368218946.1444779486>`__.
8*042d53a7SEvalZero
9*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
10*042d53a7SEvalZero| **Name**                  | **Definition**                                      | **Details**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | **btshell Notes**                            |
11*042d53a7SEvalZero+===========================+=====================================================+===========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+==============================================+
12*042d53a7SEvalZero| flags                     | Indicates basic information about the advertiser.   | Flags used over the LE physical channel are: \* Limited Discoverable Mode \* General Discoverable Mode \* BR/EDR Not Supported \* Simultaneous LE and BR/EDR to Same Device Capable (Controller) \* Simultaneous LE and BR/EDR to Same Device Capable (Host)                                                                                                                                                                                                                                                                                                                                                                                                                              | NimBLE will auto-calculate if set to 0.      |
13*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
14*042d53a7SEvalZero| uuid16                    | 16-bit Bluetooth Service UUIDs                      | Indicates the Service UUID list is incomplete i.e. more 16-bit Service UUIDs available. 16 bit UUIDs shall only be used if they are assigned by the Bluetooth SIG.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Set repeatedly for multiple service UUIDs.   |
15*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
16*042d53a7SEvalZero| uuid16\_is\_complete      | 16-bit Bluetooth Service UUIDs                      | Indicates the Service UUID list is complete. 16 bit UUIDs shall only be used if they are assigned by the Bluetooth SIG.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                              |
17*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
18*042d53a7SEvalZero| uuid32                    | 32-bit Bluetooth Service UUIDs                      | Indicates the Service UUID list is incomplete i.e. more 32-bit Service UUIDs available. 32 bit UUIDs shall only be used if they are assigned by the Bluetooth SIG.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Set repeatedly for multiple service UUIDs.   |
19*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
20*042d53a7SEvalZero| uuid32\_is\_complete      | 32-bit Bluetooth Service UUIDs                      | Indicates the Service UUID list is complete. 32 bit UUIDs shall only be used if they are assigned by the Bluetooth SIG.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                              |
21*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
22*042d53a7SEvalZero| uuid128                   | Global 128-bit Service UUIDs                        | More 128-bit Service UUIDs available.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Set repeatedly for multiple service UUIDs.   |
23*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
24*042d53a7SEvalZero| uuid128\_is\_complete     | Global 128-bit Service UUIDs                        | Complete list of 128-bit Service UUIDs                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                              |
25*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
26*042d53a7SEvalZero| tx\_power\_level          | TX Power Level                                      | Indicates the transmitted power level of the packet containing the data type. The TX Power Level data type may be used to calculate path loss on a received packet using the following equation: pathloss = Tx Power Level – RSSI where “RSSI” is the received signal strength, in dBm, of the packet received.                                                                                                                                                                                                                                                                                                                                                                           | NimBLE will auto-calculate if set to -128.   |
27*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
28*042d53a7SEvalZero| slave\_interval\_range    | Slave Connection Interval Range                     | Contains the Peripheral’s preferred connection interval range, for all logical connections. Size: 4 Octets . The first 2 octets defines the minimum value for the connection interval in the following manner: connIntervalmin = Conn\_Interval\_Min \* 1.25 ms Conn\_Interval\_Min range: 0x0006 to 0x0C80 Value of 0xFFFF indicates no specific minimum. The other 2 octets defines the maximum value for the connection interval in the following manner: connIntervalmax = Conn\_Interval\_Max \* 1.25 ms Conn\_Interval\_Max range: 0x0006 to 0x0C80 Conn\_Interval\_Max shall be equal to or greater than the Conn\_Interval\_Min. Value of 0xFFFF indicates no specific maximum.   |                                              |
29*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
30*042d53a7SEvalZero| service\_data\_uuid16     | Service Data - 16 bit UUID                          | Size: 2 or more octets The first 2 octets contain the 16 bit Service UUID followed by additional service data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                              |
31*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
32*042d53a7SEvalZero| public\_target\_address   | Public Target Address                               | Defines the address of one or more intended recipients of an advertisement when one or more devices were bonded using a public address. This data type shall exist only once. It may be sent in either the Advertising or Scan Response data, but not both.                                                                                                                                                                                                                                                                                                                                                                                                                               |                                              |
33*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
34*042d53a7SEvalZero| appearance                | Appearance                                          | Defines the external appearance of the device. The Appearance data type shall exist only once. It may be sent in either the Advertising or Scan Response data, but not both.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                              |
35*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
36*042d53a7SEvalZero| advertising\_interval     | Advertising Interval                                | Contains the advInterval value as defined in the Core specification, Volume 6, Part B, Section 4.4.2.2.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                              |
37*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
38*042d53a7SEvalZero| service\_data\_uuid32     | Service Data - 32 bit UUID                          | Size: 4 or more octets The first 4 octets contain the 32 bit Service UUID followed by additional service data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                              |
39*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
40*042d53a7SEvalZero| service\_data\_uuid128    | Service Data - 128 bit UUID                         | Size: 16 or more octets The first 16 octets contain the 128 bit Service UUID followed by additional service data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                              |
41*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
42*042d53a7SEvalZero| uri                       | Uniform Resource Identifier (URI)                   | Scheme name string and URI as a UTF-8 string                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                              |
43*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
44*042d53a7SEvalZero| mfg\_data                 | Manufacturer Specific data                          | Size: 2 or more octets The first 2 octets contain the Company Identifier Code followed by additional manufacturer specific data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                              |
45*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
46*042d53a7SEvalZero| eddystone\_url            |                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                              |
47*042d53a7SEvalZero+---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
48