You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/07/08 23:00:11 UTC
[1/3] incubator-mynewt-site git commit: ble_gap_disc_cancel() - Link
to core return codes.
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/develop d2def2645 -> f7f505f09
ble_gap_disc_cancel() - Link to core return codes.
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/4923bc54
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/4923bc54
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/4923bc54
Branch: refs/heads/develop
Commit: 4923bc545cf06fbebda4a6727a31699a2b831d8d
Parents: d2def26
Author: Christopher Collins <cc...@apache.org>
Authored: Fri Jul 8 14:52:37 2016 -0700
Committer: Christopher Collins <cc...@apache.org>
Committed: Fri Jul 8 14:52:37 2016 -0700
----------------------------------------------------------------------
docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4923bc54/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel.md
index f89b461..2986594 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel.md
@@ -19,4 +19,4 @@ None
|---------|-------------|
| 0 | Success. |
| BLE\_HS\_EALREADY | There is no discovery procedure to cancel. |
-| other | Other nonzero on unexpected error. |
+| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
[2/3] incubator-mynewt-site git commit: Add missing return code
descriptions.
Posted by ad...@apache.org.
Add missing return code descriptions.
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/d1be9d92
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/d1be9d92
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/d1be9d92
Branch: refs/heads/develop
Commit: d1be9d92f36fd19a5010bf101e28ef7b03f4e742
Parents: 4923bc5
Author: Christopher Collins <cc...@apache.org>
Authored: Fri Jul 8 14:52:56 2016 -0700
Committer: Christopher Collins <cc...@apache.org>
Committed: Fri Jul 8 14:52:56 2016 -0700
----------------------------------------------------------------------
docs/network/ble/ble_hs/ble_hs_return_codes.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d1be9d92/docs/network/ble/ble_hs/ble_hs_return_codes.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_hs_return_codes.md b/docs/network/ble/ble_hs/ble_hs_return_codes.md
index 9730f04..d485c12 100644
--- a/docs/network/ble/ble_hs/ble_hs_return_codes.md
+++ b/docs/network/ble/ble_hs/ble_hs_return_codes.md
@@ -133,7 +133,7 @@ The precise meaning of each of these error codes depends on the function that re
```
| NimBLE Value | Formal Value | Name | Condition |
-|-------|----------------|----------------------------------------------|
+|--------------|--------------|--------|-------------|
| 0x0101 | 0x01 | BLE\_ATT\_ERR\_INVALID\_HANDLE | The attribute handle given was not valid on this server. |
| 0x0102 | 0x02 | BLE\_ATT\_ERR\_READ\_NOT\_PERMITTED | The attribute cannot be read. |
| 0x0103 | 0x03 | BLE\_ATT\_ERR\_WRITE\_NOT\_PERMITTED | The attribute cannot be written. |
@@ -162,7 +162,7 @@ The precise meaning of each of these error codes depends on the function that re
```
| NimBLE Value | Formal Value | Name | Condition |
-|-------|----------------|----------------------------------------------|
+|--------------|--------------|--------|-------------|
| 0x0201 | 0x01 | BLE\_ERR\_UNKNOWN\_HCI\_CMD | Unknown HCI Command |
| 0x0202 | 0x02 | BLE\_ERR\_UNK\_CONN\_ID | Unknown Connection Identifier |
| 0x0203 | 0x03 | BLE\_ERR\_HW\_FAIL | Hardware Failure |
@@ -234,7 +234,7 @@ The precise meaning of each of these error codes depends on the function that re
```
| NimBLE Value | Formal Value | Name | Condition |
-|-------|----------------|----------------------------------------------|
+|--------------|--------------|--------|-------------|
| 0x0300 | 0x00 | BLE\_L2CAP\_SIG\_ERR\_CMD\_NOT\_UNDERSTOOD | Invalid or unsupported incoming L2CAP sig command. |
| 0x0301 | 0x01 | BLE\_L2CAP\_SIG\_ERR\_MTU\_EXCEEDED | Incoming packet too large. |
| 0x0302 | 0x02 | BLE\_L2CAP\_SIG\_ERR\_INVALID\_CID | No channel with specified ID. |
@@ -247,8 +247,8 @@ The precise meaning of each of these error codes depends on the function that re
#include "host/ble_sm.h"
```
-| NimBLE Value | Formal Value | Name | Condition |
-|-------|----------------|----------------------------------------------|
+| NimBLE Value | Formal Value | Name | Condition |
+|--------------|--------------|--------|-------------|
| 0x0401 | 0x01 | BLE\_SM\_ERR\_PASSKEY | The user input of passkey failed, for example, the user cancelled the operation. |
| 0x0402 | 0x02 | BLE\_SM\_ERR\_OOB | The OOB data is not available. |
| 0x0403 | 0x03 | BLE\_SM\_ERR\_AUTHREQ | The pairing procedure cannot be performed as authentication requirements cannot be met due to IO capabilities of one or both devices. |
@@ -272,8 +272,8 @@ The precise meaning of each of these error codes depends on the function that re
#include "host/ble_sm.h"
```
-| NimBLE Value | Formal Value | Name | Condition |
-|-----------------|--------------|--------|-------------|
+| NimBLE Value | Formal Value | Name | Condition |
+|--------------|--------------|--------|-------------|
| 0x0501 | 0x01 | BLE\_SM\_ERR\_PASSKEY | The user input of passkey failed, for example, the user cancelled the operation. |
| 0x0502 | 0x02 | BLE\_SM\_ERR\_OOB | The OOB data is not available. |
| 0x0503 | 0x03 | BLE\_SM\_ERR\_AUTHREQ | The pairing procedure cannot be performed as authentication requirements cannot be met due to IO capabilities of one or both devices. |
[3/3] incubator-mynewt-site git commit: Add ble_gap_conn_rssi()
documentation.
Posted by ad...@apache.org.
Add ble_gap_conn_rssi() documentation.
This closes #106
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/f7f505f0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/f7f505f0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/f7f505f0
Branch: refs/heads/develop
Commit: f7f505f099c41cec2b605a405f8013dc68d051de
Parents: d1be9d9
Author: Christopher Collins <cc...@apache.org>
Authored: Fri Jul 8 14:53:14 2016 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Fri Jul 8 15:32:08 2016 -0700
----------------------------------------------------------------------
.../ble_gap/functions/ble_gap_conn_rssi.md | 25 ++++++++++++++++++++
mkdocs.yml | 1 +
2 files changed, 26 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f7f505f0/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi.md
new file mode 100644
index 0000000..278dde2
--- /dev/null
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi.md
@@ -0,0 +1,25 @@
+## <font color="#F2853F" style="font-size:24pt">ble\_gap\_conn\_rssi</font>
+
+```c
+int
+ble_gap_conn_rssi(uint16_t conn_handle, int8_t *out_rssi)
+```
+
+### Description
+
+Retrieves the most-recently measured RSSI for the specified connection. A connection's RSSI is updated whenever a data channel PDU is received.
+
+### Parameters
+
+| *Parameter* | *Description* |
+|-------------|---------------|
+| conn\_handle | Specifies the connection to query. |
+| out\_rssi | On success, the retrieved RSSI is written here. |
+
+### Returned values
+
+| *Value* | *Condition* |
+|---------|-------------|
+| 0 | Success. |
+| [BLE host HCI return code](../../ble_hs_return_codes/#return-codes-hci) | The controller rejected the request. |
+| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f7f505f0/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index b25ea6e..55421c3 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -372,6 +372,7 @@ pages:
- 'ble_gap_conn_active': 'network/ble/ble_hs/ble_gap/functions/ble_gap_conn_active.md'
- 'ble_gap_conn_cancel': 'network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel.md'
- 'ble_gap_conn_find': 'network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find.md'
+ - 'ble_gap_conn_rssi': 'network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi.md'
- 'ble_gap_connect': 'network/ble/ble_hs/ble_gap/functions/ble_gap_connect.md'
- 'ble_gap_disc': 'network/ble/ble_hs/ble_gap/functions/ble_gap_disc.md'
- 'ble_gap_disc_active': 'network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active.md'