Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sandeepmistry/arduino-BLEPeripheral

An Arduino library for creating custom BLE peripherals with Nordic Semiconductor's nRF8001 or nR51822.
https://github.com/sandeepmistry/arduino-BLEPeripheral

Last synced: about 2 months ago
JSON representation

An Arduino library for creating custom BLE peripherals with Nordic Semiconductor's nRF8001 or nR51822.

Host: GitHub
URL: https://github.com/sandeepmistry/arduino-BLEPeripheral
Owner: sandeepmistry
License: mit
Created: 2014-06-20T22:15:27.000Z (about 10 years ago)
Default Branch: master
Last Pushed: 2023-11-10T14:21:36.000Z (10 months ago)
Last Synced: 2024-06-30T04:13:38.653Z (3 months ago)
Language: C
Homepage:
Size: 1.14 MB
Stars: 461
Watchers: 44
Forks: 179
Open Issues: 96
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

Awesome-arduino - arduino-BLEPeripheral - Library for creating custom BLE peripherals with Nordic Semiconductor's nRF8001 or nR51822 (Libraries)
awesome-arduino - arduino-BLEPeripheral - Library for creating custom BLE peripherals with Nordic Semiconductor's nRF8001 or nR51822 (Libraries)

README

        # Arduino BLEPeripheral

