Skip to content
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

Fix documentation for advertising interval getters #134

Merged
merged 1 commit into from
Dec 4, 2015
Merged

Fix documentation for advertising interval getters #134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions ble/Gap.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,14 +183,16 @@ class Gap {
}

/**
* @return Minimum Advertising interval in milliseconds.
* @return Minimum Advertising interval in milliseconds for connectable
* undirected and connectable directed event types.
Copy link
Contributor

Choose a reason for hiding this comment

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

might be nice to include Vincent's summary:

The standard also say that for scannable undirected and non-connectable undirected, the advertising *shall not be less than 100ms`. 
Plus, there is a low duty cycle and high duty cycle advertising rate for connectable directed events.
To summarize advertising interval:
• ADV_CONNECTABLE_UNDIRECTED => [20:10240]
• ADV_CONNECTABLE_DIRECTED 
o   low duty cycle => [20:10240]
o   high duty cycle => [X:3.75]
• ADV_SCANNABLE_UNDIRECTED => [100:10240]
• ADV_NON_CONNECTABLE_UNDIRECTED => [100:10240]

Copy link
Contributor

Choose a reason for hiding this comment

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

merging it for now. further improvements can be expected to follow.

*/
virtual uint16_t getMinAdvertisingInterval(void) const {
return 0; /* Requesting action from porter(s): override this API if this capability is supported. */
}

/**
* @return Minimum Advertising interval in milliseconds for non-connectible mode.
* @return Minimum Advertising interval in milliseconds for scannable
* undirected and non-connectable undirected event types.
*/
virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const {
return 0; /* Requesting action from porter(s): override this API if this capability is supported. */
Expand Down