Whitelisting experimental API #159
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 6 commits
December 31, 2015 13:54
This is the finilised experimental API that introduces support for whitelisting. The changes are focused in Gap and introduces the following functions, that are expected to be implemented by each of the vendor specific glue code (e.g. ble-nrf51822 module): - getMaxWhitelistSize(): Get the maximum whitelist size, this can be set by using a yotta config definition. - getWhitelist(): Gets a copy of the internal whitelist containing BLE addresses. - setWhitelist(): Replace the whitelist with new addresses. - setAdvertisingPolicyMode(), setScanningPolicyMode() and setInitiatorPolicyMode(): Functions used to set the relevan policy filter mode as described in the BLE Specification v4.2 Vol 6, Part B, Section 4.2.1. - getAdvertisingPolicyMode(), getScanningPolicyMode() and getInitiatorPolicyMode(): Functions used to get the relevan policy filter mode as described in the BLE Specification v4.2 Vol 6, Part B, Section 4.2.1. The following enumerators were added to Gap to describe the desired policy filter mode: - AdvertisingPolicyMode_t - ScanningPolicyMode_t - InitiatorPolicyMode_t Finally, the following typedef was added to provide a view of the underlying implementation's internal whitelist: - Whitelist_t **NOTE:** Clearly, these API additions require changes to the underlying implementation!
Add an empty constructor to BLEProtocol::Address_t and fixed comments with regards to BLEProtocol::Address_t.
| /** | ||
| * @return Maximum size of the whitelist. | ||
| */ | ||
| virtual uint8_t getMaxWhitelistSize(void) const |
There was a problem hiding this comment.
it should take a reference to an uint8_t as parameter and return a ble_error_t
There was a problem hiding this comment.
In this case I was trying to be consistent with the other getMax*() function. See here https://github.com/andresag01/ble/blob/whitelisting/ble/Gap.h#L273.
There was a problem hiding this comment.
Agree, in this case, it should return 0.
|
@pan-: I have made the changes as suggested in your comments. |
|
Could you tag all new api and and types with |
|
@pan-: Added |
| * | ||
| * @experimental | ||
| */ | ||
| virtual void setAdvertisingPolicyMode(AdvertisingPolicyMode_t mode) |
There was a problem hiding this comment.
maybe it would be interesting to return a status here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the finilised experimental API that introduces support for
whitelisting. The changes are focused in Gap and introduces the following
functions, that are expected to be implemented by each of the vendor specific
glue code (e.g. ble-nrf51822 module):
using a yotta config definition.
addresses.
setInitiatorPolicyMode(): Functions used to set the relevan policy filter
mode as described in the BLE Specification v4.2 Vol 6, Part B, Section 4.2.1.
getInitiatorPolicyMode(): Functions used to get the relevan policy filter
mode as described in the BLE Specification v4.2 Vol 6, Part B, Section 4.2.1.
The following enumerators were added to Gap to describe the desired policy
filter mode:
Finally, the following typedef was added to provide a view of the
underlying implementation's internal whitelist:
NOTE: Clearly, these API additions require changes to the underlying
implementation!
NOTE: Changes related to BLEProtocol::Address_t and BLEProtocol::AddressBytes_t are from @rgrover in this pull request.
@pan-