Introducing the Adafruit Bluefruit LE UART FriendSo what you really need is the new Adafruit Bluefruit LE UART Friend! The Bluefruit LE UART Friend makes it easy to add Bluetooth Low

Introducing the Adafruit Bluefruit LE UART FriendCreated by Kevin Townsend

Last updated on 2017-04-24 08:30:30 PM UTC

299

1010

1010121212121314141415

16161616181818191921212222222223

Guide Contents

Guide ContentsIntroduction

So it's a Fancy Pants Wireless UART Adapter?Download our free Android/iOS app and you're ready to rock!You can do a lot more too!

Why Use Adafruit's Module?Technical SpecificationsPinoutsPower PinsUART PinsOther PinsReverse Side BreakoutsAssembly

Prepare the header strip:Add the breakout board:And Solder!

WiringWiring for Arduino UnoWiring for an Arduino Micro or LeonardoWiring for an FTDI CableFactory ResetFactory Reset via DFU PinFactoryReset Sample SketchAT+FACTORYRESETFactory Reset via FCTR Test PadDFU UpdatesAdafruit Bluefruit LE ConnectCurrent Measurements

Test ConditionsFast Advertising ModeSlow Advertising ModeConnected Mode (UART)

© Adafruit Industries https://learn.adafruit.com/introducing-the-adafruit-bluefruit-le-uart-friend

Page 2 of 115

24252525252626

26272727272727

272728

2929293032323233373737383839404143

SoftwareConfiguration!Which board do you have?

Bluefruit Micro or Feather 32u4 BluefruitFeather M0 Bluefruit LEBluefruit LE SPI FriendBluefruit LE UART Friend or Flora BLE

Configure the Pins UsedCommon settings:Software UARTHardware UARTMode PinSPI PinsSoftware SPI Pins

Select the Serial BusUART Based Boards (Bluefruit LE UART Friend & Flora BLE)SPI Based Boards (Bluefruit LE SPI Friend)

ATCommandOpening the SketchConfigurationRunning the SketchBLEUartOpening the SketchConfigurationRunning the SketchHIDKeyboardOpening the SketchConfigurationRunning the SketchBonding the HID KeyboardAndroidiOSOS XController


Page 3 of 115

4343444445464749494950

505152545454555657586060606061616162626262

Opening the SketchConfigurationRunning the SketchUsing Bluefruit LE Connect in Controller ModeStreaming Sensor DataControl Pad ModuleColor Picker ModuleHeartRateMonitorOpening the SketchConfiguration

If Using Hardware or Software UART

Running the SketchnRF Toolbox HRM ExampleCoreBluetooth HRM ExampleUriBeaconOpening the SketchConfigurationRunning the SketchHALP!Data ModeSwitching Command/Data Mode via +++Command ModeHayes/AT CommandsTest Command Mode '=?'Write Command Mode '=xxx'Execute ModeRead Command Mode '?'Dynamically Switching Modes via +++Standard ATATATIATZ


Page 4 of 115

6263646464646465656666666667676868686869707071727272737374747474

ATE+++General PurposeAT+FACTORYRESETAT+DFUAT+HELPAT+NVMWRITEAT+NVMREADAT+MODESWITCHENHardwareAT+BAUDRATEAT+HWADCAT+HWGETDIETEMPAT+HWGPIOAT+HWGPIOMODEAT+HWI2CSCANAT+HWVBATAT+HWRANDOMAT+HWMODELEDAT+UARTFLOWBeaconAT+BLEBEACONAT+BLEURIBEACONDeprecated: AT+EDDYSTONEENABLEAT+EDDYSTONEURLAT+EDDYSTONECONFIGENAT+EDDYSTONESERVICEENAT+EDDYSTONEBROADCASTBLE GenericAT+BLEPOWERLEVELAT+BLEGETADDRTYPEAT+BLEGETADDR


Page 5 of 115

7575767676

77777878787979

798080818182828283838384848484848585868686

AT+BLEGETPEERADDRAT+BLEGETRSSIBLE ServicesAT+BLEUARTTX

TX FIFO Buffer Handling

AT+BLEUARTTXFAT+BLEUARTRXAT+BLEUARTFIFOAT+BLEKEYBOARDENAT+BLEKEYBOARDAT+BLEKEYBOARDCODE

Modifier Values

AT+BLEHIDENAT+BLEHIDMOUSEMOVEAT+BLEHIDMOUSEBUTTONAT+BLEHIDCONTROLKEYAT+BLEHIDGAMEPADENAT+BLEHIDGAMEPADAT+BLEMIDIENAT+BLEMIDIRXAT+BLEMIDITXAT+BLEBATTENAT+BLEBATTVALBLE GAPAT+GAPCONNECTABLEAT+GAPGETCONNAT+GAPDISCONNECTAT+GAPDEVNAMEAT+GAPDELBONDSAT+GAPINTERVALSAT+GAPSTARTADVAT+GAPSTOPADVAT+GAPSETADVDATA


Page 6 of 115

8888888889909192939393939396969697979898989999

100100

101101101101

102102102102

BLE GATTGATT LimitationsAT+GATTCLEARAT+GATTADDSERVICEAT+GATTADDCHARAT+GATTCHARAT+GATTLISTAT+GATTCHARRAWDebugAT+DBGMEMRDAT+DBGNVMRDAT+DBGSTACKSIZEAT+DBGSTACKDUMPHistoryVersion 0.7.7Version 0.7.0Version 0.6.7Version 0.6.6Version 0.6.5Version 0.6.2Version 0.5.0Version 0.4.7Version 0.3.0GATT Service Details

UART Service

UART ServiceCharacteristics

TX (0x0002)RX (0x0003)

Software ResourcesBluefruit LE Client Apps and Libraries

