In this exercise, we will cover core Bluetooth LE APIs in nRF Connect SDK. We will first learn how to enable the Bluetooth LE stack and the default configurations associated with it.
Then we will dive into how to configure our hardware to broadcast non-connectable advertising, making the device act as a beacon so that neighboring scanning devices can see the data.
1. Include the Bluetooth LE stack in your project.
In order to include the Bluetooth LE stack in your nRF Connect SDK project, you need to enable CONFIG_BT in prj.conf . This option will already be enabled in all upcoming exercises.
CONFIG_BT=y
Enabling this symbol will apply a set of default configurations for the stack.
The highlights of the default configuration are listed below:
Broadcast support (BT_BROADCASTER) is enabled.
The SoftDevice Controller is used (BT_LL_CHOICE = BT_LL_SOFTDEVICE).
The TX Power is set to 0 dBm (BT_CTLR_TX_PWR = BT_CTLR_TX_PWR_0)
2. Set the Bluetooth LE device name.
The name is a C string that can theoretically be up to 248 bytes long (excluding NULL termination). In practice, it is highly recommended to keep it as short as possible, as when we include it in the advertising data, we have only 31 bytes, and these 31 bytes are shared by all advertising data. It can also be an empty string. In this exercise, we will call our device Nordic_Beacon.
Add the following line in prj.conf:
CONFIG_BT_DEVICE_NAME="Nordic_Beacon"
We will include the device name in the advertising data in a later step.
3. Include the header files of the Bluetooth LE stack needed
Include the following header files needed for enabling the stack, populating the advertising data, and starting advertising.
For the advertising data, we will use both the advertising packet and the scan response packet.
4.1 Prepare the advertising packet.
4.1.1 Declare an array ad[] of type struct bt_data, which will be the advertising packet to send out.
Add the following lines in main.c
static const struct bt_data ad[] = {
/* STEP 4.1.2 - Set the advertising flags */
/* STEP 4.1.3 - Set the advertising packet data */
};
4.1.2 Populate the flags using the helper macro BT_DATA_BYTES().
The first thing we need to prepare in the advertising packet is the advertising flags, BT_DATA_FLAGS.
To help us populate these flags, we will use the helper macro BT_DATA_BYTES(), which has the following signature
In this exercise, we are creating a broadcaster with non-connectable advertising. Therefore, we will only set the advertising flag BT_LE_AD_NO_BREDR, to indicate that classic Bluetooth (BR/EDR) is not supported.
Note
Since Nordic’s products only support Bluetooth LE, this flag should always be set to this value.
Add the following line in main.c
BT_DATA_BYTES(BT_DATA_FLAGS, BT_LE_AD_NO_BREDR),
4.1.3 Set the advertising packet data using using the helper macro BT_DATA().
There are numerous standard data types that can be included in the advertising data (either in the advertising packet or the scan response). These data types are defined in the Bluetooth Supplement to the Core Specification.
Below are a few commonly used ones, that we will be using in following exercises. The complete list of advertising data types can be found here.
Complete local name (BT_DATA_NAME_COMPLETE): This is simply the device name. We will include the Complete Local Name in the advertising packet of this exercise.
Shortened local name (BT_DATA_NAME_SHORTENED): A shorter version of the Complete Local name.
Uniform Resource Identifier (BT_DATA_URI): You can use this type for advertising URI like website addresses (URLs). We will include the URL of Nordic Developer Academy (https://academy.nordicsemi.com/) in the scan response packet of this exercise.
Service UUID: Different options are available here. This is useful if you want a central to filter advertising devices based on services. We will include the UUID for the LBS and NUS services in upcoming exercises.
Manufacturer SpecificData (BT_DATA_MANUFACTURER_DATA). This is a popular type that enables companies to define their own custom advertising data, as in the case of iBeacon. We will cover using this data type in the exercise of the next lesson.
For now, we want to include the complete local name, BT_DATA_NAME_COMPLETE, in the advertising packet.
We will use the macro BT_DATA() to populate data into the advertising packet. The macro expects three parameters as shown in the signature below
Note in legacy advertising we have only 31 octets available. To send more than 31 octets in advertisements, we will need to use the scan response, as we will see next.
4.2. Prepare the scan response.
In the scan response, we will include the URL for Nordic Developer Academy, for the sake of demonstration.
4.2.1 Declare the scan response packet.
Same as we did for the advertising packet, we will declare it as an array sd[] of type struct bt_data.
Add the following code in main.c
static const struct bt_data sd[] = {
/* 4.2.3 Include the URL data in the scan response packet*/
};
4.2.2 Declare the URL data to include in the scan response packet.
We will declare the URL as an array of static unsigned char. In the first byte, we need to specify the URI Scheme Name String Mapping as specified in the Assigned Numbers Document from the Bluetooth SIG. The scheme is used to save data transmitted over the air. So for example, instead of transmitting advertising of 6 bytes for the “https:”, we only need to send one byte (0x17).
4.2.3 Include the URL data in the scan response packet. Add the following line inside the sd packet.
BT_DATA(BT_DATA_URI, url_data,sizeof(url_data)),
5. Enable the Bluetooth LE stack.
The function bt_enable()is used to enable the Bluetooth LE stack in the application. This function must be called before any other calls that require communication with the Bluetooth LE hardware (for example, start advertising).
bt_enable() is blocking when passing NULL to it, and non-blocking if you pass a bt_ready_cb_t callback.
The first parameter this function expects is the advertising parameters. Here, we can either use predefined macros that cover the most common cases. Or we can declare a variable of type bt_le_adv_param and set the parameters manually.
For now, we will use one of the predefined macros. In exercise 2, we will set this parameter manually. Available macros are documented here. In our case, we will be using BT_LE_ADV_NCONN – non-connectable advertising with a minimum advertising interval of 100 ms and a maximum advertising interval of 150 ms.
The second and third parameters are the advertising packet (created in step 4.1) and its size, while the fourth and fifth parameters are the scan response (created in step 4.2) and its size.
Add the following lines inside main()
err = bt_le_adv_start(BT_LE_ADV_NCONN, ad, ARRAY_SIZE(ad),
sd, ARRAY_SIZE(sd));
if (err) {
LOG_ERR("Advertising failed to start (err %d)\n", err);
return;
}
7. Build and flash the application on your board.
You should notice that LED1 on your board is blinking, indicating that your board is advertising.
8. Open nRF Connect for Mobile on your smartphone.
In the SCANNER tab press on the SCAN button to begin scanning
Android
9. Tap on Nordic_Beacon to view the advertising data.
Android
The first thing to notice is that there is no CONNECT button displayed. This is because we are advertising non-connectable packets (BT_LE_ADV_NCONN). Let’s now spend some time interpreting the data.
RSSI level is the received signal strength indicator on the receiver side
Advertising interval. Since we chose BT_LE_ADV_NCONN, the advertising interval is between 100-150 ms
Advertising flags that we set in step 4.1.2 (Bluetooth Classic BR/EDR not supported)
The complete local name, that we set in step 2
The URI data that we included in the scan response packet. Note that you can tap on the OPEN button to open the link directly in a browser.
We encourage you to try and change these parameters in the code, build and flash your board to see how easy it is to control the advertising data.
iOS
In the Scanner tab, select the play icon to begin scanning
iOS
9. Tap on Nordic_Beacon to view the advertising data.
iOS
The first thing to notice is that there is no Connect button displayed. This is because we are advertising non-connectable packets (BT_LE_ADV_NCONN). Let’s now spend some time interpreting the data.
RSSI level is the received signal strength indicator on the receiver side
Advertising interval. Since we chose BT_LE_ADV_NCONN, the advertising interval is between 100-150 ms
Since the iOS Bluetooth stack filters out a lot of the advertising data, this is all the information we can see.
We encourage you to try and change these parameters in the code, build and flash your board to see how easy it is to control the advertising data.
Nordic Developer Academy Privacy Policy
1. Introduction
In this Privacy Policy you will find information on Nordic Semiconductor ASA (“Nordic Semiconductor”) processes your personal data when you use the Nordic Developer Academy.
References to “we” and “us” in this document refers to Nordic Semiconductor.
2. Our processing of personal data when you use the Nordic Developer Academy
2.1 Nordic Developer Academy
Nordic Semiconductor processes personal data in order to provide you with the features and functionality of the Nordic Developer Academy. Creating a user account is optional, but required if you want to track you progress and view your completed courses and obtained certificates. If you choose to create a user account, we will process the following categories of personal data:
Email
Name
Password (encrypted)
Course progression (e.g. which course you have completely or partly completed)
Certificate information, which consists of name of completed course and the validity of the certificate
Course results
During your use of the Nordic Developer Academy, you may also be asked if you want to provide feedback. If you choose to respond to any such surveys, we will also process the personal data in your responses in that survey.
The legal basis for this processing is GDPR article 6 (1) b. The processing is necessary for Nordic Semiconductor to provide the Nordic Developer Academy under the Terms of Service.
2.2 Analytics
If you consent to analytics, Nordic Semiconductor will use Google Analytics to obtain statistics about how the Nordic Developer Academy is used. This includes collecting information on for example what pages are viewed, the duration of the visit, the way in which the pages are maneuvered, what links are clicked, technical information about your equipment. The information is used to learn how Nordic Developer Academy is used and how the user experience can be further developed.
2.2 Newsletter
You can consent to receive newsletters from Nordic from within the Nordic Developer Academy. How your personal data is processed when you sign up for our newsletters is described in the Nordic Semiconductor Privacy Policy.
3. Retention period
We will store your personal data for as long you use the Nordic Developer Academy. If our systems register that you have not used your account for 36 months, your account will be deleted.
4. Additional information
Additional information on how we process personal data can be found in the Nordic Semiconductor Privacy Policy and Cookie Policy.
Nordic Developer Academy Terms of Service
1. Introduction
These terms and conditions (“Terms of Use”) apply to the use of the Nordic Developer Academy, provided by Nordic Semiconductor ASA, org. nr. 966 011 726, a public limited liability company registered in Norway (“Nordic Semiconductor”).
Nordic Developer Academy allows the user to take technical courses related to Nordic Semiconductor products, software and services, and obtain a certificate certifying completion of these courses. By completing the registration process for the Nordic Developer Academy, you are agreeing to be bound by these Terms of Use.
These Terms of Use are applicable as long as you have a user account giving you access to Nordic Developer Academy.
2. Access to and use of Nordic Developer Academy
Upon acceptance of these Terms of Use you are granted a non-exclusive right of access to, and use of Nordic Developer Academy, as it is provided to you at any time. Nordic Semiconductor provides Nordic Developer Academy to you free of charge, subject to the provisions of these Terms of Use and the Nordic Developer Academy Privacy Policy.
To access select features of Nordic Developer Academy, you need to create a user account. You are solely responsible for the security associated with your user account, including always keeping your login details safe.
You will able to receive an electronic certificate from Nordic Developer Academy upon completion of courses. By issuing you such a certificate, Nordic Semiconductor certifies that you have completed the applicable course, but does not provide any further warrants or endorsements for any particular skills or professional qualifications.
Nordic Semiconductor will continuously develop Nordic Developer Academy with new features and functionality, but reserves the right to remove or alter any existing functions without notice.
3. Acceptable use
You undertake that you will use Nordic Developer Academy in accordance with applicable law and regulations, and in accordance with these Terms of Use. You must not modify, adapt, or hack Nordic Developer Academy or modify another website so as to falsely imply that it is associated with Nordic Developer Academy, Nordic Semiconductor, or any other Nordic Semiconductor product, software or service.
You agree not to reproduce, duplicate, copy, sell, resell or in any other way exploit any portion of Nordic Developer Academy, use of Nordic Developer Academy, or access to Nordic Developer Academy without the express written permission by Nordic Semiconductor. You must not upload, post, host, or transmit unsolicited email, SMS, or \”spam\” messages.
You are responsible for ensuring that the information you post and the content you share does not;
contain false, misleading or otherwise erroneous information
infringe someone else’s copyrights or other intellectual property rights
contain sensitive personal data or
contain information that might be received as offensive or insulting.
Such information may be removed without prior notice.
Nordic Semiconductor reserves the right to at any time determine whether a use of Nordic Developer Academy is in violation of its requirements for acceptable use.
Violation of the at any time applicable requirements for acceptable use may result in termination of your account. We will take reasonable steps to notify you and state the reason for termination in such cases.
4. Routines for planned maintenance
Certain types of maintenance may imply a stop or reduction in availability of Nordic Developer Academy. Nordic Semiconductor does not warrant any level of service availability but will provide its best effort to limit the impact of any planned maintenance on the availability of Nordic Developer Academy.
5. Intellectual property rights
Nordic Semiconductor retains all rights to all elements of Nordic Developer Academy. This includes, but is not limited to, the concept, design, trademarks, know-how, trade secrets, copyrights and all other intellectual property rights.
Nordic Semiconductor receives all rights to all content uploaded or created in Nordic Developer Academy. You do not receive any license or usage rights to Nordic Developer Academy beyond what is explicitly stated in this Agreement.
6. Liability and damages
Nothing within these Terms of Use is intended to limit your statutory data privacy rights as a data subject, as described in the Nordic Developer Academy Privacy Policy. You acknowledge that errors might occur from time to time and waive any right to claim for compensation as a result of errors in Nordic Developer Academy. When an error occurs, you shall notify Nordic Semiconductor of the error and provide a description of the error situation.
You agree to indemnify Nordic Semiconductor for any loss, including indirect loss, arising out of or in connection with your use of Nordic Developer Academy or violations of these Terms of Use. Nordic Semiconductor shall not be held liable for, and does not warrant that (i) Nordic Developer Academy will meet your specific requirements, (ii) Nordic Developer Academy will be uninterrupted, timely, secure, or error-free, (iii) the results that may be obtained from the use of Nordic Developer Academy will be accurate or reliable, (iv) the quality of any products, services, information, or other material purchased or obtained by you through Nordic Developer Academy will meet your expectations, or that (v) any errors in Nordic Developer Academy will be corrected.
You accept that this is a service provided to you without any payment and hence you accept that Nordic Semiconductor will not be held responsible, or liable, for any breaches of these Terms of Use or any loss connected to your use of Nordic Developer Academy. Unless otherwise follows from mandatory law, Nordic Semiconductor will not accept any such responsibility or liability.
7. Change of terms
Nordic Semiconductor may update and change the Terms of Use from time to time. Nordic Semiconductor will seek to notify you about significant changes before such changes come into force and give you a possibility to evaluate the effects of proposed changes. Continued use of Nordic Developer Academy after any such changes shall constitute your acceptance of such changes. You can review the current version of the Terms of Use at any time at https://academy.nordicsemi.com/terms-of-service/
8. Transfer of rights
Nordic Semiconductor is entitled to transfer its rights and obligation pursuant to these Terms of Use to a third party as part of a merger or acquisition process, or as a result of other organizational changes.
9. Third Party Services
To the extent Nordic Developer Academy facilitates access to services provided by a third party, you agree to comply with the terms governing such third party services. Nordic Semiconductor shall not be held liable for any errors, omissions, inaccuracies, etc. related to such third party services.
10. Dispute resolution
The Terms of Use and any other legally binding agreement between yourself and Nordic Semiconductor shall be subject to Norwegian law and Norwegian courts’ exclusive jurisdiction.