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/11 21:19:50 UTC
[1/4] incubator-mynewt-site git commit: BLE host API - one function
param per line.
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/develop f7f505f09 -> 7a69d2b60
BLE host API - one function param per line.
The old format was a bit difficult to read.
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/3c2742f5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/3c2742f5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/3c2742f5
Branch: refs/heads/develop
Commit: 3c2742f58083ad6ea6ce4a44969a0dab9d2ddced
Parents: f7f505f
Author: Christopher Collins <cc...@apache.org>
Authored: Sat Jul 9 12:32:55 2016 -0700
Committer: Christopher Collins <cc...@apache.org>
Committed: Sat Jul 9 12:32:55 2016 -0700
----------------------------------------------------------------------
.../ble_gap/functions/ble_gap_adv_rsp_set_fields.md | 2 +-
.../ble_gap/functions/ble_gap_adv_set_fields.md | 2 +-
.../ble_hs/ble_gap/functions/ble_gap_adv_start.md | 15 ++++++++++-----
.../ble/ble_hs/ble_gap/functions/ble_gap_adv_stop.md | 2 +-
.../ble_hs/ble_gap/functions/ble_gap_conn_cancel.md | 2 +-
.../ble_hs/ble_gap/functions/ble_gap_conn_find.md | 5 ++++-
.../ble_hs/ble_gap/functions/ble_gap_conn_rssi.md | 9 ++++++---
.../ble/ble_hs/ble_gap/functions/ble_gap_connect.md | 14 +++++++++-----
.../ble/ble_hs/ble_gap/functions/ble_gap_disc.md | 12 ++++++++----
.../ble_hs/ble_gap/functions/ble_gap_disc_cancel.md | 2 +-
.../ble_gap/functions/ble_gap_security_initiate.md | 2 +-
.../ble_hs/ble_gap/functions/ble_gap_terminate.md | 7 +++++--
.../ble_gap/functions/ble_gap_update_params.md | 8 +++++---
.../ble/ble_hs/ble_gap/functions/ble_gap_wl_set.md | 8 +++++---
.../ble_gattc/functions/ble_gattc_disc_all_chrs.md | 12 ++++++++----
.../ble_gattc/functions/ble_gattc_disc_all_dscs.md | 12 ++++++++----
.../ble_gattc/functions/ble_gattc_disc_all_svcs.md | 7 +++++--
.../functions/ble_gattc_disc_chrs_by_uuid.md | 13 +++++++++----
.../functions/ble_gattc_disc_svc_by_uuid.md | 10 +++++++---
.../ble_gattc/functions/ble_gattc_exchange_mtu.md | 8 ++++++--
.../ble_gattc/functions/ble_gattc_find_inc_svcs.md | 12 ++++++++----
.../ble_hs/ble_gattc/functions/ble_gattc_notify.md | 7 +++++--
.../ble_gattc/functions/ble_gattc_notify_custom.md | 10 +++++++---
.../ble/ble_hs/ble_gattc/functions/ble_gattc_read.md | 10 +++++++---
.../ble_gattc/functions/ble_gattc_read_by_uuid.md | 13 +++++++++----
.../ble_gattc/functions/ble_gattc_read_long.md | 10 +++++++---
.../ble_gattc/functions/ble_gattc_read_mult.md | 12 ++++++++----
.../ble_hs/ble_gattc/functions/ble_gattc_write.md | 12 +++++++++---
.../ble_gattc/functions/ble_gattc_write_long.md | 13 +++++++++----
.../ble_gattc/functions/ble_gattc_write_no_rsp.md | 10 +++++++---
.../ble_gattc/functions/ble_gattc_write_reliable.md | 11 +++++++----
.../ble_hs/ble_gatts/functions/ble_gatts_find_chr.md | 8 ++++++--
.../ble_hs/ble_gatts/functions/ble_gatts_find_dsc.md | 8 ++++++--
.../ble_hs/ble_gatts/functions/ble_gatts_find_svc.md | 5 ++++-
.../ble_gatts/functions/ble_gatts_register_svcs.md | 7 +++++--
.../ble_hs_id/functions/ble_hs_id_copy_addr.md | 7 +++++--
.../ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd.md | 7 +++++--
.../ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd.md | 2 +-
.../network/ble/ble_hs/init/functions/ble_hs_init.md | 7 +++++--
.../ble/ble_hs/init/functions/ble_hs_start.md | 2 +-
.../functions/ble_eddystone_set_adv_data_uid.md | 7 +++++--
.../functions/ble_eddystone_set_adv_data_url.md | 12 ++++++++----
.../other/functions/ble_ibeacon_set_adv_data.md | 8 ++++++--
.../ble/ble_hs/other/functions/ble_uuid_16_to_128.md | 5 ++++-
44 files changed, 245 insertions(+), 112 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_rsp_set_fields.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_rsp_set_fields.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_rsp_set_fields.md
index 4333457..7a9f32d 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_rsp_set_fields.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_rsp_set_fields.md
@@ -22,4 +22,4 @@ Configures the data to include in subsequent scan responses.
| 0 | Success. |
| BLE\_HS\_EBUSY | Advertising is in progress. |
| BLE\_HS\_EMSGSIZE | The specified data is too large to fit in an advertisement. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_set_fields.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_set_fields.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_set_fields.md
index 74d6d66..ec411a4 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_set_fields.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_set_fields.md
@@ -22,4 +22,4 @@ Configures the data to include in subsequent advertisements.
| 0 | Success. |
| BLE\_HS\_EBUSY | Advertising is in progress. |
| BLE\_HS\_EMSGSIZE | The specified data is too large to fit in an advertisement. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_start.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_start.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_start.md
index ce6bf5e..610b4de 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_start.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_start.md
@@ -2,10 +2,15 @@
```c
int
-ble_gap_adv_start(uint8_t own_addr_type, uint8_t peer_addr_type,
- const uint8_t *peer_addr, int32_t duration_ms,
- const struct ble_gap_adv_params *adv_params,
- ble_gap_event_fn *cb, void *cb_arg)
+ble_gap_adv_start(
+ uint8_t own_addr_type,
+ uint8_t peer_addr_type,
+ const uint8_t *peer_addr,
+ int32_t duration_ms,
+ const struct ble_gap_adv_params *adv_params,
+ ble_gap_event_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -29,4 +34,4 @@ Initiates advertising.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_stop.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_stop.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_stop.md
index adb3d87..83d6abd 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_stop.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_stop.md
@@ -19,4 +19,4 @@ None
|---------|-------------|
| 0 | Success. |
| BLE\_HS\_EALREADY | There is no active advertising procedure. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel.md
index 4ce05c5..6683ffd 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel.md
@@ -18,4 +18,4 @@ None
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find.md
index e107e9f..467a035 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find.md
@@ -2,7 +2,10 @@
```c
int
-ble_gap_conn_find(uint16_t handle, struct ble_gap_conn_desc *out_desc)
+ble_gap_conn_find(
+ uint16_t handle,
+ struct ble_gap_conn_desc *out_desc
+)
```
### Description
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/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
index 278dde2..51f483e 100644
--- 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
@@ -2,7 +2,10 @@
```c
int
-ble_gap_conn_rssi(uint16_t conn_handle, int8_t *out_rssi)
+ble_gap_conn_rssi(
+ uint16_t conn_handle,
+ int8_t *out_rssi
+)
```
### Description
@@ -21,5 +24,5 @@ Retrieves the most-recently measured RSSI for the specified connection. A conne
| *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. |
+| [HCI return code](../../ble_hs_return_codes/#return-codes-hci) | The controller rejected the request. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_connect.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_connect.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_connect.md
index 44b5b40..95fae32 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_connect.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_connect.md
@@ -2,10 +2,14 @@
```c
int
-ble_gap_connect(uint8_t own_addr_type,
- uint8_t peer_addr_type, const uint8_t *peer_addr,
- const struct ble_gap_conn_params *conn_params,
- ble_gap_event_fn *cb, void *cb_arg)
+ble_gap_connect(
+ uint8_t own_addr_type,
+ uint8_t peer_addr_type,
+ const uint8_t *peer_addr,
+ const struct ble_gap_conn_params *conn_params,
+ ble_gap_event_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -29,4 +33,4 @@ Initiates a connect procedure.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc.md
index d4cd67a..b8672dd 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_disc.md
@@ -2,9 +2,13 @@
```c
int
-ble_gap_disc(uint8_t own_addr_type, int32_t duration_ms,
- const struct ble_gap_disc_params *disc_params,
- ble_gap_event_fn *cb, void *cb_arg)
+ble_gap_disc(
+ uint8_t own_addr_type,
+ int32_t duration_ms,
+ const struct ble_gap_disc_params *disc_params,
+ ble_gap_event_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -26,4 +30,4 @@ Performs the Limited or General Discovery Procedures.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/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 2986594..ae4bf32 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. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_security_initiate.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_security_initiate.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_security_initiate.md
index 7e23d99..08a027c 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_security_initiate.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_security_initiate.md
@@ -22,4 +22,4 @@ Initiates the GAP encryption procedure.
| 0 | Success. |
| BLE\_HS\_ENOTCONN | The there is no connection with the specified handle. |
| BLE\_HS\_EALREADY | An encrpytion procedure for this connection is already in progress. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_terminate.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_terminate.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_terminate.md
index 4797f74..9bf6efd 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_terminate.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_terminate.md
@@ -2,7 +2,10 @@
```c
int
-ble_gap_terminate(uint16_t conn_handle, uint8_t hci_reason)
+ble_gap_terminate(
+ uint16_t conn_handle,
+ uint8_t hci_reason
+)
```
### Description
@@ -22,4 +25,4 @@ Terminates an established connection.
|---------|-------------|
| 0 | Success. |
| BLE\_HS\_ENOTCONN | There is no connection with the specified handle. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_update_params.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_update_params.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_update_params.md
index 6f5547d..9eacfbc 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_update_params.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_update_params.md
@@ -2,8 +2,10 @@
```c
int
-ble_gap_update_params(uint16_t conn_handle,
- const struct ble_gap_upd_params *params)
+ble_gap_update_params(
+ uint16_t conn_handle,
+ const struct ble_gap_upd_params *params
+)
```
### Description
@@ -24,4 +26,4 @@ Initiates a connection parameter update procedure.
| 0 | Success. |
| BLE\_HS\_ENOTCONN | The there is no connection with the specified handle. |
| BLE\_HS\_EALREADY | A connection update procedure for this connection is already in progress. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_wl_set.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_wl_set.md b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_wl_set.md
index 5876cfb..d7b3612 100644
--- a/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_wl_set.md
+++ b/docs/network/ble/ble_hs/ble_gap/functions/ble_gap_wl_set.md
@@ -2,8 +2,10 @@
```c
int
-ble_gap_wl_set(const struct ble_gap_white_entry *white_list,
- uint8_t white_list_count)
+ble_gap_wl_set(
+ const struct ble_gap_white_entry *white_list,
+ uint8_t white_list_count
+)
```
### Description
@@ -22,4 +24,4 @@ Overwrites the controller's white list with the specified contents.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_chrs.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_chrs.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_chrs.md
index 85b1032..38b8371 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_chrs.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_chrs.md
@@ -2,9 +2,13 @@
```c
int
-ble_gattc_disc_all_chrs(uint16_t conn_handle, uint16_t start_handle,
- uint16_t end_handle, ble_gatt_chr_fn *cb,
- void *cb_arg)
+ble_gattc_disc_all_chrs(
+ uint16_t conn_handle,
+ uint16_t start_handle,
+ uint16_t end_handle,
+ ble_gatt_chr_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -26,4 +30,4 @@ Initiates GATT procedure: Discover All Characteristics of a Service.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_dscs.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_dscs.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_dscs.md
index f3a6380..f5decdf 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_dscs.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_dscs.md
@@ -2,9 +2,13 @@
```c
int
-ble_gattc_disc_all_dscs(uint16_t conn_handle, uint16_t chr_def_handle,
- uint16_t chr_end_handle,
- ble_gatt_dsc_fn *cb, void *cb_arg)
+ble_gattc_disc_all_dscs(
+ uint16_t conn_handle,
+ uint16_t chr_def_handle,
+ uint16_t chr_end_handle,
+ ble_gatt_dsc_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -26,4 +30,4 @@ Initiates GATT procedure: Discover All Characteristic Descriptors.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_svcs.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_svcs.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_svcs.md
index bf37569..db63f29 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_svcs.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_all_svcs.md
@@ -2,8 +2,11 @@
```c
int
-ble_gattc_disc_all_svcs(uint16_t conn_handle, ble_gatt_disc_svc_fn *cb,
- void *cb_arg)
+ble_gattc_disc_all_svcs(
+ uint16_t conn_handle,
+ ble_gatt_disc_svc_fn *cb,
+ void *cb_arg
+)
```
### Description
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_chrs_by_uuid.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_chrs_by_uuid.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_chrs_by_uuid.md
index 9db26ee..41d90fd 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_chrs_by_uuid.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_chrs_by_uuid.md
@@ -2,9 +2,14 @@
```c
int
-ble_gattc_disc_chrs_by_uuid(uint16_t conn_handle, uint16_t start_handle,
- uint16_t end_handle, const void *uuid128,
- ble_gatt_chr_fn *cb, void *cb_arg)
+ble_gattc_disc_chrs_by_uuid(
+ uint16_t conn_handle,
+ uint16_t start_handle,
+ uint16_t end_handle,
+ const void *uuid128,
+ ble_gatt_chr_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -27,4 +32,4 @@ Initiates GATT procedure: Discover Characteristics by UUID.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_svc_by_uuid.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_svc_by_uuid.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_svc_by_uuid.md
index bd3b308..466dafc 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_svc_by_uuid.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_disc_svc_by_uuid.md
@@ -2,8 +2,12 @@
```c
int
-ble_gattc_disc_svc_by_uuid(uint16_t conn_handle, const void *svc_uuid128,
- ble_gatt_disc_svc_fn *cb, void *cb_arg)
+ble_gattc_disc_svc_by_uuid(
+ uint16_t conn_handle,
+ const void *svc_uuid128,
+ ble_gatt_disc_svc_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -24,4 +28,4 @@ Initiates GATT procedure: Discover Primary Service by Service UUID.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_exchange_mtu.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_exchange_mtu.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_exchange_mtu.md
index 81de2b4..03e285b 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_exchange_mtu.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_exchange_mtu.md
@@ -2,7 +2,11 @@
```c
int
-ble_gattc_exchange_mtu(uint16_t conn_handle, ble_gatt_mtu_fn *cb, void *cb_arg)
+ble_gattc_exchange_mtu(
+ uint16_t conn_handle,
+ ble_gatt_mtu_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -22,4 +26,4 @@ Initiates GATT procedure: Exchange MTU.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_find_inc_svcs.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_find_inc_svcs.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_find_inc_svcs.md
index 9aaa630..f60c23d 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_find_inc_svcs.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_find_inc_svcs.md
@@ -2,9 +2,13 @@
```c
int
-ble_gattc_find_inc_svcs(uint16_t conn_handle, uint16_t start_handle,
- uint16_t end_handle,
- ble_gatt_disc_svc_fn *cb, void *cb_arg)
+ble_gattc_find_inc_svcs(
+ uint16_t conn_handle,
+ uint16_t start_handle,
+ uint16_t end_handle,
+ ble_gatt_disc_svc_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -26,4 +30,4 @@ Initiates GATT procedure: Find Included Services.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_notify.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_notify.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_notify.md
index 6545cce..32b277f 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_notify.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_notify.md
@@ -2,7 +2,10 @@
```c
int
-ble_gattc_notify(uint16_t conn_handle, uint16_t chr_val_handle)
+ble_gattc_notify(
+ uint16_t conn_handle,
+ uint16_t chr_val_handle
+)
```
### Description
@@ -21,4 +24,4 @@ Sends a characteristic notification. The content of the message is read from th
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_notify_custom.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_notify_custom.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_notify_custom.md
index c9820e8..2b51e78 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_notify_custom.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_notify_custom.md
@@ -2,8 +2,12 @@
```c
int
-ble_gattc_notify_custom(uint16_t conn_handle, uint16_t chr_val_handle,
- const void *attr_data, uint16_t attr_data_len)
+ble_gattc_notify_custom(
+ uint16_t conn_handle,
+ uint16_t chr_val_handle,
+ const void *attr_data,
+ uint16_t attr_data_len
+)
```
### Description
@@ -24,4 +28,4 @@ Sends a "free-form" characteristic notification. The content of the message is
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read.md
index 19d49b0..d5c0950 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read.md
@@ -2,8 +2,12 @@
```c
int
-ble_gattc_read(uint16_t conn_handle, uint16_t attr_handle,
- ble_gatt_attr_fn *cb, void *cb_arg)
+ble_gattc_read(
+ uint16_t conn_handle,
+ uint16_t attr_handle,
+ ble_gatt_attr_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -24,4 +28,4 @@ Initiates GATT procedure: Read Characteristic Value.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_by_uuid.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_by_uuid.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_by_uuid.md
index 365ef78..df141c2 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_by_uuid.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_by_uuid.md
@@ -2,9 +2,14 @@
```c
int
-ble_gattc_read_by_uuid(uint16_t conn_handle, uint16_t start_handle,
- uint16_t end_handle, const void *uuid128,
- ble_gatt_attr_fn *cb, void *cb_arg)
+ble_gattc_read_by_uuid(
+ uint16_t conn_handle,
+ uint16_t start_handle,
+ uint16_t end_handle,
+ const void *uuid128,
+ ble_gatt_attr_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -26,4 +31,4 @@ Initiates GATT procedure: Read Using Characteristic UUID.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_long.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_long.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_long.md
index 89f8d73..13fea85 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_long.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_long.md
@@ -2,8 +2,12 @@
```c
int
-ble_gattc_read_long(uint16_t conn_handle, uint16_t handle,
- ble_gatt_attr_fn *cb, void *cb_arg)
+ble_gattc_read_long(
+ uint16_t conn_handle,
+ uint16_t handle,
+ ble_gatt_attr_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -24,4 +28,4 @@ Initiates GATT procedure: Read Long Characteristic Values.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_mult.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_mult.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_mult.md
index 2956d13..5572b14 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_mult.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_read_mult.md
@@ -2,9 +2,13 @@
```c
int
-ble_gattc_read_mult(uint16_t conn_handle, const uint16_t *handles,
- uint8_t num_handles, ble_gatt_attr_fn *cb,
- void *cb_arg)
+ble_gattc_read_mult(
+ uint16_t conn_handle,
+ const uint16_t *handles,
+ uint8_t num_handles,
+ ble_gatt_attr_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -26,4 +30,4 @@ Initiates GATT procedure: Read Multiple Characteristic Values.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write.md
index ec074c1..6e7c28e 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write.md
@@ -2,8 +2,14 @@
```c
int
-ble_gattc_write(uint16_t conn_handle, uint16_t attr_handle, const void *value,
- uint16_t value_len, ble_gatt_attr_fn *cb, void *cb_arg)
+ble_gattc_write(
+ uint16_t conn_handle,
+ uint16_t attr_handle,
+ const void *value,
+ uint16_t value_len,
+ ble_gatt_attr_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -26,4 +32,4 @@ Initiates GATT procedure: Write Characteristic Value.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_long.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_long.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_long.md
index 69f1f89..2d913f0 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_long.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_long.md
@@ -2,9 +2,14 @@
```c
int
-ble_gattc_write_long(uint16_t conn_handle, uint16_t attr_handle,
- const void *value, uint16_t value_len,
- ble_gatt_attr_fn *cb, void *cb_arg)
+ble_gattc_write_long(
+ uint16_t conn_handle,
+ uint16_t attr_handle,
+ const void *value,
+ uint16_t value_len,
+ ble_gatt_attr_fn *cb,
+ void *cb_arg
+)
```
### Description
@@ -27,4 +32,4 @@ Initiates GATT procedure: Write Long Characteristic Values.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_no_rsp.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_no_rsp.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_no_rsp.md
index 3983b8b..5872dc3 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_no_rsp.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_no_rsp.md
@@ -2,8 +2,12 @@
```c
int
-ble_gattc_write_no_rsp(uint16_t conn_handle, uint16_t attr_handle,
- const void *value, uint16_t value_len)
+ble_gattc_write_no_rsp(
+ uint16_t conn_handle,
+ uint16_t attr_handle,
+ const void *value,
+ uint16_t value_len
+)
```
### Description
@@ -24,4 +28,4 @@ Initiates GATT procedure: Write Without Response.
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_reliable.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_reliable.md b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_reliable.md
index 302eb99..2fb2ceb 100644
--- a/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_reliable.md
+++ b/docs/network/ble/ble_hs/ble_gattc/functions/ble_gattc_write_reliable.md
@@ -2,10 +2,13 @@
```c
int
-ble_gattc_write_reliable(uint16_t conn_handle,
- const struct ble_gatt_attr *attrs,
- int num_attrs, ble_gatt_reliable_attr_fn *cb,
- void *cb_arg)
+ble_gattc_write_reliable(
+ uint16_t conn_handle,
+ const struct ble_gatt_attr *attrs,
+ int num_attrs,
+ ble_gatt_reliable_attr_fn *cb,
+ void *cb_arg
+)
```
### Description
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_chr.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_chr.md b/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_chr.md
index 27cb728..8739453 100644
--- a/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_chr.md
+++ b/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_chr.md
@@ -2,8 +2,12 @@
```c
int
-ble_gatts_find_chr(const void *svc_uuid128, const void *chr_uuid128,
- uint16_t *out_def_handle, uint16_t *out_val_handle)
+ble_gatts_find_chr(
+ const void *svc_uuid128,
+ const void *chr_uuid128,
+ uint16_t *out_def_handle,
+ uint16_t *out_val_handle
+)
```
### Description
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_dsc.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_dsc.md b/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_dsc.md
index 6a2dcc1..dff84c6 100644
--- a/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_dsc.md
+++ b/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_dsc.md
@@ -2,8 +2,12 @@
```c
int
-ble_gatts_find_dsc(const void *svc_uuid128, const void *chr_uuid128,
- const void *dsc_uuid128, uint16_t *out_handle)
+ble_gatts_find_dsc(
+ const void *svc_uuid128,
+ const void *chr_uuid128,
+ const void *dsc_uuid128,
+ uint16_t *out_handle
+)
```
### Description
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_svc.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_svc.md b/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_svc.md
index 3df3349..561d0fa 100644
--- a/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_svc.md
+++ b/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_find_svc.md
@@ -2,7 +2,10 @@
```c
int
-ble_gatts_find_svc(const void *uuid128, uint16_t *out_handle)
+ble_gatts_find_svc(
+ const void *uuid128,
+ uint16_t *out_handle
+)
```
### Description
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_register_svcs.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_register_svcs.md b/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_register_svcs.md
index 593ae80..cef8d58 100644
--- a/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_register_svcs.md
+++ b/docs/network/ble/ble_hs/ble_gatts/functions/ble_gatts_register_svcs.md
@@ -2,8 +2,11 @@
```c
int
-ble_gatts_register_svcs(const struct ble_gatt_svc_def *svcs,
- ble_gatt_register_fn *cb, void *cb_arg)
+ble_gatts_register_svcs(
+ const struct ble_gatt_svc_def *svcs,
+ ble_gatt_register_fn *cb,
+ void *cb_arg
+)
```
### Description
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_copy_addr.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_copy_addr.md b/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_copy_addr.md
index ff6896d..17666bc 100644
--- a/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_copy_addr.md
+++ b/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_copy_addr.md
@@ -2,8 +2,11 @@
```c
int
-ble_hs_id_copy_addr(uint8_t id_addr_type, uint8_t *out_id_addr,
- int *out_is_nrpa)
+ble_hs_id_copy_addr(
+ uint8_t id_addr_type,
+ uint8_t *out_id_addr,
+ int *out_is_nrpa
+)
```
### Description
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd.md b/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd.md
index 754ddad..c0ad208 100644
--- a/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd.md
+++ b/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd.md
@@ -2,7 +2,10 @@
```c
int
-ble_hs_id_gen_rnd(int nrpa, uint8_t *out_addr)
+ble_hs_id_gen_rnd(
+ int nrpa,
+ uint8_t *out_addr
+)
```
### Description
@@ -21,4 +24,4 @@ Generates a new random address. This function does not configure the device wit
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd.md b/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd.md
index 61fb25b..950b615 100644
--- a/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd.md
+++ b/docs/network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd.md
@@ -20,4 +20,4 @@ Sets the device's random address. The address type (static vs. non-resolvable p
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/init/functions/ble_hs_init.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/init/functions/ble_hs_init.md b/docs/network/ble/ble_hs/init/functions/ble_hs_init.md
index 5c34ee0..e74bee7 100644
--- a/docs/network/ble/ble_hs/init/functions/ble_hs_init.md
+++ b/docs/network/ble/ble_hs/init/functions/ble_hs_init.md
@@ -2,7 +2,10 @@
```c
int
-ble_hs_init(struct os_eventq *app_evq, struct ble_hs_cfg *cfg)
+ble_hs_init(
+ struct os_eventq *app_evq,
+ struct ble_hs_cfg *cfg
+)
```
### Description
@@ -21,4 +24,4 @@ Initializes the NimBLE host. This function must be called before the OS is star
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/init/functions/ble_hs_start.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/init/functions/ble_hs_start.md b/docs/network/ble/ble_hs/init/functions/ble_hs_start.md
index 8cc860a..d88e861 100644
--- a/docs/network/ble/ble_hs/init/functions/ble_hs_start.md
+++ b/docs/network/ble/ble_hs/init/functions/ble_hs_start.md
@@ -18,4 +18,4 @@ None
| *Value* | *Condition* |
|---------|-------------|
| 0 | Success. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/other/functions/ble_eddystone_set_adv_data_uid.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/other/functions/ble_eddystone_set_adv_data_uid.md b/docs/network/ble/ble_hs/other/functions/ble_eddystone_set_adv_data_uid.md
index d96952b..e1c0843 100644
--- a/docs/network/ble/ble_hs/other/functions/ble_eddystone_set_adv_data_uid.md
+++ b/docs/network/ble/ble_hs/other/functions/ble_eddystone_set_adv_data_uid.md
@@ -2,7 +2,10 @@
```c
int
-ble_eddystone_set_adv_data_uid(struct ble_hs_adv_fields *adv_fields, void *uid)
+ble_eddystone_set_adv_data_uid(
+ struct ble_hs_adv_fields *adv_fields,
+ void *uid
+)
```
### Description
@@ -23,4 +26,4 @@ Configures the device to advertise eddystone UID beacons.
| 0 | Success. |
| BLE\_HS\_EBUSY | Advertising is in progress. |
| BLE\_HS\_EMSGSIZE | The specified data is too large to fit in an advertisement. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/other/functions/ble_eddystone_set_adv_data_url.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/other/functions/ble_eddystone_set_adv_data_url.md b/docs/network/ble/ble_hs/other/functions/ble_eddystone_set_adv_data_url.md
index f522ccb..b4e41a1 100644
--- a/docs/network/ble/ble_hs/other/functions/ble_eddystone_set_adv_data_url.md
+++ b/docs/network/ble/ble_hs/other/functions/ble_eddystone_set_adv_data_url.md
@@ -2,9 +2,13 @@
```c
int
-ble_eddystone_set_adv_data_url(struct ble_hs_adv_fields *adv_fields,
- uint8_t url_scheme, char *url_body,
- uint8_t url_body_len, uint8_t url_suffix)
+ble_eddystone_set_adv_data_url(
+ struct ble_hs_adv_fields *adv_fields,
+ uint8_t url_scheme,
+ char *url_body,
+ uint8_t url_body_len,
+ uint8_t url_suffix
+)
```
### Description
@@ -28,4 +32,4 @@ Configures the device to advertise eddystone URL beacons.
| 0 | Success. |
| BLE\_HS\_EBUSY | Advertising is in progress. |
| BLE\_HS\_EMSGSIZE | The specified data is too large to fit in an advertisement. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/other/functions/ble_ibeacon_set_adv_data.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/other/functions/ble_ibeacon_set_adv_data.md b/docs/network/ble/ble_hs/other/functions/ble_ibeacon_set_adv_data.md
index df002b2..5259517 100644
--- a/docs/network/ble/ble_hs/other/functions/ble_ibeacon_set_adv_data.md
+++ b/docs/network/ble/ble_hs/other/functions/ble_ibeacon_set_adv_data.md
@@ -2,7 +2,11 @@
```c
int
-ble_ibeacon_set_adv_data(void *uuid128, uint16_t major, uint16_t minor)
+ble_ibeacon_set_adv_data(
+ void *uuid128,
+ uint16_t major,
+ uint16_t minor
+)
```
### Description
@@ -23,4 +27,4 @@ Configures the device to advertise iBeacons.
|---------|-------------|
| 0 | Success. |
| BLE\_HS\_EBUSY | Advertising is in progress. |
-| [BLE host core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/3c2742f5/docs/network/ble/ble_hs/other/functions/ble_uuid_16_to_128.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/other/functions/ble_uuid_16_to_128.md b/docs/network/ble/ble_hs/other/functions/ble_uuid_16_to_128.md
index 64b6165..2726261 100644
--- a/docs/network/ble/ble_hs/other/functions/ble_uuid_16_to_128.md
+++ b/docs/network/ble/ble_hs/other/functions/ble_uuid_16_to_128.md
@@ -2,7 +2,10 @@
```c
int
-ble_uuid_16_to_128(uint16_t uuid16, void *out_uuid128)
+ble_uuid_16_to_128(
+ uint16_t uuid16,
+ void *out_uuid128
+)
```
### Description
[3/4] incubator-mynewt-site git commit: BLE Host API - Add ATT
reference.
Posted by ad...@apache.org.
BLE Host API - Add ATT reference.
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/e11c74c4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/e11c74c4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/e11c74c4
Branch: refs/heads/develop
Commit: e11c74c48668d2c64b9d409253332000a19be8f8
Parents: b1efe04
Author: Christopher Collins <cc...@apache.org>
Authored: Sat Jul 9 12:33:34 2016 -0700
Committer: Christopher Collins <cc...@apache.org>
Committed: Sat Jul 9 12:33:34 2016 -0700
----------------------------------------------------------------------
docs/network/ble/ble_hs/ble_att/ble_att.md | 25 +++++++
.../ble_hs/ble_att/definitions/ble_att_defs.md | 77 ++++++++++++++++++++
.../functions/ble_att_set_preferred_mtu.md | 23 ++++++
.../ble_att/functions/ble_att_svr_read_local.md | 29 ++++++++
.../functions/ble_att_svr_write_local.md | 29 ++++++++
mkdocs.yml | 8 ++
6 files changed, 191 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e11c74c4/docs/network/ble/ble_hs/ble_att/ble_att.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_att/ble_att.md b/docs/network/ble/ble_hs/ble_att/ble_att.md
new file mode 100644
index 0000000..3f0ee2e
--- /dev/null
+++ b/docs/network/ble/ble_hs/ble_att/ble_att.md
@@ -0,0 +1,25 @@
+## <font color="F2853F" style="font-size:24pt">NimBLE Host ATT Client Reference</font>
+
+### Introduction
+
+The Attribute Protocol (ATT) is a mid-level protocal that all BLE devices use to exchange data. Data is exchanged when an ATT client reads or writes an attribute belonging to an ATT server. Any device that needs to send or receive data must support both the client and server functionality of the ATT protocol. The only devices which do not support ATT are the most basic ones: broadcasters and observers (i.e., beaconing devices and listening devices).
+
+Most ATT functionality is not interesting to an application. Rather than use ATT directly, an application uses the higher level GATT profile, which sits directly above ATT in the host. NimBLE exposes the few bits of ATT functionality which are not encompassed by higher level GATT functions. This section documents the ATT functionality that the NimBLE host exposes to the application.
+
+### Header
+
+```c
+#include "host/ble_hs.h"
+```
+
+### Definitions
+
+[BLE host ATT definitions](definitions/ble_att_defs.md)
+
+### Functions
+
+| Function | Description |
+|----------|-------------|
+| [ble_att_set_preferred_mtu](functions/ble_att_set_preferred_mtu.md) | Sets the preferred ATT MTU; the device will indicate this value in all subseqeunt ATT MTU exchanges. |
+| [ble_att_svr_read_local](functions/ble_att_svr_read_local.md) | Reads a locally registered attribute. |
+| [ble_att_svr_write_local](functions/ble_att_svr_write_local.md) | Writes a locally registered attribute. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e11c74c4/docs/network/ble/ble_hs/ble_att/definitions/ble_att_defs.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_att/definitions/ble_att_defs.md b/docs/network/ble/ble_hs/ble_att/definitions/ble_att_defs.md
new file mode 100644
index 0000000..abd6902
--- /dev/null
+++ b/docs/network/ble/ble_hs/ble_att/definitions/ble_att_defs.md
@@ -0,0 +1,77 @@
+## <font color="#F2853F" style="font-size:24pt">ATT Definitions</font>
+
+```c
+/**
+ * Context for an access to an ATT attribute. When a client reads or writes a
+ * locally registered attribute, an instance of this struct gets passed to the
+ * access callback.
+ */
+struct ble_att_svr_access_ctxt {
+ /**
+ * The ATT operation being performed dictates which field in this union is
+ * valid. If a read is being performed, the read field is valid.
+ * Otherwise, a write is being performed, in which case the write field is
+ * valid.
+ */
+ union {
+ /** Context for reads of ATT attributes. */
+ struct {
+ /**
+ * (stack --> app)
+ * The offset within the attribute that the client is reading from.
+ */
+ uint16_t offset;
+
+ /**
+ * (stack --> app)
+ * Maximum number of data bytes the stack can send in the read
+ * response. This is based on the connection's ATT MTU.
+ */
+ uint16_t max_data_len;
+
+ /**
+ * (stack --> app)
+ * A buffer that the app can use to write the characteristic
+ * response value to. This buffer can hold up to max_data_len
+ * bytes.
+ */
+ uint8_t *buf;
+
+ /**
+ * (app --> stack)
+ * App points this at the characteristic data to respond with.
+ * Initially this points to "buf".
+ */
+ const void *data;
+
+ /**
+ * (app --> stack)
+ * App fills this with the number of data bytes contained in
+ * characteristic response.
+ */
+ uint16_t len;
+ } read;
+
+ /** Context for writes of ATT attributes. */
+ struct {
+ /**
+ * (stack --> app)
+ * The data that the peer is writing to the characteristic.
+ */
+ const void *data;
+
+ /**
+ * (stack --> app)
+ * The offset within the attribute that the client is writing to.
+ */
+ uint16_t offset;
+
+ /**
+ * (stack --> app)
+ * The number of bytes of characteristic data being written.
+ */
+ int len;
+ } write;
+ };
+};
+```
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e11c74c4/docs/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md b/docs/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md
new file mode 100644
index 0000000..32afc0c
--- /dev/null
+++ b/docs/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md
@@ -0,0 +1,23 @@
+## <font color="#F2853F" style="font-size:24pt">ble\_att\_set\_preferred\_mtu</font>
+
+```c
+int
+ble_att_set_preferred_mtu(uint16_t mtu)
+```
+
+### Description
+
+Sets the preferred ATT MTU; the device will indicate this value in all subseqeunt ATT MTU exchanges. The ATT MTU of a connection is equal to the lower of the two peers' preferred MTU values. The ATT MTU is what dictates the maximum size of any message sent during a GATT procedure. The specified MTU must be within the following range: [23, BLE\_ATT\_MTU\_MAX]. 23 is a minimum imposed by the Bluetooth specification; BLE\_ATT\_MTU\_MAX is a NimBLE compile-time setting.
+
+### Parameters
+
+| *Parameter* | *Description* |
+|-------------|---------------|
+| mtu | The preferred ATT MTU. |
+
+### Returned values
+
+| *Value* | *Condition* |
+|---------|-------------|
+| 0 | Success. |
+| BLE\_HS\_EINVAL | The specifeid value is not within the allowed range. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e11c74c4/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md b/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md
new file mode 100644
index 0000000..1e9a7ab
--- /dev/null
+++ b/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md
@@ -0,0 +1,29 @@
+## <font color="#F2853F" style="font-size:24pt">ble\_att\_svr\_read\_local</font>
+
+```c
+int
+ble_att_svr_read_local(
+ uint16_t attr_handle,
+ const void **out_data,
+ uint16_t *out_attr_len
+)
+```
+
+### Description
+
+Reads a locally registered attribute. If the specified attribute handle coresponds to a GATT characteristic value or descriptor, the read is performed by calling the registered GATT access callback.
+
+### Parameters
+
+| *Parameter* | *Description* |
+|-------------|---------------|
+| attr\_handle | The 16-bit handle of the attribute to read. |
+| out\_data | On success, this points to the attribute data just read. |
+| out\_attr\_len | On success, this points to the number of bytes of attribute data just read. |
+
+### Returned values
+
+| *Value* | *Condition* |
+|---------|-------------|
+| 0 | Success nimble host att return code if the attribute access callback reports failure. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e11c74c4/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md b/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md
new file mode 100644
index 0000000..829039b
--- /dev/null
+++ b/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md
@@ -0,0 +1,29 @@
+## <font color="#F2853F" style="font-size:24pt">ble\_att\_svr\_write\_local</font>
+
+```c
+int
+ble_att_svr_write_local(
+ uint16_t attr_handle,
+ const void *data,
+ uint16_t data_len
+)
+```
+
+### Description
+
+Writes a locally registered attribute. If the specified attribute handle coresponds to a GATT characteristic value or descriptor, the write is performed by calling the registered GATT access callback.
+
+### Parameters
+
+| *Parameter* | *Description* |
+|-------------|---------------|
+| attr\_handle | The 16-bit handle of the attribute to write. |
+| data | Buffer containing the data to write to the attribute. |
+| data\_len | The number of bytes to write. |
+
+### Returned values
+
+| *Value* | *Condition* |
+|---------|-------------|
+| 0 | Success nimble host att return code if the attribute access callback reports failure. |
+| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e11c74c4/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index 55421c3..a89d6e4 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -423,6 +423,14 @@ pages:
- 'ble_hs_id_set_rnd': 'network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd.md'
- 'ble_hs_id_gen_rnd': 'network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd.md'
+ - 'ATT':
+ - toc: 'network/ble/ble_hs/ble_att/ble_att.md'
+ - 'Definitions': 'network/ble/ble_hs/ble_att/definitions/ble_att_defs.md'
+ - 'Functions':
+ - 'ble_att_svr_write_local': 'network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md'
+ - 'ble_att_set_preferred_mtu': 'network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md'
+ - 'ble_att_svr_read_local': 'network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md'
+
- 'Other':
- toc: 'network/ble/ble_hs/other/other.md'
- 'Functions':
[2/4] incubator-mynewt-site git commit: BLE Host API - Add some
comments for GATT defs.
Posted by ad...@apache.org.
BLE Host API - Add some comments for GATT defs.
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/b1efe048
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/b1efe048
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/b1efe048
Branch: refs/heads/develop
Commit: b1efe0481af5034532ac9921f8f2e089796da872
Parents: 3c2742f
Author: Christopher Collins <cc...@apache.org>
Authored: Sat Jul 9 12:33:14 2016 -0700
Committer: Christopher Collins <cc...@apache.org>
Committed: Sat Jul 9 12:33:14 2016 -0700
----------------------------------------------------------------------
.../ble_hs/ble_gatts/definitions/ble_gatts_defs.md | 15 +++++++++++++++
1 file changed, 15 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b1efe048/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md b/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
index a87491a..34faff5 100644
--- a/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
+++ b/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
@@ -77,7 +77,18 @@ struct ble_gatt_svc_def {
```
```c
+/**
+ * Context for an access to a GATT characteristic or descriptor. When a client
+ * reads or writes a locally registered characteristic or descriptor, an
+ * instance of this struct gets passed to the application callback.
+ */
struct ble_gatt_access_ctxt {
+ /**
+ * The GATT operation being performed dictates which field in this union is
+ * valid. If a characteristic is being accessed, the chr field is valid.
+ * Otherwise, a descriptor is being accessed, in which case the dsc field
+ * is valid.
+ */
union {
/**
* The characteristic definition corresponding to the characteristic
@@ -92,6 +103,10 @@ struct ble_gatt_access_ctxt {
const struct ble_gatt_dsc_def *dsc;
};
+ /**
+ * Context describing the underlying ATT access. Specifies additional
+ * details about the read or write being performed.
+ */
struct ble_att_svr_access_ctxt *att;
};
```
[4/4] incubator-mynewt-site git commit: Fixed typos in pull request
#106. This closes #106
Posted by ad...@apache.org.
Fixed typos in pull request #106. 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/7a69d2b6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/7a69d2b6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/7a69d2b6
Branch: refs/heads/develop
Commit: 7a69d2b607539031a96a9ab50b9ecf34ce6b7d35
Parents: e11c74c
Author: aditihilbert <ad...@runtime.io>
Authored: Mon Jul 11 14:16:08 2016 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Mon Jul 11 14:16:08 2016 -0700
----------------------------------------------------------------------
docs/network/ble/ble_hs/ble_att/ble_att.md | 4 ++--
.../ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md | 8 ++++----
.../ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md | 5 +++--
.../ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md | 5 +++--
docs/network/ble/ble_hs/ble_gatts/ble_gatts.md | 2 +-
.../ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md | 2 +-
docs/network/ble/ble_hs/ble_hs.md | 2 +-
docs/network/ble/ble_hs/ble_hs_id/ble_hs_id.md | 4 ++--
docs/network/ble/ble_hs/ble_hs_return_codes.md | 2 +-
9 files changed, 18 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7a69d2b6/docs/network/ble/ble_hs/ble_att/ble_att.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_att/ble_att.md b/docs/network/ble/ble_hs/ble_att/ble_att.md
index 3f0ee2e..c9dace1 100644
--- a/docs/network/ble/ble_hs/ble_att/ble_att.md
+++ b/docs/network/ble/ble_hs/ble_att/ble_att.md
@@ -2,7 +2,7 @@
### Introduction
-The Attribute Protocol (ATT) is a mid-level protocal that all BLE devices use to exchange data. Data is exchanged when an ATT client reads or writes an attribute belonging to an ATT server. Any device that needs to send or receive data must support both the client and server functionality of the ATT protocol. The only devices which do not support ATT are the most basic ones: broadcasters and observers (i.e., beaconing devices and listening devices).
+The Attribute Protocol (ATT) is a mid-level protocol that all BLE devices use to exchange data. Data is exchanged when an ATT client reads or writes an attribute belonging to an ATT server. Any device that needs to send or receive data must support both the client and server functionality of the ATT protocol. The only devices which do not support ATT are the most basic ones: broadcasters and observers (i.e., beaconing devices and listening devices).
Most ATT functionality is not interesting to an application. Rather than use ATT directly, an application uses the higher level GATT profile, which sits directly above ATT in the host. NimBLE exposes the few bits of ATT functionality which are not encompassed by higher level GATT functions. This section documents the ATT functionality that the NimBLE host exposes to the application.
@@ -20,6 +20,6 @@ Most ATT functionality is not interesting to an application. Rather than use AT
| Function | Description |
|----------|-------------|
-| [ble_att_set_preferred_mtu](functions/ble_att_set_preferred_mtu.md) | Sets the preferred ATT MTU; the device will indicate this value in all subseqeunt ATT MTU exchanges. |
+| [ble_att_set_preferred_mtu](functions/ble_att_set_preferred_mtu.md) | Sets the preferred ATT MTU; the device will indicate this value in all subsequent ATT MTU exchanges. |
| [ble_att_svr_read_local](functions/ble_att_svr_read_local.md) | Reads a locally registered attribute. |
| [ble_att_svr_write_local](functions/ble_att_svr_write_local.md) | Writes a locally registered attribute. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7a69d2b6/docs/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md b/docs/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md
index 32afc0c..2fb60aa 100644
--- a/docs/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md
+++ b/docs/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu.md
@@ -7,17 +7,17 @@ ble_att_set_preferred_mtu(uint16_t mtu)
### Description
-Sets the preferred ATT MTU; the device will indicate this value in all subseqeunt ATT MTU exchanges. The ATT MTU of a connection is equal to the lower of the two peers' preferred MTU values. The ATT MTU is what dictates the maximum size of any message sent during a GATT procedure. The specified MTU must be within the following range: [23, BLE\_ATT\_MTU\_MAX]. 23 is a minimum imposed by the Bluetooth specification; BLE\_ATT\_MTU\_MAX is a NimBLE compile-time setting.
+Sets the preferred ATT MTU; the device will indicate this value in all subsequent ATT MTU exchanges. The ATT MTU of a connection is equal to the lower of the two peers' preferred MTU values. The ATT MTU is what dictates the maximum size of any message sent during a GATT procedure. The specified MTU must be within the following range: [23, BLE\_ATT\_MTU\_MAX]. 23 is a minimum imposed by the Bluetooth specification; BLE\_ATT\_MTU\_MAX is a NimBLE compile-time setting.
### Parameters
| *Parameter* | *Description* |
|-------------|---------------|
-| mtu | The preferred ATT MTU. |
+| mtu | The preferred ATT MTU |
### Returned values
| *Value* | *Condition* |
|---------|-------------|
-| 0 | Success. |
-| BLE\_HS\_EINVAL | The specifeid value is not within the allowed range. |
+| 0 | Success |
+| BLE\_HS\_EINVAL | The specified value is not within the allowed range |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7a69d2b6/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md b/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md
index 1e9a7ab..cba2718 100644
--- a/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md
+++ b/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local.md
@@ -11,7 +11,7 @@ ble_att_svr_read_local(
### Description
-Reads a locally registered attribute. If the specified attribute handle coresponds to a GATT characteristic value or descriptor, the read is performed by calling the registered GATT access callback.
+Reads a locally registered attribute. If the specified attribute handle corresponds to a GATT characteristic value or descriptor, the read is performed by calling the registered GATT access callback.
### Parameters
@@ -25,5 +25,6 @@ Reads a locally registered attribute. If the specified attribute handle corespo
| *Value* | *Condition* |
|---------|-------------|
-| 0 | Success nimble host att return code if the attribute access callback reports failure. |
+| 0 | Success |
+| [ATT return code](../../ble_hs_return_codes/#return-codes-att) | NimBLE host ATT return code if the attribute access callback reports failure. |
| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7a69d2b6/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md b/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md
index 829039b..944a8c0 100644
--- a/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md
+++ b/docs/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local.md
@@ -11,7 +11,7 @@ ble_att_svr_write_local(
### Description
-Writes a locally registered attribute. If the specified attribute handle coresponds to a GATT characteristic value or descriptor, the write is performed by calling the registered GATT access callback.
+Writes a locally registered attribute. If the specified attribute handle corresponds to a GATT characteristic value or descriptor, the write is performed by calling the registered GATT access callback.
### Parameters
@@ -25,5 +25,6 @@ Writes a locally registered attribute. If the specified attribute handle coresp
| *Value* | *Condition* |
|---------|-------------|
-| 0 | Success nimble host att return code if the attribute access callback reports failure. |
+| 0 | Success |
+| [ATT return code](../../ble_hs_return_codes/#return-codes-att) | NimBLE host att return code if the attribute access callback reports failure. |
| [Core return code](../../ble_hs_return_codes/#return-codes-core) | Unexpected error. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7a69d2b6/docs/network/ble/ble_hs/ble_gatts/ble_gatts.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gatts/ble_gatts.md b/docs/network/ble/ble_hs/ble_gatts/ble_gatts.md
index 33123a9..25aeb20 100644
--- a/docs/network/ble/ble_hs/ble_gatts/ble_gatts.md
+++ b/docs/network/ble/ble_hs/ble_gatts/ble_gatts.md
@@ -1,4 +1,4 @@
-## <font color="F2853F" style="font-size:24pt">NimBLE Host GATT Client Reference</font>
+## <font color="F2853F" style="font-size:24pt">NimBLE Host GATT Server Reference</font>
### Introduction
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7a69d2b6/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md b/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
index 34faff5..b9114c8 100644
--- a/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
+++ b/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
@@ -1,4 +1,4 @@
-## <font color="#F2853F" style="font-size:24pt">GATT Client Definitions/font>
+## <font color="#F2853F" style="font-size:24pt">GATT Server Definitions</font>
```c
typedef int ble_gatt_access_fn(uint16_t conn_handle, uint16_t attr_handle,
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7a69d2b6/docs/network/ble/ble_hs/ble_hs.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_hs.md b/docs/network/ble/ble_hs/ble_hs.md
index efde78a..d961d74 100644
--- a/docs/network/ble/ble_hs/ble_hs.md
+++ b/docs/network/ble/ble_hs/ble_hs.md
@@ -2,7 +2,7 @@
### Introduction
-At a high level, the NimBLE stack is is divided into two components:
+At a high level, the NimBLE stack is divided into two components:
* Host
* Controller
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7a69d2b6/docs/network/ble/ble_hs/ble_hs_id/ble_hs_id.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_hs_id/ble_hs_id.md b/docs/network/ble/ble_hs/ble_hs_id/ble_hs_id.md
index f34162a..818c41b 100644
--- a/docs/network/ble/ble_hs/ble_hs_id/ble_hs_id.md
+++ b/docs/network/ble/ble_hs/ble_hs_id/ble_hs_id.md
@@ -1,4 +1,4 @@
-## <font color="F2853F" style="font-size:24pt">NimBLE Host GAP Reference</font>
+## <font color="F2853F" style="font-size:24pt">NimBLE Host Identity Reference</font>
### Introduction
@@ -6,7 +6,7 @@ The identity API provides facilities for querying and configuring your device's
BLE defines four address types:
-| Type | Description | Identity? | Configured with |
+| Type | Description | Identity? | Configured with |
|-------------------------------|-------------------------------------------------------------------------------------------------|-----------|---------------------------------------------|
| Public | Address assigned by manufacturer; the three most significant bytes form the manufacturer's OUI. | Yes | N/A; read from controller at startup. |
| Static random | Randomly generated address. | Yes | *ble_hs_id_set_rnd()* |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/7a69d2b6/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 d485c12..a2923e7 100644
--- a/docs/network/ble/ble_hs/ble_hs_return_codes.md
+++ b/docs/network/ble/ble_hs/ble_hs_return_codes.md
@@ -24,7 +24,7 @@ A return code of 0 indicates success. For failure conditions, the return codes
| Core | Errors detected internally by the NimBLE host. |
| ATT | The ATT server has reported a failure via the transmission of an ATT Error Response. The return code corresponds to the value of the Error Code field in the response. |
| HCI | The controller has reported an error to the host via a command complete or command status HCI event. The return code corresponds to the value of the Status field in the event.
-| L2CAP | An L2CAP signalling procedure has failed and an L2CAP Command Reject was sent as a result. The return code corresponds to the value of the Reason field in the command.
+| L2CAP | An L2CAP signaling procedure has failed and an L2CAP Command Reject was sent as a result. The return code corresponds to the value of the Reason field in the command.
| Security manager (us) | The host detected an error during a security manager procedure and sent a Pairing Failed command to the peer. The return code corresponds to the value of the Reason field in the Pairing Failed command. |
| Security manager (peer) | A security manager procedure failed because the peer sent us a Pairing Failed command. The return code corresponds to the value of the Reason field in the Pairing Failed command. |