Bluefruit LE Connect (http://adafru.it/f4G) (Android/Java)Bluefruit LE Connect (http://adafru.it/f4H) (iOS/Swift)


Page 7 of 115

102

103103104104

105105105

106107107107

112112112112112112112112

113114114114114

Bluefruit LE Connect for OS X (http://adafru.it/o9F) (Swift)Bluefruit LE Command Line Updater for OS X (http://adafru.it/pLF)(Swift)

Deprecated: Bluefruit Buddy (http://adafru.it/mCn) (OS X)ABLE (http://adafru.it/ijB) (Cross Platform/Node+Electron)Bluefruit LE Python Wrapper (http://adafru.it/fQF)

Debug ToolsAdaLink (http://adafru.it/fPq) (Python)Adafruit nRF51822 Flasher (http://adafru.it/fVL) (Python)

BLE FAQBluefruit LE Connect (Android)Nordic nRF ToolboxAdafruit_nRF51822_Flasher

Device RecoveryHow to Recover a Bluefruit Board

1. Force DFU Mode at Startup2. Update the Bluefruit FirmwareBLEFRIEND32 Firmware (UART, 32KB SRAM)BLESPIFRIEND Firmware (SPI)3. Flash a Test Sketch4. Perform a Factory Reset

Still Having Problems?DownloadsFilesSchematicBoard Layout


Page 8 of 115

Introduction

Would you like to add powerful and easy-to-use Bluetooth Low Energy to your robot, art or other electronics project? Heck yeah! With BLE nowincluded in modern smart phones and tablets, its fun to add wireless connectivity. So what you really need is the new Adafruit Bluefruit LE UARTFriend!

The Bluefruit LE UART Friend makes it easy to add Bluetooth Low Energy connectivity to anything with a hardware or software serial port. Weeven have nice hardware flow control so you won't have to think about losing data. Connect to your Arduino or other microcontroller or even just astandard FTDI cable for debugging and testing.

This multi-function module can do quite a lot! For most people, they'll be very happy to use the standard Nordic UART RX/TX connection profile. Inthis profile, the Bluefruit acts as a data pipe, that can 'transparently' transmit back and forth from your iOS or Android device. You can use our iOSApp (http://adafru.it/iCi) or Android App (http://adafru.it/f4G), or write your own to communicate with the UART service (http://adafru.it/iCF).

So it's a Fancy Pants Wireless UART Adapter?


Page 9 of 115

https://play.google.com/store/apps/details?id=com.adafruit.bluefruit.le.connect&hl=en

The board is capable of much more than just sending strings over the air! Thanks to an easy to learn AT command set (http://adafru.it/iCG), youhave full control over how the device behaves, including the ability to define and manipulate your own GATT Services andCharacteristics (http://adafru.it/iCH), or change the way that the device advertises itself for other Bluetooth Low Energy devices to see. You canalso use the AT commands to query the die temperature, check the battery voltage, and more, check the connection RSSI or MAC address, andtons more. Really, way too long to list here!

Download our free Android/iOS app and you're ready to rock!

Using our Bluefruit iOS App (http://adafru.it/iCi) or Android App (http://adafru.it/f4G), you can quickly get your project prototyped by using your iOSor Android phone/tablet as a controller. We have a color picker (http://adafru.it/iCI), quaternion/accelerometer/gyro/magnetometer or location(GPS) (http://adafru.it/iCI), and an 8-button control game pad (http://adafru.it/iCI).

You can do a lot more too!

The Bluefruit can also act like an HID Keyboard (http://adafru.it/iCJ) (for devices that support BLE HID)Can become a BLE Heart Rate Monitor (http://adafru.it/iCK) (a standard profile for BLE) - you just need to add the pulse-detection circuitryTurn it into a UriBeacon (http://adafru.it/iCL), the Google standard for Bluetooth LE beacons. Just power it and the 'Friend will bleep out aURL to any nearby devices with the UriBeacon app installed.Built in over-the-air bootloading capability so we can keep you updated with the hottest new firmware. (http://adafru.it/iCM) Use any Androidor iOS device to get updates and install them!

Why Use Adafruit's Module?There are plenty of BLE modules out there, with varying quality on the HW design as well as the firmware.

One of the biggest advantages of the Adafruit Bluefruit LE family is that we wrote all of the firmware running on the devices ourselves fromscratch.

We control every line of code that runs on our modules ... and so we aren't at the mercy of any third party vendors who may or may not beinterested in keeping their code up to date or catering to our customer's needs.

Because we control everything about the product, we add features that are important to our customers, can solve any issues that do come upwithout begging any 3rd parties, and we can even change Bluetooth SoCs entirely if the need ever arises!

Technical SpecificationsARM Cortex M0 core running at 16MHz256KB flash memory32KB SRAMPeak current drawTransport: UART @ 9600 baud with HW flow control (CTS+RTS required!)5V-safe inputs (Arduino Uno friendly, etc.)On-board 3.3V voltage regulationBootloader with support for safe OTA firmware updatesEasy AT command set to get up and running quickly


Page 10 of 115

https://play.google.com/store/apps/details?id=com.adafruit.bluefruit.le.connect&hl=en


Page 11 of 115

Pinouts

HW flow control (CTS+RTS) should always be used with the nRF51822. The UART peripheral block is designed in a way that more or lessrequires HW flow control for reliable UART communication, with a very small internal buffer and tight timing limitations due to the SoftDevicearchitecture (Nordic's proprietary Bluetooth Low Energy stack).

Power PinsVIN: This is the power supply for the module, supply with 3.3-16V power supply input. This will be regulated down to 3.3V to run the chipGND: The common/GND pin for power and logic

UART PinsTXO - This is the UART Transmit pin out of the breakout (Bluefruit LE --> MCU), it's at 3.3V logic level.RXI - This is the UART Receive pin into the breakout (MCU --> Bluefruit LE). This has a logic level shifter on it, you can use 3-5V logic.CTS - Clear to Send hardware flow control pin into the the breakou (MCU --> Bluefruit LE). Use this pin to tell the Bluefruit that it can senddata back to the microcontroller over the TXO pin. This pin is pulled high by default and must be set to ground in order to enable datatransfer out! If you do not need hardware flow control, tie this pin to ground it is a level shifted pin, you can use 3-5V logicRTS - Read to Send flow control pin out of the module (Bluefruit LE --> MCU). This pin will be low when its fine to send data to the Bluefruit.In general, at 9600 baud we haven't seen a need for this pin, but you can watch it for full flow control! This pin is 3.3V out

Other PinsMOD: Mode Selection. The Bluefruit has two modes, Command and Data. You can keep this pin disconnected, and use the slide switch toselect the mode. Or, you can control the mode by setting this pin voltage, it will override the switch setting! High = Command Mode, Low =UART/DATA mode. This pin is level shifted, you can use 3-5V logicDFU: Setting this pin low when you power the device up will force the Bluefruit LE module to enter a special firmware update mode to updatethe firmware over the air. Once the device is powered up, this pin can also be used to perform a factory reset. Wire the pin to GND for >5suntil the two LEDs start to blink, then release the pin (set it to 5V or logic high) and a factory reset will be performed.


Page 12 of 115

Reverse Side BreakoutsOn the back we also have a few breakouts!

Opt VBat: If you fancy, you can solder on a JST 2-PH connector (http://adafru.it/1769), this will let you easily plug in a Lithium Ion or other batterypack. This connector pad is diode protected so you can use both Vin and VBat and the regulator will automatically switch to the higher voltage

Opt. 32 KHz: If you're doing some funky low power work, we wanted to give you the option of solderin in a 32khz oscillator. (http://adafru.it/f4U)Our firmware doesn't support it yet but its there!

SWC: This is the SWD clock pin, 3v logic - for advanced hackers!

SWD: This is the SWD data pin, 3v logic - for advanced hackers!

3Vo: This is the output from the 3V regulator, for testing and also if you really need regulated 3V, up to 250mA available

FCR: This is the factory reset pin. When all else fails and you did something to really weird out your module, tie this pad to ground while poweringup the module and it will factory reset. You should try the DFU reset method first tho (see that tutorial page)


Page 13 of 115

https://www.adafruit.com/products/1769

https://www.adafruit.com/product/2211

Assembly

Prepare the header strip:

Cut the strip to length if necessary. It will be easier to solder if you insert it into abreadboard - long pins down

Add the breakout board:

Place the breakout board over the pins so that the short pins poke through the breakoutpads


Page 14 of 115

https://learn.adafruit.com/assets/25167


And Solder!

Be sure to solder all pins for reliable electrical contact.

Solder the longer power/data strip first

(For tips on soldering, be sure to check out our Guide to ExcellentSoldering (http://adafru.it/aTk)).

You're done! Check your solder joints visually and continue onto the next steps


Page 15 of 115




http://learn.adafruit.com/adafruit-guide-excellent-soldering


WiringYou can use the Bluefruit LE UART friend with any microcontroller with 3 or 5V logic, but we'll be demoing it with an Arduino UNO. Depending onwhether your microcontroller has a hardware or software UART, adjust pins as necessary!

Wiring for Arduino UnoTo connect the Bluefruit LE UART Friend to your Arduino Uno using the default pinout in our sample sketches, connect the pins up as follows:

MOD to Pin 12CTS to Pin 11TXO to Pin 10RXI to Pin 9VIN to 5VRTS to Pin 8GND to GND

The wiring diagram below shows how this might look on your system:

All of these pins are 'flexible' and you can change them around as necesary after you get your setup running nicely, but we recommend startingout with our default wiring.

Wiring for an Arduino Micro or LeonardoTo connect the Bluefruit LE UART Friend to an Arduino Micro or Leonardo, use the following pinout and make sure you've selected HW UART asthe constructor in your sample sketches (they default to SW Serial):

1/TX to RXI0/RX to TXO+5V on the Micro/Leonardo to VINGND to GNDConnect CTS on the Bluefruit LE Module to GND

The HW Serial constructor can be seen below, and should be uncommented in the sample sketches:

/* ...or hardware serial, which does not need the RTS/CTS pins. Uncomment this line */Adafruit_BluefruitLE_UART ble(BLUEFRUIT_HWSERIAL_NAME, BLUEFRUIT_UART_MODE_PIN);

Wiring for an FTDI Cable


Page 16 of 115

Since the UART Friend is, well, a serial port, you can use an FTDI Friend or cable to quickly connect using any serial console. You won't getMODE or DFU connections, so don't forget to flick the mode switch as necessary if you want to be in a particular mode.

Simply insert an FTDI cable directly into the Bluefruit LE UART Friend header by using the six pins in the middle, being careful to align the powerpins up correctly (the red wire to VIN and the black wire to GND):


Page 17 of 115

Factory ResetThere are several methods that you can use to perform a factory reset on your Bluefruit LE module if something gets misconfigured, or to deletepersistent changes like UriBeacon or advertising payload changes, etc.

These methods are the same for both UART and SPI versions of Bluefruit LE

Factory Reset via DFU PinIf you hold the DFU pin low (set the pin to GND) for >5 seconds, the red and blue LEDs next to the module will start blinking and the device willperform a factory reset as soon as you release the DFU pin (disconnecting it from GND).

If you have a DFU button instead of a pin, just hold the button down.

FactoryReset Sample SketchThere is a FactoryReset sample sketch in the Adafruit Bluefruit LE library, which can be access in the File > Examples >Adafruit_BluefruitLE_nRF51 folder (See the Software section of this tutorial (http://adafru.it/iCj) for instructions on installing the library):


Page 18 of 115

Upload this sketch and open the Serial Monitor and it should perform a factory reset for you:

AT+FACTORYRESETYou can also perform a factory reset by sending the AT+FACTORYRESET command to your Bluefruit LE module in your favorite terminalemulator or using the ATCommand (http://adafru.it/iCk) example sketch.

AT+FACTORYRESETOK

This command will also cause the device to reset.

Factory Reset via FCTR Test PadOn the bottom of the Bluefruit LE Friend board or shields there is a test pad or pin that exposes the Factory Reset pin on the modules (markedFCR or F.RST). Setting this pad low when the device is powered up will cause a factory reset at startup.


Page 19 of 115


Page 20 of 115

DFU UpdatesWe're constantly working on the Bluefruit LE firmware to add new features, and keep up to date with what customers need and want.

To make sure you stay up to date with those changes, we've included an easy to use over the air updater on all of our nRF51 based Bluefruit LEmodules.

Adafruit Bluefruit LE ConnectUpdating your Bluefruit LE device to the latest firmware is as easy as installing Adafruit's Bluefruit LE Connectapplication (http://adafru.it/f4G) (Android) from the Google Play Store or Bluefruit LE Connect for iOS (http://adafru.it/f4H) from the Apple AppStore.

Any time a firmware update is available, the application will propose to download the latest binaries and take care of all the details of transferringthem to your Bluefruit device, ans shown in the video below:


Page 21 of 115

https://play.google.com/store/apps/details?id=com.adafruit.bluefruit.le.connect

https://itunes.apple.com/app/adafruit-bluefruit-le-connect/id830125974?mt=8

Current MeasurementsThe following tables give you an idea of the average current draw in three different operating modes with the Bluefruit LE UART Friend:

Fast Advertising Mode (the first 30 seconds after power up)Slow Advertising Mode (>30s since power up)Connected Mode (using the UART profile in this case)

Test Conditions

The board was powered from a fully charged 1200mAh 4.2V LIPO (http://adafru.it/dyW) cell running at 4.2V. Power efficiency will generallyincrease as the LIPO battery voltage drops, so 4.2V should be considered a worst case scenario.

Power Supply: 1200mAh 4.2V LIPO Cell (at 4.2V)Firmware: 0.6.2

Fast Advertising Mode

The first 30 seconds that the Bluefruit LE UART Friend is powered up it will enter 'Fast Advertising Mode', which sends an advertising packet onceevery 100ms.

Average Current: 1.44mAPeak Current: 13.5mAExpected Battery Life: 832 hours (~34.6 days)

The MODE LEDs can be seen blinking in regular intervals as the three rectangular bumps at the bottom of the chart.

Slow Advertising Mode

After 30 seconds the Bluefruit LE UART Friend will enter 'Slow Advertising Mode', which sends an advertising packet once every 546.25ms.

Average Current: 1.25mAPeak Current: 13.5mAExpected Battery Life: 956 hours (~40 days)


Page 22 of 115


Connected Mode (UART)

The following measurements illustrate the average current draw in connected mode (with the connected LED enabled). UART mode was used asa test case.

Average Current: 1.86mAPeak Current: 15.2mAExpected Battery Life: 645 hours (~26.8 days)


Page 23 of 115

SoftwareIn order to try out our demos, you'll need to download the Adafruit BLE library for the nRF51 based modules such as this one (a.k.a.Adafruit_BluefruitLE_nRF51)

You can check out the code here at github, (http://adafru.it/f4V) but its likely easier to just download by clicking:

Download Adafruit_BluefruitLE_nRF51http://adafru.it/f4W

Rename the uncompressed folder Adafruit_BluefruitLE_nRF51 and check that the Adafruit_BluefruitLE_nRF51 folder containsAdafruit_BLE.cpp and Adafruit_BLE.h (as well as a bunch of other files)

Place the Adafruit_BluefruitLE_nRF51 library folder your arduinosketchfolder/libraries/ folder. You may need to create the libraries subfolder if its your first library. Restart the IDE.

We also have a great tutorial on Arduino library installation at:http://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use (http://adafru.it/aYM)

After restarting, check that you see the library folder with examples:


Page 24 of 115

https://github.com/adafruit/Adafruit_BluefruitLE_nRF51

https://github.com/adafruit/Adafruit_BluefruitLE_nRF51/archive/master.zip

http://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use

Configuration!Before you start uploading any of the example sketches, you'll need to CONFIGURE the Bluefruit interface - there's a lot of options so pay closeattention!

Which board do you have?There's a few products under the Bluefruit name:

If you are using the Bluefruit LE Shield then you have an SPI-connected NRF51822module. You can use this with Atmega328 (Arduino UNO or compatible), ATmega32u4(Arduino Leonardo, compatible) or ATSAMD21 (Arduino Zero, compatible) and possiblyothers. Your pinouts are Hardware SPI, CS = 8, IRQ = 7, RST = 4

Bluefruit Micro or Feather 32u4 Bluefruit

If you have a Bluefruit Micro or Feather 32u4 Bluefruit LE then you have anATmega32u4 chip with Hardware SPI, CS = 8, IRQ = 7, RST = 4

Feather M0 Bluefruit LE

If you have a Feather M0 Bluefruit LE then you have an ATSAMD21 chip with HardwareSPI, CS = 8, IRQ = 7, RST = 4


Page 25 of 115




Bluefruit LE SPI Friend

If you have a stand-alone module, you have a bit of flexibility with wiring however westrongly recommend Hardware SPI, CS = 8, IRQ = 7, RST = 4

You can use this with just about any microcontroller with 5 or 6 pins

Bluefruit LE UART Friend or Flora BLE

If you have a stand-alone UART module you have some flexibility with wiring. Howeverwe suggest hardware UART if possible. You will likely need to use the flow control CTSpin if you are not using hardware UART. There's also a MODE pin

You can use this with just about any microcontroller with at least 3 pins, but best usedwith a Hardware Serial/UART capable chip!

Configure the Pins UsedYou'll want to check the Bluefruit Config to set up the pins you'll be using for UART or SPI

Each example sketch has a secondary tab with configuration details. You'll want to edit and save the sketch to your own documents folder onceset up.


Page 26 of 115




Common settings:

You can set up how much RAM to set aside for a communication buffer and whether you want to have full debug output. Debug output is 'noisy' onthe serial console but is handy since you can see all communication between the micro and the BLE

// ----------------------------------------------------------------------------------------------// These settings are used in both SW UART, HW UART and SPI mode// ----------------------------------------------------------------------------------------------#define BUFSIZE 128 // Size of the read buffer for incoming data#define VERBOSE_MODE true // If set to 'true' enables debug output

Software UART

If you are using Software UART, you can set up which pins are going to be used for RX, TX, and CTS flow control. Some microcontrollers arelimited on which pins can be used! Check the SoftwareSerial library documentation for more details

// SOFTWARE UART SETTINGS#define BLUEFRUIT_SWUART_RXD_PIN 9 // Required for software serial!#define BLUEFRUIT_SWUART_TXD_PIN 10 // Required for software serial!#define BLUEFRUIT_UART_CTS_PIN 11 // Required for software serial!#define BLUEFRUIT_UART_RTS_PIN -1 // Optional, set to -1 if unused

Hardware UART

If you have Hardware Serial, there's a 'name' for it, usually Serial1 - you can set that up here:

// HARDWARE UART SETTINGS#ifdef Serial1 // this makes it not complain on compilation if there's no Serial1 #define BLUEFRUIT_HWSERIAL_NAME Serial1#endif

Mode Pin

For both hardware and software serial, you will likely want to define the MODE pin. There's a few sketches that dont use it, instead depending oncommands to set/unset the mode. Its best to use the MODE pin if you have a GPIO to spare!

#define BLUEFRUIT_UART_MODE_PIN 12 // Set to -1 if unused

SPI Pins

For both Hardware and Software SPI, you'll want to set the CS (chip select) line, IRQ (interrupt request) line and if you have a pin to spare, RST(Reset)

// SHARED SPI SETTINGS#define BLUEFRUIT_SPI_CS 8#define BLUEFRUIT_SPI_IRQ 7#define BLUEFRUIT_SPI_RST 4 // Optional but recommended, set to -1 if unused

Software SPI Pins

If you don't have a hardware SPI port available, you can use any three pins...its a tad slower but very flexible

// SOFTWARE SPI SETTINGS#define BLUEFRUIT_SPI_SCK 13#define BLUEFRUIT_SPI_MISO 12#define BLUEFRUIT_SPI_MOSI 11

Refer to the table above to determine whether you have SPI or UART controlled Bluefruits!

Select the Serial BusOnce you've configured your pin setup in the BluefruitConfig.h file, you can now check and adapt the example sketch.

The Adafruit_BluefruitLE_nRF51 library supports four different serial bus options, depending on the HW you are using: SPI both hardware andsoftware type, and UART both hardware and software type.

UART Based Boards (Bluefruit LE UART Friend & Flora BLE)

This is for Bluefruit LE UART Friend & Flora BLE boards. You can use either software serial or hardware serial. Hardware serial is higher quality,and less risky with respect to losing data. However, you may not have hardware serial available! Software serial does work just fine with flow-


Page 27 of 115

control and we do have that available at the cost of a single GPIO pin.

For software serial (Arduino Uno, Adafruit Metro) you should uncomment the software serial contructor below, and make sure the other threeoptions (hardware serial & SPI) are commented out.

// Create the bluefruit object, either software serial...uncomment these linesSoftwareSerial bluefruitSS = SoftwareSerial(BLUEFRUIT_SWUART_TXD_PIN, BLUEFRUIT_SWUART_RXD_PIN);

Adafruit_BluefruitLE_UART ble(bluefruitSS, BLUEFRUIT_UART_MODE_PIN, BLUEFRUIT_UART_CTS_PIN, BLUEFRUIT_UART_RTS_PIN);

For boards that require hardware serial (Adafruit Flora, etc.), uncomment the hardware serial constructor, and make sure the other three optionsare commented out

/* ...or hardware serial, which does not need the RTS/CTS pins. Uncomment this line */Adafruit_BluefruitLE_UART ble(BLUEFRUIT_HWSERIAL_NAME, BLUEFRUIT_UART_MODE_PIN);

SPI Based Boards (Bluefruit LE SPI Friend)

For SPI based boards, you should uncomment the hardware SPI constructor below, making sure the other constructors are commented out:

/* ...hardware SPI, using SCK/MOSI/MISO hardware SPI pins and then user selected CS/IRQ/RST */Adafruit_BluefruitLE_SPI ble(BLUEFRUIT_SPI_CS, BLUEFRUIT_SPI_IRQ, BLUEFRUIT_SPI_RST);

If for some reason you can't use HW SPI, you can switch to software mode to bit-bang the SPI transfers via the following constructor:

/* ...software SPI, using SCK/MOSI/MISO user-defined SPI pins and then user selected CS/IRQ/RST */Adafruit_BluefruitLE_SPI ble(BLUEFRUIT_SPI_SCK, BLUEFRUIT_SPI_MISO, BLUEFRUIT_SPI_MOSI, BLUEFRUIT_SPI_CS, BLUEFRUIT_SPI_IRQ, BLUEFRUIT_SPI_RST);


Page 28 of 115

ATCommandThe ATCommand example allows you to execute AT commands from your sketch, and see the results in the Serial Monitor. This can be usefulfor debugging, or just testing different commands out to see how they work in the real world. It's a good one to start with!

Opening the SketchTo open the ATCommand sketch, click on the File > Examples > Adafruit_BluefruitLE_nRF51 folder in the Arduino IDE and select atcommand:

This will open up a new instance of the example in the IDE, as shown below:

ConfigurationCheck the Configuration! page earlier to set up the sketch for Software/Hardware UART or Software/Hardware SPI. The default is hardware SPI

If using software or hardware Serial UART:

This tutorial does not need to use the MODE pin, make sure you have the mode switch in CMD mode if you do not configure & connect a


Page 29 of 115

MODE pinDon't forget to also connect the CTS pin on the Bluefruit to ground if you are not using it! (The Flora has this already done)

Running the SketchOnce you upload the sketch to your board (via the arrow-shaped upload icon), and the upload process has finished, open up the Serial Monitorvia Tools > Serial Monitor, and make sure that the baud rate in the lower right-hand corner is set to 115200:

To send an AT command to the Bluefruit LE module, enter the command in the textbox at the top of the Serial Monitor and click the Send button:

The response to the AT command will be displayed in the main part of the Serial Monitor. The response from 'ATI' is shown below:


Page 30 of 115

You can do pretty much anything at this prompt, with the AT command set. Try AT+HELP to get a list of all commands, and try out ones likeAT+HWGETDIETEMP (get temperature at the nRF51822 die) and AT+HWRANDOM (generate a random number)


Page 31 of 115

BLEUartThe BLEUart example sketch allows you to send and receive text data between the Arduino and a connected Bluetooth Low Energy Centraldevice on the other end (such as you mobile phone using the Adafruit Bluefruit LE Connect application for Android (http://adafru.it/f4G) oriOS (http://adafru.it/f4H) in UART mode).

Opening the SketchTo open the ATCommand sketch, click on the File > Examples > Adafruit_BluefruitLE_nRF51 folder in the Arduino IDE and selectbleuart_cmdmode:




Page 32 of 115




This tutorial does not need to use the MODE pin, make sure you have the mode switch in CMD mode if you do not configure & connect aMODE pinDon't forget to also connect the CTS pin on the Bluefruit to ground if you are not using it! (The Flora has this already done)


Once you see the request, use the App to connect to the Bluefruit LE module in UART mode so you get the text box on your phone

Any text that you type in the box at the top of the Serial Monitor will be sent to the connected phone, and any data sent from the phone will bedisplayed in the serial monitor:


Page 33 of 115

You can see the incoming string here in the Adafruit Bluefruit LE Connect app below (iOS in this case):


Page 34 of 115

The response text ('Why hello, Arduino!') can be seen below:


Page 35 of 115


Page 36 of 115

HIDKeyboardThe HIDKeyboard example shows you how you can use the built-in HID keyboard AT commands to send keyboard data to any BLE-enabledAndroid or iOS phone, or other device that supports BLE HID peripherals.

Opening the SketchTo open the ATCommand sketch, click on the File > Examples > Adafruit_BluefruitLE_nRF51 folder in the Arduino IDE and selecthidkeyboard:





Page 37 of 115

This tutorial does not need to use the MODE pin, make sure you have the mode switch in CMD mode!Don't forget to also connect the CTS pin on the Bluefruit to ground if you are not using it! (The Flora has this already done)


To send keyboard data, type anything into the textbox at the top of the Serial Monitor and click the Send button.

Bonding the HID KeyboardBefore you can use the HID keyboard, you will need to 'bond' it to your phone or PC. The bonding process establishes a permanent connectionbetween the two devices, meaning that as soon as your phone or PC sees the Bluefruit LE module again it will automatically connect.

The exact procedures for bonding the keyboard will varying from one platform to another.

When you no longer need a bond, or wish to bond the Bluefruit LE module to another device, be sure to delete the bonding information on thephone or PC, otherwise you may not be able to connect on a new device!


Page 38 of 115

AndroidTo bond the keyboard on a Bluetooth Low Energy enabled Android device, go to the Settings application and click the Bluetooth icon.

These screenshots are based on Android 5.0 running on a Nexus 7 2013. The exact appearance may vary depending on your device and OSversion.

Inside the Bluetooth setting panel you should see the Bluefruit LE module advertising itself as Bluefruit Keyboard under the 'Available devices'list:

Tapping the device will start the bonding process, which should end with the Bluefruit Keyboard device being moved to a new 'Paired devices' listwith 'Connected' written underneath the device name:

To delete the bonding information, click the gear icon to the right of the device name and the click the Forget button:


Page 39 of 115

iOSTo bond the keyboard on an iOS device, go to the Settings application on your phone, and click the Bluetooth menu item.

The keyboard should appear under the OTHER DEVICES list:


Page 40 of 115

Once the bonding process is complete the device will be moved to the MY DEVICES category, and you can start to use the Bluefruit LE module asa keyboard:

To unbond the device, click the 'info' icon and then select the Forget this Device option in the menu:

OS XTo bond the keyboard on an OS X device, go to the Bluetooth Preferences window and click the Pair button beside the Bluefruit Keyboarddevice generated by this example sketch:


Page 41 of 115

To unbond the device once it has been paired, click the small 'x' icon beside Bluefruit Keyboard:

... and then click the Remove button when the confirmation dialogue box pops up:


Page 42 of 115

ControllerThe Controller sketch allows you to turn your BLE-enabled iOS or Android device in a hand-held controller or an external data source, takingadvantage of the wealth of sensors on your phone or tablet.

You can take accelerometer or quaternion data from your phone, and push it out to your Arduino via BLE, or get the latest GPS co-ordinates foryour device without having to purchase (or power!) any external HW.

Opening the SketchTo open the Controller sketch, click on the File > Examples > Adafruit_BluefruitLE_nRF51 folder in the Arduino IDE and select controller:




Page 43 of 115


This tutorial will also be easier to use if you wire up the MODE pin, you can use any pin but our tutorial has pin 12 by default. You can changethis to any pin. If you do not set the MODE pin then make sure you have the mode switch in CMD modeIf you are using a Flora or otherwise don't want to wire up the Mode pin, set the BLUEFRUIT_UART_MODE_PIN to -1 in the configurationtab so that the sketch will use the +++ method to switch between Command and Data mode!Don't forget to also connect the CTS pin on the Bluefruit to ground if you are not using it! (The Flora has this already done)


Using Bluefruit LE Connect in Controller ModeOnce the sketch is running you can open Adafruit's Bluefruit LE Connect application (available for Android (http://adafru.it/f4G) oriOS (http://adafru.it/f4H)) and use the Controller application to interact with the sketch. (If you're new to Bluefruit LE Connect, have a look at ourdedicated Bluefruit LE Connect learning guide (http://adafru.it/iCm).)

On the welcome screen, select the Adafruit Bluefruit LE device from the list of BLE devices in range:

Then from the activity list select Controller:


Page 44 of 115



This will bring up a list of data points you can send from your phone or tablet to your Bluefruit LE module, by enabling or disabling the appropriatesensor(s).

Streaming Sensor DataYou can take Quaternion (absolute orientation), Accelerometer, Gyroscope, Magnetometer or GPS Location data from your phone and send itdirectly to your Arduino from the Controller activity.

By enabling the Accelerometer field, for example, you should see accelerometer data update in the app:

The data is parsed in the example sketch and output to the Serial Monitor as follows:

Accel 0.20 -0.51 -0.76Accel 0.22 -0.50 -0.83


Page 45 of 115

Accel 0.25 -0.51 -0.83Accel 0.21 -0.47 -0.76Accel 0.27 -0.48 -0.82

Note that even though we only print 2 decimal points, the values are received from the App as a full 4-byte floating point.

Control Pad ModuleYou can also use the Control Pad Module to capture button presses and releases by selecting the appropriate menu item:

This will bring up the Control Pad panel, shown below:

Button presses and releases will all be logged to the Serial Monitor with the ID of the button used:

Button 8 pressedButton 8 releasedButton 3 pressedButton 3 released


Page 46 of 115

Color Picker ModuleYou can also send RGB color data via the Color Picker module, which presents the following color selection dialogue:

This will give you Hexadecimal color data in the following format:

RGB #A42FFF

You can combine the color picker and controller sample sketches to make color-configurable animations triggered by buttons in the mobile app--very handy for wearables! Download this combined sample code (configured for Feather but easy to adapt to FLORA, BLE Micro, etc.) to getstarted:


Page 47 of 115

feather_bluefruit_neopixel_animation_controller.ziphttp://adafru.it/kzF


Page 48 of 115

https://learn.adafruit.com/system/assets/assets/000/029/260/original/feather_bluefruit_neopixel_animation_controller.zip?1450791688

HeartRateMonitorThe HeartRateMonitor example allows you to define a new GATT Service and associated GATT Characteristics, and update the characteristicvalues using standard AT commands.

Opening the SketchTo open the ATCommand sketch, click on the File > Examples > Adafruit_BluefruitLE_nRF51 folder in the Arduino IDE and selectheartratemonitor:


Configuration


Page 49 of 115

Check the Configuration! page earlier to set up the sketch for Software/Hardware UART or Software/Hardware SPI. The default is hardware SPI

If Using Hardware or Software UART

This tutorial does not need to use the MODE pin, make sure you have the mode switch in CMD mode if you do not configure & connect aMODE pin

This demo uses some long data transfer strings, so we recommend defining and connecting both CTS and RTS to pins, even if you are usinghardware serial.

If you are using a Flora or just dont want to connect CTS or RTS, set the pin #define's to -1 and Don't forget to also connect the CTS pin on theBluefruit to ground! (The Flora has this already done)

If you are using RTS and CTS, you can remove this line below, which will slow down the data transmission

// this line is particularly required for Flora, but is a good idea // anyways for the super long lines ahead! ble.setInterCharWriteDelay(5); // 5 ms



Page 50 of 115

If you open up an application on your mobile device or laptop that support the standard Heart Rate Monitor Service (http://adafru.it/f4I), you shouldbe able to see the heart rate being updated in sync with the changes seen in the Serial Monitor:

nRF Toolbox HRM ExampleThe image below is a screenshot from the free nRF Toolbox (http://adafru.it/e9M) application from Nordic on Android (also available oniOS (http://adafru.it/f4J)), showing the incoming Heart Rate Monitor data:


Page 51 of 115

https://developer.bluetooth.org/TechnologyOverview/Pages/HRS.aspx

https://play.google.com/store/apps/details?id=no.nordicsemi.android.nrftoolbox&hl=en

https://itunes.apple.com/app/nrf-toolbox/id820906058?mt=8

CoreBluetooth HRM ExampleThe image below is from a freely available CoreBluetooth sample application (http://adafru.it/f4K) from Apple showing how to work with BluetoothLow Energy services and characteristics:


Page 52 of 115

https://developer.apple.com/library/mac/samplecode/HeartRateMonitor/Introduction/Intro.html


Page 53 of 115

UriBeaconThe UriBeacon example shows you how to use the built-in UriBeacon AT commands to configure the Bluefruit LE module as a UriBeaconadvertiser, following Google's Physical Web UriBeacon (http://adafru.it/edk) specification.

Opening the SketchTo open the ATCommand sketch, click on the File > Examples > Adafruit_BluefruitLE_nRF51 folder in the Arduino IDE and select uribeacon:

This will open up a new instance of the example in the IDE, as shown below. You can edit the URL that the beacon will point to, from the defaulthttp://www.adafruit.com or just upload as is to test




Page 54 of 115

https://github.com/google/uribeacon

This tutorial does not need to use the MODE pin, make sure you have the mode switch in CMD mode if you do not configure & connect aMODE pinDon't forget to also connect the CTS pin on the Bluefruit to ground if you are not using it! (The Flora has this already done)


At this point you can open the Physical Web Application for Android (http://adafru.it/edi) or for iOS (http://adafru.it/edj), and you should see a linkadvertising Adafruit's website:


Page 55 of 115

https://play.google.com/store/apps/details?id=physical_web.org.physicalweb

https://itunes.apple.com/us/app/physical-web/id927653608?mt=8

HALP!When using the Bluefruit Micro or a Bluefruit LE with Flora/Due/Leonardo/Micro the examples dont run?

We add a special line to setup() to make it so the Arduino will halt until it sees you've connected over the Serial console. This makes debugginggreat but makes it so you cannot run the program disconnected from a computer.

Solution? Once you are done debugging, remove these two lines from setup()

while (!Serial); delay(500);

I can't seem to "Find" the Bluefruit LE!

Getting something like this?

For UART/Serial Bluefruits:

Check you have the MODE switch in CMD and the MODE pin not wired to anything if it isnt used!If you are trying to control the MODE from your micro, make sure you set the MODE pin in the sketchMake sure you have RXI and TXO wired right! They are often swapped by accidentMake sure CTS is tied to GND if you are using hardware serial and not using CTSCheck the MODE red LED, is it blinking? If its blinking continuously, you might be in DFU mode, power cycle the module!If you are using Hardware Serial/Software Serial make sure you know which one and have that set up

If using SPI Bluefruit:

Make sure you have all 5 (or 6) wires connected properly.If using hardware SPI, you need to make sure you're connected to the hardware SPI port, which differs depending on the main chipset.

If using Bluefruit Micro:

Make sure you change the RESET pin to #4 in any Config file. Also be sure you are using hardware SPI to connect!


Page 56 of 115

Data ModeBy placing the BLEFriend module in 'UART Data' mode (set the mode selection switch to UART or setting the MODE pin to gound) you can usethe module as a 'tranparent UART connection' to the Bluefruit app. This makes data transfer super simple. Data is sent to the app when any 9600baud data is received on the RXI pin and any data from the app is automatically transmitted via the TXO pin

In order to keep from overloading your microcontroller, you can use the flow control pins. Keep the CTS pin high until you're ready for more data,then ground it to let the Bluefruit module know you're ready for more data!

This mode uses hardware flow control! You must set the CTS pin to ground in order to enable the TXO pin, so if you're wondering why its notsending data, check that CTS is being used right!

You can determine if you are in Data Mode by looking at the mode LED. It should blink two times followed by a three second pause, as shownbelow:

You can then connect the the app in UART mode and send/receive data transparently


Page 57 of 115

Switching Command/Data Mode via +++On either side of the connection (via the Arduino Uno or in your mobile app), you can dynamically switch between command and data mode bysending the "+++\n" string, as detailed in the +++ command summary (http://adafru.it/iCN).

If you start in data mode, you can send text for example, with "+++\nATI\n+++\n", which will cause the Bluefruit LE module to switch to commandmode, execute the ATI command, and then switch back to data mode.

The +++ command can be sent from either side, making it possible to execute commands from the mobile application as well as on the Bluefruit LEside.

# Start in Data Mode


Page 58 of 115

> Hello, World! Data mode! # Send command to switch modes> +++ # Bluefruit LE module switches to CMD mode# Send ATI command and wait for the response> ATI< BLEFRIEND< nRF51822 QFAAG00< B122AAC33F3D2296< 0.6.2< 0.6.2< May 01 2015< OK # Switch back to DATA mode> +++< OK # We're back in data mode nowWelcome back!


Page 59 of 115

Command ModeBy placing the BLEFriend module in 'Command' mode (set the mode selection switch to CMD or setting the MODE pin to a high voltage) you canenter a variety of Hayes AT style commands to configure the device or retrieve basic information about the module of BLE connection.

In order to keep from overloading your microcontroller, you can use the flow control pins. Keep the CTS pin high until you're ready for more data,then ground it to let the Bluefruit module know you're ready for more data!

This mode uses hardware flow control! You must set the CTS pin to ground in order to enable the TXO pin, so if you're wondering why its notresponding to commands, check that CTS is being used right!

You can determine if you are in Command Mode by looking at the mode LED. It should blink three times followed by a three second pause, asshown below:

Hayes/AT CommandsWhen operating in command mode, the Bluefruit LE Pro modules use a Hayes AT-style command set (http://adafru.it/ebJ)to configure the device.

The advantage of an AT style command set is that it's easy to use in machine to machine communication, while still being somewhat user friendlyfor humans.

Test Command Mode '=?''Test' mode is used to check whether or not the specified command exists on the system or not.

Certain firmware versions or configurations may or may not include a specific command, and you can determine if the command is present bytaking the command name and appending '=?' to it, as shown below

AT+BLESTARTADV=?

If the command is present, the device will reply with 'OK'. If the command is not present, the device will reply with 'ERROR'.

AT+BLESTARTADV=?OK\r\nAT+MISSINGCMD=?ERROR\r\n

Write Command Mode '=xxx''Write' mode is used to assign specific value(s) to the command, such as changing the radio's transmit power level using the command we usedabove.

To write a value to the command, simple append an '=' sign to the command followed by any paramater(s) you wish to write (other than a lone '?'character which will be interpretted as tet mode):

AT+BLEPOWERLEVEL=-8

If the write was successful, you will generally get an 'OK' response on a new line, as shown below:

AT+BLEPOWERLEVEL=-8OK\r\n

If there was a problem with the command (such as an invalid parameter) you will get an 'ERROR' response on a new line, as shown below:

AT+BLEPOWERLEVEL=3ERROR\r\n

Note: This particular error was generated because '3' is not a valid value for the AT+BLEPOWERLEVEL command. Entering '-4', '0' or '4' would


Page 60 of 115

http://en.wikipedia.org/wiki/Hayes_command_set

succeed since these are all valid values for this command.

Execute Mode'Execute' mode will cause the specific command to 'run', if possible, and will be used when the command name is entered with no additionalparameters.

AT+FACTORYRESET

You might use execute mode to perform a factory reset, for example, by executing the AT+FACTORYRESET command as follows:

AT+FACTORYRESETOK\r\n

NOTE: Many commands that are means to be read will perform the same action whether they are sent to the command parser in 'execute' or'read' mode. For example, the following commands will produce identical results:

AT+BLEGETPOWERLEVEL-4\r\nOK\r\nAT+BLEGETPOWERLEVEL?-4\r\nOK\r\n

If the command doesn't support execute mode, the response will normally be 'ERROR' on a new line.

Read Command Mode '?''Read' mode is used to read the current value of a command.

Not every command supports read mode, but you generally use this to retrieve information like the current transmit power level for the radio byappending a '?' to the command, as shown below:

AT+BLEPOWERLEVEL?

If the command doesn't support read mode or if there was a problem with the request, you will normally get an 'ERROR' response.

If the command read was successful, you will normally get the read results followed by 'OK' on a new line, as shown below:

AT+BLEPOWERLEVEL?-4\r\nOK\r\n

Note: For simple commands, 'Read' mode and 'Execute' mode behave identically.

Dynamically Switching Modes via +++When operating in Command Mode you can dynamically switch to Data Mode (and back again) in software via the +++command (http://adafru.it/iCN). See the full command description for details.


Page 61 of 115

Standard ATThe following standard Hayes/AT commands are available on Bluefruit LE modules:

ATActs as a ping to check if we are in command mode. If we are in command mode, we should receive the 'OK' response.

Codebase Revision: 0.3.0

Parameters: None

Output: None

ATOK

ATIDisplays basic information about the Bluefruit module.


Parameters: None

Output: Displays the following values:

Board NameMicrocontroller/Radio SoC NameUnique Serial NumberCore Bluefruit Codebase RevisionProject Firmware RevisionFirmware Build DateSoftdevice, Softdevice Version, Bootloader Version (0.5.0+)

ATIBLEFRIENDnRF51822 QFAAG00FB462DF92A2C86560.5.00.5.0Feb 24 2015S110 7.1.0, 0.0OK

Updates:

Version 0.4.7+ of the firmware adds the chip revision after the chip name if it can be detected (ex. 'nRF51822 QFAAG00').Version 0.5.0+ of the firmware adds a new 7th record containing the softdevice, softdevice version and bootloader version (ex. 'S110 7.1.0,0.0').

ATZPerforms a system reset.


Parameters: None

Output: None

ATZOK

ATE


Page 62 of 115

Enables or disables echo of input characters with the AT parser


Parameters: '1' = enable echo, '0' = disable echo

Output: None

# Disable echo supportATE=0OK#Enable echo supportATE=1OK

+++Dynamically switches between DATA and COMMAND mode without changing the physical CMD/UART select switch.

When you are in COMMAND mode, entering '+++\n' or '+++\r\n' will cause the module to switch to DATA mode, and anything typed into theconsole will go direct to the BLUE UART service.

To switch from DATA mode back to COMMAND mode, simply enter '+++\n' or '+++\r\n' again (be sure to include the new line character!), and anew 'OK' response will be displayed letting you know that you are back in COMMAND mode (see the two 'OK' entries in the sample code below).


Parameters: None

Output: None

Note that +++ can also be used on the mobile device to send and receive AT command on iOS or Android, though this should always be used withcare.See the AT+MODESWITCHEN command to control the availability of the +++ command

ATIBLEFRIENDnRF51822 QFAAG00B122AAC33F3D22960.4.60.4.6Dec 22 2014OK+++OKOK


Page 63 of 115

General PurposeThe following general purpose commands are available on all Bluefruit LE modules:

AT+FACTORYRESETClears any user config data from non-volatile memory and performs a factory reset before resetting the Bluefruit module.


Parameters: None

Output: None

AT+FACTORYRESETOK

As of version 0.5.0+ of the firmware, you can perform a factory reset by holding the DFU button down for 10s until the blue CONNECTED LEDlights up, and then releasing the button.

AT+DFUForces the module into DFU mode, allowing over the air firmware updates using a dedicated DFU app on iOS or Android.


Parameters: None

Output: None

The AT parser will no longer responsd after the AT+DFU command is entered, since normal program execution effectively halts and a full systemreset is performed to start the bootloader code

AT+DFUOK

AT+HELPDisplays a comma-separated list of all AT parser commands available on the system.

Codebase Version: 0.3.0

Parameters: None

Output: A comma-separated list of all AT parser commands available on the system.

The sample code below may not match future firmware releases and is provided for illustration purposes only

AT+HELPAT+FACTORYRESET,AT+DFU,ATZ,ATI,ATE,AT+DBGMEMRD,AT+DBGNVMRD,AT+HWLEDPOLARITY,AT+HWLED,AT+HWGETDIETEMP,AT+HWMODEPINPOLARITY,AT+HWMODEPIN,AT+HWGPIOMODE,AT+HWGPIO,AT+HWI2CSCAN,AT+HWADC,AT+HWVBAT,AT+HWPWM,AT+HWPWRDN,AT+BLEPOWERLEVEL,AT+BLEGETADDRTYPE,AT+BLEGETADDR,AT+BLEBEACON,AT+BLEGETRSSI,AT+GAPGETCONN,AT+GAPDISCONNECT,AT+GAPDEVNAME,AT+GAPDELBONDS,AT+GAPINTERVALS,AT+GAPSTARTADV,AT+GAPSTOPADV,AT+GAPAUTOADV,AT+GAPSETADVDATA,AT+BLEUARTTX,AT+BLEUARTRX,AT+GATTADDSERVICE,AT+GATTADDCHAR,AT+GATTCHAR,AT+GATTLIST,AT+GATTCLEAR,AT+HELPOK

AT+NVMWRITEWrites data to the 256 byte user non-volatile memory (NVM) region.


Parameters:

offset: The numeric offset for the first byte from the starting position in the user NVMdatatype: Which can be one of STRING (1), BYTEARRAY (2) or INTEGER (3)data: The data to write to NVM memory (the exact payload format will change based on the specified datatype).

Output: Nothing

# Write 32768 as an integer starting at byte 16 in user NVM


Page 64 of 115

AT+NVMWRITE=16,INTEGER,32768OK

AT+NVMREADReads data from the 256 byte user non-volatile memory (NVM) region.


Parameters:

offset: The numeric offset for the first byte from the starting position in the user NVMsize: The number of bytes to readdatatype: The type used for the data being read, which is required to properly parse the data and display it as a response. The value can beone of STRING (1), BYTEARRAY (2) or INTEGER (3)

Output: The data read back, formatted based on the datatype argument.

# Read an integer back from position 16 in user NVMAT+NVMREAD=16, 4, INTEGER32768OK

AT+MODESWITCHENEnables or disables mode switches via the '+++' command on the BLE peripheral of BLE UART side of the connection.


Parameters:

location: This can be a string, either 'local' or 'ble' indicating which side should have the '+++' command enabled or disabled, 'local' beingthe Bluefruit peripheral and 'ble' being the phone or tablet.state: '0' to disable '+++' mode switches, '1' to enable them.

Output: None

By default, '+++' is enabled locally, and disabled in BLE

# Disable reomte '+++' mode switchesAT+MODESWITCHEN=ble,0OK


Page 65 of 115

HardwareThe following commands allow you to interact with the low level HW on the Bluefruit LE module, such as reading or toggling the GPIO pins,performing an ADC conversion ,etc.:

AT+BAUDRATEChanges the baud rate used by the HW UART peripheral on the nRF51822.


Parameters: Baud rate, which must be one of the following values:

12002400480096001440019200288003840057600768001152002304002500004608009216001000000

Output: The current baud rate

# Set the baud rate to 115200AT+BAUDRATE=115200OK

# Check the current baud rateAT+BAUDRATE115200OK

AT+HWADCPerforms an ADC conversion on the specified ADC pin


Parameters: The ADC channel (0..7)

Output: The results of the ADC conversion

AT+HWADC=0178OK

AT+HWGETDIETEMPGets the temperature in degree celcius of the BLE module's die. This can be used for debug purposes (higher die temperature generally meanshigher current consumption), but does not corresponds to ambient temperature and can nto be used as a replacement for a normal temperaturesensor.


Parameters: None

Output: The die temperature in degrees celcius


Page 66 of 115

AT+HWGETDIETEMP32.25OK

AT+HWGPIOGets or sets the value of the specified GPIO pin (depending on the pin's mode).


Parameters: The parameters for this command change depending on the pin mode.

OUTPUT MODE: The following comma-separated parameters can be used when updating a pin that is set as an output:

Pin numbersPin state, where:

0 = clear the pin (logic low/GND)1 = set the pin (logic high/VCC)

INPUT MODE: To read the current state of an input pin or a pin that has been configured as an output, enter the pin number as a singleparameter.

Output: The pin state if you are reading an input or checking the state of an input pin (meaning only 1 parameter is supplied, the pin number),where:

0 means the pin is logic low/GND1 means the pin is logic high/VCC

Trying to set the value of a pin that has not been configured as an output will produce an 'ERROR' response.Some pins are reserved for specific functions on Bluefruit modules and can not be used as GPIO. If you try to make use of a reserved pin numberan 'ERROR' response will be generated.

# Set pin 14 HIGHAT+HWGPIO=14,1OK # Set pin 14 LOWAT+HWGPIO=14,0OK # Read the current state of pin 14AT+HWGPIO=140OK # Try to update a pin that is not set as an outputAT+HWGPIOMODE=14,0OKAT+HWGPIO=14,1ERROR

AT+HWGPIOMODEThis will set the mode for the specified GPIO pin (input, output, etc.).


Parameters: This command one or two values (comma-separated in the case of two parameters being used):

The pin numberThe new GPIO mode, where:

0 = Input1 = Output2 = Input with pullup enabled3 = Input with pulldown enabled

Output: If a single parameters is passed (the GPIO pin number) the current pin mode will be returned.

Some pins are reserved for specific functions on Bluefruit modules and can not be used as GPIO. If you try to make use of a reserved pin numberan 'ERROR' response will be generated.

# Configure pin 14 as an outputAT+HWGPIOMODE=14,0


Page 67 of 115

OK

# Get the current mode for pin 14AT+HWPGIOMODE=140OK

AT+HWI2CSCANScans the I2C bus to try to detect any connected I2C devices, and returns the address of devices that were found during the scan process.


Parameters: None

Output: A comma-separated list of any I2C address that were found while scanning the valid address range on the I2C bus, or nothing is nodevices were found.

# I2C scan with two devices detectedAT+HWI2CSCAN0x23,0x35OK

# I2C scan with no devices detectedAT+HWI2CSCANOK

AT+HWVBATReturns the main power supply voltage level in millivolts


Parameters: None

Output: The VBAT level in millivolts

AT+HWVBAT3248OK

AT+HWRANDOMGenerates a random 32-bit number using the HW random number generator on the nRF51822 (based on white noise).


Parameters: None

Output: A random 32-bit hexadecimal value (ex. '0x12345678')

AT+HWRANDOM0x769ED823OK

AT+HWMODELEDAllows you to override the default behaviour of the MODE led (which indicates the operating mode by default).


Parameters: LED operating mode, which can be one of the following values:

disable or DISABLE or 0 - Disable the MODE LED entirely to save powermode or MODE or 1 - Default behaviour, indicates the current operating modehwuart or HWUART or 2 - Toggles the LED on any activity on the HW UART bus (TX or RX)bleuart or BLEUART or 3 - Toggles the LED on any activity on the BLE UART Service (TX or RX characteristic)spi or SPI or 4 - Toggles the LED on any SPI activitymanual or MANUAL or 5 - Manually sets the state of the MODE LED via a second comma-separated parameter, which can be on, off,or toggle.


Page 68 of 115

Output: If run with no parameters, returns an upper-case string representing the current MODE LED operating mode from the fields above

# Get the curent MODE LED settingAT+HWMODELEDMODEOK # Change the MODE LED to indicate BLE UART activityAT+HWMODELED=BLEUARTOK

# Manually toggle the MODE LEDAT+HWMODELED=MANUAL,TOGGLEOK

AT+UARTFLOWEnables or disable hardware flow control (CTS + RTS) on the UART peripheral block of the nRF51822.


Parameters: HW flow control state, which can be one of:

onoff01

Output: If run with no parameters, returns a number representing whether flow control is enabled (1) or disabled (0).

# Check the current flow control stateAT+UARTFLOW1OK

# Disable HW flow controlAT+UARTFLOW=offOK


Page 69 of 115

BeaconAdafruit's Bluefruit LE modules currently support the following 'Beacon' technologies:

Beacon (Apple) via AT+BLEBEACONUriBeacon (Google) via AT+BLEURIBEACON (deprecated)Eddystone (Google) via AT+EDDYSTONE*

Modules can be configured to act as 'Beacons' using the following commands:

AT+BLEBEACONCodebase Revision: 0.3.0

Parameters: The following comma-separated parameters are required to enable beacon mode:

Bluetooth Manufacturer ID (uint16_t)128-bit UUIDMajor Value (uint16_t)Minor Value (uint16_t)RSSI @ 1m (int8_t)

Output: None

# Enable Apple iBeacon emulation# Manufacturer ID = 0x004CAT+BLEBEACON=0x004C,01-12-23-34-45-56-67-78-89-9A-AB-BC-CD-DE-EF-F0,0x0000,0x0000,-59OK# Reset to change the advertising dataATZOK # Enable Nordic Beacon emulation# Manufacturer ID = 0x0059AT+BLEBEACON=0x0059,01-12-23-34-45-56-67-78-89-9A-AB-BC-CD-DE-EF-F0,0x0000,0x0000,-59OK# Reset to change the advertising dataATZOK

AT+BLEBEACON will cause the beacon data to be stored in non-volatile config memory on the Bluefruit LE module, and these values will bepersisted across system resets and power cycles. To remove or clear the beacon data you need to enter the 'AT+FACTORYRESET' command incommand mode.

Entering Nordic Beacon emulation using the sample code above, you can see the simulated beacon in Nordic's 'Beacon Config' tool below:


Page 70 of 115

AT+BLEURIBEACONConverts the specified URI into a UriBeacon (http://adafru.it/edk) advertising packet, and configures the module to advertise as a UriBeacon (partof Google's Physical Web (http://adafru.it/ehZ) project).

To view the UriBeacon URIs you can use one of the following mobile applications:

Android 4.3+: Physical Web (http://adafru.it/edi) on the Google Play StoreiOS: Physical Web (http://adafru.it/edj) in Apple's App Store


Parameters: The URI to encode (ex. http://www.adafruit.com/blog (http://adafru.it/ei0))

Output: None of a valid URI was entered (length is acceptable, etc.).


Page 71 of 115

https://github.com/google/uribeacon

http://google.github.io/physical-web/



http://www.adafruit.com/blog

AT+BLEURIBEACON=http://www.adafruit.com/blogOK

# Reset to change the advertising dataATZOK

If the supplied URI is too long you will get the following output:

AT+BLEURIBEACON=http://www.adafruit.com/this/uri/is/too/longURL is too longERROR

If the URI that you are trying to encode is too long, try using a shortening service like bit.ly, and encode the shortened URI.UriBeacon should be considered deprecated as a standard, and EddyStone should be used for any future development. No further developmentwill happen in the Bluefruit LE firmware around UriBeacon.

Deprecated: AT+EDDYSTONEENABLEThis command will enable Eddystone (http://adafru.it/fSA) support on the Bluefruit LE module. Eddystone support must be enabled before theother related commands can be used.


Parameters: 1 or 0 (1 = enable, 0 = disable)

Output: The current state of Eddystone support if no parameters are provided (1 = enabled, 0 = disabled)

This command was removed in firmware 0.7.0 to avoid confusion. Use AT+EDDYSTONESERVICEEN in 0.7.0 and higher.

# Enable Eddystone supportAT+EDDYSTONEENABLE=1OK

# Check the current Eddystone status on the moduleAT+EDDYSTONEENABLE1OK

AT+EDDYSTONEURLThis command will set the URL for the Eddystone-URL (http://adafru.it/fSB) protocol.


Parameters:

The URL to encode (mandatory)An optional second parameter indicates whether to continue advertising the Eddystone URL even when the peripheral is connected to acentral deviceFirmware 0.6.7 added an optional third parameter for the RSSI at 0 meters value. This should be measured by the end user by checking theRSSI value on the receiving device at 1m and then adding 41 to that value (to compensate for the signal strength loss over 1m), so an RSSIof -62 at 1m would mean that you should enter -21 as the RSSI at 0m. Default value is -18dBm.

Output: Firmware <= 0.6.6: none. With firmware >= 0.6.7 running this command with no parameters will return the current URL.

# Set the Eddystone URL to adafruitAT+EDDYSTONEURL=http://www.adafruit.comOK # Set the Eddystone URL to adafruit and advertise it even when connectedAT+EDDYSTONEURL=http://www.adafruit.com,1OK

AT+EDDYSTONECONFIGENThis command causes the Bluefruit LE module to enable the Eddystone URL config service for the specified number of seconds.

This command should be used in combination with the Physical Web application from Google, available for Android (http://adafru.it/edi) oriOS (http://adafru.it/edj). Run this command then select the 'Edit URL' option from the app to change the destination URL over the air.



Page 72 of 115

https://github.com/google/eddystone

https://github.com/google/eddystone/tree/master/eddystone-url



Parameters: The number of seconds to advertised the config service UUID

Output: None

# Start advertising the Eddystone config service for 5 minutes (300s)AT+EDDYSTONECONFIGEN=300OK

AT+EDDYSTONESERVICEENAdds or removes the Eddystone service from the GATT table (requires a reset to take effect).


Parameters: Whether or not the Eddystone service should be enabled or not, using on of the following values:

onoff10

Output: If the command is executed with no parameters it will disable a numeric value indicating whether the service is enabled (1) or disabled (0).

You must perform a system reset for this command to take effect.

# Enable Eddystone serviceAT+EddyStonServiceEn=onOK

AT+EddyStonServiceEn=1OK

# Disable Eddystone serviceAT+EddyStonServiceEn=offOK

AT+EddyStonServiceEn=0OK

AT+EDDYSTONEBROADCASTThis command can be used to start of stop advertising the Eddystone payload using the URL stored in non-volatile memory (NVM).


Parameters: Whether or not the payload should be broadcast, using one of the following values:

onoff10

Output: If executed with no parameters, the current broadcast state will be displayed as a numeric value.

# Enable broadcasting current setting of EddyStone (stored previously on nvm)AT+EddyStoneBroadcast=onOK

AT+EddyStoneBroadcast=1OK # Disable broadcasting current setting of EddyStone (still stored on nvm)AT+EddyStoneBroadcast=offOK

AT+EddyStoneBroadcast=0OK


Page 73 of 115

BLE GenericThe following general purpose BLE commands are available on Bluefruit LE modules:

AT+BLEPOWERLEVELGets or sets the current transmit power level for the module's radio (higher transmit power equals better range, lower transmit power equals betterbattery life).


Parameters: The TX power level (in dBm), which can be one of the following values (from lowest to higher transmit power):

-40-20-16-12-8-404

Output: The current transmit power level (in dBm)

The updated power level will take affect as soon as the command is entered. If the device isn't connected to another device, advertising will stopmomentarily and then restart once the new power level has taken affect.

# Get the current TX power level (in dBm)AT+BLEPOWERLEVEL0OK # Set the TX power level to 4dBm (maximum value)AT+BLEPOWERLEVEL=4OK # Set the TX power level to -12dBm (better battery life)AT+BLEPOWERLEVEL=-12OK # Set the TX power level to an invalid valueAT+BLEPOWERLEVEL=-3ERROR

AT+BLEGETADDRTYPEGets the address type (for the 48-bit BLE device address).

Normally this will be '1' (random), which means that the module uses a 48-bit address that was randomly generated during the manufacturingprocess and written to the die by the manufacturer.

Random does not mean that the device address is randomly generated every time, only that a one-time random number is used.


Parameters: None

Output: The address type, which can be one of the following values:

0 = public1 = random

AT+BLEGETADDRTYPE1OK

AT+BLEGETADDR


Page 74 of 115

Gets the 48-bit BLE device address.


Parameters: None

Output: The 48-bit BLE device address in the following format: 'AA:BB:CC:DD:EE:FF'

AT+BLEGETADDRE4:C6:C7:31:95:11OK

AT+BLEGETPEERADDRGets the 48-bit address of the peer (central) device we are connected to.


Parameters: None

Output: The 48-bit address of the connected central device in hex format. The command will return ERROR if we are not connected to a centraldevice.

Please note that the address returned by the central device is almost always a random value that will change over time, and this value shouldgenerally not be trusted. This command is provided for certain edge cases, but is not useful in most day to day scenarios.

AT+BLEGETPEERADDR48:B2:26:E6:C1:1DOK

AT+BLEGETRSSIGets the RSSI value (Received Signal Strength Indicator), which can be used to estimate the reliability of data transmission between two devices(the lower the number the better).


Parameters: None

Output: The RSSI level (in dBm) if we are connected to a device, otherwise '0'

# Connected to an external deviceAT+BLEGETRSSI-46OK # Not connected to an external deviceAT+BLEGETRSSI0OK


Page 75 of 115

BLE ServicesThe following commands allow you to interact with various GATT services present on Bluefruit LE modules when running in Command Mode.

AT+BLEUARTTXThis command will transmit the specified text message out via the UART Service (http://adafru.it/iCn) while you are running in Command Mode.


Parameters: The message payload to transmit. The payload can be up to 240 characters (since AT command strings are limited to a maximum of256 bytes total).

Output: This command will produce an ERROR message if you are not connected to a central device, or if the internal TX FIFO on the BluefruitLE module is full.

As of firmware release 0.6.2 and higher, AT+BLEUARTTX can accept a limited set of escape code sequences:

\r = carriage return\n = new line\t = tab\b = backspace\\ = backward slash

As of firmware release 0.6.7 and higher, AT+BLEUARTTX can accept the following escape code sequence since AT+BLEUARTTX=? has aspecific meaning to the AT parser:

\? = transmits a single question mark

As of firmware release 0.7.6 and higher, AT+BLEUARTTX can accept the following escape code sequence:

\+ = transmit a single '+' character without having to worry about `+++` mode switch combinations

You must be connected to another device for this command to execute

# Send a string when connected to another deviceAT+BLEUARTTX=THIS IS A TESTOK # Send a string when not connectedAT+BLEUARTTX=THIS IS A TESTERROR

TX FIFO Buffer Handling

Starting with firmware version 0.6.7, when the TX FIFO buffer is full a 200ms blocking delay will be used to see if any free space becomesavailable in the FIFO before returning ERROR. The exact process is detailed in the flow chart below:


Page 76 of 115

Note: The TX FIFO full check will happen for each GATT transaction (of up to 20 bytes of data each), so large data transfers may have multiple200ms wait states.

You can use the AT+BLEUARTFIFO=TX (http://adafru.it/id3) command to check the size of the TX FIFO before sending data to ensure that youhave enough free space available in the buffer.

The TX FIFO has the following size, depending on the firmware version used:

Firmware <=0.6.6: 160 characters wideFirmware >=0.6.7: 1024 characters wide

It IS possible with large data transfers that part of the payload can be transmitted, and the command can still produce an ERROR if the FIFOdoesn't empty in time in the middle of the payload transfer (since data is transmitted in maximum 20 byte chunks). If you need to ensure reliabledata transfer, you should always check the TX FIFO size before sending data, which you can do using the AT+BLEUARTFIFO command. If notenough space is available for the entire payload, add a SW delay until enough space is available. Any single AT+BLEUARTTX command can fitinto the FIFO, but multiple large instances of this command may cause the FIFO to fill up mid transfer.

AT+BLEUARTTXFThis is a convenience function the serves the same purpose as AT+BLEUARTTX, but data is immediately sent in a single BLE packet ('F' for forcepacket). This command will accept a maximum of 20 characters, which is the limit of what can be send in a single packet.


Parameters: See AT+BLEUARTTX

Output: See AT+BLEUARTTX

AT+BLEUARTRXThis command will dump the UART service (http://adafru.it/iCn)'s RX buffer to the display if any data has been received from from the UARTservice while running in Command Mode. The data will be removed from the buffer once it is displayed using this command.

Any characters left in the buffer when switching back to Data Mode will cause the buffered characters to be displayed as soon as the mode switchis complete (within the limits of available buffer space, which is 1024 bytes on current black 32KB SRAM devices, or 160 bytes for the blue firstgeneration BLEFriend board based on 16KB SRAM parts).


Parameters: None

Output: The RX buffer's content if any data is available, otherwise nothing.

You can also use the AT+BLEUARTFIFO=RX command to check if any incoming data is available or not.


Page 77 of 115

# Command results when data is availableAT+BLEUARTRXSent from AndroidOK # Command results when no data is availableAT+BLEUARTRXOK

AT+BLEUARTFIFOThis command will return the free space available in the BLE UART TX and RX FIFOs. If you are transmitting large chunks of data, you may wantto check if you have enough free space in the TX FIFO before sending, keeping in mind that individual GATT packets can contain up to 20 userbytes each.


Parameters: Running this command with no parameters will return two comma-separated values indicating the free space in the TX buffer,following by the RX buffer. To request a specific buffer, you can execute the command with either a "TX" or "RX" value (For example:"AT+BLEUARTFIFO=TX").

Output: The free space remaining in the TX and RX FIFO buffer if no parameter is present, otherwise the free space remaining in the specifiedFIFO buffer.

AT+BLEUARTFIFO1024,1024OK

AT+BLEUARTFIFO=TX1024OK

AT+BLEUARTFIFO=RX1024OK

AT+BLEKEYBOARDENThis command will enable GATT over HID (GoH) keyboard support, which allows you to emulate a keyboard on supported iOS and Androiddevices. By default HID keyboard support is disabled, so you need to set BLEKEYBOARDEN to 1 and then perform a system reset before thekeyboard will be enumerated and appear in the Bluetooth preferences on your phone, where if can be bonded as a BLE keyboard.



Output: None

As of firmware version 0.6.6 this command is now an alias for AT+BLEHIDENYou must perform a system reset (ATZ) before the changes take effect!Before you can use your HID over GATT keyboard, you will need to bond your mobile device with the Bluefruit LE module in the Bluetoothpreferences panel.

# Enable BLE keyboard support then resetAT+BLEKEYBOARDEN=1OKATZOK # Disable BLE keyboard support then resetAT+BLEKEYBOARDEN=0OKATZOK

AT+BLEKEYBOARDSends text data over the BLE keyboard interface (if it has previously been enabled via AT+BLEKEYBOARDEN).

Any valid alpha-numeric character can be sent, and the following escape sequences are also supported:

\r - Carriage Return


Page 78 of 115

\n - Line Feed\b - Backspace\t - Tab\\ - Backslash

As of version 0.6.7 you can also use the following escape code when sending a single character ('AT+BLEKEYBOARD=?' has another meaningfor the AT parser):

\? - Question mark


Parameters: The text string (optionally including escape characters) to transmit

Output: None

# Send a URI with a new line ending to execute in Chrome, etc.AT+BLEKEYBOARD=http://www.adafruit.com\r\nOK # Send a single question mark (special use case, 0.6.7+)AT+BLEKEYBOARD=\?OK

AT+BLEKEYBOARDCODESends a raw hex sequence of USB HID keycodes to the BLE keyboard interface including key modifiers and up to six alpha-numeric characters.

This command accepts the following ascii-encoded HEX payload, matching the way HID over GATT sends keyboard data:

Byte 0: ModifierByte 1: Reserved (should always be 00)Bytes 2..7: Hexadecimal values for ASCII-encoded characters (if no character is used you can enter '00' or leave trailing characters empty)

After a keycode sequence is sent with the AT+BLEKEYBOARDCODE command, you must send a second AT+BLEKEYBOARDCODEcommand with at least two 00 characters to indicate the keys were released!

Modifier Values

The modifier byte can have one or more of the following bits set:

Bit 0 (0x01): Left ControlBit 1 (0x02): Left ShiftBit 2 (0x04): Left AltBit 3 (0x08): Left WindowBit 4 (0x10): Right ControlBit 5 (0x20): Right ShiftBit 6 (0x40): Right AltBit 7 (0x80): Right Window


Parameters: A set of hexadecimal values separated by a hyphen ('-'). Note that these are HID scan code values, not standard ASCII values!

Output: None

HID key code values don't correspond to ASCII key codes! For example, 'a' has an HID keycode value of '04', and there is no keycode for an uppercase 'A' since you use the modifier to set upper case values. For details, google 'usb hid keyboard scan codes', and see the example below.

A list of HID keyboard codes can be found here (http://adafru.it/cQV) (see section 7).

# send 'abc' with shift key --> 'ABC'AT+BLEKEYBOARDCODE=02-00-04-05-06-00-00OK# Indicate that the keys were released (mandatory!)AT+BLEKEYBOARDCODE=00-00OK

AT+BLEHIDENThis command will enable GATT over HID (GoH) support, which allows you to emulate a keyboard, mouse or media controll on supported iOS,


Page 79 of 115

http://www.freebsddiary.org/APC/usb_hid_usages.php

Android, OSX and Windows 10 devices. By default HID support is disabled, so you need to set BLEHIDEN to 1 and then perform a system resetbefore the HID devices will be enumerated and appear in on your central device.



Output: None

You normally need to 'bond' the Bluefruit LE peripheral to use the HID commands, and the exact bonding process will change from one operatingsystem to another.If you have previously bonded to a device and need to clear the bond, you can run the AT+FACTORYRESET command which will erase all storedbond data on the Bluefruit LE module.

# Enable GATT over HID support on the Bluefruit LE moduleAT+BLEHIDEN=1OK # Reset so that the changes take effectATZOK

AT+BLEHIDMOUSEMOVEMoves the HID mouse or scroll wheen position the specified number of ticks.

All parameters are signed 8-bit values (-128 to +127). Positive values move to the right or down, and origin is the top left corner.


Parameters: X Ticks (+/-), Y Ticks (+/-), Scroll Wheel (+/-), Pan Wheel (+/-)

Output: None

# Move the mouse 100 ticks right and 100 ticks downAT+BLEHIDMOUSEMOVE=100,100OK # Scroll down 20 pixels or lines (depending on context)AT+BLEHIDMOUSEMOVE=,,20,OK # Pan (horizontal scroll) to the right (exact behaviour depends on OS)AT+BLEHIDMOUSEMOVE=0,0,0,100

AT+BLEHIDMOUSEBUTTONManipulates the HID mouse buttons via the specific string(s).


Parameters: Button Mask String [L][R][M][B][F], Action [PRESS][CLICK][DOUBLECLICK][HOLD]

L = Left ButtonR = Right ButtonM = Middle ButtonB = Back ButtonF = Forward ButtonIf the second parameter (Action) is "HOLD", an optional third parameter can be passed specifying how long the button should be held inmilliseconds.

Output: None

# Double click the left mouse buttonAT+BLEHIDMOUSEBUTTON=L,doubleclickOK

# Press the left mouse button down, move the mouse, then release L# This is required to perform 'drag' then stop type operationsAT+BLEHIDMOUSEBUTTON=LOKAT+BLEHIDMOUSEMOVE=-100,50OKAT+BLEHIDMOUSEBUTTON=0


Page 80 of 115

OK # Hold the backward mouse button for 200 milliseconds (OS dependent)AT+BLEHIDMOUSEBUTTON=B,hold,200OK

AT+BLEHIDCONTROLKEYSends HID media control commands for the bonded device (adjust volume, screen brightness, song selection, etc.).


Parameters: The HID control key to send, followed by an optional delay in ms to hold the button

The control key string can be one of the following values:

System Controls (works on most systems)BRIGHTNESS+BRIGHTNESS-

Media Controls (works on most systems)PLAYPAUSEMEDIANEXTMEDIAPREVIOUSMEDIASTOP

Sound Controls (works on most systems)VOLUMEMUTEBASSTREBLEBASS_BOOSTVOLUME+VOLUME-BASS+BASS-TREBLE+TREBLE-

Application Launchers (Windows 10 only so far)EMAILREADERCALCULATORFILEBROWSER

Browser/File Explorer Controls (Firefox on Windows/Android only)SEARCHHOMEBACKFORWARDSTOPREFRESHBOOKMARKS

You can also send a raw 16-bit hexadecimal value in the '0xABCD' format. A full list of 16-bit 'HID Consumer Control Key Codes' can be foundhere (http://adafru.it/cQV)(see section 12).

Output: Normally none.

If you are not bonded and connected to a central device, this command will return ERROR. Make sure you are connected and HID support isenabled before running these commands.

# Toggle the sound on the bonded central deviceAT+BLEHIDCONTROLKEY=MUTEOK

# Hold the VOLUME+ key for 500msAT+BLEHIDCONTROLKEY=VOLUME+,500OK

# Send a raw 16-bit Consumer Key Code (0x006F = Brightness+)AT+BLEHIDCONTROLKEY=0x006FOK

AT+BLEHIDGAMEPADEN


Page 81 of 115

http://www.freebsddiary.org/APC/usb_hid_usages.php

Enables HID gamepad support in the HID service. By default the gamepad is disabled as of version 0.7.6 of the firmware since it causes problemson iOS and OS X and should only be used on Android and Windows based devices.


Parameters: Whether the gamepad service should be enabled via one of the following values:

onoff10

Output: If executed with no parameters, a numeric value will be returned indicating whether the battery service is enabled (1) or disabled (0).

This command requires a system reset to take effect.

AT+BLEHIDGAMEPADSends a specific HID gamepad payload out over BLE


Parameters: The following comma-separated parameters are available:

x: LEFT, RIGHT: If X=-1 then 'LEFT' is pressed, if X=1 then 'RIGHT' is pressed, if X=0 then neither left nor right are pressedy: UP, DOWN: If Y=-1 then 'UP' is pressed, if Y=1 then 'DOWN' is pressed, if Y=0 then neither up nor down are pressedbuttons: 0x00-0xFF, which is a bit mask for 8 button 0-7

Output: Nothing

HID gamepad is disabled by default as of version 0.7.6, and must first be enabled via AT+BLEHIDGAMEPADEN=1 before it can be used.Note: You need to send both 'press' and 'release' events for each button, otherwise the system will think that the button is still pressed until arelease state is received.

# Press 'RIGHT' and 'Button0' at the same timeAT+BLEHIDGAMEPAD=1,0,0x01

# Press 'UP' and 'Button1' + 'Button0' at the same timeAT+BLEHIDGAMEPAD=0,-1,0x03

AT+BLEMIDIENEnables or disables the BLE MIDI service.


Parameters: State, which can be one of:

onoff01

Output: If executed with no parameters, it will return the current state of the MIDI service as an integer indicating if it is enabled (1) or disabled (0).

Note: This command will require a reset to take effect.

# Check the current state of the MIDI serviceAT+BLEMIDIEN1OK

# Enable the MIDI ServiceAT+BLEMIDIEN=1OK

AT+BLEMIDIRXReads an incoming MIDI character array from the buffer.



Page 82 of 115

Parameters: None

Output: The midi event in byte array format

AT+BLEMIDIRX90-3C-7FOK

AT+BLEMIDITXSends a MIDI event to host.


Parameters: The MIDI event in hex array format, which can be either:

A series of full MIDI events (up to 4 events)Exactly 1 full MIDI event + several running events without status (up to 7)

Output: None

# Send 1 event (middle C with max velocity)AT+BLEMIDITX=90-3C-7FOK

# Send 2 eventsAT+BLEMIDITX=90-3C-7F-A0-3C-7FOK

# Send 1 full event + running eventAT+BLEMIDITX=90-3C-7F-3C-7FOK

AT+BLEBATTENEnables the Battery Service following the definition from the Bluetooth SIG.


Parameters: Whether the battery service should be enabled, via on of the following values:

onoff10

Output: If executed with no parameters, a numeric value will be returned indicating whether the battery service is enabled (1) or disabled (0).

This command requires a system reset to take effect.

# Enable the Battery ServiceAT+BLEBATTEN=1OK

AT+BLEBATTVALSets the current battery level in percentage (0..100) for the Battery Service (if enabled).


Parameters: The percentage for the battery in the range of 0..100.

Output: If executed with no parameters, the current battery level stored in the characteristic.

# Set the battery level to 72%AT+BLEBATTVAL=72OK


Page 83 of 115

BLE GAPGAP (http://adafru.it/iCo), which stands for the Generic Access Profile, governs advertising and connections with Bluetooth Low Energy devices.

The following commands can be used to configure the GAP settings on the BLE module.

You can use these commands to modify the advertising data (for ex. the device name that appears during the advertising process), to retrieveinformation about the connection that has been established between two devices, or the disconnect if you no longer wish to maintain a connection.

AT+GAPCONNECTABLEThis command can be used to prevent the device from being 'connectable'.


Parameters: Whether or not the device should advertise itself as connectable, using one of the following values:

yesno10

Output: The 'connectable' state of the device if no parameter is provided

# Make the device non-connectable (advertising only)AT+GAPCONNECTABLE=0OK

# Check the current connectability statusAT+GAPCONNECTABLE1OK

AT+GAPGETCONNDiplays the current connection status (if we are connected to another BLE device or not).


Parameters: None

Output: 1 if we are connected, otherwise 0

# ConnectedAT+GAPGETCONN1OK # Not connectedAT+GAPGETCONN0OK

AT+GAPDISCONNECTDisconnects to the external device if we are currently connected.


Parameters: None

Output: None

AT+GAPDISCONNECTOK

AT+GAPDEVNAME


Page 84 of 115

Gets or sets the device name, which is included in the advertising payload for the Bluefruit LE module


Parameters:

None to read the current device nameThe new device name if you want to change the value

Output: The device name if the command is executed in read mode

Updating the device name will persist the new value to non-volatile memory, and the updated name will be used when the device is reset. To resetthe device to factory settings and clean the config data from memory run the AT+FACTORYRESET command.

# Read the current device nameAT+GAPDEVNAMEUARTOK # Update the device name to 'BLEFriend'AT+GAPDEVNAME=BLEFriendOK# Reset to take effectATZOK

AT+GAPDELBONDSDeletes and bonding information stored on the Bluefruit LE module.


Parameters: None

Output: None

AT+GAPDELBONDSOK

AT+GAPINTERVALSGets or sets the various advertising and connection intervals for the Bluefruit LE module.

Be extremely careful with this command since it can be easy to cause problems changing the intervals, and depending on the values selectedsome mobile devices may no longer recognize the module or refuse to connect to it.


Parameters: If updating the GAP intervals, the following comma-separated values can be entered:

Minimum connection interval (in milliseconds)Maximum connection interval (in milliseconds)Fast Advertising interval (in milliseconds)Fast Advertising timeout (in seconds)>= 0.7.0: Low power advertising interval (in milliseconds), default = 417.5 ms

To save power, the Bluefruit modules automatically drop to a lower advertising rate after 'fast advertising timeout' seconds. The default value is 30seconds ('Fast Advertising Timeout'). The low power advertising interval is hard-coded to approximately 0.6s in firmware < 0.7.0. Support tocontrol the low power interval was added in the 0.7.0 firmware release via an optional fifth parameter.

Please note the following min and max limitations for the GAP parameters:

Absolute minimum connection interval: 10msAbsolute maximum connection interval: 4000msAbsolute minimum fast advertising interval: 20msAbsolute maximum fast advertisting interval: 10240msAbsolute minimum low power advertising interval: 20msAbsolute maximum low power advertising interval: 10240ms

If you only wish to update one interval value, leave the other comma-separated values empty (ex. ',,110,' will only update the third value,advertising interval).


Page 85 of 115

Output: If reading the current GAP interval settings, the following comma-separated information will be displayed:

Minimum connection interval (in milliseconds)Maximum connection interval (in milliseconds)Advertising interval (in milliseconds)Advertising timeout (in milliseconds)

Updating the GAP intervals will persist the new values to non-volatile memory, and the updated values will be used when the device is reset. Toreset the device to factory settings and clean the config data from memory run the AT+FACTORYRESET command.

# Read the current GAP intervalsAT+GAPINTERVALS20,100,100,30 # Update all valuesAT+GAPINTERVALS=20,200,200,30OK # Update only the advertising intervalAT+GAPINTERVALS=,,150,OK

AT+GAPSTARTADVCauses the Bluefruit LE module to start transmitting advertising packets if this isn't already the case (assuming we aren't already connected to anexternal device).


Parameters: None

Output: None

# Command results when advertising data is not being sentAT+GAPSTARTADVOK # Command results when we are already advertisingAT+GAPSTARTADVERROR # Command results when we are connected to another deviceAT+GAPSTARTADVERROR

AT+GAPSTOPADVStops advertising packets from being transmitted by the Bluefruit LE module.


Parameters: None

Output: None

AT+GAPSTOPADVOK

AT+GAPSETADVDATASets the raw advertising data payload to the specified byte array (overriding the normal advertising data), following the guidelines in the Bluetooth4.0 or 4.1 Core Specification (http://adafru.it/ddd).

In particular, Core Specification Supplement (CSS) v4 contains the details on common advertising data fields like 'Flags' (Part A, Section 1.3)and the various Service UUID lists (Part A, Section 1.1). A list of all possible GAP Data Types is available on the Bluetooth SIG's Generic AccessProfile (http://adafru.it/cYs) page.

The Advertising Data payload consists of Generic Access Profile (http://adafru.it/cYs) data that is inserted into the advertising packet in thefollowing format: [U8:LEN] [U8:Data Type Value] [n:Value]

WARNING: This command requires a degree of knowledge about the low level details of the Bluetooth 4.0 or 4.1 Core Specification, and shouldonly be used by expert users. Misuse of this command can easily cause your device to be undetectable by central devices in radio range.


Page 86 of 115

https://www.bluetooth.org/en-us/specification/adopted-specifications

https://www.bluetooth.org/en-us/specification/assigned-numbers/generic-access-profile


WARNING: This command will override the normal advertising payload and may prevent some services from acting as expected.To restore the advertising data to the normal default values use the AT+FACTORYRESET command.

For example, to insert the 'Flags' Data Type (Data Type Value 0x01), and set the value to 0x06/0b00000110 (BR/EDR Not Supported and LEGeneral Discoverable Mode) we would use the following byte array:

02-01-06

0x02 indicates the number of bytes in the entry0x01 is the 'Data Type Value (http://adafru.it/cYs)' and indicates that this is a 'Flag'0x06 (0b00000110) is the Flag value, and asserts the following fields (see Core Specification 4.0, Volume 3, Part C, 18.1):

LE General Discoverable Mode (i.e. anyone can discover this device)BR/EDR Not Supported (i.e. this is a Bluetooth Low Energy only device)

If we also want to include two 16-bit service UUIDs in the advertising data (so that listening devices know that we support these services) we couldappend the following data to the byte array:

05-02-0D-18-0A-18

0x05 indicates that the number of bytes in the entry (5)0x02 is the 'Data Type Value (http://adafru.it/cYs)' and indicates that this is an 'Incomplete List of 16-bit Service Class UUIDs'0x0D 0x18 is the first 16-bit UUID (which translates to 0x180D, corresponding to the Heart Rate Service (http://adafru.it/ddB)).0x0A 0x18 is another 16-bit UUID (which translates to 0x180A, corresponding to the Device Information Service (http://adafru.it/ecj)).

Including the service UUIDs is important since some mobile applications will only work with devices that advertise a specific service UUID in theadvertising packet. This is true for most apps from Nordic Semiconductors, for example.


Parameters: The raw byte array that should be inserted into the advertising data section of the advertising packet, being careful to stay within thespace limits defined by the Bluetooth Core Specification.

Response: None

# Advertise as Discoverable and BLE only with 16-bit UUIDs 0x180D and 0x180AAT+GAPSETADVDATA=02-01-06-05-02-0d-18-0a-18OK

The results of this command can be seen in the screenshot below, taken from a sniffer analyzing the advertising packets in Wireshark. Theadvertising data payload is higlighted in blue in the raw byte array at the bottom of the image, and the packet analysis is in the upper section:


Page 87 of 115



https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.heart_rate.xml

https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.device_information.xml

BLE GATTGATT (http://adafru.it/iCp), which standards for the Generic ATTribute Profile, governs data organization and data exchanges between connecteddevices. One device (the peripheral) acts as a GATT Server, which stores data in Attribute records, and the second device in the connection (thecentral) acts as a GATT Client, requesting data from the server whenever necessary.

The following commands can be used to create custom GATT services and characteristics on the BLEFriend, which are used to store andexchange data.

Please note that any characteristics that you define here will automatically be saved to non-volatile FLASH config memory on the device and re-initialised the next time the device starts.

You need to perform a system reset via 'ATZ' before most of the commands below will take effect!

GATT LimitationsThe commands below have the following limitations due to SRAM and resource availability, which should be kept in mind when creating orworking with customer GATT services and characteristics.

These values apply to firmware 0.7.0 and higher:

Maximum number of services: 10Maximum number of characteristics: 30Maximum buffer size for each characteristic: 32 bytesMaximum number of CCCDs: 16

If you want to clear any previous config value, enter the 'AT+FACTORYRESET' command before working on a new peripheral configuration.

AT+GATTCLEARClears any custom GATT services and characteristics that have been defined on the device.


Parameters: None

Response: None

AT+GATTCLEAROK

AT+GATTADDSERVICEAdds a new custom service definition to the device.


Parameters: This command accepts a set of comma-separated key-value pairs that are used to define the service properties. The following key-value pairs can be used:

UUID: The 16-bit UUID to use for this service. 16-bit values should be in hexadecimal format (0x1234).UUID128: The 128-bit UUID to use for this service. 128-bit values should be in the following format: 00-11-22-33-44-55-66-77-88-99-AA-BB-CC-DD-EE-FF

Response: The index value of the service in the custom GATT service lookup table. (It's important to keep track of these index values to work withthe service later.)

Note: Key values are not case-sensitiveOnly one UUID type can be entered for the service (either UUID or UUID128)

# Clear any previous custom services/characteristicsAT+GATTCLEAROK

# Add a battery service (UUID = 0x180F) to the peripheralAT+GATTADDSERVICE=UUID=0x180F


Page 88 of 115

1OK # Add a battery measurement characteristic (UUID = 0x2A19), notify enabledAT+GATTADDCHAR=UUID=0x2A19,PROPERTIES=0x10,MIN_LEN=1,VALUE=1001OK


# Add a custom service to the peripheralAT+GATTADDSERVICE=UUID128=00-11-00-11-44-55-66-77-88-99-AA-BB-CC-DD-EE-FF1OK

# Add a custom characteristic to the above service (making sure that there# is no conflict between the 16-bit UUID and bytes 3+4 of the 128-bit service UUID)AT+GATTADDCHAR=UUID=0x0002,PROPERTIES=0x02,MIN_LEN=1,VALUE=1001OK

AT+GATTADDCHARAdds a custom characteristic to the last service that was added to the peripheral (via AT+GATTADDSERVICE).

AT+GATTADDCHAR must be run AFTER AT+GATTADDSERVICE, and will add the new characteristic to the last service definition that wasadded.As of version 0.6.6 of the Bluefruit LE firmware you can now use custom 128-bit UUIDs with this command. See the example at the bottom of thiscommand description.


Parameters: This command accepts a set of comma-separated key-value pairs that are used to define the characteristic properties. The followingkey-value pais can be used:

UUID: The 16-bit UUID to use for the characteristic (which will be insert in the 3rd and 4th bytes of the parent services 128-bit UUID). Thisvalue should be entered in hexadecimal format (ex. 'UUID=0x1234'). This value must be unique, and should not conflict with bytes 3+4 of theparent service's 128-bit UUID.PROPERTIES: The 8-bit characteristic properties field, as defined by the Bluetooth SIG. The following values can be used:

0x02 - Read0x04 - Write Without Response0x08 - Write0x10 - Notify0x20 - Indicate

MIN_LEN: The minimum size of the values for this characteristic (in bytes, min = 1, max = 20, default = 1)MAX_LEN: The maximum size of the values for the characteristic (in bytes, min = 1, max = 20, default = 1)VALUE: The initial value to assign to this characteristic (within the limits of 'MIN_LEN' and 'MAX_LEN'). Value can be an integer ("-100","27"), a hexadecimal value ("0xABCD"), a byte array ("aa-bb-cc-dd") or a string ("GATT!").>=0.7.0 - DATATYPE: This argument indicates the data type stored in the characteristic, and is used to help parse data properly. It can beone of the following values:

AUTO (0, default)STRING (1)BYTEARRAY (2)INTEGER (3)

>=0.7.0 - DESCRIPTION: Adds the specified string as the characteristic description entry>=0.7.0 - PRESENTATION: Adds the specified value as the characteristic presentation format entry

Response: The index value of the characteristic in the custom GATT characteristic lookup table. (It's important to keep track of thesecharacteristic index values to work with the characteristic later.)

Note: Key values are not case-sensitiveMake sure that the 16-bit UUID is unique and does not conflict with bytes 3+4 of the 128-bit service UUID


# Add a battery service (UUID = 0x180F) to the peripheralAT+GATTADDSERVICE=UUID=0x180F1OK


Page 89 of 115

# Add a battery measurement characteristic (UUID = 0x2A19), notify enabledAT+GATTADDCHAR=UUID=0x2A19,PROPERTIES=0x10,MIN_LEN=1,VALUE=1001OK


# Add a custom service to the peripheralAT+GATTADDSERVICE=UUID128=00-11-00-11-44-55-66-77-88-99-AA-BB-CC-DD-EE-FF1OK


Version 0.6.6 of the Bluefruit LE firmware added the ability to use a new 'UUID128' flag to add custom 128-bit UUIDs that aren't related to theparent service UUID (which is used when passing the 16-bit 'UUID' flag).

To specify a 128-bit UUID for your customer characteristic, enter a value resembling the following syntax:

# Add a custom characteristic to the above service using a# custom 128-bit UUIDAT+GATTADDCHAR=UUID128=00-11-22-33-44-55-66-77-88-99-AA-BB-CC-DD-EE-FF,PROPERTIES=0x02,MIN_LEN=1,VALUE=1001OK

Version 0.7.0 of the Bluefruit LE firmware added the new DESCRIPTION and PRESENTATION keywoards, corresponding the the GATTCharacteristic User Description (http://adafru.it/oIA) and the GATT Characteristic Presentation Format (http://adafru.it/oIB) Descriptors.

The DESCRIPTION field is a string that contains a short text description of the characteristic. Some apps may not display this data, but it shouldbe visible using something like the Master Control Panel application from Nordic on iOS and Android.

The PRESENTATION field contains a 7-byte payload that encapsulates the characteristic presentation format data. It requires a specific set ofbytes and values to work properly. See the following link for details on how to format thepayload: https://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml (http://adafru.it/oIB)

The following example shows how you might use both of these new fields:

AT+GATTADDCHAR=UUID=0x2A37, PROPERTIES=0x10, MIN_LEN=2, MAX_LEN=3, VALUE=00-40, DESCRIPTION=HRM Measurement, PRESENTATION=17-00-AC-27-01-00-00

For the Characteristic Presentation Format we have:

Format = IEEE-11073 32-bit FLOAT (Decimal 23, Hex 0x17)Exponent = 0/NoneUnit = Thermodynamic temperature: Degrees Fahrenheit (0x27AC) - Bluetooth LE Unit List (http://adafru.it/oID)Namespace = Bluetooth SIG Assigned Number (0x01)Description = None (0x0000)

The results from Nordic's Master Control Panel app can be seen below:

AT+GATTCHAR


Page 90 of 115

https://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_user_description.xml

https://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml

https://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml

https://www.bluetooth.com/specifications/assigned-numbers/units

Gets or sets the value of the specified custom GATT characteristic (based on the index ID returned when the characteristic was added to thesystem via AT+GATTADDCHAR).


Parameters: This function takes one or two comma-separated functions (one parameter = read, two parameters = write).

The first parameter is the characteristic index value, as returned from the AT+GATTADDCHAR function. This parameter is always required,and if no second parameter is entered the current value of this characteristic will be returned.The second (optional) parameter is the new value to assign to this characteristic (within the MIN_SIZE and MAX_SIZE limits defined whencreating it).

Response: If the command is used in read mode (only the characteristic index is provided as a value), the response will display the current valueof the characteristics. If the command is used in write mode (two comma-separated values are provided), the characteristics will be updated touse the provided value.


# Add a battery service (UUID = 0x180F) to the peripheralAT+GATTADDSERVICE=UUID=0x180F1OK # Add a battery measurement characteristic (UUID = 0x2A19), notify enabledAT+GATTADDCHAR=UUID=0x2A19,PROPERTIES=0x10,MIN_LEN=1,VALUE=1001OK

# Read the battery measurement characteristic (index ID = 1)AT+GATTCHAR=10x64OK

# Update the battery measurement characteristic to 32 (hex 0x20)AT+GATTCHAR=1,32OK

# Verify the previous write attemptAT+GATTCHAR=10x20OK

AT+GATTLISTLists all custom GATT services and characteristics that have been defined on the device.


Parameters: None

Response: A list of all custom services and characteristics defined on the device.


# Add a battery service (UUID = 0x180F) to the peripheralAT+GATTADDSERVICE=UUID=0x180F1OK # Add a battery measurement characteristic (UUID = 0x2A19), notify enabledAT+GATTADDCHAR=UUID=0x2A19,PROPERTIES=0x10,MIN_LEN=1,VALUE=1001OK # Add a custom service to the peripheralAT+GATTADDSERVICE=UUID128=00-11-00-11-44-55-66-77-88-99-AA-BB-CC-DD-EE-FF2OK



Page 91 of 115

# Get a list of all custom GATT services and characteristics on the deviceAT+GATTLISTID=01,UUID=0x180F ID=01,UUID=0x2A19,PROPERTIES=0x10,MIN_LEN=1,MAX_LEN=1,VALUE=0x64ID=02,UUID=0x11, UUID128=00-11-00-11-44-55-66-77-88-99-AA-BB-CC-DD-EE-FF ID=02,UUID=0x02,PROPERTIES=0x02,MIN_LEN=1,MAX_LEN=1,VALUE=0x64OK

AT+GATTCHARRAWThis read only command reads binary (instead of ASCII) data from a characteristic. It is non-printable but has less overhead and is easier whenwriting libraries in Arduino.


Parameters: The numeric ID of the characteristic to display the data for

Output: Binary data corresponding to the specified characteristic.

Note: This is a specialized command and no NEWLINE is present at the end of the command!


Page 92 of 115

DebugThe following debug commands are available on Bluefruit LE modules:

Use these commands with care since they can easily lead to a HardFault error on the ARM core, which will cause the device to stop responding.

AT+DBGMEMRDDisplays the raw memory contents at the specified address.


Parameters: The following comma-separated parameters can be used with this command:

The starting address to read memory from (in hexadecimal form, with or without the leading '0x')The word size (can be 1, 2, 4 or 8)The number of words to read

Output: The raw memory contents in hexadecimal format using the specified length and word size (see examples below for details)

# Read 12 1-byte values starting at 0x10000009AT+DBGMEMRD=0x10000009,1,12FF FF FF FF FF FF FF 00 04 00 00 00OK

# Try to read 2 4-byte values starting at 0x10000000AT+DBGMEMRD=0x10000000,4,255AA55AA 55AA55AAOK # Try to read 2 4-byte values starting at 0x10000009# This will fail because the Cortex M0 can't perform misaligned# reads, and any non 8-bit values must start on an even addressAT+DBGMEMRD=0x10000009,4,2MISALIGNED ACCESSERROR

AT+DBGNVMRDDisplays the raw contents of the config data section of non-volatile memory


Properties: None

Output: The raw config data from non-volatile memory

AT+DBGNVMRDFE CA 38 05 00 03 00 00 01 12 01 00 55 41 52 54 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 14 00 64 00 64 00 1E 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 BA FF 00 00OK

AT+DBGSTACKSIZEReturns the current stack size, to help detect stack overflow or detect stack memory usage when optimising memory usage on the system.


Parameters: None

Output: The current size of stack memory in bytes

AT+DBGSTACKSIZE1032OK

AT+DBGSTACKDUMP


Page 93 of 115

Dumps the current stack contents. Unused sections of stack memory are filled with '0xCAFEFOOD' to help determine where stack usage stops.

This command is purely for debug and development purposes.


Parameters: None

Output: The memory contents of the entire stack region

AT+DBGSTACKDUMP0x20003800: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003810: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003820: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003830: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003840: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003850: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003860: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003870: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003880: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003890: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200038A0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200038B0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200038C0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200038D0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200038E0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200038F0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003900: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003910: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003920: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003930: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003940: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003950: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003960: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003970: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003980: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003990: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200039A0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200039B0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200039C0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200039D0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200039E0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x200039F0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003A00: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003A10: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003A20: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003A30: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003A40: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003A50: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003A60: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003A70: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003A80: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003A90: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003AA0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003AB0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003AC0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003AD0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003AE0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003AF0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003B00: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003B10: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003B20: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003B30: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003B40: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003B50: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003B60: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003B70: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003B80: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003B90: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003BA0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003BB0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003BC0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003BD0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003BE0: CAFEF00D CAFEF00D CAFEF00D CAFEF00D0x20003BF0: CAFEF00D CAFEF00D 00000000 CAFEF00D0x20003C00: 00000004 20001D04 CAFEF00D FFFFEF680x20003C10: CAFEF00D 00001098 CAFEF00D CAFEF00D0x20003C20: CAFEF00D CAFEF00D 00001006 200018D80x20003C30: 00000001 200018D8 20001C50 000000040x20003C40: 20001BB0 000134A5 0000100D 20001D280x20003C50: 00000006 00000006 20001C38 20001D440x20003C60: 20001C6C 20001D44 00000006 00000005


Page 94 of 115

0x20003C70: 20001D38 00000005 20001D38 000000000x20003C80: 00000001 00012083 200018C8 000013D30x20003C90: 00550000 00000001 80E80000 4FC400000x20003CA0: 000080E8 00000009 60900000 000080E80x20003CB0: 60140000 20002764 0009608F 000080E80x20003CC0: 80000000 000080E8 00000000 00129F5F0x20003CD0: 00000000 0001E4D9 80E80000 200018C80x20003CE0: 200018D4 00000000 80E80000 000000FF0x20003CF0: 0000011C 0001BCE1 0000203A 0001BC1D0x20003D00: 00000000 0001BC1D 80E80000 0001BCE10x20003D10: 0000011C 0001BDA9 80E80000 0001BDA90x20003D20: 0000011C FFFFFFF9 008B8000 0001BC1D0x20003D30: 00000048 00000010 0000A000 000000090x20003D40: 0001E326 00000001 80E80000 515380000x20003D50: 000080E8 0001E9CF 00000000 000000090x20003D60: 61C78000 000080E8 00000048 000005040x20003D70: 0000A1FC 0002125C 00000000 000080E80x20003D80: 00000000 0012A236 00000000 0001E4D90x20003D90: 000080E8 00000009 00004998 000080E80x20003DA0: 622C8000 0012A29B 00000042 0001E4790x20003DB0: 40011000 000185EF 00006E10 000000000x20003DC0: 00000000 00000004 0000000C 000000000x20003DD0: 62780000 00018579 2000311B 0001ACDF0x20003DE0: 00000000 20003054 20002050 000000010x20003DF0: 20003DF8 0002085D 00000001 200030D40x20003E00: 00000200 0001F663 00000001 200030D40x20003E10: 00000001 2000311B 0001F631 00020A6D0x20003E20: 00000001 00000000 0000000C 200030D40x20003E30: 2000311B 00000042 200030D4 00020AD70x20003E40: 20002050 200030D4 20002050 000208330x20003E50: 20002050 20003F1B 20002050 0001FF890x20003E60: 20002050 0001FFA3 00000005 20003ED80x20003E70: 20002050 0001FF8B 00000010 000204910x20003E80: 00000001 0012A54E 00000020 000224090x20003E90: 00000000 20002050 200030D4 0001FF8B0x20003EA0: 00021263 00000005 0000000C 20003F740x20003EB0: 20003ED8 20002050 200030D4 000201870x20003EC0: 20003ED4 20003054 00000000 20003F750x20003ED0: 00000008 20003F64 00000084 FFFFFFFF0x20003EE0: FFFFFFFF 00000008 00000001 000000080x20003EF0: 20302058 2000311B 0001F631 00020A6D0x20003F00: 20002050 00000000 0000000C 200030D40x20003F10: 32002050 32303032 00323330 000258D70x20003F20: 20002050 200030D4 20002050 000208330x20003F30: 00000000 20002050 00000020 000001CE0x20003F40: 20003F40 200030D4 00000004 0001ED830x20003F50: 200030D4 20003F60 000001D6 000001D70x20003F60: 000001D8 00016559 0000000C 000000000x20003F70: 6C383025 00000058 200030D4 FFFFFFFF0x20003F80: 1FFF4000 00000028 00000028 000217F80x20003F90: 200020C7 000166C5 000166AD 00017ED90x20003FA0: FFFFFFFF 200020B8 2000306C 200030D40x20003FB0: 200020B4 000180AD 1FFF4000 200020B00x20003FC0: 200020B0 200020B0 1FFF4000 0001A63D0x20003FD0: CAFEF00D CAFEF00D 200020B4 000000020x20003FE0: FFFFFFFF FFFFFFFF 1FFF4000 000000000x20003FF0: 00000000 00000000 00000000 00016113OK


Page 95 of 115

HistoryThis page tracks additions or changes to the AT command set based on the firmware version number (which you can obtain via the 'ATI'command):

Version 0.7.7The following AT commands and features were added in the 0.7.7 release:

Added AT+BLEUARTTXF (F for force) to immediately send the specified data out in an BLE UART packet (max 20 bytes), bypassing anyFIFO delays and avoiding packets potentially being transmitted in two transactions.Adjusted BLE UART service to use min connection interval as the tx intervalAdded AT+DFUIRQ to enable using the DFU Pin for IRQ purposes when there is a supported event on the nRF51822Enabled the internal pullup resistor on the CS pin for Bluefruit SPI boardsAdded AT+MODESWITCHEN to enable/disable +++ mode switching from the local (serial or SPI) or BLE UART side. By default local =enabled, ble = disabled, meaning commands can only be executed via the local interface by default.Implemented a '\+' escape code to immediately send '+' chars without trigger the +++ delay waiting for further similar inputAdded AT+BLEHIDGAMEPADEN to separately enable HID Gamepad, since iOS/OSX has a conflict with gamepad devices causing HIDkeyboard to not working properly.

The following bugs were fixed in release 0.7.7:

Fixed a factory reset issue when a long delay occurs in app_error_handler()Fixed an issue where strings were being truncated at 64 chars in UARTFixed HID keyboard support not working with iOS 9 & 10

Version 0.7.0The following AT commands were added in the 0.7.0 release:

AT+BAUDRATEChange the HW UART baudrateAT+UARTFLOWEnable or disable HW UART flow controlAT+BLEMIDIEN=on/off/0/1Enable/disable MIDI service, requires a reset to take affectAT+BLEMIDITXSend a MIDI eventAT+BLEMIDIRXReceive an available MIDI eventAT+GATTCHARRAWAdded this read only command to read binary (instead of ASCII) data from a characteristic. It is non-printable but less overhead and easierfor writing library in ArduinoAT+NVMWRITE=offset,datatype,dataWrites data to 256 byte user NVM. Datatype must be STRING (1), BYTEARRAY (2), or INTEGER (3)AT+NVMREAD=offset,size,datatypeReads data back from 256 bytes user NVMAT+NVMREADRAW=offset,size binary dataBinary data (instead of ASCII) is returned, ending with "OK\r\n". It is non-printable but less overhead and easier to use in some situations.AT+BLEHIDGAMEPAD=x,y,buttons

X is LEFT, RIGHT: X=-1 LEFT is pressed, X=1 RIGHT is pressed, X=0 no pressedY is UP, DOWN: Y=-1 i UP, Y=1 is DOWN, Y=0 no pressedButton [0x00-0xFF] is a bit mask for 8 button 0-7

AT+GAPCONNECTABLE=on/off/1/0Allow/disallow connection to the deviceAT+EDDYSTONESERVICEENAdd/remove EddyStone service to GATT table (requires reset)AT+EDDYSTONEBROADCAST=on/off/0/1Start/stop broadcasting url using settings from NVMAT+BLEBATTEN=on/off/1/0Enable battery service. Reset required due to the service change.AT+BLEBATTVAL=percentUpdates the Battery level, percent is 0 to 100


Page 96 of 115

The following commands were changed in the 0.7.0 release:

AT+GATTADDCHARAdded a DATATYPE option to indicate the data type for the GATT characteristic's payload. Valid option are: AUTO (0, default),STRING (1), BYTEARRAY (2), INTEGER (3)Added characteristic user description option via the DESCRIPTION flagAdded characteristic presentation format support via the PRESENTATION flag

AT+GAPINTERVALSAdded a new 'adv_lowpower_interval' parameter, default value is 417.5 ms. Current arguments are now: min_conn, max_conn, adv_interval,adv_timeout, adv_lowpower_interval

Key bug fixes and changes in this release:

Significant BTLE UART speed and reliability improvementsAdded callback support (work in progress) for:

BLE UART RXGATT Characteristic(s) RXMIDI RXConnect/Disconnect

Increased MAX_LEN for each characteristic from 20 to 32 bytesChanged the default GAP parameters:

Advertising interval = 20msMin connection interval = 20 msMax connection interval = 40 ms

Increased the maximum number of CCCDs saved to flash from 8 to 16Eddystone config service disabled by defaultRemoved AT+EDDYSTONEENABLE to avoid confusionChanged advertising timeout for Eddystone to 'unlimited'Fixed Write-No-Response characteristic property, which wasn't being handled properlyFixed timing constraints to meet Apple design guidelinesFixed systick to ms calculationFixed all tests with google eddystone validator except for writing tx_power = 1 dB (not valid on nrf51)Fixed a bug where writing from the central does not update the value on the characteristic correctlyFixed an issue with HID examples, where when paired with Central, a disconnect then reconnect could not send HID reports anymore


AT+BLEUARTFIFOReturns the number of free bytes available in the TX and RX FIFOs for the Bluetooth UART Service.


AT+BLEUARTTXIf the TX FIFO is full, the command will wait up to 200ms to see if the FIFO size decreases before exiting and returning an ERROR responsedue to the FIFO being full.AT+BLEURIBEACONThis command will go back to using the old (deprecated) UriBeacon UUID (0xFED8), and only the AT+EDDYSTONEURL command will usethe newer Eddystone UUID (0xFEAA).AT+BLEKEYBOARD and AT+BLEUARTTXThese commands now accept '\?' as an escape code since 'AT+BLEKEYBOARD=?' has another meaning for the AT parser. To send asingle question mark the following command should be used: 'AT+BLEKEYBOARD=\?' or 'AT+BLEUARTTX=\?'AT+EDDYSTONEURLThis command now accepts an optional third parameter for RSSI at 0m value (default is -18dBm). Running this command with no parameters ('AT+EDDYSTONEURL\r\n') will now return the current URL.

Key bug fixes in this release:

The FIFO handling for the Bluetooth UART Service was improved for speed and stability, and the TX and RF FIFOs were increased to 1024bytes each.An issue where a timer overflow was causing factory resets every 4 hours or so has been resolved.Fixed a problem with the GATT server where 'value_len' was being incorrectly parsed for integer values in characteristics where 'max_len' >4



Page 97 of 115

AT+EDDYSTONEURLUpdate the URL for the beacon and switch to beacon modeAT+EDDYSTONEENABLEEnable/disable beacon mode using the configured urlAT+EDDYSTONECONFIGENEnable advertising for the the Eddystone configuration service for the specified number of secondsAT+HWMODELEDAllows the user to override the default MODE LED behaviour with one of the following options: DISABLE, MODE, HWUART, BLEUART, SPI,MANUALAT+BLECONTROLKEYAllows HID media control values to be sent to a bonded central device (volume, screen brightness, etc.)AT+BLEHIDENEnables or disables BLE HID support in the Bluefruit LE firmware (mouse, keyboard and media control)AT+BLEMOUSEMOVETo move the HID mouseAT+BLEMOUSEBUTTONTo set the state of the HID mouse buttons


AT+BLEKEYBOARDEN - Now an alias for AT+BLEHIDENAT+GATTADDCHAR - Added a new UUID128 field to allow custom UUIDs

Key bug fixes in this release:

Fixed issues with long beacon URLsFixed big endian issue in at+blebeacon for major & minor number

Known issues with this release:

Windows 10 seems to support a limited number of characteristics for the DIS service. We had to disable the Serial Number characteristic toenable HID support with windows 10.


AT+BLEGETPEERADDR (http://adafru.it/iCq)


Increased the UART buffer size (on the nRF51) from 128 to 256 bytes+++ now responds with the current operating modeFixed a bug with AT+GATTCHAR values sometimes not being saved to NVMFixed a bug with AT+GATTCHAR max_len value not being taken into account after a reset (min_len was always used when repopulating thevalue)

Version 0.6.2This is the first release targetting 32KB SRAM parts (QFAC). 16KB SRAM parts can't be used with this firmware due to memory managementissues, and should use the earlier 0.5.0 firmware.

The following AT commands were changed in the 0.6.2 release:

AT+BLEUARTTX (http://adafru.it/iCr)Basic escape codes were added for new lines, tabs and backspaceAT+BLEKEYBOARD (http://adafru.it/iCr)Also works with OS X now, and may function with other operating systems that support BLE HID keyboards


AT+BLEKEYBOARDEN (http://adafru.it/iCr)AT+BLEKEYBOARD (http://adafru.it/iCr)AT+BLEKEYBOARDCODE (http://adafru.it/iCr)


Page 98 of 115

The following AT commands were changed in the 0.5.0 release:

ATI (http://adafru.it/iCs)The SoftDevice, SoftDevice version and bootloader version were added as a new (7th) record. For Ex: "S110 7.1.0, 0.0" indicates version7.1.0 of the S110 softdevice is used with the 0.0 bootloader (future boards will use a newer 0.1 bootloader).

Other notes concerning 0.5.0:

Starting with version 0.5.0, you can execute the AT+FACTORYRESET command at any point (and without a terminal emulator) by holding theDFU button down for 10 seconds until the blue CONNECTED LED starts flashing, then releasing it.


+++ (http://adafru.it/iCs)AT+HWRANDOM (http://adafru.it/iCt)AT+BLEURIBEACON (http://adafru.it/iCu)AT+DBGSTACKSIZE (http://adafru.it/iCv)AT+DBGSTACKDUMP (http://adafru.it/iCv)


ATI (http://adafru.it/iCs)The chip revision was added after the chip name. Whereas ATI would previously report 'nRF51822', it will now add thespecific HW revision if it can be detected (ex 'nRF51822 QFAAG00')

Version 0.3.0First public release


Page 99 of 115

GATT Service DetailsData in Bluetooth Low Energy is organized around units called 'GATT Services (http://adafru.it/iCp)' and 'GATT Characteristics'. To expose data toanother device, you must instantiate at least one service on your device.

Adafruit's Bluefruit LE Pro modules support some 'standard' services, described below (more may be added in the future).

UART Service

The UART Service is the standard means of sending and receiving data between connected devices, and simulates a familiar two-line UARTinterface (one line to transmit data, another to receive it).

The service is described in detail on the dedicated UART Service (http://adafru.it/iCn) page.


Page 100 of 115

UART ServiceBase UUID: 6E400001-B5A3-F393- E0A9- E50E24DCCA9E

This service simulates a basic UART connection over two lines, TXD and RXD.

It is based on a proprietary UART service specification by Nordic Semiconductors. Data sent to and from this service can be viewed using thenRFUART apps from Nordic Semiconductors for Android and iOS.

This service is available on every Bluefruit LE module and is automatically started during the power-up sequence.

CharacteristicsNordic’s UART Service includes the following characteristics:

NameTXRX

MandatoryYesYes

UUID0x00020x0003

TypeU8[20]U8[20]

R

X

WX

N

X

I

R = Read; W = Write; N = Notify; I = Indicate

Characteristic names are assigned from the point of view of the Central device

TX (0x0002)

This characteristic is used to send data back to the sensor node, and can be written to by the connected Central device (the mobile phone, tablet,etc.).

RX (0x0003)

This characteristic is used to send data out to the connected Central device. Notify can be enabled by the connected device so that an alert israised every time the TX channel is updated.


Page 101 of 115

Software ResourcesTo help you get your Bluefruit LE module talking to other Central devices, we've put together a number of open source tools for most of the majorplatforms supporting Bluetooth Low Energy.

Bluefruit LE Client Apps and LibrariesAdafruit has put together the following mobile or desktop apps and libraries to make it as easy as possible to get your Bluefruit LE module talkingto your mobile device or laptop, with full source available where possible:

Bluefruit LE Connect (http://adafru.it/f4G) (Android/Java)

Bluetooth Low Energy support was added to Android starting with Android 4.3 (though it was only really stable starting with 4.4), and we'vealready released Bluefruit LE Connect to the Play Store (http://adafru.it/f4G).

The full source code (http://adafru.it/fY9) for Bluefruit LE Connect for Android is also available on Github to help you get started with your ownAndroid apps. You'll need a recent version of Android Studio (http://adafru.it/fYa) to use this project.

Bluefruit LE Connect (http://adafru.it/f4H) (iOS/Swift)

Apple was very early to adopt Bluetooth Low Energy, and we also have an iOS version of the Bluefruit LE Connect (http://adafru.it/f4H) appavailable in Apple's app store.

The full swift source code for Bluefruit LE Connect for iOS is also available on Github. You'll need XCode and access to Apple's developperprogram to use this project:

Version 1.x source code: https://github.com/adafruit/Bluefruit_LE_Connect (http://adafru.it/ddv)Version 2.x source code: https://github.com/adafruit/Bluefruit_LE_Connect_v2 (http://adafru.it/o9E)

Version 2.x of the app is a complete rewrite that includes iOS, OS X GUI and OS X command-line tools in a single codebase.

Bluefruit LE Connect for OS X (http://adafru.it/o9F) (Swift)This OS X desktop application is based on the same V2.x codebase as the iOS app, and gives you access to BLE UART, basic Pin I/O and OTADFU firmware updates from the convenience of your laptop or mac.

This is a great choice for logging sensor data locally and exporting it as a CSV, JSON or XML file for parsing in another application, and uses thenative hardware on your computer so no BLE dongle is required on any recent mac.

The full source is also available on Github (http://adafru.it/o9E).


Page 102 of 115



https://github.com/adafruit/Bluefruit_LE_Connect_Android

https://developer.android.com/sdk/index.html



https://github.com/adafruit/Bluefruit_LE_Connect

https://github.com/adafruit/Bluefruit_LE_Connect_v2

https://itunes.apple.com/us/app/adafruit-bluefruit-le-connect/id1082414600?mt=12

https://github.com/adafruit/Bluefruit_LE_Connect_v2

Bluefruit LE Command Line Updater for OS X (http://adafru.it/pLF)(Swift)This experimental command line tool is unsupported and provided purely as a proof of concept, but can be used to allow firmware updates forBluefruit devices from the command line.

This utility performs automatic firmware updates similar to the way that the GUI application does, by checking the firmware version on yourBluefruit device (via the Device Information Service), and comparing this against the firmware versions available online, downloading files in thebackground if appropriate.

Simply install the pre-compiled tool via the DMG file (http://adafru.it/pLF) and place it somewhere in the system path, or run the file locally via'./bluefruit' to see the help menu:

$ ./bluefruitbluefruit v0.3Usage: bluefruit <command> [options...]

Commands: Scan peripherals: scan Automatic update: update [--enable-beta] [--uuid <uuid>] Custom firmware: dfu --hex <filename> [--init <filename>] [--uuid <uuid>] Show this screen: --help Show version: --version

Options: --uuid <uuid> If present the peripheral with that uuid is used. If not present a list of peripherals is displayed --enable-beta If not present only stable versions are used

Short syntax: -u = --uuid, -b = --enable-beta, -h = --hex, -i = --init, -v = --version, -? = --help

Deprecated: Bluefruit Buddy (http://adafru.it/mCn) (OS X)

This native OS X application is a basic proof of concept app that allows you to connect to your Bluefruit LE module using most recent macbooks oriMacs. You can get basic information about the modules and use the UART service to send and receive data.

The full source for the application is available in the github repo at Adafruit_BluefruitLE_OSX (http://adafru.it/mCo).


Page 103 of 115

https://github.com/adafruit/Bluefruit_LE_Connect_v2/releases/tag/OSXcommandline_0.3

https://github.com/adafruit/Bluefruit_LE_Connect_v2/releases/tag/OSXcommandline_0.3

https://itunes.apple.com/us/app/bluefruit-buddy/id1042412646?mt=12

https://github.com/adafruit/Adafruit_BluefruitLE_OSX

ABLE (http://adafru.it/ijB) (Cross Platform/Node+Electron)

ABLE (http://adafru.it/ijB) (Adafruit Bluefruit LE Desktop) is a cross-platform desktop application based on Sandeep Misty's noblelibrary (http://adafru.it/ijC) and the Electron (http://adafru.it/ijD) project from Github (used by Atom).

It runs on OS X, Windows 7+ and select flavours of Linux (Ubuntu tested locally). Windows 7 support is particularly interesting since Windows 7has no native support for Bluetooth Low Energy but the noble library talks directly to supported Bluetooth 4.0 USB dongles (http://adafru.it/1327) toemulate BLE on the system (though at this stage it's still in early BETA and drops the connection and takes more care to work with).

This app allows you to collect sensor data or perform many of the same functionality offered by the mobile Bluefruit LE Connect apps, but on thedesktop.

The app is still in BETA, but full source (http://adafru.it/ijE) is available in addition to the easy to use pre-compiled binaries (http://adafru.it/ijB).

Bluefruit LE Python Wrapper (http://adafru.it/fQF)

As a proof of concept, we've played around a bit with getting Python working with the native Bluetooth APIs on OS X and the latest version ofBluez on certain Linux targets.

There are currently example sketches showing how to retreive BLE UART data as well as some basic details from the Device Information Service(DIS).


Page 104 of 115

https://github.com/adafruit/adafruit-bluefruit-le-desktop/releases


https://github.com/sandeepmistry/noble

https://github.com/atom/electron


https://github.com/adafruit/adafruit-bluefruit-le-desktop


https://github.com/adafruit/Adafruit_Python_BluefruitLE

This isn't an actively support project and was more of an experiment, but if you have a recent Macbook or a Raspberry Pi and know Python, youmight want to look at Adafruit_Python_BluefruitLE (http://adafru.it/fQF) in our github account.

Debug ToolsIf your sense of adventure gets the better of you, and your Bluefruit LE module goes off into the weeds, the following tools might be useful to get itback from unknown lands.

These debug tools are provided purely as a convenience for advanced users for device recovery purposes, and are not recommended unlessyou're OK with potentially bricking your board. Use them at your own risk.

AdaLink (http://adafru.it/fPq) (Python)

This command line tool is a python-based wrapper for programming ARM MCUs using either a Segger J-Link (http://adafru.it/fYU) or anSTLink/V2 (http://adafru.it/ijF). You can use it to reflash your Bluefruit LE module using the latest firmware from the Bluefruit LE firmwarerepo (http://adafru.it/edX).

Details on how to use the tool are available in the readme.md file on the main Adafruit_Adalink (http://adafru.it/fPq) repo on Github.

Completely reprogramming a Bluefruit LE module with AdaLink would require four files, and would look something like this (using a JLink):

adalink nrf51822 --programmer jlink --wipe --program-hex "Adafruit_BluefruitLE_Firmware/softdevice/s110_nrf51_8.0.0_softdevice.hex" --program-hex "Adafruit_BluefruitLE_Firmware/bootloader/bootloader_0002.hex" --program-hex "Adafruit_BluefruitLE_Firmware/0.6.7/blefriend32/blefriend32_s110_xxac_0_6_7_150917_blefriend32.hex" --program-hex "Adafruit_BluefruitLE_Firmware/0.6.7/blefriend32/blefriend32_s110_xxac_0_6_7_150917_blefriend32_signature.hex"

You can also use the AdaLink tool to get some basic information about your module, such as which SoftDevice is currently programmed or the ICrevision (16KB SRAM or 32KB SRAM) via the --info command:

$ adalink nrf51822 -p jlink --infoHardware ID : QFACA10 (32KB)Segger ID : nRF51822_xxACSD Version : S110 8.0.0Device Addr : **:**:**:**:**:**Device ID : ****************

Adafruit nRF51822 Flasher (http://adafru.it/fVL) (Python)

Adafruit's nRF51822 Flasher is an internal Python tool we use in production to flash boards as they go through the test procedures and off theassembly line, or just testing against different firmware releases when debugging.

It relies on AdaLink or OpenOCD beneath the surface (see above), but you can use this command line tool to flash your nRF51822 with a specificSoftDevice, Bootloader and Bluefruit firmware combination.

It currently supports using either a Segger J-Link or STLink/V2 via AdaLink, or GPIO on a Raspberry Pi (http://adafru.it/fVL) if you don't haveaccess to a traditional ARM SWD debugger. (A pre-built version of OpenOCD for the RPi is included in the repo since building it from scratchtakes a long time on the original RPi.)

We don't provide active support for this tool since it's purely an internal project, but made it public just in case it might help an adventurouscustomer debrick a board on their own.

$ python flash.py --jtag=jlink --board=blefriend32 --softdevice=8.0.0 --bootloader=2 --firmware=0.6.7jtag : jlinksoftdevice : 8.0.0bootloader : 2board : blefriend32firmware : 0.6.7Writing Softdevice + DFU bootloader + Application to flash memoryadalink -v nrf51822 --programmer jlink --wipe --program-hex "Adafruit_BluefruitLE_Firmware/softdevice/s110_nrf51_8.0.0_softdevice.hex" --program-hex "Adafruit_BluefruitLE_Firmware/bootloader/bootloader_0002.hex" --program-hex "Adafruit_BluefruitLE_Firmware/0.6.7/blefriend32/blefriend32_s110_xxac_0_6_7_150917_blefriend32.hex" --program-hex "Adafruit_BluefruitLE_Firmware/0.6.7/blefriend32/blefriend32_s110_xxac_0_6_7_150917_blefriend32_signature.hex"...


Page 105 of 115

https://github.com/adafruit/Adafruit_Python_BluefruitLE

https://github.com/adafruit/Adafruit_Adalink

https://www.adafruit.com/search?q=J-Link


https://github.com/adafruit/Adafruit_BluefruitLE_Firmware


https://github.com/adafruit/Adafruit_nRF51822_Flasher

https://github.com/adafruit/Adafruit_nRF51822_Flasher#rpi-gpio-requirements

BLE FAQCan I talk to Classic Bluetooth devices with a Bluefruit LE modules?

No. Bluetooth Low Energy and 'Classic' Bluetooth are both part of the same Bluetooth Core Specification -- defined and maintained by theBluetooth SIG -- but they are completely different protocols operating with different physical constraints and requirements. The two protocols can'ttalk to each other directly.

Can my Bluefruit LE module connect to other Bluefruit LE peripherals

No, the Bluefruit LE firmware from Adafruit is currently peripheral only, and doesn't run in Central mode, which would cause the module to behavesimilar to your mobile phone or BLE enabled laptop.

At some point we might consider a new firmware image offering this, but since 98% of the uses cases for BLE involved running as a peripheralwe've concentrated all of our development effort there for now.

Why are none of my changes persisting when I reset with the sample sketches?

In order to ensure that the Bluefruit LE modules are in a known state for the Adafruit demo sketches, most of them perform a factory reset at thestart of the sketch.

This is useful to ensure that the sketch functions properly, but has the side effect of erasing any custom user data in NVM and setting everythingback to factory defaults every time your board comes out of reset and the sketch runs.

To disable factory reset, open the demo sketch and find the FACTORYRESET_ENABLE flag and set this to '0', which will prevent the factory resetfrom happening at startup.

If you don't see the 'FACTORYRESET_ENABLE' flag in your .ino sketch file, you probably have an older version of the sketches and may need toupdate to the latest version via the Arduino library manager.

Do I need CTS and RTS on my UART based Bluefruit LE Module?

Using CTS and RTS isn't strictly necessary when using HW serial, but they should both be used with SW serial, or any time that a lot of data isbeing transmitted.

The reason behind the need for CTS and RTS is that the UART block on the nRF51822 isn't very robust, and early versions of the chip had anextremely small FIFO meaning that the UART peripheral was quickly overwhelmed.

Using CTS and RTS significantly improves the reliability of the UART connection since these two pins tell the device on the other end when theyneed to wait while the existing buffered data is processed.

To enable CTS and RTS support, go into the BluefruitConfig.h file in your sketch folder and simply assign an appropriate pin to the macrosdedicated to those functions (they may be set to -1 if they aren't currently being used).

Enabling both of these pins should solve any data reliability issues you are having with large commands, or when transmitting a number ofcommands in a row.

How can I update to the latest Bluefruit LE Firmware?

The easiest way to keep your Bluefruit LE modules up to date is with our Bluefruit LE Connect app for Android (http://adafru.it/f4G) or Bluefruit LEConnect for iOS (http://adafru.it/f4H). Both of these apps include a firmware update feature that allows you to automatically download the latestfirmware and flash your Bluefruit LE device in as safe and painless a manner as possible. You can also roll back to older versions of the BluefruitLE firmware using these apps if you need to do some testing on a previous version.

Which firmware version supports 'xxx'?

We regularly release Bluefruit LE firmware images (http://adafru.it/edX) with bug fixes and new features. Each AT command in this learning guidelists the minimum firmware version required to use that command, but for a higher level overview of the changes from one firmware version to thenext, consult the firmware history page (http://adafru.it/iCw).

Does my Bluefruit LE device support ANCS?

ANCS is on the roadmap for us (most likely in the 0.7.x release family), but we don't currently support it since there are some unusual edge caseswhen implementing it as a service.

My Bluefruit LE device is stuck in DFU mode ... what can I do?

If your device is stuck in DFU mode for some reason and the firmware was corrupted, you have several options.

First, try a factory reset by holding down the DFU button for about 10 seconds until the CONN LED starts flashing, then release the DFU button to


Page 106 of 115




perform a factory reset.

If this doesn't work, you may need to reflash your firmware starting from DFU mode, which can be done in one of the following ways:

Bluefruit LE Connect (Android)

Place the module in DFU mode (constant LED blinky)Open Bluefruit LE ConnectConnect to the 'DfuTarg' deviceOnce connected, you will see a screen with some basic device information. Click the '...' in the top-right corner and select Firmware UpdatesClick the Use Custom Firmware buttonSelect the appropriate .hex and .init files (copied from the Bluefruit LE Firmware repo (http://adafru.it/edX)) ... for the BLEFRIEND32 firmwareversion 0.6.7, this would be:

Hex File: blefriend32_s110_xxac_0_6_7_150917_blefriend32.hexInit File: blefriend32_s110_xxac_0_6_7_150917_blefriend32_init.dat

Click Start Update

Unfortunately, the iOS app doesn't yet support custom firmware updates from DFU mode yet, but we will get this into the next release.

Nordic nRF Toolbox

You can also use Nordic's nRF Toolbox application to update the firmware using the OTA bootloader.

On Android:

Open nRF Toolbox (using the latest version)Click the DFU iconClick the Select File buttonSelect Application from the radio button list, then click OKFind the appropriate .hex file (ex. 'blefriend32_s110_xxac_0_6_7_150917_blefriend32.hex')When asked about the 'Init packet', indicate Yes, and select the appropriate *_init.dat file (for example:'blefriend32_s110_xxac_0_6_7_150917_blefriend32_init.dat').Click the Select Device button at the bottom of the main screen and find the DfuTarg device, clicking on itClick the Upload button, which should now be enabled on the home screenThis will begin the DFU update process which should cause the firmware to be updated or restored on your Bluefruit LE module

On iOS:

Create a .zip file containing the .hex file and init.dat file that you will use for the firmware update. For example:Rename 'blefriend32_s110_xxac_0_6_7_150917_blefriend32.hex' to application.hexRename 'blefriend32_s110_xxac_0_6_7_150917_blefriend32_init.dat' to application.dat

Upload the .zip file containing the application.hex and application.dat files to your iPhone using uTunes, as describedhere (http://adafru.it/iCx)Open the nRF Toolbox app (using the latest version)Click the DFU iconClick the Select File text labelSwitch to User Files to see the .zip file you uploaded aboveSelect the .zip file (ex. blefriend32_065.zip)On the main screen select Select File TypeSelect applicationOn the main screen select SELECT DEVICESelect DfuTargClick the Upload button which should now be enabledThis will begin the DFU process and your Bluefruit LE module will reset when the update is completeIf you get the normal 2 or 3 pulse blinky pattern, the update worked!

Adafruit_nRF51822_Flasher

As a last resort, if you have access to a Raspberry Pi, a Segger J-Link or a STLink/V2, you can also try manually reflashing the entire device, asdescribed in the FAQ above (http://adafru.it/iCy), with further details on the Software Resources (http://adafru.it/iCz) page.

How do I reflash my Bluefruit LE module over SWD?

Reflashing Bluefruit LE modules over SWD (ex. switching to the sniffer firmware and back) is at your own risk and can lead to a bricked device,and we can't offer any support for this operation! You're on your own here, and there are unfortunately 1,000,000 things that can go wrong,which is why we offer two separate Bluefruit LE Friend boards -- the sniffer and the normal Bluefruit LE Friend board with the non-sniffer firmware,which provides a bootloader with fail safe features that prevents you from ever bricking boards via OTA updates.

AdaLink (SWD/JTAG Debugger Wrapper)


Page 107 of 115


Transitioning between the two board types (sniffer and Bluefruit LE module) is unfortunately not a risk-free operation, and requires externalhardware, software and know-how to get right, which is why it isn't covered by our support team.

That said ... if you're determined to go down that lonely road, and you have a Segger J-Link (http://adafru.it/fYU) (which is what we use internallyfor production and development), or have already erased your Bluefruit LE device, you should have a look at AdaLink (http://adafru.it/fPq), which isthe tool we use internally to flash the four files required to restore a Bluefruit LE module. (Note: recent version of AdaLink also support the cheaperSTLink/V2 (http://adafru.it/2548), though the J-Link is generally more robust if you are going to purchase a debugger for long term use.)

The mandatory Intel Hex files are available in the Bluefruit LE Firmware repo (http://adafru.it/edX). You will need to flash:

An appropriate bootloader imageAn appropriate SoftDevice imageThe Bluefruit LE firmware imageThe matching signature file containing a CRC check so that the bootloader accepts the firmware image above (located in the same folder asthe firmware image)

The appropriate files are generally listed in the version control .xml file (http://adafru.it/fPr) in the firmware repository.

If you are trying to flash the sniffer firmware (at your own risk!), you only need to flash a single .hex file, which you can findhere (http://adafru.it/fYV). The sniffer doesn't require a SoftDevice image, and doesn't use the fail-safe bootloader -- which is why changing is a oneway and risky operation if you don't have a supported SWD debugger.

Adafruit_nF51822_Flasher

We also have an internal python tool available that sits one level higher than AdaLink (referenced above), and makes it easier to flash specificversions of the official firmware to a Bluefruit LE module. For details, see the Adafruit_nRF51822_Flasher (http://adafru.it/fVL) repo.

Can I access BETA firmware releases?

The latest versions of the Bluefruit LE Connect applications for iOS and Android allow you to optionally update your Bluefruit LE modules with pre-release or BETA firmware.

This functionality is primarilly provided as a debug and testing mechanism for support issues in the forum, and should only be used when trying toidentify and resolve specific issues with your modules!

Enabling BETA Releases on iOS

Make sure you have at least version 1.7.1 of Bluefruit LE ConnectGo to the Settings pageScroll to the bottom of the Settings page until you find Bluefruit LEClick on the Bluefruit LE icon and enable the Show beta releases switchYou should be able to see any BETA releases available in the firmware repo now when you use Bluefruit LE Connect

Enabling BETA Releases on Android

Make sure you have the latest version of Bluefruit LE ConnectOpen the Bluefruit LE Connect applicationClick the "..." icon in the top-right corner of the app's home screenSelect SettingsScroll down to the Software Updates section and enable Show beta releasesYou should be able to see any BETA releases available in the firmware repo now when you use Bluefruit LE Connect

Why can't I see my Bluefruit LE device after upgrading to Android 6.0?

In Android 6.0 there were some important security changes (http://adafru.it/jcU) that affect Bluetooth Low Energy devices. If location services areunavailable (meaning the GPS is turned off) you won't be able to see Bluetooth Low Energy devices advertising either. See thisissue (http://adafru.it/jcV) for details.

Be sure to enable location services on your Android 6.0 device when using Bluefruit LE Connect or other Bluetooth Low Energy applications withyour Bluefruit LE modules.

What is the theoretical speed limit for BLE?

This depends on a variety of factors, and is determined by the capabilities of the central device (the mobile phone, etc.) as much as the peripheral.

Taking the HW limits on the nR51822 into account (max 6 packets per connection interval, and a minimum connection interval of 7.5ms) you endup with the following theoretical limits on various mobile operating systems:

iPhone 5/6 + IOS 8.0/8.16 packets * 20 bytes * 1/0.030 s = 4 kB/s = 32 kbpsiPhone 5/6 + IOS 8.2/8.33 packets * 20 bytes * 1/0.030 s = 2 kB/s = 16 kbps


Page 108 of 115

https://www.adafruit.com/search?q=J-Link




https://github.com/adafruit/Adafruit_BluefruitLE_Firmware/blob/master/releases.xml

https://github.com/adafruit/Adafruit_BluefruitLE_Firmware/tree/master/sniffer/1.0.1

https://github.com/adafruit/Adafruit_nRF51822_Flasher

http://developer.android.com/about/versions/marshmallow/android-6.0-changes.html#behavior-hardware-id

https://code.google.com/p/android/issues/detail?id=190372&q=GPS&colspec=ID Type Status Owner Summary Stars

iPhone 5/6 + IOS 8.x with nRF80011 packet * 20 bytes * 1/0.030 s = 0.67 kB/s = 5.3 kbpsNexus 44 packets * 20 bytes * 1/0.0075 s = 10.6 kB/s = 84 kbpsNordic Master Emulator Firmware (MEFW) with nRF51822 0.9.01 packet * 20 bytes * 1/0.0075 = 2.67 kB/s = 21.33 kbpsNordic Master Emulator Firmware (MEFW) with nRF51822 0.11.06 packets * 20 bytes * 1/0.0075 = 16 kB/s = 128 kbps

There are also some limits imposed by the Bluefruit LE firmware, but we are actively working to significantly improve the throughput in theupcoming 0.7.0 release, which will be available Q2 2016. The above figures are useful as a theoretical maximum to decide if BLE is appropriatefor you project or not.

UPDATE: For more specific details on the limitations of various Android versions and phones, see this helpful post from NordicSemiconductors (http://adafru.it/sKc).

Can my Bluefruit board detect other Bluefruit boards or Central devices?

No. All of our Bluefruit LE modules currently operate in peripheral mode, which means they can only advertise their own existence via theadvertising payload. The central device (usually your phone or laptop) is responsible for listening for these advertising packets, starting theconnection process, and inititating any transactions between the devices. There is no way for a Bluefruit module to detect other Bluefruit modulesor central devices in range, they can only send their own advertising data out and wait for a connection request to come in.

How can I determine the distance between my Bluefruit module and my phone in m/ft?

The short answer is: you can't.

RF devices normally measure signal strength using RSSI, which stands for Received Signal Strength Indicator, which is measured in dBm. Thecloser the devices are the strong the RSSI value generally is (-90dBm is much weaker than -60dBm, for example), but there is no reliablerelationship between RSSI values in dBm and distance in the real world. If there is a wall between devices, RSSI will fall. If there is a lot ofinterference on the same 2.4GHz band, RSSI will fall. Depending on the device, if you simply change the antenna orientation, RSSI will fall. Youcan read the RSSI value between two connected devices with the AT+BLEGETRSSI command, but there are no meaningful and repeatableconclusions that can be drawn from this value about distance other than perhaps 'farther' or 'closer' in a very loose sense of the terms.

How far away from my phone can I have my Bluefruit LE module?

This depends on a number of factors beyond the module itself such as antenna orientation, the antenna design on the phone, transmit power onthe sending node, competing traffic in the same 2.4GHz bandwidth, obstacles between end points, etc.

It could be as low as a couple meters up to about 10 meters line of sight, but generally Bluetooth Low Energy is designed for very short range andwill work best in the 5-6 meter or less range for reliable communication, assuming normal Bluefruit firmware settings.

How many GATT services and characteristics can I create?

For firmware 0.7.0 and higher, the following limitations are present:

Maximum number of services: 10Maximum number of characteristics: 30Maximum buffer size for each characteristic: 32 bytesMaximum number of CCCDs: 16

Is it possible to modify or disable the built in GATT services and characteristics (DIS, DFU, etc.)?

No, unfortunately you can't. We rely on the Device Information Service (http://adafru.it/q9E) (DIS) contents to know which firmware and bootloaderversion you are running, and wouldn't be able to provide firmware updates without being able to trust this information, which i why it's bothmandatory and read only.

Similarly, the DFU service is mandatory to maintain over the air updates and disabling it would create more problems that it's presence wouldcause.

How can I use BlueZ and gatttool with Bluefruit modules?

BlueZ has a bit of a learning curve associated with it, but you can find some notes below on one option to send and receive data using the BLEUART Service built into all of our Bluefruit LE modules and boards.

These commands may change with different versions of BlueZ. Version 5.21 was used below.

# Initialise the USB dongle$ sudo hciconfig hci0 up

# Scan for the UART BLE device$ sudo hcitool lescan D6:4E:06:4F:72:86 UART


Page 109 of 115

https://devzone.nordicsemi.com/blogs/1046/what-to-keep-in-mind-when-developing-your-ble-andr/

https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.service.device_information.xml

# Start gatttool, pointing to the UART device found above$ sudo gatttool -b D6:4E:06:4F:72:86 -I -t random --sec-level=high

[D6:4E:06:4F:72:86][LE]> connect Attempting to connect to D6:4E:06:4F:72:86 Connection successful # Scan for primary GATT Services [D6:4E:06:4F:72:86][LE]> primary attr handle: 0x0001, end grp handle: 0x0007 uuid: 00001800-0000-1000-8000-00805f9b34fb attr handle: 0x0008, end grp handle: 0x0008 uuid: 00001801-0000-1000-8000-00805f9b34fb attr handle: 0x0009, end grp handle: 0x000e uuid: 6e400001-b5a3-f393-e0a9-e50e24dcca9e attr handle: 0x000f, end grp handle: 0xffff uuid: 0000180a-0000-1000-8000-00805f9b34fb

# Get the handles for the entries in the UART service (handle 0x0009) [D6:4E:06:4F:72:86][LE]> char-desc handle: 0x0001, uuid: 00002800-0000-1000-8000-00805f9b34fb handle: 0x0002, uuid: 00002803-0000-1000-8000-00805f9b34fb handle: 0x0003, uuid: 00002a00-0000-1000-8000-00805f9b34fb handle: 0x0004, uuid: 00002803-0000-1000-8000-00805f9b34fb handle: 0x0005, uuid: 00002a01-0000-1000-8000-00805f9b34fb handle: 0x0006, uuid: 00002803-0000-1000-8000-00805f9b34fb handle: 0x0007, uuid: 00002a04-0000-1000-8000-00805f9b34fb handle: 0x0008, uuid: 00002800-0000-1000-8000-00805f9b34fb handle: 0x0009, uuid: 00002800-0000-1000-8000-00805f9b34fb handle: 0x000a, uuid: 00002803-0000-1000-8000-00805f9b34fb handle: 0x000b, uuid: 6e400002-b5a3-f393-e0a9-e50e24dcca9e handle: 0x000c, uuid: 00002803-0000-1000-8000-00805f9b34fb handle: 0x000d, uuid: 6e400003-b5a3-f393-e0a9-e50e24dcca9e handle: 0x000e, uuid: 00002902-0000-1000-8000-00805f9b34fb handle: 0x000f, uuid: 00002800-0000-1000-8000-00805f9b34fb handle: 0x0010, uuid: 00002803-0000-1000-8000-00805f9b34fb handle: 0x0011, uuid: 00002a27-0000-1000-8000-00805f9b34fb

# 6e400002 (handle 0x000b) = TX characteristic# 6e400003 (handle 0x000d) = RX characteristic

# Optional (but maybe helpful) ... scan for CCCD entries [D6:4E:06:4F:72:86][LE]> char-read-uuid 2902 handle: 0x000e value: 00 00 # Enable notifications on the RX characteristic (CCCD handle = 0x000e)# 0100 = get notifications# 0200 = get indications# 0300 = get notifications + indications# 0000 = disable notifications + indications [D6:4E:06:4F:72:86][LE]> char-write-req 0x000e 0100 Characteristic value was written successfully

# Just to make sure it was updated [D6:4E:06:4F:72:86][LE]> char-read-hnd 0x000e Characteristic value/descriptor: 01 00 # Writing "test" in the Serial Monitor of the Arduino sketch should# cause this output not that notifications are enabled: Notification handle = 0x000d value: 74 65 73 74

# Write something to the TX characteristic (handle = 0x000b)# This should cause E F G H to appear in the Serial Monitor [D6:4E:06:4F:72:86][LE]> char-write-cmd 0x000b 45 [D6:4E:06:4F:72:86][LE]> char-write-cmd 0x000b 46 [D6:4E:06:4F:72:86][LE]> char-write-cmd 0x000b 47 [D6:4E:06:4F:72:86][LE]> char-write-cmd 0x000b 48

# To send multiple bytes [D6:4E:06:4F:72:86][LE]> char-write-cmd 0x000B 707172737475 # If you are running the callbackEcho sketch and notifications# are enabled you should get this response after the above cmd: Notification handle = 0x000d value: 70 71 72 73 74 75

--------------

# If you just want to enable constant listening, enter the following command from the CLI:$ sudo gatttool -b D6:4E:06:4F:72:86 -t random --char-write-req -a 0x000e -n 0100 --listen

# This should give us the following output as data is written on the Uno,# though we can't send anything back: Characteristic value was written successfully Notification handle = 0x000d value: 74 65 73 74 Notification handle = 0x000d value: 6d 6f 72 65 20 74 65 73 74


Page 110 of 115

Can I use the IRQ pin to wake my MCU up from sleep when BLE UART data is available?

No, on SPI-based boards the IRQ pin is used to indicate that an SDEP response is available to an SDEP command. For example, when you sentthe `AT+BLEUARTRX` command as an SDEP message, the Bluefruit firmware running on the nRF51822 will parse the message, prepare anSDEP response, and trigger the IRQ pin to tell the MCU that the response is ready. This is completely independant from the BLE UART service,which doesn't have interrupt capability at present.


Page 111 of 115

Device RecoverySometimes, bad things unfortunately happen. Thankfully, 99% of the time it's purely a SW issue and the Bluefruit devices have a robust bootloaderwith some fail safes that can almost always recover your device.

How to Recover a Bluefruit Board1. Force DFU Mode at Startup

The first step is to force your board into a special bootloader mode, which will prevent any faulty user sketches or corrupted config data fromcausing problems.

Connect the DFU pin to GND with a jumper cable, or if your board has a DFU button hold the button down when adding power to your board(connecting the USB cable, etc.)Once the device is powered, you should see a faster DFU MODE blinky pattern that lets you know you are in bootloader mode.Now remove the jumper cable between DFU and GND (to prevent going into DFU mode when you reset)

Remove the jumper cable between DFU and GND once you are in DFU mode so that you exit it during the next reset!

2. Update the Bluefruit Firmware

Next, update your device to the latest Bluefruit firmware using the Bluefruit LE Connect app. We regularly fix bugs, and it's always a good idea tobe on the latest release.

You can perform a firmware update in DFU mode, although the Bluefruit board may appear as DfuTarg in the Bluefruit LE Connect app, and youwill will need to select the right firmware 'family' for you board.

Because bootloader mode is a fail safe mode and has a small subset of Bluefruit's features, we can't tell the Bluefruit LE Connect app very manydetails about our HW. As such, you will need to indicate which firmware type to flash ... specifically, whether to flash the UART of SPI basedfirmware. Be sure to select the right one, based on your product and the table below:

BLEFRIEND32 Firmware (UART, 32KB SRAM)

Bluefruit UART Friend V2 (http://adafru.it/edl)Bluefruit LE UART Friend (http://adafru.it/tYD)

BLESPIFRIEND Firmware (SPI)

Bluefruit LE SPI Friend (http://adafru.it/fLp)Bluefruit LE Shield (http://adafru.it/2746)Bluefruit LE Micro (http://adafru.it/tYE)Feather 32u4 Bluefruit LE (http://adafru.it/tYF)Feather M0 Bluefruit LE (http://adafru.it/2995)

3. Flash a Test Sketch

Once the core Bluefruit firmware has been updated, flash a test sketch to the device from the Arduino IDE, such as the following blinky code:

// the setup function runs once when you press reset or power the boardvoid setup() { // initialize digital pin LED_BUILTIN as an output. pinMode(LED_BUILTIN, OUTPUT);}

// the loop function runs over and over again forevervoid loop() { digitalWrite(LED_BUILTIN, HIGH); // turn the LED on (HIGH is the voltage level) delay(1000); // wait for a second digitalWrite(LED_BUILTIN, LOW); // turn the LED off by making the voltage LOW delay(1000); // wait for a second}

4. Perform a Factory Reset

Once the core Bluefruit firmware has been updated, the final step is to perform a factory reset.

With the board still powered up, connect the DFU pin to GND


Page 112 of 115





Leave the pin set to GND (or hold the DFU button down) for >5 seconds until the BLUE status LED starts to blinkRemove the DFU jumper cable or release the DFU button

This will cause a factory reset which will wipe all config data, and should restore your board, getting you back to a normal state in most situations!

Still Having Problems?Hop on over to our support forums (http://adafru.it/dYq) clearly explaining your problem along with the following information, and, we'll be happy tohelp:

You product name and ideally the product IDThe Bluefruit firmware version you are using (available at the top of the Serial Monitor output on most example sketches)The Operating System your are usingThe Arduino IDE version you are using

Providing the above information in your first post will skip a round of two of back and forth and you'll get an answer from us quicker, savingeveryone time and effort!

Be sure to see the FAQ section of this learning guide as well, which has answer to many common problems!


Page 113 of 115

https://forums.adafruit.com/

Downloads

FilesMDBT Datasheet (http://adafru.it/oYE)EagleCAD PCB files on GitHub (http://adafru.it/rDV)Fritzing object in the Adafruit Fritzing Library (http://adafru.it/aP3)

Schematic

Board LayoutAll measurements are in inches.


Page 114 of 115

https://cdn-shop.adafruit.com/product-files/2267/MDBT40-P256R.pdf

https://github.com/adafruit/Adafruit-Bluefruit-LE-UART-Friend-PCB

https://github.com/adafruit/Fritzing-Library

© Adafruit Industries Last Updated: 2017-04-24 08:30:29 PM UTC Page 115 of 115

Documents

Introducing the Adafruit Bluefruit LE UART FriendSo what you really need is the new Adafruit Bluefruit LE UART Friend! The Bluefruit LE UART Friend makes it easy to add Bluetooth Low