Skip to content

Commit 7f735ee

Browse files
authored
Update README.md
1 parent f648e59 commit 7f735ee

1 file changed

Lines changed: 5 additions & 72 deletions

File tree

README.md

Lines changed: 5 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,12 @@
33
[![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)
44

55

6-
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).
6+
An [Arduino](http://arduino.cc) library for creating custom BLE peripherals and observers with [Nordic Semiconductor](http://www.nordicsemi.com)'s [nR51822](http://www.nordicsemi.com/eng/Products/Bluetooth-R-low-energy/nRF51822).
77

8-
Enables you to create more customized BLE Peripheral's compared to the basic UART most other Arduino BLE libraries provide.
9-
10-
[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).
8+
This is heavily based on @sandeepmistry's [arduino-BLEPeripheral](https://github.com/sandeepmistry/arduino-BLEPeripheral) library. This fork adds support for the observer role (i.e. receiving Bluetooth advertisements), but consequently can't support the nRF8001 anymore.
119

1210
## Compatible Hardware
1311

14-
### [Nordic Semiconductor nRF8001](http://www.nordicsemi.com/eng/Products/Bluetooth-R-low-energy/nRF8001)
15-
16-
* [Adafruit](http://www.adafruit.com)
17-
* [Bluefruit LE - nRF8001 Breakout](http://www.adafruit.com/products/1697)
18-
* [RedBearLab](http://redbearlab.com)
19-
* [BLE Shield](http://redbearlab.com/bleshield/)
20-
* [Blend Micro](http://redbearlab.com/blendmicro/)
21-
* [Blend](http://redbearlab.com/blend/)
22-
* [Femtoduino](http://www.femtoduino.com)
23-
* [IMUduino BTLE](http://www.femtoduino.com/spex/imuduino-btle)
24-
* [Olimex](https://www.olimex.com)
25-
* [MOD-nRF8001](https://www.olimex.com/Products/Modules/RF/MOD-nRF8001/)
26-
* [OLIMEXINO-NANO-BLE](https://www.olimex.com/Products/Duino/AVR/OLIMEXINO-NANO-BLE/)
27-
* [Jaycon Systems](http://www.jayconsystems.com)
28-
* [nRF8001 Bluetooth Breakout Board](http://www.jayconsystems.com/nrf8001-breakout-board.html)
29-
* [TinyCircuits](https://www.tiny-circuits.com)
30-
* [TinyShield Bluetooth Low Energy - Nordic](https://www.tiny-circuits.com/tiny-shield-bluetooth-low-energy-nordic.html)
31-
32-
**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.
33-
3412
### [Nordic Semiconductor nRF51822](http://www.nordicsemi.com/eng/Products/Bluetooth-R-low-energy/nRF51822)
3513

3614
* [RedBearLab](http://redbearlab.com) with [Arduino Add-on](https://github.com/RedBearLab/nRF51822-Arduino)
@@ -44,39 +22,6 @@ Enables you to create more customized BLE Peripheral's compared to the basic UAR
4422

4523
* 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)
4624

47-
#### Pinouts
48-
49-
| Chip | Shield/Board | REQ Pin | RDY Pin | RST Pin |
50-
| ---- | ------------ | ------- | ------- | ------- |
51-
| nRF8001|
52-
| | Bluefruit LE | 10 | 2 | 9 |
53-
| | BLE Shield 1.x | 9 | 8 | UNUSED |
54-
| | BLE Shield 2.x | 9 | 8 | UNUSED or 4/7 via jumper|
55-
| | Blend | 9 | 8 | UNUSED or 4/5 via jumper |
56-
| | Blend Micro | 6 | 7 | UNUSED or 4 |
57-
| | IMUduino BTLE | 10 | 7 | 9 |
58-
| | TinyShield Bluetooth Low Energy | 10 | 2 | 9 |
59-
| nRF51822 |
60-
| | RedBearLab nRF51822 | -1 (UNUSED) | -1 (UNUSED) | -1 (UNUSED) |
61-
| | BLE Nano | -1 (UNUSED) | -1 (UNUSED) | -1 (UNUSED) |
62-
| | RFduino | -1 (UNUSED) | -1 (UNUSED) | -1 (UNUSED) |
63-
64-
## Compatible IDE's and MCU's
65-
66-
* [Arduino IDE](http://arduino.cc/en/Main/Software#toc1)
67-
* AVR (Uno, Lenoardo, Mega, etc.)
68-
* SAM3X8E (Due)
69-
* SAMD21G18A (Zero)
70-
* [Teensy](https://www.pjrc.com/teensy/) (via [Teensyduino](https://www.pjrc.com/teensy/td_download.html))
71-
* 2.0
72-
* 3.0
73-
* 3.1
74-
* LC
75-
76-
**Warning**: For more advanced sketches an MCU with more than 2kB of RAM and 32kB of flash space is recommended. Advance sketches include:
77-
* Multiple services and characteristics
78-
* HID API usage
79-
8025
## Usage
8126

8227
### Download Library
@@ -86,20 +31,20 @@ Enables you to create more customized BLE Peripheral's compared to the basic UAR
8631
#### Using the Arduino IDE Library Manager
8732

8833
1. Choose ```Sketch``` -> ```Include Library``` -> ```Manage Libraries...```
89-
2. Type ```BLEPeripheral``` into the search box.
34+
2. Type ```BLEPeripheralObserver``` into the search box.
9035
3. Click the row to select the library.
9136
4. Click the ```Install``` button to install the library.
9237

9338
#### Using Git
9439
```sh
9540
cd ~/Documents/Arduino/libraries/
96-
git clone https://github.com/sandeepmistry/arduino-BLEPeripheral BLEPeripheral
41+
git clone https://github.com/floe/BLEPeripheralObserver BLEPeripheralObserver
9742
```
9843

9944
#### MPIDE
10045
```
10146
cd ~/Documents/mpide/libraries/
102-
git clone https://github.com/sandeepmistry/arduino-BLEPeripheral BLEPeripheral
47+
git clone https://github.com/floe/BLEPeripheralObserver BLEPeripheralObserver
10348
```
10449

10550
### [arduino-nRF5x core](https://github.com/sandeepmistry/arduino-nRF5) users
@@ -120,15 +65,3 @@ See [examples](examples) folder.
12065
## License
12166

12267
This libary is [licensed](LICENSE) under the [MIT Licence](http://en.wikipedia.org/wiki/MIT_License).
123-
124-
## Useful Links
125-
* [@lizardo](https://github.com/lizardo)'s [nRF8001 Experiments](https://github.com/lizardo/nrf8001)
126-
* used as a starting point to reverse engineer the proprietary setup message format for the chips
127-
* [@NordicSemiconductor](https://github.com/NordicSemiconductor)'s [ble-sdk-arduino](https://github.com/NordicSemiconductor/ble-sdk-arduino)
128-
* Original Arduino SDK for nRF8001
129-
* [@guanix](https://github.com/guanix)'s [arduino-nrf8001](https://github.com/guanix/arduino-nrf8001)
130-
* nRF8001 support for Arduino
131-
132-
133-
[![Analytics](https://ga-beacon.appspot.com/UA-56089547-1/sandeepmistry/arduino-BLEPeripheral?pixel)](https://github.com/igrigorik/ga-beacon)
134-

0 commit comments

Comments
 (0)