pull request #106: adds to ble host api docs
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/14876ba5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/14876ba5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/14876ba5 Branch: refs/heads/asf-site Commit: 14876ba58a376b3f57785dedf27d5e1c0cd1e2ab Parents: e98b0c1 Author: aditihilbert <ad...@runtime.io> Authored: Fri Jul 8 15:59:11 2016 -0700 Committer: aditihilbert <ad...@runtime.io> Committed: Fri Jul 8 15:59:11 2016 -0700 ---------------------------------------------------------------------- develop/mkdocs/search_index.json | 39 +- .../functions/ble_gap_adv_active/index.html | 8 + .../ble_gap_adv_rsp_set_fields/index.html | 8 + .../functions/ble_gap_adv_set_fields/index.html | 8 + .../functions/ble_gap_adv_start/index.html | 8 + .../functions/ble_gap_adv_stop/index.html | 8 + .../functions/ble_gap_conn_active/index.html | 8 + .../functions/ble_gap_conn_cancel/index.html | 8 + .../functions/ble_gap_conn_find/index.html | 12 +- .../functions/ble_gap_conn_rssi/index.html | 734 +++++++++++++++++++ .../functions/ble_gap_connect/index.html | 12 +- .../ble_gap/functions/ble_gap_disc/index.html | 8 + .../functions/ble_gap_disc_active/index.html | 8 + .../functions/ble_gap_disc_cancel/index.html | 12 +- .../ble_gap_security_initiate/index.html | 8 + .../functions/ble_gap_terminate/index.html | 8 + .../functions/ble_gap_update_params/index.html | 8 + .../ble_gap/functions/ble_gap_wl_set/index.html | 8 + .../ble/ble_hs/ble_hs_return_codes/index.html | 99 +++ 19 files changed, 999 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/mkdocs/search_index.json ---------------------------------------------------------------------- diff --git a/develop/mkdocs/search_index.json b/develop/mkdocs/search_index.json index 3f31246..62377a2 100644 --- a/develop/mkdocs/search_index.json +++ b/develop/mkdocs/search_index.json @@ -7297,7 +7297,7 @@ }, { "location": "/network/ble/ble_hs/ble_hs_return_codes/", - "text": "NimBLE Host Return Codes\n\n\n\n\nIntroduction\n\n\nSummary\n\n\nExample\n\n\n\n\n\n\nReturn Code Reference\n\n\nReturn codes - Core\n\n\nReturn codes - ATT\n\n\nReturn codes - HCI\n\n\nReturn codes - L2CAP\n\n\nReturn codes - Security manager (us)\n\n\nReturn codes - Security manager (peer)\n\n\n\n\n\n\n\n\nIntroduction\n\n\nSummary\n\n\nThe NimBLE host reports status to the application via a set of return codes. The host encompasses several layers of the Bluetooth specification that each defines its own set of status codes. Rather than \"abstract away\" information from lower layers that the application developer might find useful, the NimBLE host aims to indicate precisely what happened when something fails. Consequently, the host utilizes a rather large set of return codes.\n\n\nA return code of 0 indicates success. For failure conditions, the return codes are partitioned into five separate sets:\n\n\n\n\n\n\n\n\nSet\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\nC ore\n\n\nErrors detected internally by the NimBLE host.\n\n\n\n\n\n\nATT\n\n\nThe 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.\n\n\n\n\n\n\nHCI\n\n\nThe 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.\n\n\n\n\n\n\nL2CAP\n\n\nAn 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.\n\n\n\n\n\n\nSecurity manager (us)\n\n\nThe 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.\n\n\n\n\n\n\nSecurity manager (peer)\n\n\nA security manager procedure failed because the peer sent us a Pairing Fai led command. The return code corresponds to the value of the Reason field in the Pairing Failed command.\n\n\n\n\n\n\n\n\nThe return codes in the core set are defined by the NimBLE Host. The other sets are defined in the Bluetooth specification; the codes in this latter group are referred to as \nformal status codes\n. As defined in the Bluetooth specification, the formal status code sets are not disjoint. That is, they overlap. For example, the spec defines a status code of 1 to have all of the following meanings:\n\n\n\n\n\n\n\n\nLayer\n\n\nMeaning\n\n\n\n\n\n\n\n\n\n\nATT\n\n\nInvalid handle.\n\n\n\n\n\n\nHCI\n\n\nUnknown HCI command.\n\n\n\n\n\n\nL2CAP\n\n\nSignalling MTU exceeded.\n\n\n\n\n\n\nSM\n\n\nPasskey entry failed.\n\n\n\n\n\n\n\n\nClearly, the host can't just return an unadorned formal status code and expect the application to make sense of it. To resolve this ambiguity, the NimBLE host divides the full range of an int into several subranges. Each subrange corre sponds to one of the five return code sets. For example, the ATT set is mapped onto the subrange \n[0x100, 0x200)\n. To indicate an ATT error of 3 (write not permitted), the NimBLE host returns a value 0x103 to the application.\n\n\nThe host defines a set of convenience macros for converting from a formal status code to NimBLE host status code. These macros are documented in the table below.\n\n\n\n\n\n\n\n\nMacro\n\n\nStatus code set\n\n\nBase value\n\n\n\n\n\n\n\n\n\n\nBLE_HS_ATT_ERR()\n\n\nATT\n\n\n0x100\n\n\n\n\n\n\nBLE_HS_HCI_ERR()\n\n\nHCI\n\n\n0x200\n\n\n\n\n\n\nBLE_HS_L2C_ERR()\n\n\nL2CAP\n\n\n0x300\n\n\n\n\n\n\nBLE_HS_SM_US_ERR()\n\n\nSecurity manager (us)\n\n\n0x400\n\n\n\n\n\n\nBLE_HS_SM_PEER_ERR()\n\n\nSecurity manager (peer)\n\n\n0x500\n\n\n\n\n\n\n\n\nExample\n\n\nThe following example demonstrates how an application might determine which error is being reported by the host. In this example, the application performs the GAP encryption procedure and checks the retur n code. To simplify the example, the application uses a hypothetical \nmy_blocking_enc_proc()\n function, which blocks until the pairing operation has completed.\n\n\nvoid\n\n\nencrypt_connection\n(\nuint16_t\n \nconn_handle\n)\n{\n \nint\n \nrc\n;\n\n \n/* Perform a blocking GAP encryption procedure. */\n\n \nrc\n \n=\n \nmy_blocking_enc_proc\n(\nconn_handle\n);\n \nswitch\n (\nrc\n) {\n \ncase\n \n0\n:\n\n \nconsole_printf\n(\nsuccess - link successfully encrypted\\n\n);\n \nbreak\n;\n\n \ncase\n \nBLE_HS_ENOTCONN\n:\n \nconsole_printf\n(\nfailure - no connection with handle %d\\n\n,\n \nconn_handle\n);\n \nbreak\n;\n\n \ncase\n \nBLE_HS_ERR_SM_US_BASE\n(\nBLE_SM_ERR_CONFIRM_MISMATCH\n)\n:\n\n \nconsole_printf\n(\nfailure - mismatch in peer\ns confirm and random \n\n \ncommands.\\n\n);\n \nbreak\n;\n\n \ncase\n \nBLE_HS_ERR_SM_PEER_BASE\n(\nBLE_SM_ERR_CONFIRM_MISMATCH\n)\ n:\n\n \nconsole_printf\n(\nfailure - peer reports mismatch in our confirm and \n\n \nrandom commands.\\n\n);\n \nbreak\n;\n\n \ndefault\n:\n\n \nconsole_printf\n(\nfailure - other error: 0x%04x\\n\n, \nrc\n);\n \nbreak\n;\n }\n}\n\n\n\n\n\nReturn Code Reference\n\n\nReturn codes - Core\n\n\nThe precise meaning of each of these error codes depends on the function that returns it. The API reference for a particular function indicates the conditions under which each of these codes are returned.\n\n\n#include \nhost/ble_hs.h\n\n\n\n\n\n\n\n\n\n\n\n\nValue\n\n\nName\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0x00\n\n\nN/A\n\n\nSuccess\n\n\n\n\n\n\n0x01\n\n\nBLE_HS_EAGAIN\n\n\nTemporary failure; try again.\n\n\n\n\n\n\n0x02\n\n\nBLE_HS_EALREADY\n\n\nOperation already in progress or completed.\n\n\n\n\n\n\n0x03\n\n\nBLE_HS_EINVAL\n\n\nOne or more arguments are invalid.\n\n\n\n\n\n\n0x04\n\n\nBLE_HS_EMSGSIZE\n\n\nThe provided buffer is too small.\n\n\n\n\n\n\n0x05\n\n\nBLE_HS_ENOENT\n\n\nNo entry matching the specified criteria.\n\n\n\n\n\n\n0x06\n\n\nBLE_HS_ENOMEM\n\n\nOperation failed due to resource exhaustion.\n\n\n\n\n\n\n0x07\n\n\nBLE_HS_ENOTCONN\n\n\nNo open connection with the specified handle.\n\n\n\n\n\n\n0x08\n\n\nBLE_HS_ENOTSUP\n\n\nOperation disabled at compile time.\n\n\n\n\n\n\n0x09\n\n\nBLE_HS_EAPP\n\n\nApplication callback behaved unexpectedly.\n\n\n\n\n\n\n0x0a\n\n\nBLE_HS_EBADDATA\n\n\nCommand from peer is invalid.\n\n\n\n\n\n\n0x0b\n\n\nBLE_HS_EOS\n\n\nMynewt OS error.\n\n\n\n\n\n\n0x0c\n\n\nBLE_HS_ECONTROLLER\n\n\nEvent from controller is invalid.\n\n\n\n\n\n\n0x0d\n\n\nBLE_HS_ETIMEOUT\n\n\nOperation timed out.\n\n\n\n\n\n\n0x0e\n\n\nBLE_HS_EDONE\n\n\nOperation completed successfully.\n\n\n\n\n\n\n0x0f\n\n\nBLE_HS_EBUSY\n\n\nOperation cannot be performed until procedure completes.\n\n\n\n\n\n\n0x10\n\n\nBLE_HS_EREJECT\n\n\nPeer rejected a connection parameter update request.\n\n\n\n\n\n\n0x11\n\n\ nBLE_HS_EUNKNOWN\n\n\nUnexpected failure; catch all.\n\n\n\n\n\n\n0x12\n\n\nBLE_HS_EROLE\n\n\nOperation requires different role (e.g., central vs. peripheral).\n\n\n\n\n\n\n0x13\n\n\nBLE_HS_ETIMEOUT_HCI\n\n\nHCI request timed out; controller unresponsive.\n\n\n\n\n\n\n0x14\n\n\nBLE_HS_ENOMEM_EVT\n\n\nController failed to send event due to memory exhaustion (combined host-controller only).\n\n\n\n\n\n\n0x15\n\n\nBLE_HS_ENOADDR\n\n\nOperation requires an identity address but none configured.\n\n\n\n\n\n\n\n\nReturn codes - ATT\n\n\n#include \nhost/ble_hs.h\n\n\n#include \nhost/ble_att.h\n\n\n\n\n\n\n\n\n\n\n\n\nNimBLE Value\n\n\nFormal Value\n\n\nName\n\n\n\n\n\n\n\n\n\n\n0x0101\n\n\n0x01\n\n\nBLE_ATT_ERR_INVALID_HANDLE\n\n\n\n\n\n\n0x0102\n\n\n0x02\n\n\nBLE_ATT_ERR_READ_NOT_PERMITTED\n\n\n\n\n\n\n0x0103\n\n\n0x03\n\n\nBLE_ATT_ERR_WRITE_NOT_PERMITTED\n\n\n\n\n\n\n0x0104\n\n\n0x04\n\n\nBLE_ATT_ERR_INVALID_PDU\n\n\n\n\n\n\n0x0105\n\n\n0x05\n\n\nBLE_ATT_ERR_INSUFFICIENT_AUTHEN\n\n\n\n\n\ n\n0x0106\n\n\n0x06\n\n\nBLE_ATT_ERR_REQ_NOT_SUPPORTED\n\n\n\n\n\n\n0x0107\n\n\n0x07\n\n\nBLE_ATT_ERR_INVALID_OFFSET\n\n\n\n\n\n\n0x0108\n\n\n0x08\n\n\nBLE_ATT_ERR_INSUFFICIENT_AUTHOR\n\n\n\n\n\n\n0x0109\n\n\n0x09\n\n\nBLE_ATT_ERR_PREPARE_QUEUE_FULL\n\n\n\n\n\n\n0x010a\n\n\n0x0a\n\n\nBLE_ATT_ERR_ATTR_NOT_FOUND\n\n\n\n\n\n\n0x010b\n\n\n0x0b\n\n\nBLE_ATT_ERR_ATTR_NOT_LONG\n\n\n\n\n\n\n0x010c\n\n\n0x0c\n\n\nBLE_ATT_ERR_INSUFFICIENT_KEY_SZ\n\n\n\n\n\n\n0x010d\n\n\n0x0d\n\n\nBLE_ATT_ERR_INVALID_ATTR_VALUE_LEN\n\n\n\n\n\n\n0x010e\n\n\n0x0e\n\n\nBLE_ATT_ERR_UNLIKELY\n\n\n\n\n\n\n0x010f\n\n\n0x0f\n\n\nBLE_ATT_ERR_INSUFFICIENT_ENC\n\n\n\n\n\n\n0x0110\n\n\n0x10\n\n\nBLE_ATT_ERR_UNSUPPORTED_GROUP\n\n\n\n\n\n\n0x0111\n\n\n0x11\n\n\nBLE_ATT_ERR_INSUFFICIENT_RES\n\n\n\n\n\n\n\n\nReturn codes - HCI\n\n\n#include \nhost/ble_hs.h\n\n\n#include \nnimble/ble.h\n\n\n\n\n\n\n\n\n\n\n\n\nNimBLE Value\n\n\nFormal Value\n\n\nName\n\n\n\n\n\n\n\n\n\n\n0x0201\n\n\n0x01\n\n\nBLE_ERR_UNKNOWN_HCI_CMD\n\n\n\n\n\ n\n0x0202\n\n\n0x02\n\n\nBLE_ERR_UNK_CONN_ID\n\n\n\n\n\n\n0x0203\n\n\n0x03\n\n\nBLE_ERR_HW_FAIL\n\n\n\n\n\n\n0x0204\n\n\n0x04\n\n\nBLE_ERR_PAGE_TMO\n\n\n\n\n\n\n0x0205\n\n\n0x05\n\n\nBLE_ERR_AUTH_FAIL\n\n\n\n\n\n\n0x0206\n\n\n0x06\n\n\nBLE_ERR_PINKEY_MISSING\n\n\n\n\n\n\n0x0207\n\n\n0x07\n\n\nBLE_ERR_MEM_CAPACITY\n\n\n\n\n\n\n0x0208\n\n\n0x08\n\n\nBLE_ERR_CONN_SPVN_TMO\n\n\n\n\n\n\n0x0209\n\n\n0x09\n\n\nBLE_ERR_CONN_LIMIT\n\n\n\n\n\n\n0x020a\n\n\n0x0a\n\n\nBLE_ERR_SYNCH_CONN_LIMIT\n\n\n\n\n\n\n0x020b\n\n\n0x0b\n\n\nBLE_ERR_ACL_CONN_EXISTS\n\n\n\n\n\n\n0x020c\n\n\n0x0c\n\n\nBLE_ERR_CMD_DISALLOWED\n\n\n\n\n\n\n0x020d\n\n\n0x0d\n\n\nBLE_ERR_CONN_REJ_RESOURCES\n\n\n\n\n\n\n0x020e\n\n\n0x0e\n\n\nBLE_ERR_CONN_REJ_SECURITY\n\n\n\n\n\n\n0x020f\n\n\n0x0f\n\n\nBLE_ERR_CONN_REJ_BD_ADDR\n\n\n\n\n\n\n0x0210\n\n\n0x10\n\n\nBLE_ERR_CONN_ACCEPT_TMO\n\n\n\n\n\n\n0x0211\n\n\n0x11\n\n\nBLE_ERR_UNSUPPORTED\n\n\n\n\n\n\n0x0212\n\n\n0x12\n\n\nBLE_ERR_INV_HCI_CMD_PARMS\n\n\n\n\n\n\n0x0213\n\n\n0x13\n\n\nB LE_ERR_REM_USER_CONN_TERM\n\n\n\n\n\n\n0x0214\n\n\n0x14\n\n\nBLE_ERR_RD_CONN_TERM_RESRCS\n\n\n\n\n\n\n0x0215\n\n\n0x15\n\n\nBLE_ERR_RD_CONN_TERM_PWROFF\n\n\n\n\n\n\n0x0216\n\n\n0x16\n\n\nBLE_ERR_CONN_TERM_LOCAL\n\n\n\n\n\n\n0x0217\n\n\n0x17\n\n\nBLE_ERR_REPEATED_ATTEMPTS\n\n\n\n\n\n\n0x0218\n\n\n0x18\n\n\nBLE_ERR_NO_PAIRING\n\n\n\n\n\n\n0x0219\n\n\n0x19\n\n\nBLE_ERR_UNK_LMP\n\n\n\n\n\n\n0x021a\n\n\n0x1a\n\n\nBLE_ERR_UNSUPP_REM_FEATURE\n\n\n\n\n\n\n0x021b\n\n\n0x1b\n\n\nBLE_ERR_SCO_OFFSET\n\n\n\n\n\n\n0x021c\n\n\n0x1c\n\n\nBLE_ERR_SCO_ITVL\n\n\n\n\n\n\n0x021d\n\n\n0x1d\n\n\nBLE_ERR_SCO_AIR_MODE\n\n\n\n\n\n\n0x021e\n\n\n0x1e\n\n\nBLE_ERR_INV_LMP_LL_PARM\n\n\n\n\n\n\n0x021f\n\n\n0x1f\n\n\nBLE_ERR_UNSPECIFIED\n\n\n\n\n\n\n0x0220\n\n\n0x20\n\n\nBLE_ERR_UNSUPP_LMP_LL_PARM\n\n\n\n\n\n\n0x0221\n\n\n0x21\n\n\nBLE_ERR_NO_ROLE_CHANGE\n\n\n\n\n\n\n0x0222\n\n\n0x22\n\n\nBLE_ERR_LMP_LL_RSP_TMO\n\n\n\n\n\n\n0x0223\n\n\n0x23\n\n\nBLE_ERR_LMP_COLLISION\n\n\n\n\n\n\n0x0224\n\n\n0x24\n\n\nBLE_ERR_LMP_ PDU\n\n\n\n\n\n\n0x0225\n\n\n0x25\n\n\nBLE_ERR_ENCRYPTION_MODE\n\n\n\n\n\n\n0x0226\n\n\n0x26\n\n\nBLE_ERR_LINK_KEY_CHANGE\n\n\n\n\n\n\n0x0227\n\n\n0x27\n\n\nBLE_ERR_UNSUPP_QOS\n\n\n\n\n\n\n0x0228\n\n\n0x28\n\n\nBLE_ERR_INSTANT_PASSED\n\n\n\n\n\n\n0x0229\n\n\n0x29\n\n\nBLE_ERR_UNIT_KEY_PAIRING\n\n\n\n\n\n\n0x022a\n\n\n0x2a\n\n\nBLE_ERR_DIFF_TRANS_COLL\n\n\n\n\n\n\n0x022c\n\n\n0x2c\n\n\nBLE_ERR_QOS_PARM\n\n\n\n\n\n\n0x022d\n\n\n0x2d\n\n\nBLE_ERR_QOS_REJECTED\n\n\n\n\n\n\n0x022e\n\n\n0x2e\n\n\nBLE_ERR_CHAN_CLASS\n\n\n\n\n\n\n0x022f\n\n\n0x2f\n\n\nBLE_ERR_INSUFFICIENT_SEC\n\n\n\n\n\n\n0x0230\n\n\n0x30\n\n\nBLE_ERR_PARM_OUT_OF_RANGE\n\n\n\n\n\n\n0x0232\n\n\n0x32\n\n\nBLE_ERR_PENDING_ROLE_SW\n\n\n\n\n\n\n0x0234\n\n\n0x34\n\n\nBLE_ERR_RESERVED_SLOT\n\n\n\n\n\n\n0x0235\n\n\n0x35\n\n\nBLE_ERR_ROLE_SW_FAIL\n\n\n\n\n\n\n0x0236\n\n\n0x36\n\n\nBLE_ERR_INQ_RSP_TOO_BIG\n\n\n\n\n\n\n0x0237\n\n\n0x37\n\n\nBLE_ERR_SEC_SIMPLE_PAIR\n\n\n\n\n\n\n0x0238\n\n\n0x38\n\n\nBLE_ERR_HOST_BUSY_PAIR\n\n\n\n\n\n\n 0x0239\n\n\n0x39\n\n\nBLE_ERR_CONN_REJ_CHANNEL\n\n\n\n\n\n\n0x023a\n\n\n0x3a\n\n\nBLE_ERR_CTLR_BUSY\n\n\n\n\n\n\n0x023b\n\n\n0x3b\n\n\nBLE_ERR_CONN_PARMS\n\n\n\n\n\n\n0x023c\n\n\n0x3c\n\n\nBLE_ERR_DIR_ADV_TMO\n\n\n\n\n\n\n0x023d\n\n\n0x3d\n\n\nBLE_ERR_CONN_TERM_MIC\n\n\n\n\n\n\n0x023e\n\n\n0x3e\n\n\nBLE_ERR_CONN_ESTABLISHMENT\n\n\n\n\n\n\n0x023f\n\n\n0x3f\n\n\nBLE_ERR_MAC_CONN_FAIL\n\n\n\n\n\n\n0x0240\n\n\n0x40\n\n\nBLE_ERR_COARSE_CLK_ADJ\n\n\n\n\n\n\n\n\nReturn codes - L2CAP\n\n\n#include \nhost/ble_hs.h\n\n\n#include \nhost/ble_l2cap.h\n\n\n\n\n\n\n\n\n\n\n\n\nNimBLE Value\n\n\nFormal Value\n\n\nName\n\n\n\n\n\n\n\n\n\n\n0x0300\n\n\n0x00\n\n\nBLE_L2CAP_SIG_ERR_CMD_NOT_UNDERSTOOD\n\n\n\n\n\n\n0x0301\n\n\n0x01\n\n\nBLE_L2CAP_SIG_ERR_MTU_EXCEEDED\n\n\n\n\n\n\n0x0302\n\n\n0x02\n\n\nBLE_L2CAP_SIG_ERR_INVALID_CID\n\n\n\n\n\n\n\n\nReturn codes - Security manager (us)\n\n\n#include \nhost/ble_hs.h\n\n\n#include \nhost/ble_sm.h\n\n\n\n\n\n\n\n\n\n\n\n\nNimBLE Value\n\n\nFormal Value\n\n\nN ame\n\n\n\n\n\n\n\n\n\n\n0x0401\n\n\n0x01\n\n\nBLE_SM_ERR_PASSKEY\n\n\n\n\n\n\n0x0402\n\n\n0x02\n\n\nBLE_SM_ERR_OOB\n\n\n\n\n\n\n0x0403\n\n\n0x03\n\n\nBLE_SM_ERR_AUTHREQ\n\n\n\n\n\n\n0x0404\n\n\n0x04\n\n\nBLE_SM_ERR_CONFIRM_MISMATCH\n\n\n\n\n\n\n0x0405\n\n\n0x05\n\n\nBLE_SM_ERR_PAIR_NOT_SUPP\n\n\n\n\n\n\n0x0406\n\n\n0x06\n\n\nBLE_SM_ERR_ENC_KEY_SZ\n\n\n\n\n\n\n0x0407\n\n\n0x07\n\n\nBLE_SM_ERR_CMD_NOT_SUPP\n\n\n\n\n\n\n0x0408\n\n\n0x08\n\n\nBLE_SM_ERR_UNSPECIFIED\n\n\n\n\n\n\n0x0409\n\n\n0x09\n\n\nBLE_SM_ERR_REPEATED\n\n\n\n\n\n\n0x040a\n\n\n0x0a\n\n\nBLE_SM_ERR_INVAL\n\n\n\n\n\n\n0x040b\n\n\n0x0b\n\n\nBLE_SM_ERR_DHKEY\n\n\n\n\n\n\n0x040c\n\n\n0x0c\n\n\nBLE_SM_ERR_NUMCMP\n\n\n\n\n\n\n0x040d\n\n\n0x0d\n\n\nBLE_SM_ERR_ALREADY\n\n\n\n\n\n\n0x040e\n\n\n0x0e\n\n\nBLE_SM_ERR_CROSS_TRANS\n\n\n\n\n\n\n\n\nReturn codes - Security manager (peer)\n\n\n#include \nhost/ble_hs.h\n\n\n#include \nhost/ble_sm.h\n\n\n\n\n\n\n\n\n\n\n\n\nNimBLE Value\n\n\nFormal Value\n\n\nName\n\n\nCondition\n\n\n\n\n \n\n\n\n\n\n0x0501\n\n\n0x01\n\n\nBLE_SM_ERR_PASSKEY\n\n\nThe user input of passkey failed, for example, the user cancelled the operation.\n\n\n\n\n\n\n0x0502\n\n\n0x02\n\n\nBLE_SM_ERR_OOB\n\n\nThe OOB data is not available.\n\n\n\n\n\n\n0x0503\n\n\n0x03\n\n\nBLE_SM_ERR_AUTHREQ\n\n\nThe pairing procedure cannot be performed as authentication requirements cannot be met due to IO capabilities of one or both devices.\n\n\n\n\n\n\n0x0504\n\n\n0x04\n\n\nBLE_SM_ERR_CONFIRM_MISMATCH\n\n\nThe confirm value does not match the calculated compare value.\n\n\n\n\n\n\n0x0505\n\n\n0x05\n\n\nBLE_SM_ERR_PAIR_NOT_SUPP\n\n\nPairing is not supported by the device.\n\n\n\n\n\n\n0x0506\n\n\n0x06\n\n\nBLE_SM_ERR_ENC_KEY_SZ\n\n\nThe resultant encryption key size is insufficient for the security requirements of this device.\n\n\n\n\n\n\n0x0507\n\n\n0x07\n\n\nBLE_SM_ERR_CMD_NOT_SUPP\n\n\nThe SMP command received is not supported on this device.\n\n\n\n\n\n\n0x0508\n\n\n0x08\n\n\nBLE_SM_ERR_UNSPECIFIED\n\n\n Pairing failed due to an unspecified reason.\n\n\n\n\n\n\n0x0509\n\n\n0x09\n\n\nBLE_SM_ERR_REPEATED\n\n\nPairing or authentication procedure is disallowed because too little time has elapsed since last pairing request or security request.\n\n\n\n\n\n\n0x050a\n\n\n0x0a\n\n\nBLE_SM_ERR_INVAL\n\n\nThe Invalid Parameters error code indicates that the command length is invalid or that a parameter is outside of the specified range.\n\n\n\n\n\n\n0x050b\n\n\n0x0b\n\n\nBLE_SM_ERR_DHKEY\n\n\nIndicates to the remote device that the DHKey Check value received doesn\u2019t match the one calculated by the local device.\n\n\n\n\n\n\n0x050c\n\n\n0x0c\n\n\nBLE_SM_ERR_NUMCMP\n\n\nIndicates that the confirm values in the numeric comparison protocol do not match.\n\n\n\n\n\n\n0x050d\n\n\n0x0d\n\n\nBLE_SM_ERR_ALREADY\n\n\nIndicates that the pairing over the LE transport failed due to a Pairing Request sent over the BR/EDR transport in process.\n\n\n\n\n\n\n0x050e\n\n\n0x0e\n\n\nBLE_SM_ERR_CROSS_TRANS\n\ n\nIndicates that the BR/EDR Link Key generated on the BR/EDR transport cannot be used to derive and distribute keys for the LE transport.", + "text": "NimBLE Host Return Codes\n\n\n\n\nIntroduction\n\n\nSummary\n\n\nExample\n\n\n\n\n\n\nReturn Code Reference\n\n\nReturn codes - Core\n\n\nReturn codes - ATT\n\n\nReturn codes - HCI\n\n\nReturn codes - L2CAP\n\n\nReturn codes - Security manager (us)\n\n\nReturn codes - Security manager (peer)\n\n\n\n\n\n\n\n\nIntroduction\n\n\nSummary\n\n\nThe NimBLE host reports status to the application via a set of return codes. The host encompasses several layers of the Bluetooth specification that each defines its own set of status codes. Rather than \"abstract away\" information from lower layers that the application developer might find useful, the NimBLE host aims to indicate precisely what happened when something fails. Consequently, the host utilizes a rather large set of return codes.\n\n\nA return code of 0 indicates success. For failure conditions, the return codes are partitioned into five separate sets:\n\n\n\n\n\n\n\n\nSet\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\nC ore\n\n\nErrors detected internally by the NimBLE host.\n\n\n\n\n\n\nATT\n\n\nThe 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.\n\n\n\n\n\n\nHCI\n\n\nThe 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.\n\n\n\n\n\n\nL2CAP\n\n\nAn 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.\n\n\n\n\n\n\nSecurity manager (us)\n\n\nThe 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.\n\n\n\n\n\n\nSecurity manager (peer)\n\n\nA security manager procedure failed because the peer sent us a Pairing Fai led command. The return code corresponds to the value of the Reason field in the Pairing Failed command.\n\n\n\n\n\n\n\n\nThe return codes in the core set are defined by the NimBLE Host. The other sets are defined in the Bluetooth specification; the codes in this latter group are referred to as \nformal status codes\n. As defined in the Bluetooth specification, the formal status code sets are not disjoint. That is, they overlap. For example, the spec defines a status code of 1 to have all of the following meanings:\n\n\n\n\n\n\n\n\nLayer\n\n\nMeaning\n\n\n\n\n\n\n\n\n\n\nATT\n\n\nInvalid handle.\n\n\n\n\n\n\nHCI\n\n\nUnknown HCI command.\n\n\n\n\n\n\nL2CAP\n\n\nSignalling MTU exceeded.\n\n\n\n\n\n\nSM\n\n\nPasskey entry failed.\n\n\n\n\n\n\n\n\nClearly, the host can't just return an unadorned formal status code and expect the application to make sense of it. To resolve this ambiguity, the NimBLE host divides the full range of an int into several subranges. Each subrange corre sponds to one of the five return code sets. For example, the ATT set is mapped onto the subrange \n[0x100, 0x200)\n. To indicate an ATT error of 3 (write not permitted), the NimBLE host returns a value 0x103 to the application.\n\n\nThe host defines a set of convenience macros for converting from a formal status code to NimBLE host status code. These macros are documented in the table below.\n\n\n\n\n\n\n\n\nMacro\n\n\nStatus code set\n\n\nBase value\n\n\n\n\n\n\n\n\n\n\nBLE_HS_ATT_ERR()\n\n\nATT\n\n\n0x100\n\n\n\n\n\n\nBLE_HS_HCI_ERR()\n\n\nHCI\n\n\n0x200\n\n\n\n\n\n\nBLE_HS_L2C_ERR()\n\n\nL2CAP\n\n\n0x300\n\n\n\n\n\n\nBLE_HS_SM_US_ERR()\n\n\nSecurity manager (us)\n\n\n0x400\n\n\n\n\n\n\nBLE_HS_SM_PEER_ERR()\n\n\nSecurity manager (peer)\n\n\n0x500\n\n\n\n\n\n\n\n\nExample\n\n\nThe following example demonstrates how an application might determine which error is being reported by the host. In this example, the application performs the GAP encryption procedure and checks the retur n code. To simplify the example, the application uses a hypothetical \nmy_blocking_enc_proc()\n function, which blocks until the pairing operation has completed.\n\n\nvoid\n\n\nencrypt_connection\n(\nuint16_t\n \nconn_handle\n)\n{\n \nint\n \nrc\n;\n\n \n/* Perform a blocking GAP encryption procedure. */\n\n \nrc\n \n=\n \nmy_blocking_enc_proc\n(\nconn_handle\n);\n \nswitch\n (\nrc\n) {\n \ncase\n \n0\n:\n\n \nconsole_printf\n(\nsuccess - link successfully encrypted\\n\n);\n \nbreak\n;\n\n \ncase\n \nBLE_HS_ENOTCONN\n:\n \nconsole_printf\n(\nfailure - no connection with handle %d\\n\n,\n \nconn_handle\n);\n \nbreak\n;\n\n \ncase\n \nBLE_HS_ERR_SM_US_BASE\n(\nBLE_SM_ERR_CONFIRM_MISMATCH\n)\n:\n\n \nconsole_printf\n(\nfailure - mismatch in peer\ns confirm and random \n\n \ncommands.\\n\n);\n \nbreak\n;\n\n \ncase\n \nBLE_HS_ERR_SM_PEER_BASE\n(\nBLE_SM_ERR_CONFIRM_MISMATCH\n)\ n:\n\n \nconsole_printf\n(\nfailure - peer reports mismatch in our confirm and \n\n \nrandom commands.\\n\n);\n \nbreak\n;\n\n \ndefault\n:\n\n \nconsole_printf\n(\nfailure - other error: 0x%04x\\n\n, \nrc\n);\n \nbreak\n;\n }\n}\n\n\n\n\n\nReturn Code Reference\n\n\nReturn codes - Core\n\n\nThe precise meaning of each of these error codes depends on the function that returns it. The API reference for a particular function indicates the conditions under which each of these codes are returned.\n\n\n#include \nhost/ble_hs.h\n\n\n\n\n\n\n\n\n\n\n\n\nValue\n\n\nName\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0x00\n\n\nN/A\n\n\nSuccess\n\n\n\n\n\n\n0x01\n\n\nBLE_HS_EAGAIN\n\n\nTemporary failure; try again.\n\n\n\n\n\n\n0x02\n\n\nBLE_HS_EALREADY\n\n\nOperation already in progress or completed.\n\n\n\n\n\n\n0x03\n\n\nBLE_HS_EINVAL\n\n\nOne or more arguments are invalid.\n\n\n\n\n\n\n0x04\n\n\nBLE_HS_EMSGSIZE\n\n\nThe provided buffer is too small.\n\n\n\n\n\n\n0x05\n\n\nBLE_HS_ENOENT\n\n\nNo entry matching the specified criteria.\n\n\n\n\n\n\n0x06\n\n\nBLE_HS_ENOMEM\n\n\nOperation failed due to resource exhaustion.\n\n\n\n\n\n\n0x07\n\n\nBLE_HS_ENOTCONN\n\n\nNo open connection with the specified handle.\n\n\n\n\n\n\n0x08\n\n\nBLE_HS_ENOTSUP\n\n\nOperation disabled at compile time.\n\n\n\n\n\n\n0x09\n\n\nBLE_HS_EAPP\n\n\nApplication callback behaved unexpectedly.\n\n\n\n\n\n\n0x0a\n\n\nBLE_HS_EBADDATA\n\n\nCommand from peer is invalid.\n\n\n\n\n\n\n0x0b\n\n\nBLE_HS_EOS\n\n\nMynewt OS error.\n\n\n\n\n\n\n0x0c\n\n\nBLE_HS_ECONTROLLER\n\n\nEvent from controller is invalid.\n\n\n\n\n\n\n0x0d\n\n\nBLE_HS_ETIMEOUT\n\n\nOperation timed out.\n\n\n\n\n\n\n0x0e\n\n\nBLE_HS_EDONE\n\n\nOperation completed successfully.\n\n\n\n\n\n\n0x0f\n\n\nBLE_HS_EBUSY\n\n\nOperation cannot be performed until procedure completes.\n\n\n\n\n\n\n0x10\n\n\nBLE_HS_EREJECT\n\n\nPeer rejected a connection parameter update request.\n\n\n\n\n\n\n0x11\n\n\ nBLE_HS_EUNKNOWN\n\n\nUnexpected failure; catch all.\n\n\n\n\n\n\n0x12\n\n\nBLE_HS_EROLE\n\n\nOperation requires different role (e.g., central vs. peripheral).\n\n\n\n\n\n\n0x13\n\n\nBLE_HS_ETIMEOUT_HCI\n\n\nHCI request timed out; controller unresponsive.\n\n\n\n\n\n\n0x14\n\n\nBLE_HS_ENOMEM_EVT\n\n\nController failed to send event due to memory exhaustion (combined host-controller only).\n\n\n\n\n\n\n0x15\n\n\nBLE_HS_ENOADDR\n\n\nOperation requires an identity address but none configured.\n\n\n\n\n\n\n\n\nReturn codes - ATT\n\n\n#include \nhost/ble_hs.h\n\n\n#include \nhost/ble_att.h\n\n\n\n\n\n\n\n\n\n\n\n\nNimBLE Value\n\n\nFormal Value\n\n\nName\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0x0101\n\n\n0x01\n\n\nBLE_ATT_ERR_INVALID_HANDLE\n\n\nThe attribute handle given was not valid on this server.\n\n\n\n\n\n\n0x0102\n\n\n0x02\n\n\nBLE_ATT_ERR_READ_NOT_PERMITTED\n\n\nThe attribute cannot be read.\n\n\n\n\n\n\n0x0103\n\n\n0x03\n\n\nBLE_ATT_ERR_WRITE_NOT_PERMITTED\n\n\nThe attribute canno t be written.\n\n\n\n\n\n\n0x0104\n\n\n0x04\n\n\nBLE_ATT_ERR_INVALID_PDU\n\n\nThe attribute PDU was invalid.\n\n\n\n\n\n\n0x0105\n\n\n0x05\n\n\nBLE_ATT_ERR_INSUFFICIENT_AUTHEN\n\n\nThe attribute requires authentication before it can be read or written.\n\n\n\n\n\n\n0x0106\n\n\n0x06\n\n\nBLE_ATT_ERR_REQ_NOT_SUPPORTED\n\n\nAttribute server does not support the request received from the client.\n\n\n\n\n\n\n0x0107\n\n\n0x07\n\n\nBLE_ATT_ERR_INVALID_OFFSET\n\n\nOffset specified was past the end of the attribute.\n\n\n\n\n\n\n0x0108\n\n\n0x08\n\n\nBLE_ATT_ERR_INSUFFICIENT_AUTHOR\n\n\nThe attribute requires authorization before it can be read or written.\n\n\n\n\n\n\n0x0109\n\n\n0x09\n\n\nBLE_ATT_ERR_PREPARE_QUEUE_FULL\n\n\nToo many prepare writes have been queued.\n\n\n\n\n\n\n0x010a\n\n\n0x0a\n\n\nBLE_ATT_ERR_ATTR_NOT_FOUND\n\n\nNo attribute found within the given attribute handle range.\n\n\n\n\n\n\n0x010b\n\n\n0x0b\n\n\nBLE_ATT_ERR_ATTR_NOT_LONG\n\n\nThe attribute cannot be read or wr itten using the Read Blob Request.\n\n\n\n\n\n\n0x010c\n\n\n0x0c\n\n\nBLE_ATT_ERR_INSUFFICIENT_KEY_SZ\n\n\nThe Encryption Key Size used for encrypting this link is insufficient.\n\n\n\n\n\n\n0x010d\n\n\n0x0d\n\n\nBLE_ATT_ERR_INVALID_ATTR_VALUE_LEN\n\n\nThe attribute value length is invalid for the operation.\n\n\n\n\n\n\n0x010e\n\n\n0x0e\n\n\nBLE_ATT_ERR_UNLIKELY\n\n\nThe attribute request that was requested has encountered an error that was unlikely, and therefore could not be completed as requested.\n\n\n\n\n\n\n0x010f\n\n\n0x0f\n\n\nBLE_ATT_ERR_INSUFFICIENT_ENC\n\n\nThe attribute requires encryption before it can be read or written.\n\n\n\n\n\n\n0x0110\n\n\n0x10\n\n\nBLE_ATT_ERR_UNSUPPORTED_GROUP\n\n\nThe attribute type is not a supported grouping attribute as defined by a higher layer specification.\n\n\n\n\n\n\n0x0111\n\n\n0x11\n\n\nBLE_ATT_ERR_INSUFFICIENT_RES\n\n\nInsufficient Resources to complete the request.\n\n\n\n\n\n\n\n\nReturn codes - HCI\n\n\n#include \nhost/ble_hs.h \n\n\n#include \nnimble/ble.h\n\n\n\n\n\n\n\n\n\n\n\n\nNimBLE Value\n\n\nFormal Value\n\n\nName\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0x0201\n\n\n0x01\n\n\nBLE_ERR_UNKNOWN_HCI_CMD\n\n\nUnknown HCI Command\n\n\n\n\n\n\n0x0202\n\n\n0x02\n\n\nBLE_ERR_UNK_CONN_ID\n\n\nUnknown Connection Identifier\n\n\n\n\n\n\n0x0203\n\n\n0x03\n\n\nBLE_ERR_HW_FAIL\n\n\nHardware Failure\n\n\n\n\n\n\n0x0204\n\n\n0x04\n\n\nBLE_ERR_PAGE_TMO\n\n\nPage Timeout\n\n\n\n\n\n\n0x0205\n\n\n0x05\n\n\nBLE_ERR_AUTH_FAIL\n\n\nAuthentication Failure\n\n\n\n\n\n\n0x0206\n\n\n0x06\n\n\nBLE_ERR_PINKEY_MISSING\n\n\nPIN or Key Missing\n\n\n\n\n\n\n0x0207\n\n\n0x07\n\n\nBLE_ERR_MEM_CAPACITY\n\n\nMemory Capacity Exceeded\n\n\n\n\n\n\n0x0208\n\n\n0x08\n\n\nBLE_ERR_CONN_SPVN_TMO\n\n\nConnection Timeout\n\n\n\n\n\n\n0x0209\n\n\n0x09\n\n\nBLE_ERR_CONN_LIMIT\n\n\nConnection Limit Exceeded\n\n\n\n\n\n\n0x020a\n\n\n0x0a\n\n\nBLE_ERR_SYNCH_CONN_LIMIT\n\n\nSynchronous Connection Limit To A Device Exceeded\n\n\n\n\n\n\n0x020b\n\n\n0x0b\n \n\nBLE_ERR_ACL_CONN_EXISTS\n\n\nACL Connection Already Exists\n\n\n\n\n\n\n0x020c\n\n\n0x0c\n\n\nBLE_ERR_CMD_DISALLOWED\n\n\nCommand Disallowed\n\n\n\n\n\n\n0x020d\n\n\n0x0d\n\n\nBLE_ERR_CONN_REJ_RESOURCES\n\n\nConnection Rejected due to Limited Resources\n\n\n\n\n\n\n0x020e\n\n\n0x0e\n\n\nBLE_ERR_CONN_REJ_SECURITY\n\n\nConnection Rejected Due To Security Reasons\n\n\n\n\n\n\n0x020f\n\n\n0x0f\n\n\nBLE_ERR_CONN_REJ_BD_ADDR\n\n\nConnection Rejected due to Unacceptable BD_ADDR\n\n\n\n\n\n\n0x0210\n\n\n0x10\n\n\nBLE_ERR_CONN_ACCEPT_TMO\n\n\nConnection Accept Timeout Exceeded\n\n\n\n\n\n\n0x0211\n\n\n0x11\n\n\nBLE_ERR_UNSUPPORTED\n\n\nUnsupported Feature or Parameter Value\n\n\n\n\n\n\n0x0212\n\n\n0x12\n\n\nBLE_ERR_INV_HCI_CMD_PARMS\n\n\nInvalid HCI Command Parameters\n\n\n\n\n\n\n0x0213\n\n\n0x13\n\n\nBLE_ERR_REM_USER_CONN_TERM\n\n\nRemote User Terminated Connection\n\n\n\n\n\n\n0x0214\n\n\n0x14\n\n\nBLE_ERR_RD_CONN_TERM_RESRCS\n\n\nRemote Device Terminated Connection due to Low Resour ces\n\n\n\n\n\n\n0x0215\n\n\n0x15\n\n\nBLE_ERR_RD_CONN_TERM_PWROFF\n\n\nRemote Device Terminated Connection due to Power Off\n\n\n\n\n\n\n0x0216\n\n\n0x16\n\n\nBLE_ERR_CONN_TERM_LOCAL\n\n\nConnection Terminated By Local Host\n\n\n\n\n\n\n0x0217\n\n\n0x17\n\n\nBLE_ERR_REPEATED_ATTEMPTS\n\n\nRepeated Attempts\n\n\n\n\n\n\n0x0218\n\n\n0x18\n\n\nBLE_ERR_NO_PAIRING\n\n\nPairing Not Allowed\n\n\n\n\n\n\n0x0219\n\n\n0x19\n\n\nBLE_ERR_UNK_LMP\n\n\nUnknown LMP PDU\n\n\n\n\n\n\n0x021a\n\n\n0x1a\n\n\nBLE_ERR_UNSUPP_REM_FEATURE\n\n\nUnsupported Remote Feature / Unsupported LMP Feature\n\n\n\n\n\n\n0x021b\n\n\n0x1b\n\n\nBLE_ERR_SCO_OFFSET\n\n\nSCO Offset Rejected\n\n\n\n\n\n\n0x021c\n\n\n0x1c\n\n\nBLE_ERR_SCO_ITVL\n\n\nSCO Interval Rejected\n\n\n\n\n\n\n0x021d\n\n\n0x1d\n\n\nBLE_ERR_SCO_AIR_MODE\n\n\nSCO Air Mode Rejected\n\n\n\n\n\n\n0x021e\n\n\n0x1e\n\n\nBLE_ERR_INV_LMP_LL_PARM\n\n\nInvalid LMP Parameters / Invalid LL Parameters\n\n\n\n\n\n\n0x021f\n\n\n0x1f\n\n\nBLE_ERR_UNSPECIFIED\n\n\nUnspe cified Error\n\n\n\n\n\n\n0x0220\n\n\n0x20\n\n\nBLE_ERR_UNSUPP_LMP_LL_PARM\n\n\nUnsupported LMP Parameter Value / Unsupported LL Parameter Value\n\n\n\n\n\n\n0x0221\n\n\n0x21\n\n\nBLE_ERR_NO_ROLE_CHANGE\n\n\nRole Change Not Allowed\n\n\n\n\n\n\n0x0222\n\n\n0x22\n\n\nBLE_ERR_LMP_LL_RSP_TMO\n\n\nLMP Response Timeout / LL Response Timeout\n\n\n\n\n\n\n0x0223\n\n\n0x23\n\n\nBLE_ERR_LMP_COLLISION\n\n\nLMP Error Transaction Collision\n\n\n\n\n\n\n0x0224\n\n\n0x24\n\n\nBLE_ERR_LMP_PDU\n\n\nLMP PDU Not Allowed\n\n\n\n\n\n\n0x0225\n\n\n0x25\n\n\nBLE_ERR_ENCRYPTION_MODE\n\n\nEncryption Mode Not Acceptable\n\n\n\n\n\n\n0x0226\n\n\n0x26\n\n\nBLE_ERR_LINK_KEY_CHANGE\n\n\nLink Key cannot be Changed\n\n\n\n\n\n\n0x0227\n\n\n0x27\n\n\nBLE_ERR_UNSUPP_QOS\n\n\nRequested QoS Not Supported\n\n\n\n\n\n\n0x0228\n\n\n0x28\n\n\nBLE_ERR_INSTANT_PASSED\n\n\nInstant Passed\n\n\n\n\n\n\n0x0229\n\n\n0x29\n\n\nBLE_ERR_UNIT_KEY_PAIRING\n\n\nPairing With Unit Key Not Supported\n\n\n\n\n\n\n0x022a\n\n\n0x2a\n\n\nBL E_ERR_DIFF_TRANS_COLL\n\n\nDifferent Transaction Collision\n\n\n\n\n\n\n0x022c\n\n\n0x2c\n\n\nBLE_ERR_QOS_PARM\n\n\nQoS Unacceptable Parameter\n\n\n\n\n\n\n0x022d\n\n\n0x2d\n\n\nBLE_ERR_QOS_REJECTED\n\n\nQoS Rejected\n\n\n\n\n\n\n0x022e\n\n\n0x2e\n\n\nBLE_ERR_CHAN_CLASS\n\n\nChannel Classification Not Supported\n\n\n\n\n\n\n0x022f\n\n\n0x2f\n\n\nBLE_ERR_INSUFFICIENT_SEC\n\n\nInsufficient Security\n\n\n\n\n\n\n0x0230\n\n\n0x30\n\n\nBLE_ERR_PARM_OUT_OF_RANGE\n\n\nParameter Out Of Mandatory Range\n\n\n\n\n\n\n0x0232\n\n\n0x32\n\n\nBLE_ERR_PENDING_ROLE_SW\n\n\nRole Switch Pending\n\n\n\n\n\n\n0x0234\n\n\n0x34\n\n\nBLE_ERR_RESERVED_SLOT\n\n\nReserved Slot Violation\n\n\n\n\n\n\n0x0235\n\n\n0x35\n\n\nBLE_ERR_ROLE_SW_FAIL\n\n\nRole Switch Failed\n\n\n\n\n\n\n0x0236\n\n\n0x36\n\n\nBLE_ERR_INQ_RSP_TOO_BIG\n\n\nExtended Inquiry Response Too Large\n\n\n\n\n\n\n0x0237\n\n\n0x37\n\n\nBLE_ERR_SEC_SIMPLE_PAIR\n\n\nSecure Simple Pairing Not Supported By Host\n\n\n\n\n\n\n0x0238\n\n\n0x38\n\n\nBLE_E RR_HOST_BUSY_PAIR\n\n\nHost Busy - Pairing\n\n\n\n\n\n\n0x0239\n\n\n0x39\n\n\nBLE_ERR_CONN_REJ_CHANNEL\n\n\nConnection Rejected due to No Suitable Channel Found\n\n\n\n\n\n\n0x023a\n\n\n0x3a\n\n\nBLE_ERR_CTLR_BUSY\n\n\nController Busy\n\n\n\n\n\n\n0x023b\n\n\n0x3b\n\n\nBLE_ERR_CONN_PARMS\n\n\nUnacceptable Connection Parameters\n\n\n\n\n\n\n0x023c\n\n\n0x3c\n\n\nBLE_ERR_DIR_ADV_TMO\n\n\nDirected Advertising Timeout\n\n\n\n\n\n\n0x023d\n\n\n0x3d\n\n\nBLE_ERR_CONN_TERM_MIC\n\n\nConnection Terminated due to MIC Failure\n\n\n\n\n\n\n0x023e\n\n\n0x3e\n\n\nBLE_ERR_CONN_ESTABLISHMENT\n\n\nConnection Failed to be Established\n\n\n\n\n\n\n0x023f\n\n\n0x3f\n\n\nBLE_ERR_MAC_CONN_FAIL\n\n\nMAC Connection Failed\n\n\n\n\n\n\n0x0240\n\n\n0x40\n\n\nBLE_ERR_COARSE_CLK_ADJ\n\n\nCoarse Clock Adjustment Rejected but Will Try to Adjust Using Clock Dragging\n\n\n\n\n\n\n\n\nReturn codes - L2CAP\n\n\n#include \nhost/ble_hs.h\n\n\n#include \nhost/ble_l2cap.h\n\n\n\n\n\n\n\n\n\n\n\n\nNimBLE Value\n\n\nForma l Value\n\n\nName\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0x0300\n\n\n0x00\n\n\nBLE_L2CAP_SIG_ERR_CMD_NOT_UNDERSTOOD\n\n\nInvalid or unsupported incoming L2CAP sig command.\n\n\n\n\n\n\n0x0301\n\n\n0x01\n\n\nBLE_L2CAP_SIG_ERR_MTU_EXCEEDED\n\n\nIncoming packet too large.\n\n\n\n\n\n\n0x0302\n\n\n0x02\n\n\nBLE_L2CAP_SIG_ERR_INVALID_CID\n\n\nNo channel with specified ID.\n\n\n\n\n\n\n\n\nReturn codes - Security manager (us)\n\n\n#include \nhost/ble_hs.h\n\n\n#include \nhost/ble_sm.h\n\n\n\n\n\n\n\n\n\n\n\n\nNimBLE Value\n\n\nFormal Value\n\n\nName\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0x0401\n\n\n0x01\n\n\nBLE_SM_ERR_PASSKEY\n\n\nThe user input of passkey failed, for example, the user cancelled the operation.\n\n\n\n\n\n\n0x0402\n\n\n0x02\n\n\nBLE_SM_ERR_OOB\n\n\nThe OOB data is not available.\n\n\n\n\n\n\n0x0403\n\n\n0x03\n\n\nBLE_SM_ERR_AUTHREQ\n\n\nThe pairing procedure cannot be performed as authentication requirements cannot be met due to IO capabilities of one or both devices.\n\n\n\n\ n\n\n0x0404\n\n\n0x04\n\n\nBLE_SM_ERR_CONFIRM_MISMATCH\n\n\nThe confirm value does not match the calculated compare value.\n\n\n\n\n\n\n0x0405\n\n\n0x05\n\n\nBLE_SM_ERR_PAIR_NOT_SUPP\n\n\nPairing is not supported by the device.\n\n\n\n\n\n\n0x0406\n\n\n0x06\n\n\nBLE_SM_ERR_ENC_KEY_SZ\n\n\nThe resultant encryption key size is insufficient for the security requirements of this device.\n\n\n\n\n\n\n0x0407\n\n\n0x07\n\n\nBLE_SM_ERR_CMD_NOT_SUPP\n\n\nThe SMP command received is not supported on this device.\n\n\n\n\n\n\n0x0408\n\n\n0x08\n\n\nBLE_SM_ERR_UNSPECIFIED\n\n\nPairing failed due to an unspecified reason.\n\n\n\n\n\n\n0x0409\n\n\n0x09\n\n\nBLE_SM_ERR_REPEATED\n\n\nPairing or authentication procedure is disallowed because too little time has elapsed since last pairing request or security request.\n\n\n\n\n\n\n0x040a\n\n\n0x0a\n\n\nBLE_SM_ERR_INVAL\n\n\nThe Invalid Parameters error code indicates that the command length is invalid or that a parameter is outside of the specified ran ge.\n\n\n\n\n\n\n0x040b\n\n\n0x0b\n\n\nBLE_SM_ERR_DHKEY\n\n\nIndicates to the remote device that the DHKey Check value received doesn\u2019t match the one calculated by the local device.\n\n\n\n\n\n\n0x040c\n\n\n0x0c\n\n\nBLE_SM_ERR_NUMCMP\n\n\nIndicates that the confirm values in the numeric comparison protocol do not match.\n\n\n\n\n\n\n0x040d\n\n\n0x0d\n\n\nBLE_SM_ERR_ALREADY\n\n\nIndicates that the pairing over the LE transport failed due to a Pairing Request sent over the BR/EDR transport in process.\n\n\n\n\n\n\n0x040e\n\n\n0x0e\n\n\nBLE_SM_ERR_CROSS_TRANS\n\n\nIndicates that the BR/EDR Link Key generated on the BR/EDR transport cannot be used to derive and distribute keys for the LE transport.\n\n\n\n\n\n\n\n\nReturn codes - Security manager (peer)\n\n\n#include \nhost/ble_hs.h\n\n\n#include \nhost/ble_sm.h\n\n\n\n\n\n\n\n\n\n\n\n\nNimBLE Value\n\n\nFormal Value\n\n\nName\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0x0501\n\n\n0x01\n\n\nBLE_SM_ERR_PASSKEY\n\n\nThe user input of passk ey failed, for example, the user cancelled the operation.\n\n\n\n\n\n\n0x0502\n\n\n0x02\n\n\nBLE_SM_ERR_OOB\n\n\nThe OOB data is not available.\n\n\n\n\n\n\n0x0503\n\n\n0x03\n\n\nBLE_SM_ERR_AUTHREQ\n\n\nThe pairing procedure cannot be performed as authentication requirements cannot be met due to IO capabilities of one or both devices.\n\n\n\n\n\n\n0x0504\n\n\n0x04\n\n\nBLE_SM_ERR_CONFIRM_MISMATCH\n\n\nThe confirm value does not match the calculated compare value.\n\n\n\n\n\n\n0x0505\n\n\n0x05\n\n\nBLE_SM_ERR_PAIR_NOT_SUPP\n\n\nPairing is not supported by the device.\n\n\n\n\n\n\n0x0506\n\n\n0x06\n\n\nBLE_SM_ERR_ENC_KEY_SZ\n\n\nThe resultant encryption key size is insufficient for the security requirements of this device.\n\n\n\n\n\n\n0x0507\n\n\n0x07\n\n\nBLE_SM_ERR_CMD_NOT_SUPP\n\n\nThe SMP command received is not supported on this device.\n\n\n\n\n\n\n0x0508\n\n\n0x08\n\n\nBLE_SM_ERR_UNSPECIFIED\n\n\nPairing failed due to an unspecified reason.\n\n\n\n\n\n\n0x0509\n\n\n0x09\n\n\nB LE_SM_ERR_REPEATED\n\n\nPairing or authentication procedure is disallowed because too little time has elapsed since last pairing request or security request.\n\n\n\n\n\n\n0x050a\n\n\n0x0a\n\n\nBLE_SM_ERR_INVAL\n\n\nThe Invalid Parameters error code indicates that the command length is invalid or that a parameter is outside of the specified range.\n\n\n\n\n\n\n0x050b\n\n\n0x0b\n\n\nBLE_SM_ERR_DHKEY\n\n\nIndicates to the remote device that the DHKey Check value received doesn\u2019t match the one calculated by the local device.\n\n\n\n\n\n\n0x050c\n\n\n0x0c\n\n\nBLE_SM_ERR_NUMCMP\n\n\nIndicates that the confirm values in the numeric comparison protocol do not match.\n\n\n\n\n\n\n0x050d\n\n\n0x0d\n\n\nBLE_SM_ERR_ALREADY\n\n\nIndicates that the pairing over the LE transport failed due to a Pairing Request sent over the BR/EDR transport in process.\n\n\n\n\n\n\n0x050e\n\n\n0x0e\n\n\nBLE_SM_ERR_CROSS_TRANS\n\n\nIndicates that the BR/EDR Link Key generated on the BR/EDR transport cannot be used to derive and distribute keys for the LE transport.", "title": "Return codes" }, { @@ -7332,22 +7332,22 @@ }, { "location": "/network/ble/ble_hs/ble_hs_return_codes/#return-codes-att", - "text": "#include host/ble_hs.h #include host/ble_att.h NimBLE Value Formal Value Name 0x0101 0x01 BLE_ATT_ERR_INVALID_HANDLE 0x0102 0x02 BLE_ATT_ERR_READ_NOT_PERMITTED 0x0103 0x03 BLE_ATT_ERR_WRITE_NOT_PERMITTED 0x0104 0x04 BLE_ATT_ERR_INVALID_PDU 0x0105 0x05 BLE_ATT_ERR_INSUFFICIENT_AUTHEN 0x0106 0x06 BLE_ATT_ERR_REQ_NOT_SUPPORTED 0x0107 0x07 BLE_ATT_ERR_INVALID_OFFSET 0x0108 0x08 BLE_ATT_ERR_INSUFFICIENT_AUTHOR 0x0109 0x09 BLE_ATT_ERR_PREPARE_QUEUE_FULL 0x010a 0x0a BLE_ATT_ERR_ATTR_NOT_FOUND 0x010b 0x0b BLE_ATT_ERR_ATTR_NOT_LONG 0x010c 0x0c BLE_ATT_ERR_INSUFFICIENT_KEY_SZ 0x010d 0x0d BLE_ATT_ERR_INVALID_ATTR_VALUE_LEN 0x010e 0x0e BLE_ATT_ERR_UNLIKELY 0x010f 0x0f BLE_ATT_ERR_INSUFFICIENT_ENC 0x0110 0x10 BLE_ATT_ERR_UNSUPPORTED_GROUP 0x0111 0x11 BLE_ATT_ERR_INSUFFICIENT_RES", + "text": "#include host/ble_hs.h #include host/ble_att.h 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. 0x0104 0x04 BLE_ATT_ERR_INVALID_PDU The attribute PDU was invalid. 0x0105 0x05 BLE_ATT_ERR_INSUFFICIENT_AUTHEN The attribute requires authentication before it can be read or written. 0x0106 0x06 BLE_ATT_ERR_REQ_NOT_SUPPORTED Attribute server does not support the request received from the client. 0x0107 0x07 BLE_ATT_ERR_INVALID_OFFSET Offset specified was past the end of the attribute. 0x0108 0x08 BLE_ATT_ERR_INSUFFICIENT_AUTHOR The attribute requires authorization before it can be read or written. 0x0109 0x09 BLE_ATT_ERR_PREPARE_QUEUE_FULL Too many prepare writes have been queued. 0x010a 0x0a BLE_ATT_ERR_ATTR_NOT_FOUND No attribute found within the given attribute handle range. 0x010b 0x0b BLE_ATT_ERR_ATTR_NOT_LONG The attribute cannot be read or written using the Read Blob Request. 0x010c 0x0c BLE_ATT_ERR_INSUFFICIENT_KEY_SZ The Encryption Key Size used for encrypting this link is insufficient. 0x010d 0x0d BLE_ATT_ERR_INVALID_ATTR_VALUE_LEN The attribute value length is invalid for the operation. 0x010e 0x0e BLE_ATT_ERR_UNLIKELY The attribute request that was requested has encountered an error that was unlikely, and therefore could not be completed as requested. 0x010f 0x0f BLE_ATT_ERR_INSUFFICIENT_ENC The attribute requires encryption before it can be read or written. 0x0110 0x10 BLE_ATT_ERR_UNSUPPORTED_GROUP The attribute type is not a supported grouping attribute as defined by a higher layer specification. 0x0111 0x11 BLE_ATT_ERR_INSUFFICIENT_RES Insufficient Resources to complete the request.", "title": "Return codes - ATT" }, { "location": "/network/ble/ble_hs/ble_hs_return_codes/#return-codes-hci", - "text": "#include host/ble_hs.h #include nimble/ble.h NimBLE Value Formal Value Name 0x0201 0x01 BLE_ERR_UNKNOWN_HCI_CMD 0x0202 0x02 BLE_ERR_UNK_CONN_ID 0x0203 0x03 BLE_ERR_HW_FAIL 0x0204 0x04 BLE_ERR_PAGE_TMO 0x0205 0x05 BLE_ERR_AUTH_FAIL 0x0206 0x06 BLE_ERR_PINKEY_MISSING 0x0207 0x07 BLE_ERR_MEM_CAPACITY 0x0208 0x08 BLE_ERR_CONN_SPVN_TMO 0x0209 0x09 BLE_ERR_CONN_LIMIT 0x020a 0x0a BLE_ERR_SYNCH_CONN_LIMIT 0x020b 0x0b BLE_ERR_ACL_CONN_EXISTS 0x020c 0x0c BLE_ERR_CMD_DISALLOWED 0x020d 0x0d BLE_ERR_CONN_REJ_RESOURCES 0x020e 0x0e BLE_ERR_CONN_REJ_SECURITY 0x020f 0x0f BLE_ERR_CONN_REJ_BD_ADDR 0x0210 0x10 BLE_ERR_CONN_ACCEPT_TMO 0x0211 0x11 BLE_ERR_UNSUPPORTED 0x0212 0x12 BLE_ERR_INV_HCI_CMD_PARMS 0x0213 0x13 BLE_ERR_REM_USER_CONN_TERM 0x0214 0x14 BLE_ERR_RD_CONN_TERM_RESRCS 0x0215 0x15 BLE_ERR_RD_CONN_TERM_PWROFF 0x0216 0x16 BLE_ERR_CONN_TERM_LOCAL 0x02 17 0x17 BLE_ERR_REPEATED_ATTEMPTS 0x0218 0x18 BLE_ERR_NO_PAIRING 0x0219 0x19 BLE_ERR_UNK_LMP 0x021a 0x1a BLE_ERR_UNSUPP_REM_FEATURE 0x021b 0x1b BLE_ERR_SCO_OFFSET 0x021c 0x1c BLE_ERR_SCO_ITVL 0x021d 0x1d BLE_ERR_SCO_AIR_MODE 0x021e 0x1e BLE_ERR_INV_LMP_LL_PARM 0x021f 0x1f BLE_ERR_UNSPECIFIED 0x0220 0x20 BLE_ERR_UNSUPP_LMP_LL_PARM 0x0221 0x21 BLE_ERR_NO_ROLE_CHANGE 0x0222 0x22 BLE_ERR_LMP_LL_RSP_TMO 0x0223 0x23 BLE_ERR_LMP_COLLISION 0x0224 0x24 BLE_ERR_LMP_PDU 0x0225 0x25 BLE_ERR_ENCRYPTION_MODE 0x0226 0x26 BLE_ERR_LINK_KEY_CHANGE 0x0227 0x27 BLE_ERR_UNSUPP_QOS 0x0228 0x28 BLE_ERR_INSTANT_PASSED 0x0229 0x29 BLE_ERR_UNIT_KEY_PAIRING 0x022a 0x2a BLE_ERR_DIFF_TRANS_COLL 0x022c 0x2c BLE_ERR_QOS_PARM 0x022d 0x2d BLE_ERR_QOS_REJECTED 0x022e 0x2e BLE_ERR_CHAN_CLASS 0x022f 0x2f BLE_ERR_INSUFFICIENT_SEC 0x0230 0x30 BLE_ERR_PARM_OUT_OF_RANGE 0x0232 0x32 BLE_ERR_PENDING _ROLE_SW 0x0234 0x34 BLE_ERR_RESERVED_SLOT 0x0235 0x35 BLE_ERR_ROLE_SW_FAIL 0x0236 0x36 BLE_ERR_INQ_RSP_TOO_BIG 0x0237 0x37 BLE_ERR_SEC_SIMPLE_PAIR 0x0238 0x38 BLE_ERR_HOST_BUSY_PAIR 0x0239 0x39 BLE_ERR_CONN_REJ_CHANNEL 0x023a 0x3a BLE_ERR_CTLR_BUSY 0x023b 0x3b BLE_ERR_CONN_PARMS 0x023c 0x3c BLE_ERR_DIR_ADV_TMO 0x023d 0x3d BLE_ERR_CONN_TERM_MIC 0x023e 0x3e BLE_ERR_CONN_ESTABLISHMENT 0x023f 0x3f BLE_ERR_MAC_CONN_FAIL 0x0240 0x40 BLE_ERR_COARSE_CLK_ADJ", + "text": "#include host/ble_hs.h #include nimble/ble.h 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 0x0204 0x04 BLE_ERR_PAGE_TMO Page Timeout 0x0205 0x05 BLE_ERR_AUTH_FAIL Authentication Failure 0x0206 0x06 BLE_ERR_PINKEY_MISSING PIN or Key Missing 0x0207 0x07 BLE_ERR_MEM_CAPACITY Memory Capacity Exceeded 0x0208 0x08 BLE_ERR_CONN_SPVN_TMO Connection Timeout 0x0209 0x09 BLE_ERR_CONN_LIMIT Connection Limit Exceeded 0x020a 0x0a BLE_ERR_SYNCH_CONN_LIMIT Synchronous Connection Limit To A Device Exceeded 0x020b 0x0b BLE_ERR_ACL_CONN_EXISTS ACL Connection Already Exists 0x020c 0x0c BLE_ERR_CMD_DISALLOWED Command Disallowed 0x020d 0x0d BLE_ERR_CONN_REJ_RESOURCES Connection Rejected due to Limited Resources 0x020e 0x0e BLE_ERR_CON N_REJ_SECURITY Connection Rejected Due To Security Reasons 0x020f 0x0f BLE_ERR_CONN_REJ_BD_ADDR Connection Rejected due to Unacceptable BD_ADDR 0x0210 0x10 BLE_ERR_CONN_ACCEPT_TMO Connection Accept Timeout Exceeded 0x0211 0x11 BLE_ERR_UNSUPPORTED Unsupported Feature or Parameter Value 0x0212 0x12 BLE_ERR_INV_HCI_CMD_PARMS Invalid HCI Command Parameters 0x0213 0x13 BLE_ERR_REM_USER_CONN_TERM Remote User Terminated Connection 0x0214 0x14 BLE_ERR_RD_CONN_TERM_RESRCS Remote Device Terminated Connection due to Low Resources 0x0215 0x15 BLE_ERR_RD_CONN_TERM_PWROFF Remote Device Terminated Connection due to Power Off 0x0216 0x16 BLE_ERR_CONN_TERM_LOCAL Connection Terminated By Local Host 0x0217 0x17 BLE_ERR_REPEATED_ATTEMPTS Repeated Attempts 0x0218 0x18 BLE_ERR_NO_PAIRING Pairing Not Allowed 0x0219 0x19 BLE_ERR_UNK_LMP Unknown LMP PDU 0x021a 0x1a BLE_ERR_UNSUPP_REM_FEATURE Unsupported Remote Feature / Unsupported LMP Feature 0x021b 0x1b BLE_ERR_SCO_OFFSET SCO Offset Rejected 0x021c 0x1c BLE_ERR_SCO_ITVL SCO Interval Rejected 0x021d 0x1d BLE_ERR_SCO_AIR_MODE SCO Air Mode Rejected 0x021e 0x1e BLE_ERR_INV_LMP_LL_PARM Invalid LMP Parameters / Invalid LL Parameters 0x021f 0x1f BLE_ERR_UNSPECIFIED Unspecified Error 0x0220 0x20 BLE_ERR_UNSUPP_LMP_LL_PARM Unsupported LMP Parameter Value / Unsupported LL Parameter Value 0x0221 0x21 BLE_ERR_NO_ROLE_CHANGE Role Change Not Allowed 0x0222 0x22 BLE_ERR_LMP_LL_RSP_TMO LMP Response Timeout / LL Response Timeout 0x0223 0x23 BLE_ERR_LMP_COLLISION LMP Error Transaction Collision 0x0224 0x24 BLE_ERR_LMP_PDU LMP PDU Not Allowed 0x0225 0x25 BLE_ERR_ENCRYPTION_MODE Encryption Mode Not Acceptable 0x0226 0x26 BLE_ERR_LINK_KEY_CHANGE Link Key cannot be Changed 0x0227 0x27 BLE_ERR_UNSUPP_QOS Requested QoS Not Supported 0x0228 0x28 BLE_ERR_INSTANT_PASSED Instant Passed 0x0229 0x29 BLE _ERR_UNIT_KEY_PAIRING Pairing With Unit Key Not Supported 0x022a 0x2a BLE_ERR_DIFF_TRANS_COLL Different Transaction Collision 0x022c 0x2c BLE_ERR_QOS_PARM QoS Unacceptable Parameter 0x022d 0x2d BLE_ERR_QOS_REJECTED QoS Rejected 0x022e 0x2e BLE_ERR_CHAN_CLASS Channel Classification Not Supported 0x022f 0x2f BLE_ERR_INSUFFICIENT_SEC Insufficient Security 0x0230 0x30 BLE_ERR_PARM_OUT_OF_RANGE Parameter Out Of Mandatory Range 0x0232 0x32 BLE_ERR_PENDING_ROLE_SW Role Switch Pending 0x0234 0x34 BLE_ERR_RESERVED_SLOT Reserved Slot Violation 0x0235 0x35 BLE_ERR_ROLE_SW_FAIL Role Switch Failed 0x0236 0x36 BLE_ERR_INQ_RSP_TOO_BIG Extended Inquiry Response Too Large 0x0237 0x37 BLE_ERR_SEC_SIMPLE_PAIR Secure Simple Pairing Not Supported By Host 0x0238 0x38 BLE_ERR_HOST_BUSY_PAIR Host Busy - Pairing 0x0239 0x39 BLE_ERR_CONN_REJ_CHANNEL Connection Rejected due to No Suitable Channel Found 0x023a 0x3a BLE_ERR_CTLR _BUSY Controller Busy 0x023b 0x3b BLE_ERR_CONN_PARMS Unacceptable Connection Parameters 0x023c 0x3c BLE_ERR_DIR_ADV_TMO Directed Advertising Timeout 0x023d 0x3d BLE_ERR_CONN_TERM_MIC Connection Terminated due to MIC Failure 0x023e 0x3e BLE_ERR_CONN_ESTABLISHMENT Connection Failed to be Established 0x023f 0x3f BLE_ERR_MAC_CONN_FAIL MAC Connection Failed 0x0240 0x40 BLE_ERR_COARSE_CLK_ADJ Coarse Clock Adjustment Rejected but Will Try to Adjust Using Clock Dragging", "title": "Return codes - HCI" }, { "location": "/network/ble/ble_hs/ble_hs_return_codes/#return-codes-l2cap", - "text": "#include host/ble_hs.h #include host/ble_l2cap.h NimBLE Value Formal Value Name 0x0300 0x00 BLE_L2CAP_SIG_ERR_CMD_NOT_UNDERSTOOD 0x0301 0x01 BLE_L2CAP_SIG_ERR_MTU_EXCEEDED 0x0302 0x02 BLE_L2CAP_SIG_ERR_INVALID_CID", + "text": "#include host/ble_hs.h #include host/ble_l2cap.h 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.", "title": "Return codes - L2CAP" }, { "location": "/network/ble/ble_hs/ble_hs_return_codes/#return-codes-security-manager-us", - "text": "#include host/ble_hs.h #include host/ble_sm.h NimBLE Value Formal Value Name 0x0401 0x01 BLE_SM_ERR_PASSKEY 0x0402 0x02 BLE_SM_ERR_OOB 0x0403 0x03 BLE_SM_ERR_AUTHREQ 0x0404 0x04 BLE_SM_ERR_CONFIRM_MISMATCH 0x0405 0x05 BLE_SM_ERR_PAIR_NOT_SUPP 0x0406 0x06 BLE_SM_ERR_ENC_KEY_SZ 0x0407 0x07 BLE_SM_ERR_CMD_NOT_SUPP 0x0408 0x08 BLE_SM_ERR_UNSPECIFIED 0x0409 0x09 BLE_SM_ERR_REPEATED 0x040a 0x0a BLE_SM_ERR_INVAL 0x040b 0x0b BLE_SM_ERR_DHKEY 0x040c 0x0c BLE_SM_ERR_NUMCMP 0x040d 0x0d BLE_SM_ERR_ALREADY 0x040e 0x0e BLE_SM_ERR_CROSS_TRANS", + "text": "#include host/ble_hs.h #include host/ble_sm.h 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. 0x0404 0x04 BLE_SM_ERR_CONFIRM_MISMATCH The confirm value does not match the calculated compare value. 0x0405 0x05 BLE_SM_ERR_PAIR_NOT_SUPP Pairing is not supported by the device. 0x0406 0x06 BLE_SM_ERR_ENC_KEY_SZ The resultant encryption key size is insufficient for the security requirements of this device. 0x0407 0x07 BLE_SM_ERR_CMD_NOT_SUPP The SMP command received is not supported on this device. 0x0408 0x08 BLE_SM_ERR_UNSPECIFIED Pairing failed due to an unspecified reason. 0x0409 0x09 BLE_SM_ERR_REPEATED Pairing or authentication procedure is disallowed because too little time has elapsed since last pairing request or security request. 0x040a 0x0a BLE_SM_ERR_INVAL The Invalid Parameters error code indicates that the command length is invalid or that a parameter is outside of the specified range. 0x040b 0x0b BLE_SM_ERR_DHKEY Indicates to the remote device that the DHKey Check value received doesn\u2019t match the one calculated by the local device. 0x040c 0x0c BLE_SM_ERR_NUMCMP Indicates that the confirm values in the numeric comparison protocol do not match. 0x040d 0x0d BLE_SM_ERR_ALREADY Indicates that the pairing over the LE transport failed due to a Pairing Request sent over the BR/EDR transport in process. 0x040e 0x0e BLE_SM_ERR_CROSS_TRANS Indicates that the BR/EDR Link Key generated on the BR/EDR transport cannot be used to derive and distribute keys for the LE transport.", "title": "Return codes - Security manager (us)" }, { @@ -7686,6 +7686,31 @@ "title": "Returned values" }, { + "location": "/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi/", + "text": "ble_gap_conn_rssi\n\n\nint\n\n\nble_gap_conn_rssi\n(\nuint16_t\n \nconn_handle\n, \nint8_t\n \n*out_rssi\n)\n\n\n\n\n\nDescription\n\n\nRetrieves the most-recently measured RSSI for the specified connection. A connection's RSSI is updated whenever a data channel PDU is received. \n\n\nParameters\n\n\n\n\n\n\n\n\nParameter\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nconn_handle\n\n\nSpecifies the connection to query.\n\n\n\n\n\n\nout_rssi\n\n\nOn success, the retrieved RSSI is written here.\n\n\n\n\n\n\n\n\nReturned values\n\n\n\n\n\n\n\n\nValue\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0\n\n\nSuccess.\n\n\n\n\n\n\nBLE host HCI return code\n\n\nThe controller rejected the request.\n\n\n\n\n\n\nBLE host core return code\n\n\nUnexpected error.", + "title": "ble_gap_conn_rssi" + }, + { + "location": "/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi/#ble95gap95conn95rssi", + "text": "int ble_gap_conn_rssi ( uint16_t conn_handle , int8_t *out_rssi )", + "title": "ble_gap_conn_rssi" + }, + { + "location": "/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi/#description", + "text": "Retrieves the most-recently measured RSSI for the specified connection. A connection's RSSI is updated whenever a data channel PDU is received.", + "title": "Description" + }, + { + "location": "/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi/#parameters", + "text": "Parameter Description conn_handle Specifies the connection to query. out_rssi On success, the retrieved RSSI is written here.", + "title": "Parameters" + }, + { + "location": "/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi/#returned-values", + "text": "Value Condition 0 Success. BLE host HCI return code The controller rejected the request. BLE host core return code Unexpected error.", + "title": "Returned values" + }, + { "location": "/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/", "text": "ble_gap_connect\n\n\nint\n\n\nble_gap_connect\n(\nuint8_t\n \nown_addr_type\n,\n \nuint8_t\n \npeer_addr_type\n, \nconst\n \nuint8_t\n \n*peer_addr\n,\n \nconst\n \nstruct\n \nble_gap_conn_params\n \n*conn_params\n,\n \nble_gap_event_fn\n \n*cb\n, \nvoid\n \n*cb_arg\n)\n\n\n\n\n\nDescription\n\n\nInitiates a connect procedure. \n\n\nParameters\n\n\n\n\n\n\n\n\nParameter\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nown_addr_type\n\n\nThe type of address the stack should use for itself during connection establishment. \nBLE_ADDR_TYPE_PUBLIC\n \nBLE_ADDR_TYPE_RANDOM\n \nBLE_ADDR_TYPE_RPA_PUB_DEFAULT\n \nBLE_ADDR_TYPE_RPA_RND_DEFAULT\n\n\n\n\n\n\npeer_addr_type\n\n\nThe peer's address type. One of: \nBLE_HCI_CONN_PEER_ADDR_PUBLIC\n \nBLE_HCI_CONN_PEER_ADDR_RANDOM\n \nBLE_HCI_CONN_PEER_ADDR_PUBLIC_IDENT\n \nBLE_HCI_CONN_PEER_ADDR_RANDOM_IDENT\n \nBLE_GAP_ADDR_TYPE_WL\n\n\n\n\n\n\npeer_addr\n\n\nThe identity address of the peer t o connect to. This parameter is ignored when the white list is used.\n\n\n\n\n\n\nduration_ms\n\n\nThe duration of the discovery procedure. On expiration, the procedure ends and a BLE_GAP_EVENT_DISC_COMPLETE event is reported. Units are milliseconds.\n\n\n\n\n\n\nconn_params\n\n\nAdditional arguments specifying the particulars of the connect procedure. Specify null for default values.\n\n\n\n\n\n\ncb\n\n\nThe callback to associate with this connect procedure. When the connect procedure completes, the result is reported through this callback. If the connect procedure succeeds, the connection inherits this callback as its event-reporting mechanism.\n\n\n\n\n\n\ncb_arg\n\n\nThe optional argument to pass to the callback function.\n\n\n\n\n\n\n\n\nReturned values\n\n\n\n\n\n\n\n\nValue\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0\n\n\nSuccess.\n\n\n\n\n\n\nBLE host core return code\n\n\nUnexpected error.", "title": "ble_gap_connect" @@ -7762,7 +7787,7 @@ }, { "location": "/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/", - "text": "ble_gap_disc_cancel\n\n\nint\n\n\nble_gap_disc_cancel\n(\nvoid\n)\n\n\n\n\n\nDescription\n\n\nCancels the discovery procedure currently in progress. A success return code indicates that scanning has been fully aborted; a new discovery or connect procedure can be initiated immediately. \n\n\nParameters\n\n\nNone\n\n\nReturned values\n\n\n\n\n\n\n\n\nValue\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0\n\n\nSuccess.\n\n\n\n\n\n\nBLE_HS_EALREADY\n\n\nThere is no discovery procedure to cancel.\n\n\n\n\n\n\nother\n\n\nOther nonzero on unexpected error.", + "text": "ble_gap_disc_cancel\n\n\nint\n\n\nble_gap_disc_cancel\n(\nvoid\n)\n\n\n\n\n\nDescription\n\n\nCancels the discovery procedure currently in progress. A success return code indicates that scanning has been fully aborted; a new discovery or connect procedure can be initiated immediately. \n\n\nParameters\n\n\nNone\n\n\nReturned values\n\n\n\n\n\n\n\n\nValue\n\n\nCondition\n\n\n\n\n\n\n\n\n\n\n0\n\n\nSuccess.\n\n\n\n\n\n\nBLE_HS_EALREADY\n\n\nThere is no discovery procedure to cancel.\n\n\n\n\n\n\nBLE host core return code\n\n\nUnexpected error.", "title": "ble_gap_disc_cancel" }, { @@ -7782,7 +7807,7 @@ }, { "location": "/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/#returned-values", - "text": "Value Condition 0 Success. BLE_HS_EALREADY There is no discovery procedure to cancel. other Other nonzero on unexpected error.", + "text": "Value Condition 0 Success. BLE_HS_EALREADY There is no discovery procedure to cancel. BLE host core return code Unexpected error.", "title": "Returned values" }, { http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_active/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_active/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_active/index.html index 779a24b..a4c697d 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_active/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_active/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_rsp_set_fields/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_rsp_set_fields/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_rsp_set_fields/index.html index 4650b60..f0d0602 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_rsp_set_fields/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_rsp_set_fields/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_set_fields/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_set_fields/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_set_fields/index.html index 1129f27..604f87d 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_set_fields/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_set_fields/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_start/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_start/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_start/index.html index 78630b4..33b5d79 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_start/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_start/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_stop/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_stop/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_stop/index.html index ec71ed8..bd10a28 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_stop/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_adv_stop/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_active/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_active/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_active/index.html index cbcbf50..32bfa2b 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_active/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_active/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel/index.html index cc33f95..78fa9c0 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_cancel/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find/index.html index fbc3c58..d79f576 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> @@ -670,8 +678,8 @@ </li> <li class="pull-right"> - <a href=../ble_gap_connect/> - Next: ble_gap_connect + <a href=../ble_gap_conn_rssi/> + Next: ble_gap_conn_rssi <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi/index.html new file mode 100644 index 0000000..708dbda --- /dev/null +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi/index.html @@ -0,0 +1,734 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_rssi/";> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_gap_conn_rssi - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link href="../../../../../../css/font-awesome-4.0.3.css" rel="stylesheet"> + <link rel="stylesheet" href="../../../../../../css/highlight.css"> + <link href="../../../../../../css/base.css" rel="stylesheet"> + <link href="../../../../../../css/custom.css" rel="stylesheet"> + <link href="../../../../../../css/v2.css" rel="stylesheet"> + <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> + <link href="../../../../../../extra.css" rel="stylesheet"> + + <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> + <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> + <![endif]--> + + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-72162311-1', 'auto'); + ga('send', 'pageview'); + </script> + + </head> + + + <body class="ble_gap_conn_rssi"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> + <div class="container"> + <!-- Collapsed navigation --> + <div class="navbar-header"> + <!-- Expander button --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav navbar-right"> + <li + class="" +> + <a href="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">Documentation</a> + </li> + <li + class="" +> + <a href="/download/">Download</a> + </li> + <li + class="" +> + <a href="/community/">Community</a> + </li> + <li + class="" +> + <a href="/events/">Events</a> + </li> + </ul> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../../../../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search documentation" /> + </div> + </form> + </div> + </div> + <ul class="toc-nav"> + <li class="doc-version"> +<select class="form-control" onchange="if (this.value) window.location.href=this.value"> + + <option + value="/develop/os/introduction" + selected="selected" + > + Version: develop + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </option> + +</select> +</li> + + + + + + + + + + + + + + + + + + <li ><a href="../../../../../../os/introduction/">Mynewt Documentation</a> + + + <ul> + + + + + + + + <li ><a href="../../../../../../os/get_started/get_started/">Basic Setup</a> + + + </li> + + + + + + <li > + <a href="../../../../../../os/get_started/vocabulary/">Concepts</a> + </li> + + + + + + + + <li ><a href="../../../../../../os/tutorials/tutorials/">Tutorials</a> + + + </li> + + + + + + + + <li ><a href="../../../../../../os/os_user_guide/">OS User Guide</a> + + + </li> + + + + + + + + <li><a href=" + ../../../../ble_intro/ +">BLE User Guide</a> + + + <ul> + + + + <li > + <a href="../../../../ble_intro/">NimBLE Introduction</a> + </li> + + + + + + <li > + <a href="../../../../ble_sec/">NimBLE Security</a> + </li> + + + + + + <li > + <a href="../../../../nimble_setup/">Set up application</a> + </li> + + + + + + + + <li ><a href="../../../../ini_stack/ble_ini_intro/">Initialize stack</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_hs/">NimBLE Host API</a> + + + <ul> + + + + + + <li > + <a href="../../../ble_hs_return_codes/">Return codes</a> + </li> + + + + + + + + <li ><a href="../../../init/init/">Init and config</a> + + + </li> + + + + + + + + <li ><a href="../../ble_gap/">GAP</a> + + + <ul> + + + + + + + + <li><a href=" + ../../definitions/ble_gap_defs/ +">Definitions</a> + + + </li> + + + + + + + + <li><a href=" + ../ble_gap_adv_active/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_gap_adv_active/">ble_gap_adv_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_rsp_set_fields/">ble_gap_adv_rsp_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_set_fields/">ble_gap_adv_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_start/">ble_gap_adv_start</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_stop/">ble_gap_adv_stop</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_active/">ble_gap_conn_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_cancel/">ble_gap_conn_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_find/">ble_gap_conn_find</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_gap_conn_rssi</a> + </li> + + + + + + <li > + <a href="../ble_gap_connect/">ble_gap_connect</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc/">ble_gap_disc</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc_active/">ble_gap_disc_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc_cancel/">ble_gap_disc_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_security_initiate/">ble_gap_security_initiate</a> + </li> + + + + + + <li > + <a href="../ble_gap_terminate/">ble_gap_terminate</a> + </li> + + + + + + <li > + <a href="../ble_gap_update_params/">ble_gap_update_params</a> + </li> + + + + + + <li > + <a href="../ble_gap_wl_set/">ble_gap_wl_set</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../ble_gattc/ble_gattc/">GATT client</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gatts/ble_gatts/">GATT server</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_hs_id/ble_hs_id/">Identity</a> + + + </li> + + + + + + + + <li ><a href="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../bletiny_api/">bletiny app Usage API</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../../../newt/newt_intro/">Newt Tool Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../../../../newtmgr/overview/">Newt Manager Guide</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_gap/">GAP</a></li> + + + + <li>» <a href="../ble_gap_adv_active/">Functions</a></li> + + + + <li>» ble_gap_conn_rssi</li> + + + + </ul> +</div> + </div> + </div> + + <h2 id="ble95gap95conn95rssi"><font color="#F2853F" style="font-size:24pt">ble_gap_conn_rssi</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_gap_conn_rssi</span>(<span style="color: #A90D91">uint16_t</span> <span style="color: #000000">conn_handle</span>, <span style="color: #A90D91">int8_t</span> <span style="color: #000000">*out_rssi</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Retrieves the most-recently measured RSSI for the specified connection. A connection's RSSI is updated whenever a data channel PDU is received. </p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>conn_handle</td> +<td>Specifies the connection to query.</td> +</tr> +<tr> +<td>out_rssi</td> +<td>On success, the retrieved RSSI is written here.</td> +</tr> +</tbody> +</table> +<h3 id="returned-values">Returned values</h3> +<table> +<thead> +<tr> +<th><em>Value</em></th> +<th><em>Condition</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>0</td> +<td>Success.</td> +</tr> +<tr> +<td><a href="../../../ble_hs_return_codes/#return-codes-hci">BLE host HCI return code</a></td> +<td>The controller rejected the request.</td> +</tr> +<tr> +<td><a href="../../../ble_hs_return_codes/#return-codes-core">BLE host core return code</a></td> +<td>Unexpected error.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../ble_gap_conn_find/> + <span class="fa fa-arrow-left"></span> + Previous: ble_gap_conn_find + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_gap_connect/> + Next: ble_gap_connect + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + </div> + </div> +</footer> + </div> + </div> + </div> + + + </div> + + <script src="../../../../../../js/jquery-1.10.2.min.js"></script> + <script src="../../../../../../js/bootstrap-3.0.3.min.js"></script> + <script src="../../../../../../js/highlight.pack.js"></script> + <script src="../../../../../../js/base.js"></script> + <script src="../../../../../../js/custom.js"></script> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/index.html index 4c29444..e6b91c3 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/index.html @@ -392,6 +392,14 @@ + <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + <li class="active"> <a href="./">ble_gap_connect</a> </li> @@ -685,9 +693,9 @@ <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../ble_gap_conn_find/> + <a href=../ble_gap_conn_rssi/> <span class="fa fa-arrow-left"></span> - Previous: ble_gap_conn_find + Previous: ble_gap_conn_rssi </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc/index.html index 64dd642..9927219 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active/index.html index 40759dc..15a9c63 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/index.html index a9b2566..e6227c0 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li> @@ -635,8 +643,8 @@ <td>There is no discovery procedure to cancel.</td> </tr> <tr> -<td>other</td> -<td>Other nonzero on unexpected error.</td> +<td><a href="../../../ble_hs_return_codes/#return-codes-core">BLE host core return code</a></td> +<td>Unexpected error.</td> </tr> </tbody> </table> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/14876ba5/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_security_initiate/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_security_initiate/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_security_initiate/index.html index 15a7ab1..437ffaf 100644 --- a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_security_initiate/index.html +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_security_initiate/index.html @@ -393,6 +393,14 @@ <li > + <a href="../ble_gap_conn_rssi/">ble_gap_conn_rssi</a> + </li> + + + + + + <li > <a href="../ble_gap_connect/">ble_gap_connect</a> </li>
