MicroBitBLEManager Class Reference

Constructor.

Configure and manage the micro:bit's Bluetooth Low Energy (BLE) stack.

Parameters:

_storage

an instance of MicroBitStorage used to persist sys attribute information. (This is required for compatability with iOS).

Note:

The BLE stack *cannot* be brought up in a static context (the software simply hangs or corrupts itself). Hence, the init() member function should be used to initialise the BLE stack.

Definition at line 226 of file MicroBitBLEManager.cpp.

Constructor.

Configure and manage the micro:bit's Bluetooth Low Energy (BLE) stack.

Note:

The BLE stack *cannot* be brought up in a static context (the software simply hangs or corrupts itself). Hence, the init() member function should be used to initialise the BLE stack.

Definition at line 241 of file MicroBitBLEManager.cpp.

When called, the micro:bit will begin advertising for a predefined period, MICROBIT_BLE_ADVERTISING_TIMEOUT seconds to bonded devices.

Definition at line 265 of file MicroBitBLEManager.cpp.

Set the content of Eddystone UID frames.

Parameters:

uid_namespace,:	the uid namespace. Must 10 bytes long.
uid_instance,:	the uid instance value. Must 6 bytes long.
calibratedPower	the transmission range of the beacon (Defaults to: 0xF0 ~10m).
connectable	true to keep bluetooth connectable for other services, false otherwise. (Defaults to true)
interval	the rate at which the micro:bit will advertise url frames. (Defaults to MICROBIT_BLE_EDDYSTONE_ADV_INTERVAL)

Note:

The calibratedPower value ranges from -100 to +20 to a resolution of 1. The calibrated power should be binary encoded. More information can be found at https://github.com/google/eddystone/tree/master/eddystone-uid#tx-power

Definition at line 585 of file MicroBitBLEManager.cpp.

Set the content of Eddystone URL frames.

Parameters:

url	The url to broadcast
calibratedPower	the transmission range of the beacon (Defaults to: 0xF0 ~10m).
connectable	true to keep bluetooth connectable for other services, false otherwise. (Defaults to true)
interval	the rate at which the micro:bit will advertise url frames. (Defaults to MICROBIT_BLE_EDDYSTONE_ADV_INTERVAL)

Note:

The calibratedPower value ranges from -100 to +20 to a resolution of 1. The calibrated power should be binary encoded. More information can be found at https://github.com/google/eddystone/tree/master/eddystone-uid#tx-power

Definition at line 528 of file MicroBitBLEManager.cpp.

Set the content of Eddystone URL frames, but accepts a ManagedString as a url.

Parameters:

url	The url to broadcast
calibratedPower	the transmission range of the beacon (Defaults to: 0xF0 ~10m).
connectable	true to keep bluetooth connectable for other services, false otherwise. (Defaults to true)
interval	the rate at which the micro:bit will advertise url frames. (Defaults to MICROBIT_BLE_EDDYSTONE_ADV_INTERVAL)

Note:

The calibratedPower value ranges from -100 to +20 to a resolution of 1. The calibrated power should be binary encoded. More information can be found at https://github.com/google/eddystone/tree/master/eddystone-uid#tx-power

Definition at line 562 of file MicroBitBLEManager.cpp.

Determines the number of devices currently bonded with this micro:bit.

Returns:

The number of active bonds.

Definition at line 446 of file MicroBitBLEManager.cpp.

getInstance

When called, the micro:bit will begin advertising for a predefined period, MICROBIT_BLE_ADVERTISING_TIMEOUT seconds to bonded devices.

Allows other objects to easily obtain a pointer to the single instance of this object. By rights the constructor should be made private to properly implement the singleton pattern.

Definition at line 252 of file MicroBitBLEManager.cpp.

Periodic callback in thread context.

We use this here purely to safely issue a disconnect operation after a pairing operation is complete.

Reimplemented from MicroBitComponent.

Definition at line 494 of file MicroBitBLEManager.cpp.

Post constructor initialisation method as the BLE stack cannot be brought up in a static context.

Parameters:

deviceName	The name used when advertising
serialNumber	The serial number exposed by the device information service
messageBus	An instance of an EventModel, used during pairing.
enableBonding	If true, the security manager enabled bonding.

 bleManager.init(uBit.getName(), uBit.getSerial(), uBit.messageBus, true);

Definition at line 284 of file MicroBitBLEManager.cpp.

A pairing request has been sucessfully completed.

If we're in pairing mode, display a success or failure message.

Note:

for internal use only.

Definition at line 477 of file MicroBitBLEManager.cpp.

Enter pairing mode.

This is mode is called to initiate pairing, and to enable FOTA programming of the micro:bit in cases where BLE is disabled during normal operation.

Parameters:

display	An instance of MicroBitDisplay used when displaying pairing information.
authorizationButton	The button to use to authorise a pairing request.

 // initiate pairing mode
 bleManager.pairingMode(uBit.display, uBit.buttonA);

Definition at line 618 of file MicroBitBLEManager.cpp.

A request to pair has been received from a BLE device.

If we're in pairing mode, display the passkey to the user. Also, purge the bonding table if it has reached capacity.

Note:

for internal use only.

Definition at line 464 of file MicroBitBLEManager.cpp.

Change the output power level of the transmitter to the given value.

Parameters:

power

a value in the range 0..7, where 0 is the lowest power and 7 is the highest.

Returns:

MICROBIT_OK on success, or MICROBIT_INVALID_PARAMETER if the value is out of range.

 // maximum transmission power.
 bleManager.setTransmitPower(7);

Definition at line 431 of file MicroBitBLEManager.cpp.

Stops any currently running BLE advertisements.

Definition at line 508 of file MicroBitBLEManager.cpp.