sandeepmistry / arduino-BLEPeripheral

An Arduino library for creating custom BLE peripherals with Nordic Semiconductor's nRF8001 or nR51822.
MIT License
464 stars 180 forks source link

README.md: add instructions for softdevice #129

Closed jacobrosenthal closed 7 years ago

jacobrosenthal commented 7 years ago

Closes #128

jacobrosenthal commented 7 years ago

ble_gatts.h Is odd in the core too though, because it has nothing to do with core..

But lets just say we that under softdevice in core, then just add a link there talking about softdevice for nordic devices?

On Thu, Mar 2, 2017 at 5:53 PM, Sandeep Mistry notifications@github.com wrote:

@sandeepmistry commented on this pull request.

In README.md https://github.com/sandeepmistry/arduino-BLEPeripheral/pull/129#discussion_r104067796 :

@@ -102,6 +102,23 @@ cd ~/Documents/mpide/libraries/ git clone https://github.com/sandeepmistry/arduino-BLEPeripheral BLEPeripheral

+### Flashing a SoftDevice +

I'm not too keen to duplicate stuff from the nRF5 read me here, what do you think of having a link to it?

Also, these steps are only needed when you also use the nRF5 core. Other scenarios include cores like the original RBL ones or when using the an nRF8001 shield with an Uno, Zero, etc.

Maybe we need an nRF5x core section?

In README.md https://github.com/sandeepmistry/arduino-BLEPeripheral/pull/129#discussion_r104067828 :

@@ -111,6 +128,9 @@ See API.md.

Examples

See examples folder.

+## Troubleshooting +* If you see fatal error: ble_gatts.h: No such file or directory it actually means you havent selected your softdevice, and the BLEPeripheral SDK files are not available to the Verify +

Again, also only applies for nRF5x core

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/sandeepmistry/arduino-BLEPeripheral/pull/129#pullrequestreview-24883057, or mute the thread https://github.com/notifications/unsubscribe-auth/AAb0dHuKk1x-8kDeILYqrHgBspQ8gjyOks5rh2SagaJpZM4MQtkn .

sandeepmistry commented 7 years ago

ble_gatts.h Is odd in the core too though, because it has nothing to do with core..

Right, but that's the only place we can allow people to select the right version and custom include paths.

But lets just say we that under softdevice in core, then just add a link there talking about softdevice for nordic devices?

Sure, that works.