Schoumi/BLE_API
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
BLE_API/CONTRIBUTING.md

8 lines
747 B
Markdown
Raw Permalink Normal View History

Release 2.0.0 ============= * Major change to the APIs around stack initialization. BLE::init() is now meant to only trigger the initialization of the underlying BLE stack. init() now takes a completion callback as an optional parameter; this callback gets invoked when initialization completes. - There's a new type: BLE::InitializationCompleteCallback_t - There's a new API: BLEInstanceBase::hasInitialized() which transports need to implement. - If no init-completion callback is setup, the application can still determine the status of initialization using BLE::hasInitialized(). !This update may require in a minor change to existing apps! mbed-classic demos would look something like: ``` main() { BLE::Instance().init(); while (!BLE::Instance().hasInitialized()) { /* spin wait */ } /* rest of the initialization ending in the waitForEvent loop */ } ``` whereas mbedOS demos would look like: ``` void bleInitComplete(BLE &ble, ble_error_t error) { WsfTrace("bleInitComplete"); if (error != BLE_ERROR_NONE) { WsfTrace("initailization failed with error: %u", error); return; } if (ble.getInstanceID() == BLE::DEFAULT_INSTANCE) { /* use the BLE instance */ } } extern "C" void app_start(int argc, char *argv[]) { BLE::Instance().init(bleInitComplete); } ``` The Nordic stack initializes right-away, and so existing demos based on Nordic should continue to work. * There's a new API: BLE::getInstanceID(), which simply returns the ID of an instance. * Reduce the memory footprint consumed by a FunctionPointerWithContext to 20 bytes (originally, it was 32 bytes !). Also enforce alignment constraints of the embedded pointer to member function. This should help with the size of a GattCharacteristic. * Add EnvironmentalService.h under services/. * There have been minor improvements to EddystoneService and EddystoneConfigService. * We've added a CONTRIBUTING.md to help guide user contributions.
2015-10-30 15:18:02 +00:00
# Hello!
Minor changes ofr the README and CONTRIBUTING files. Fix broken/wrong links and minor typo fixes. Added current supported services.
2015-11-24 18:59:40 +00:00
We are an open source project of [ARM mbed](https://www.mbed.com). Contributions via [pull request](https://github.com/ARMmbed/ble/pulls), and [bug reports](https://github.com/ARMmbed/ble/issues) are welcome!
Release 2.0.0 ============= * Major change to the APIs around stack initialization. BLE::init() is now meant to only trigger the initialization of the underlying BLE stack. init() now takes a completion callback as an optional parameter; this callback gets invoked when initialization completes. - There's a new type: BLE::InitializationCompleteCallback_t - There's a new API: BLEInstanceBase::hasInitialized() which transports need to implement. - If no init-completion callback is setup, the application can still determine the status of initialization using BLE::hasInitialized(). !This update may require in a minor change to existing apps! mbed-classic demos would look something like: ``` main() { BLE::Instance().init(); while (!BLE::Instance().hasInitialized()) { /* spin wait */ } /* rest of the initialization ending in the waitForEvent loop */ } ``` whereas mbedOS demos would look like: ``` void bleInitComplete(BLE &ble, ble_error_t error) { WsfTrace("bleInitComplete"); if (error != BLE_ERROR_NONE) { WsfTrace("initailization failed with error: %u", error); return; } if (ble.getInstanceID() == BLE::DEFAULT_INSTANCE) { /* use the BLE instance */ } } extern "C" void app_start(int argc, char *argv[]) { BLE::Instance().init(bleInitComplete); } ``` The Nordic stack initializes right-away, and so existing demos based on Nordic should continue to work. * There's a new API: BLE::getInstanceID(), which simply returns the ID of an instance. * Reduce the memory footprint consumed by a FunctionPointerWithContext to 20 bytes (originally, it was 32 bytes !). Also enforce alignment constraints of the embedded pointer to member function. This should help with the size of a GattCharacteristic. * Add EnvironmentalService.h under services/. * There have been minor improvements to EddystoneService and EddystoneConfigService. * We've added a CONTRIBUTING.md to help guide user contributions.
2015-10-30 15:18:02 +00:00
Fix minor typos. Mardkown links syntax was inverted :)
2015-11-25 19:55:54 +00:00
Please submit your pull request to the `develop` branch of [this module](https://github.com/ARMmbed/ble/tree/develop). Commits to develop will be merge into the master branch at the time of the next release.
Release 2.0.0 ============= * Major change to the APIs around stack initialization. BLE::init() is now meant to only trigger the initialization of the underlying BLE stack. init() now takes a completion callback as an optional parameter; this callback gets invoked when initialization completes. - There's a new type: BLE::InitializationCompleteCallback_t - There's a new API: BLEInstanceBase::hasInitialized() which transports need to implement. - If no init-completion callback is setup, the application can still determine the status of initialization using BLE::hasInitialized(). !This update may require in a minor change to existing apps! mbed-classic demos would look something like: ``` main() { BLE::Instance().init(); while (!BLE::Instance().hasInitialized()) { /* spin wait */ } /* rest of the initialization ending in the waitForEvent loop */ } ``` whereas mbedOS demos would look like: ``` void bleInitComplete(BLE &ble, ble_error_t error) { WsfTrace("bleInitComplete"); if (error != BLE_ERROR_NONE) { WsfTrace("initailization failed with error: %u", error); return; } if (ble.getInstanceID() == BLE::DEFAULT_INSTANCE) { /* use the BLE instance */ } } extern "C" void app_start(int argc, char *argv[]) { BLE::Instance().init(bleInitComplete); } ``` The Nordic stack initializes right-away, and so existing demos based on Nordic should continue to work. * There's a new API: BLE::getInstanceID(), which simply returns the ID of an instance. * Reduce the memory footprint consumed by a FunctionPointerWithContext to 20 bytes (originally, it was 32 bytes !). Also enforce alignment constraints of the embedded pointer to member function. This should help with the size of a GattCharacteristic. * Add EnvironmentalService.h under services/. * There have been minor improvements to EddystoneService and EddystoneConfigService. * We've added a CONTRIBUTING.md to help guide user contributions.
2015-10-30 15:18:02 +00:00
# Contributor agreement
Minor changes ofr the README and CONTRIBUTING files. Fix broken/wrong links and minor typo fixes. Added current supported services.
2015-11-24 18:59:40 +00:00
For your pull request to be accepted, we will need you to agree to our [contributor agreement](https://developer.mbed.org/contributor_agreement/) to give us the necessary rights to use and distribute your contributions. (To click through the agreement create an account on mbed.com and log in.)
Reference in a new issue Copy permalink