Skip to content

Remove deprecated BLE:: APIs and unsupported services #12676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Apr 3, 2020
Merged

Remove deprecated BLE:: APIs and unsupported services #12676

merged 3 commits into from
Apr 3, 2020

Conversation

LDong-Arm
Copy link
Contributor

@LDong-Arm LDong-Arm commented Mar 23, 2020 •
edited
Loading

Summary of changes

  • Remove deprecated APIs from BLE namespace.
  • Remove DFUService, UARTService and beacon-related services (iBeacon, EddyStone) whose standards/stacks are externally maintained.

Impact of changes

  • Legacy APIs in BLE namespace are no longer available.
  • DFUService, UARTService and beacon-related services (iBeacon, EddyStone) are no longer available.

Migration actions required

  • Applications that use legacy APIs in BLE namespace need to be updated to use up-to-date APIs.
  • Applications based on removed services can copy the service definitions over from previous mbed-os releases (with deprecated API usages manually fixed), or provide their own implementations.

Documentation

None

Pull request type 

[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[X] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results 

[] No Tests required for this change (E.g docs only update)
[] Covered by existing mbed-os tests (Greentea or Unittest)
[x] Tests / results supplied as part of this PR

Manual testing: mbed-os-example-ble/BLE_SM example runs on DISCO_L475VG_IOT01A and NRF52840_DK.

Reviewers

@pan- @evedon

@LDong-Arm
Copy link
Contributor Author

Hi @pan- and @evedon, this PR covers the first (and most trivial) component to clean up - work for several other components will follow up.

(Writing a comment as I do not have permissions to add reviewers directly...)

LDong-Arm
LDong-Arm commented Mar 23, 2020
View reviewed changes
features/FEATURE_BLE/ble/BLE.h
*/
MBED_DEPRECATED("Use BLE::Instance() instead of BLE constructor.")
BLE(InstanceID_t instanceID = DEFAULT_INSTANCE);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now the constructor is private as the internal stack still needs it.
(This comment forces GitHub to render large diff too)

@ciarmcom ciarmcom requested review from a team March 23, 2020 18:00
@ciarmcom
Copy link
Member

@LDong-Arm, thank you for your changes.
@ARMmbed/mbed-os-pan @ARMmbed/mbed-os-maintainers please review.

@LDong-Arm LDong-Arm changed the title Remove deprecated BLE:: APIs and unsupported services WIP: Remove deprecated BLE:: APIs and unsupported services Mar 24, 2020
@mergify mergify bot added the do not merge label Mar 24, 2020
evedon
evedon approved these changes Mar 24, 2020
View reviewed changes
Copy link
Contributor

@evedon evedon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mergify mergify bot added needs: CI and removed needs: review labels Mar 24, 2020
@LDong-Arm LDong-Arm changed the title WIP: Remove deprecated BLE:: APIs and unsupported services Remove deprecated BLE:: APIs and unsupported services Mar 25, 2020
@0xc0170
Copy link
Contributor

0xc0170 commented Mar 26, 2020

CI started

@mbed-ci
Copy link

mbed-ci commented Mar 26, 2020

Test run: SUCCESS

Summary: 6 of 6 test jobs passed
Build number : 1
Build artifacts

@0xc0170
Copy link
Contributor

0xc0170 commented Mar 26, 2020

@LDong-Arm Is this ready (WIP was removed, just checking) ?

@ARMmbed/mbed-os-pan Please review

@LDong-Arm
Copy link
Contributor Author

@0xc0170 Yes it is ready

@adbridge
Copy link
Contributor

@pan- @paul-szczepanek-arm could one of you review this please ?

@mergify mergify bot added needs: CI and removed needs: review labels Mar 30, 2020
@0xc0170
Copy link
Contributor

0xc0170 commented Mar 31, 2020

@pan- @paul-szczepanek-arm could one of you review this please ?

Lets get this in in the next day or so, please review

@0xc0170 0xc0170 requested review from a user and bulislaw and removed request for a user March 31, 2020 09:03
@LDong-Arm LDong-Arm mentioned this pull request Mar 31, 2020
Merged
bulislaw
bulislaw approved these changes Mar 31, 2020
View reviewed changes
Copy link
Member

@bulislaw bulislaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good if @donatieng or @pan- or @paul-szczepanek-arm could review

@pan-
Copy link
Member

pan- commented Mar 31, 2020

Is work on Gap coming in another PR ?

donatieng
donatieng approved these changes Mar 31, 2020
View reviewed changes
Copy link
Contributor

@donatieng donatieng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, sanity checked with the Hearthrate example, GCC and WB55 and NRF52840 boards.

@LDong-Arm LDong-Arm mentioned this pull request Apr 1, 2020
Merged
@LDong-Arm
Copy link
Contributor Author

LDong-Arm commented Apr 2, 2020 •
edited
Loading

@adbridge @0xc0170 This has been approved and CI passed, can it be merged now?

@adbridge
Copy link
Contributor

adbridge commented Apr 2, 2020

This needs to go through CI again as it was last run 7 days again so the results are stale.

@adbridge
Copy link
Contributor

adbridge commented Apr 2, 2020

CI started

@mbed-ci
Copy link

mbed-ci commented Apr 2, 2020

Test run: SUCCESS

Summary: 6 of 6 test jobs passed
Build number : 2
Build artifacts

@0xc0170 0xc0170 merged commit 548e1c6 into ARMmbed:master Apr 3, 2020
@mergify mergify bot removed the ready for merge label Apr 3, 2020
@AGlass0fMilk AGlass0fMilk mentioned this pull request Oct 21, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bulislaw bulislaw bulislaw approved these changes

@donatieng donatieng donatieng approved these changes

@evedon evedon evedon approved these changes

Assignees
No one assigned
Labels
BREAKING-CHANGE release-version: 6.0.0-beta-1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@LDong-Arm @ciarmcom @0xc0170 @mbed-ci @adbridge @pan- @bulislaw @donatieng @evedon