[![Build Status](https://travis-ci.org/sandeepmistry/arduino-BLEPeripheral.svg?branch=master)](https://travis-ci.org/sandeepmistry/arduino-BLEPeripheral) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sandeepmistry/arduino-BLEPeripheral?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

An [Arduino](http://arduino.cc) library for creating custom BLE peripherals with [Nordic Semiconductor](http://www.nordicsemi.com)'s [nRF8001](http://www.nordicsemi.com/eng/Products/Bluetooth-R-low-energy/nRF8001) or [nR51822](http://www.nordicsemi.com/eng/Products/Bluetooth-R-low-energy/nRF51822).

Enables you to create more customized BLE Peripheral's compared to the basic UART most other Arduino BLE libraries provide.

[nRFgo Studio](http://www.nordicsemi.com/chi/node_176/2.4GHz-RF/nRFgo-Studio) (and Windows) is not required when using the [nRF8001](http://www.nordicsemi.com/eng/Products/Bluetooth-R-low-energy/nRF8001).

## Compatible Hardware

### [Nordic Semiconductor nRF8001](http://www.nordicsemi.com/eng/Products/Bluetooth-R-low-energy/nRF8001)

 * [Adafruit](http://www.adafruit.com)

   * [Bluefruit LE - nRF8001 Breakout](http://www.adafruit.com/products/1697)

 * [RedBearLab](http://redbearlab.com)

   * [BLE Shield](http://redbearlab.com/bleshield/)

   * [Blend Micro](http://redbearlab.com/blendmicro/)

   * [Blend](http://redbearlab.com/blend/)

 * [Femtoduino](http://www.femtoduino.com)

   * [IMUduino BTLE](http://www.femtoduino.com/spex/imuduino-btle)

 * [Olimex](https://www.olimex.com)

   * [MOD-nRF8001](https://www.olimex.com/Products/Modules/RF/MOD-nRF8001/)

   * [OLIMEXINO-NANO-BLE](https://www.olimex.com/Products/Duino/AVR/OLIMEXINO-NANO-BLE/)

 * [Jaycon Systems](http://www.jayconsystems.com)

   * [nRF8001 Bluetooth Breakout Board](http://www.jayconsystems.com/nrf8001-breakout-board.html)

 * [TinyCircuits](https://www.tiny-circuits.com)

  * [TinyShield Bluetooth Low Energy - Nordic](https://www.tiny-circuits.com/tiny-shield-bluetooth-low-energy-nordic.html)

**Note:** Does not require use of [nRFgo Studio](http://www.nordicsemi.com/chi/node_176/2.4GHz-RF/nRFgo-Studio)! However, uses more code space.

### [Nordic Semiconductor nRF51822](http://www.nordicsemi.com/eng/Products/Bluetooth-R-low-energy/nRF51822)

 * [RedBearLab](http://redbearlab.com) with [Arduino Add-on](https://github.com/RedBearLab/nRF51822-Arduino)

   * [nRF51822](http://redbearlab.com/redbearlab-nrf51822)

   * [BLE Nano](http://redbearlab.com/blenano/)

 * [RFduino](http://www.rfduino.com) with [Arduino Add-on](https://github.com/RFduino/RFduino)

 

**WARNING**: Adafruit nRF51 boards are **NOT** compatible with this library, this includes the [Bluefruit LE UART Friend](https://www.adafruit.com/products/2479), [Bluefruit LE SPI Friend](https://www.adafruit.com/products/2633), [Bluefruit LE Shield](https://www.adafruit.com/products/2746), [Flora Wearable Bluefruit LE Module](https://www.adafruit.com/products/2487), [Feather 32u4 Bluefruit LE](https://www.adafruit.com/products/2829), and [Feather M0 Bluefruit LE](https://www.adafruit.com/products/2995).

### Nordic Semiconductor nRF51 or nRF52 based boards

 * Various, see [arduino-nRF5 supported boards](https://github.com/sandeepmistry/arduino-nRF5#supported-boards) via [nRF5 Arduino Add-on](https://github.com/sandeepmistry/arduino-nRF5)

#### Pinouts

| Chip | Shield/Board | REQ Pin | RDY Pin | RST Pin |

| ---- | ------------ | ------- | ------- | ------- |

| nRF8001|

| | Bluefruit LE | 10 | 2 | 9 |

| | BLE Shield 1.x | 9 | 8 | UNUSED |

| | BLE Shield 2.x | 9 | 8 | UNUSED or 4/7 via jumper|

| | Blend | 9 | 8 | UNUSED or 4/5 via jumper |

| | Blend Micro | 6 | 7 | UNUSED or 4 |

| | IMUduino BTLE | 10 | 7 | 9 |

| | TinyShield Bluetooth Low Energy | 10 | 2 | 9 |

| nRF51822 |

| | RedBearLab nRF51822 | -1 (UNUSED) | -1 (UNUSED) | -1 (UNUSED) |

| | BLE Nano | -1 (UNUSED) | -1 (UNUSED) | -1 (UNUSED) |

| | RFduino | -1 (UNUSED) | -1 (UNUSED) | -1 (UNUSED) |

## Compatible IDE's and MCU's

 * [Arduino IDE](http://arduino.cc/en/Main/Software#toc1)

   * AVR (Uno, Lenoardo, Mega, etc.)

   * SAM3X8E (Due)

   * SAMD21G18A (Zero)

 * [Teensy](https://www.pjrc.com/teensy/) (via [Teensyduino](https://www.pjrc.com/teensy/td_download.html))

   * 2.0

   * 3.0

   * 3.1

   * LC

**Warning**: For more advanced sketches an MCU with more than 2kB of RAM and 32kB of flash space is recommended. Advance sketches include:

 * Multiple services and characteristics

 * HID API usage

## Usage

### Download Library

#### Arduino

#### Using the Arduino IDE Library Manager

1. Choose ```Sketch``` -> ```Include Library``` -> ```Manage Libraries...```

2. Type ```BLEPeripheral``` into the search box.

3. Click the row to select the library.

4. Click the ```Install``` button to install the library.

#### Using Git

```sh

cd ~/Documents/Arduino/libraries/

git clone https://github.com/sandeepmistry/arduino-BLEPeripheral BLEPeripheral

```

#### MPIDE

```

cd ~/Documents/mpide/libraries/

git clone https://github.com/sandeepmistry/arduino-BLEPeripheral BLEPeripheral

```

### [arduino-nRF5x core](https://github.com/sandeepmistry/arduino-nRF5) users

The [arduino-nRF5x core](https://github.com/sandeepmistry/arduino-nRF5) **REQUIRES** a SoftDevice in order to successfully use this library. Please see [Flashing a SoftDevice](https://github.com/sandeepmistry/arduino-nRF5#flashing-a-softdevice).

Further, the error ```fatal error: ble_gatts.h: No such file or directory``` in indicitive of no SoftDevice being selected.

### Starter sketch

Load [starter.ino](examples/starter/starter.ino)

## API

See [API.md](API.md).

## Examples

See [examples](examples) folder.

## License

This libary is [licensed](LICENSE) under the [MIT Licence](http://en.wikipedia.org/wiki/MIT_License).

## Useful Links

 * [@lizardo](https://github.com/lizardo)'s [nRF8001 Experiments](https://github.com/lizardo/nrf8001)

   * used as a starting point to reverse engineer the proprietary setup message format for the chips

 * [@NordicSemiconductor](https://github.com/NordicSemiconductor)'s [ble-sdk-arduino](https://github.com/NordicSemiconductor/ble-sdk-arduino)

   * Original Arduino SDK for nRF8001

 * [@guanix](https://github.com/guanix)'s [arduino-nrf8001](https://github.com/guanix/arduino-nrf8001)

   * nRF8001 support for Arduino

[![Analytics](https://ga-beacon.appspot.com/UA-56089547-1/sandeepmistry/arduino-BLEPeripheral?pixel)](https://github.com/igrigorik/ga-beacon)