CONTRIBUTING.md@1118:88af68f0226b, 2016-01-11 (annotated)

Committer:

vcoubard

Date:

Mon Jan 11 08:52:02 2016 +0000

Revision:

1118:88af68f0226b

Parent:

1053:ec4a5b9b254e

Synchronized with git rev 42a202e0

Author: Andres Amaya Garcia

Finilise Whitelisting experimental API



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!

Who changed what in which revision?