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

Documentation issue #193

Open
lilliesAndRoses opened this issue Aug 28, 2018 · 1 comment
Open

Documentation issue #193

lilliesAndRoses opened this issue Aug 28, 2018 · 1 comment
Labels

Comments

@lilliesAndRoses
Copy link

The documentation of the function updateConnectionParameters says following about the connection parameters object.

{number} min_conn_interval: Minimum Connection Interval in 1.25 ms units.
{number} max_conn_interval: Maximum Connection Interval in 1.25 ms units.
{number} slave_latency: Slave Latency in number of connection events.
{number} conn_sup_timeout: Connection Supervision Timeout in 10 ms units.

If one passes a structure as below the API fails.

var connParams = {
            min_conn_interval: interval,
            max_conn_interval: interval,
            slave_latency: 3, 
            conn_sup_timeout: 4000,
        };

This is because internally a _getConnectionUpdateParams is called which expects

var connParams = {
            minConnectionInterval: interval,
            maxConnectionInterval: interval,
            slaveLatency: 3,
            connectionSupervisionTimeout: 4000,
        }

The connect API on the other hand takes the first structure as input. This is inconsistent and needs fix.

There is one more problem with the connection parameters. The documentation says that it is in the 1.5 ms units, but actually the value is used "AS IS". The documentation needs a fix here as well.

Thanks
Amruta

@bihanssen
Copy link
Contributor

@lilliesAndRoses thanks for reporting. Marking this as a bug.

@bihanssen bihanssen added the bug label Oct 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants