Skip to content

Commit ed61a17

Browse files
committedFeb 23, 2022
Bluetooth trademark fix
1 parent 8d4d1dc commit ed61a17

File tree

13 files changed

+198
-197
lines changed

13 files changed

+198
-197
lines changed
 

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
[![Compile Examples Status](https://github.com/arduino-libraries/ArduinoBLE/workflows/Compile%20Examples/badge.svg)](https://github.com/arduino-libraries/ArduinoBLE/actions?workflow=Compile+Examples) [![Spell Check Status](https://github.com/arduino-libraries/ArduinoBLE/workflows/Spell%20Check/badge.svg)](https://github.com/arduino-libraries/ArduinoBLE/actions?workflow=Spell+Check)
44

5-
Enables BLE connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, and Arduino Nano 33 BLE.
5+
Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, and Arduino Nano 33 BLE.
66

7-
This library supports creating a BLE peripheral and BLE central mode.
7+
This library supports creating a Bluetooth® Low Energy peripheral & central mode.
88

99
For the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, and Arduino Nano 33 IoT boards, it requires the NINA module to be running [Arduino NINA-W102 firmware](https://github.com/arduino/nina-fw) v1.2.0 or later.
1010

‎docs/api.md

+140-139
Large diffs are not rendered by default.

‎docs/readme.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
# ArduinoBLE library
22

3-
This library supports all the Arduino boards that have the hardware enabled for BLE and Bluetooth 4.0 and above; these include Nano 33 BLE, Arduino NANO 33 IoT, Uno WiFi Rev 2, MKR WiFi 1010, Nicla Sense ME.
3+
This library supports all the Arduino boards that have the hardware enabled for Bluetooth® Low Energy and Bluetooth® 4.0 and above; these include Nano 33 BLE, Arduino NANO 33 IoT, Uno WiFi Rev 2, MKR WiFi 1010, Nicla Sense ME.
44

55
To use this library
66
``#include <ArduinoBLE.h>``
77

88
## A quick introduction to BLE
99

10-
Bluetooth 4.0 includes both traditional Bluetooth, now labeled "Bluetooth Classic", and the Bluetooth Low Energy (Bluetooth LE, or BLE). BLE is optimized for low power use at low data rates, and was designed to operate from simple lithium coin cell batteries.
10+
Bluetooth® 4.0 includes both traditional Bluetooth®, now labeled "Bluetooth® Classic", and the Bluetooth® Low Energy. Bluetooth® Low Energy is optimized for low power use at low data rates, and was designed to operate from simple lithium coin cell batteries.
1111

12-
Unlike standard bluetooth communication basically based on an asynchronous serial connection (UART) a Bluetooth LE radio acts like a community bulletin board. The computers that connect to it are like community members that read the bulletin board. Each radio acts as either the bulletin board or the reader. If your radio is a bulletin board (called a peripheral device in Bluetooth LE parlance) it posts data for all radios in the community to read. If your radio is a reader (called a central device in Blueooth LE terms) it reads from any of the bulletin boards (peripheral devices) that have information about which it cares. You can also think of peripheral devices as the servers in a client-server transaction, because they contain the information that reader radios ask for. Similarly, central devices are the clients of the Bluetooth LE world because they read information available from the peripherals.
12+
Unlike standard Bluetooth® communication basically based on an asynchronous serial connection (UART) a Bluetooth® LE radio acts like a community bulletin board. The computers that connect to it are like community members that read the bulletin board. Each radio acts as either the bulletin board or the reader. If your radio is a bulletin board (called a peripheral device in Bluetooth® LE parlance) it posts data for all radios in the community to read. If your radio is a reader (called a central device in Blueooth LE terms) it reads from any of the bulletin boards (peripheral devices) that have information about which it cares. You can also think of peripheral devices as the servers in a client-server transaction, because they contain the information that reader radios ask for. Similarly, central devices are the clients of the Bluetooth® LE world because they read information available from the peripherals.
1313

1414
![Communication between central and peripheral devices](www.arduino.cc/en/uploads/Reference/ble-bulletin-board-model.png)
1515

16-
Think of a Bluetooth LE peripheral device as a bulletin board and central devices as viewers of the board. Central devices view the services, get the data, then move on. Each transaction is quick (a few milliseconds), so multiple central devices can get data from one peripheral.
16+
Think of a Bluetooth® LE peripheral device as a bulletin board and central devices as viewers of the board. Central devices view the services, get the data, then move on. Each transaction is quick (a few milliseconds), so multiple central devices can get data from one peripheral.
1717

1818
The information presented by a peripheral is structured as **services**, each of which is subdivided into **characteristics**. You can think of services as the notices on a bulletin board, and characteristics as the individual paragraphs of those notices. If you're a peripheral device, you just update each service characteristic when it needs updating and don't worry about whether the central devices read them or not. If you're a central device, you connect to the peripheral then read the boxes you want. If a given characteristic is readable and writable, then the peripheral and central can both change it.
1919

2020
## Notify
2121

22-
The Bluetooth LE specification includes a mechanism known as **notify** that lets you know when data's changed. When notify on a characteristic is enabled and the sender writes to it, the new value is automatically sent to the receiver, without the receiver explicitly issuing a read command. This is commonly used for streaming data such as accelerometer or other sensor readings. There's a variation on this specification called **indicate** which works similarly, but in the indicate specification, the reader sends an acknowledgement of the pushed data.
22+
The Bluetooth® LE specification includes a mechanism known as **notify** that lets you know when data's changed. When notify on a characteristic is enabled and the sender writes to it, the new value is automatically sent to the receiver, without the receiver explicitly issuing a read command. This is commonly used for streaming data such as accelerometer or other sensor readings. There's a variation on this specification called **indicate** which works similarly, but in the indicate specification, the reader sends an acknowledgement of the pushed data.
2323

24-
The client-server structure of Bluetooth LE, combined with the notify characteristic, is generally called a **publish-and-subscribe model**.
24+
The client-server structure of Bluetooth® LE, combined with the notify characteristic, is generally called a **publish-and-subscribe model**.
2525

2626
## Update a characteristic
2727

@@ -35,7 +35,7 @@ Just as with writing to a characteristic, you could update your characteristics
3535

3636
## Services, characteristics, and UUIDs
3737

38-
A BLE peripheral will provide **services**, which in turn provide **characteristics**. You can define your own services, or use [standard services](https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx).
38+
A Bluetooth® Low Energy peripheral will provide **services**, which in turn provide **characteristics**. You can define your own services, or use [standard services](https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx).
3939

4040
Services are identified by unique numbers known as UUIDs. You know about UUIDs from other contexts. Standard services have a 16-bit UUID and custom services have a 128-bit UUID. The ability to define services and characteristics depends on the radio you're using and its firmware.
4141

@@ -84,8 +84,8 @@ The Bluetooth LE protocol operates on multiple layers. **General Attribute Profi
8484

8585
As the library enables multiple types of functionality, there are a number of different classes.
8686

87-
- BLE used to enable the BLE module.
88-
- BLEDevice used to get information about the devices connected or discovered while scanning.
89-
- BLEService used to enable the services board provides or interact with services a remote board provides.
90-
- BLECharacteristic used to enable the characteristics board offers in a service or interact with characteristics a remote board provides.
91-
- BLEDescriptor used to describe a characteristic the board offers.
87+
- `BLE` used to enable the Bluetooth® Low Energy module.
88+
- `BLEDevice` used to get information about the devices connected or discovered while scanning.
89+
- `BLEService` used to enable the services board provides or interact with services a remote board provides.
90+
- `BLECharacteristic` used to enable the characteristics board offers in a service or interact with characteristics a remote board provides.
91+
- `BLEDescriptor` used to describe a characteristic the board offers.

‎examples/Central/LedControl/LedControl.ino

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/*
22
LED Control
33
4-
This example scans for BLE peripherals until one with the advertised service
4+
This example scans for Bluetooth® Low Energy peripherals until one with the advertised service
55
"19b10000-e8f2-537e-4f6c-d104768a1214" UUID is found. Once discovered and connected,
6-
it will remotely control the BLE Peripheral's LED, when the button is pressed or released.
6+
it will remotely control the Bluetooth® Low Energy peripheral's LED, when the button is pressed or released.
77
88
The circuit:
99
- Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT,
@@ -29,10 +29,10 @@ void setup() {
2929
// configure the button pin as input
3030
pinMode(buttonPin, INPUT);
3131

32-
// initialize the BLE hardware
32+
// initialize the Bluetooth® Low Energy hardware
3333
BLE.begin();
3434

35-
Serial.println("BLE Central - LED control");
35+
Serial.println("Bluetooth® Low Energy Central - LED control");
3636

3737
// start scanning for peripherals
3838
BLE.scanForUuid("19b10000-e8f2-537e-4f6c-d104768a1214");

‎examples/Central/PeripheralExplorer/PeripheralExplorer.ino

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
Peripheral Explorer
33
4-
This example scans for BLE peripherals until one with a particular name ("LED")
4+
This example scans for Bluetooth® Low Energy peripherals until one with a particular name ("LED")
55
is found. Then connects, and discovers + prints all the peripheral's attributes.
66
77
The circuit:
@@ -22,12 +22,12 @@ void setup() {
2222

2323
// begin initialization
2424
if (!BLE.begin()) {
25-
Serial.println("starting BLE failed!");
25+
Serial.println("starting Bluetooth® Low Energy module failed!");
2626

2727
while (1);
2828
}
2929

30-
Serial.println("BLE Central - Peripheral Explorer");
30+
Serial.println("Bluetooth® Low Energy Central - Peripheral Explorer");
3131

3232
// start scanning for peripherals
3333
BLE.scan();

‎examples/Central/Scan/Scan.ino

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
Scan
33
4-
This example scans for BLE peripherals and prints out their advertising details:
4+
This example scans for Bluetooth® Low Energy peripherals and prints out their advertising details:
55
address, local name, advertised service UUID's.
66
77
The circuit:
@@ -19,12 +19,12 @@ void setup() {
1919

2020
// begin initialization
2121
if (!BLE.begin()) {
22-
Serial.println("starting BLE failed!");
22+
Serial.println("starting Bluetooth® Low Energy module failed!");
2323

2424
while (1);
2525
}
2626

27-
Serial.println("BLE Central scan");
27+
Serial.println("Bluetooth® Low Energy Central scan");
2828

2929
// start scanning for peripheral
3030
BLE.scan();

‎examples/Central/ScanCallback/ScanCallback.ino

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
Scan Callback
33
4-
This example scans for BLE peripherals and prints out their advertising details:
4+
This example scans for Bluetooth® Low Energy peripherals and prints out their advertising details:
55
address, local name, advertised service UUIDs. Unlike the Scan example, it uses
66
the callback style APIs and disables filtering so the peripheral discovery is
77
reported for every single advertisement it makes.
@@ -21,12 +21,12 @@ void setup() {
2121

2222
// begin initialization
2323
if (!BLE.begin()) {
24-
Serial.println("starting BLE failed!");
24+
Serial.println("starting Bluetooth® Low Energy module failed!");
2525

2626
while (1);
2727
}
2828

29-
Serial.println("BLE Central scan callback");
29+
Serial.println("Bluetooth® Low Energy Central scan callback");
3030

3131
// set the discovered event handle
3232
BLE.setEventHandler(BLEDiscovered, bleCentralDiscoverHandler);

‎examples/Central/SensorTagButton/SensorTagButton.ino

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
SensorTag Button
33
4-
This example scans for BLE peripherals until a TI SensorTag is discovered.
4+
This example scans for Bluetooth® Low Energy peripherals until a TI SensorTag is discovered.
55
It then connects to it, discovers the attributes of the 0xffe0 service,
66
subscribes to the Simple Key Characteristic (UUID 0xffe1). When a button is
77
pressed on the SensorTag a notification is received and the button state is
@@ -23,12 +23,12 @@ void setup() {
2323

2424
// begin initialization
2525
if (!BLE.begin()) {
26-
Serial.println("starting BLE failed!");
26+
Serial.println("starting Bluetooth® Low Energy module failed!");
2727

2828
while (1);
2929
}
3030

31-
Serial.println("BLE Central - SensorTag button");
31+
Serial.println("Bluetooth® Low Energy Central - SensorTag button");
3232
Serial.println("Make sure to turn on the device.");
3333

3434
// start scanning for peripheral

‎examples/Peripheral/BatteryMonitor/BatteryMonitor.ino

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
/*
22
Battery Monitor
33
4-
This example creates a BLE peripheral with the standard battery service and
4+
This example creates a Bluetooth® Low Energy peripheral with the standard battery service and
55
level characteristic. The A0 pin is used to calculate the battery level.
66
77
The circuit:
88
- Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT,
99
Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board.
1010
11-
You can use a generic BLE central app, like LightBlue (iOS and Android) or
11+
You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or
1212
nRF Connect (Android), to interact with the services and characteristics
1313
created in this sketch.
1414
@@ -17,10 +17,10 @@
1717

1818
#include <ArduinoBLE.h>
1919

20-
// BLE Battery Service
20+
// Bluetooth® Low Energy Battery Service
2121
BLEService batteryService("180F");
2222

23-
// BLE Battery Level Characteristic
23+
// Bluetooth® Low Energy Battery Level Characteristic
2424
BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID
2525
BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes
2626

@@ -40,9 +40,9 @@ void setup() {
4040
while (1);
4141
}
4242

43-
/* Set a local name for the BLE device
43+
/* Set a local name for the Bluetooth® Low Energy device
4444
This name will appear in advertising packets
45-
and can be used by remote devices to identify this BLE device
45+
and can be used by remote devices to identify this Bluetooth® Low Energy device
4646
The name can be changed but maybe be truncated based on space left in advertisement packet
4747
*/
4848
BLE.setLocalName("BatteryMonitor");
@@ -51,18 +51,18 @@ void setup() {
5151
BLE.addService(batteryService); // Add the battery service
5252
batteryLevelChar.writeValue(oldBatteryLevel); // set initial value for this characteristic
5353

54-
/* Start advertising BLE. It will start continuously transmitting BLE
55-
advertising packets and will be visible to remote BLE central devices
54+
/* Start advertising Bluetooth® Low Energy. It will start continuously transmitting Bluetooth® Low Energy
55+
advertising packets and will be visible to remote Bluetooth® Low Energy central devices
5656
until it receives a new connection */
5757

5858
// start advertising
5959
BLE.advertise();
6060

61-
Serial.println("Bluetooth device active, waiting for connections...");
61+
Serial.println("Bluetooth® device active, waiting for connections...");
6262
}
6363

6464
void loop() {
65-
// wait for a BLE central
65+
// wait for a Bluetooth® Low Energy central
6666
BLEDevice central = BLE.central();
6767

6868
// if a central is connected to the peripheral:

‎examples/Peripheral/ButtonLED/ButtonLED.ino

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
Button LED
33
4-
This example creates a BLE peripheral with service that contains a
4+
This example creates a Bluetooth® Low Energy peripheral with service that contains a
55
characteristic to control an LED and another characteristic that
66
represents the state of the button.
77
@@ -10,7 +10,7 @@
1010
Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board.
1111
- Button connected to pin 4
1212
13-
You can use a generic BLE central app, like LightBlue (iOS and Android) or
13+
You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or
1414
nRF Connect (Android), to interact with the services and characteristics
1515
created in this sketch.
1616
@@ -38,7 +38,7 @@ void setup() {
3838

3939
// begin initialization
4040
if (!BLE.begin()) {
41-
Serial.println("starting BLE failed!");
41+
Serial.println("starting Bluetooth® Low Energy module failed!");
4242

4343
while (1);
4444
}
@@ -61,11 +61,11 @@ void setup() {
6161
// start advertising
6262
BLE.advertise();
6363

64-
Serial.println("Bluetooth device active, waiting for connections...");
64+
Serial.println("Bluetooth® device active, waiting for connections...");
6565
}
6666

6767
void loop() {
68-
// poll for BLE events
68+
// poll for Bluetooth® Low Energy events
6969
BLE.poll();
7070

7171
// read the current button pin state

‎examples/Peripheral/CallbackLED/CallbackLED.ino

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
/*
22
Callback LED
33
4-
This example creates a BLE peripheral with service that contains a
4+
This example creates a Bluetooth® Low Energy peripheral with service that contains a
55
characteristic to control an LED. The callback features of the
66
library are used.
77
88
The circuit:
99
- Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT,
1010
Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board.
1111
12-
You can use a generic BLE central app, like LightBlue (iOS and Android) or
12+
You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or
1313
nRF Connect (Android), to interact with the services and characteristics
1414
created in this sketch.
1515
@@ -33,7 +33,7 @@ void setup() {
3333

3434
// begin initialization
3535
if (!BLE.begin()) {
36-
Serial.println("starting BLE failed!");
36+
Serial.println("starting Bluetooth® Low Energy module failed!");
3737

3838
while (1);
3939
}
@@ -61,11 +61,11 @@ void setup() {
6161
// start advertising
6262
BLE.advertise();
6363

64-
Serial.println(("Bluetooth device active, waiting for connections..."));
64+
Serial.println(("Bluetooth® device active, waiting for connections..."));
6565
}
6666

6767
void loop() {
68-
// poll for BLE events
68+
// poll for Bluetooth® Low Energy events
6969
BLE.poll();
7070
}
7171

‎examples/Peripheral/LED/LED.ino

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
/*
22
LED
33
4-
This example creates a BLE peripheral with service that contains a
4+
This example creates a Bluetooth® Low Energy peripheral with service that contains a
55
characteristic to control an LED.
66
77
The circuit:
88
- Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT,
99
Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board.
1010
11-
You can use a generic BLE central app, like LightBlue (iOS and Android) or
11+
You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or
1212
nRF Connect (Android), to interact with the services and characteristics
1313
created in this sketch.
1414
@@ -17,9 +17,9 @@
1717

1818
#include <ArduinoBLE.h>
1919

20-
BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service
20+
BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service
2121

22-
// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central
22+
// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central
2323
BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite);
2424

2525
const int ledPin = LED_BUILTIN; // pin to use for the LED
@@ -33,7 +33,7 @@ void setup() {
3333

3434
// begin initialization
3535
if (!BLE.begin()) {
36-
Serial.println("starting BLE failed!");
36+
Serial.println("starting Bluetooth® Low Energy module failed!");
3737

3838
while (1);
3939
}
@@ -58,7 +58,7 @@ void setup() {
5858
}
5959

6060
void loop() {
61-
// listen for BLE peripherals to connect:
61+
// listen for Bluetooth® Low Energy peripherals to connect:
6262
BLEDevice central = BLE.central();
6363

6464
// if a central is connected to peripheral:

‎library.properties

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ name=ArduinoBLE
22
version=1.2.1
33
author=Arduino
44
maintainer=Arduino <info@arduino.cc>
5-
sentence=Enables BLE connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME.
6-
paragraph=This library supports creating a BLE peripheral and BLE central mode.
5+
sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME.
6+
paragraph=This library supports creating a Bluetooth® Low Energy peripheral & central mode.
77
category=Communication
88
url=https://www.arduino.cc/en/Reference/ArduinoBLE
99
architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla

0 commit comments

Comments
 (0)
Please sign in to comment.