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.

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

Conversation

andresag01
Copy link

Fix documentation for getMinAdvertisingInterval() and getMinNonConnectableAdvertisingInterval() functions in Gap.h

@andresag01
Copy link
Author

@rgrover

@@ -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.

rgrover added a commit that referenced this pull request Dec 4, 2015
Fix documentation for advertising interval getters
@rgrover rgrover merged commit 1922b9a into ARMmbed:develop Dec 4, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants