|
|
|
BLE-Stack APIs
3.00.00
|
Macros | |
| #define | GAPROLE_ADV_CHANNEL_MAP 0x30C |
| Which channels to advertise on (Read/Write) More... | |
| #define | GAPROLE_ADV_DIRECT_ADDR 0x30B |
| Direct Advertisement Address (Read/Write) More... | |
| #define | GAPROLE_ADV_DIRECT_TYPE 0x30A |
| Direct Advertisement Type (Read/Write) More... | |
| #define | GAPROLE_ADV_EVENT_TYPE 0x309 |
| Advertisement Types (Read/Write) More... | |
| #define | GAPROLE_ADV_FILTER_POLICY 0x30D |
| Policy for filtering advertisements (Read/Write) More... | |
| #define | GAPROLE_ADV_NONCONN_ENABLED 0x31B |
| Enable / Disable non-connectable advertising (Read/Write) More... | |
| #define | GAPROLE_ADVERT_DATA 0x307 |
| Advertisement data (Read/Write) More... | |
| #define | GAPROLE_ADVERT_ENABLED 0x305 |
| Enable/Disable Connectable Advertising (Read/Write) More... | |
| #define | GAPROLE_ADVERT_OFF_TIME 0x306 |
| How long to remain off (in sec) after advertising stops before starting again (Read/Write) More... | |
| #define | GAPROLE_BD_ADDR 0x304 |
| Device Address read from the controller (Read-only) More... | |
| #define | GAPROLE_BD_ADDR_TYPE 0x31C |
| Address type of connected device (Read-only) More... | |
| #define | GAPROLE_CONN_BD_ADDR 0x315 |
| Address of connected device (Read-only) More... | |
| #define | GAPROLE_CONN_INTERVAL 0x316 |
| Connection Interval (n x 1.25 ms) of current connection (Read-only) More... | |
| #define | GAPROLE_CONN_LATENCY 0x317 |
| Slave Latency of current connection (Read-only) More... | |
| #define | GAPROLE_CONN_TERM_REASON 0x31D |
| Reason of the last connection terminated event. More... | |
| #define | GAPROLE_CONN_TIMEOUT 0x318 |
| Connection Interval (n x 10 ms) of current connection (Read-only) More... | |
| #define | GAPROLE_CONNHANDLE 0x30E |
| Connection Handle of current connected device (Read-only) More... | |
| #define | GAPROLE_IRK 0x301 |
| Identity Resolving Key (Read/Write) Size is uint8_t[KEYLEN]. More... | |
| #define | GAPROLE_MAX_CONN_INTERVAL 0x312 |
| Maximum connection interval (n * 1.25 ms) to use when performing param update (Read/Write) More... | |
| #define | GAPROLE_MIN_CONN_INTERVAL 0x311 |
| Minimum connection interval (n * 1.25 ms) to use when performing param update (Read/Write) More... | |
| #define | GAPROLE_PARAM_UPDATE_ENABLE 0x310 |
| Whether to request a connection parameter update upon connection (Read/Write) More... | |
| #define | GAPROLE_PARAM_UPDATE_REQ 0x319 |
| Used to send a Parameter Update Request (Write-only) More... | |
| #define | GAPROLE_PROFILEROLE 0x300 |
| This parameter will return GAP Role type (Read-only) More... | |
| #define | GAPROLE_SCAN_RSP_DATA 0x308 |
| Scan Response Data (Read/Write) More... | |
| #define | GAPROLE_SIGNCOUNTER 0x303 |
| Sign Counter (Read/Write) More... | |
| #define | GAPROLE_SLAVE_LATENCY 0x313 |
| Slave latency to use when performing param update (Read/Write) More... | |
| #define | GAPROLE_SRK 0x302 |
| Signature Resolving Key (Read/Write) More... | |
| #define | GAPROLE_STATE 0x31A |
| Current Peripheral GAPRole state (Read-only) More... | |
| #define | GAPROLE_TIMEOUT_MULTIPLIER 0x314 |
| Supervision timeout (n x 10 ms) to use when performing param update (Read/Write) More... | |
Parameters set via GAPRole_SetParameter
| #define GAPROLE_ADV_CHANNEL_MAP 0x30C |
Which channels to advertise on (Read/Write)
Multiple channels can be selected by ORing the bit values below.
size: uint8_t
default: GAP_ADVCHAN_ALL
| #define GAPROLE_ADV_DIRECT_ADDR 0x30B |
Direct Advertisement Address (Read/Write)
size: uint8_t[6]
default: NULL
range: 0x000000000000 – 0xFFFFFFFFFFFE
| #define GAPROLE_ADV_DIRECT_TYPE 0x30A |
Direct Advertisement Type (Read/Write)
size: uint8_t
default: ADDRMODE_PUBLIC
range: GAP Addressing Modes
| #define GAPROLE_ADV_EVENT_TYPE 0x309 |
Advertisement Types (Read/Write)
size: uint8_t
default: GAP_ADTYPE_ADV_IND
range: GAP Advertising Event Types
| #define GAPROLE_ADV_FILTER_POLICY 0x30D |
Policy for filtering advertisements (Read/Write)
size: uint8_t
default: GAP_FILTER_POLICY_ALL
| #define GAPROLE_ADV_NONCONN_ENABLED 0x31B |
Enable / Disable non-connectable advertising (Read/Write)
size: uint8_t
default: FALSE
range: TRUE (enable) or FALSE (disable)
| #define GAPROLE_ADVERT_DATA 0x307 |
Advertisement data (Read/Write)
size: a uint8_t array of up to 31 bytes
default: 02:01:01 (general advertising)
| #define GAPROLE_ADVERT_ENABLED 0x305 |
Enable/Disable Connectable Advertising (Read/Write)
size: uint8_t
default: TRUE
range: TRUE (enabled) or FALSE (disabled)
| #define GAPROLE_ADVERT_OFF_TIME 0x306 |
How long to remain off (in sec) after advertising stops before starting again (Read/Write)
If set to 0, advertising will not start again.
size: uint16
default: 30
range: 0-65535
| #define GAPROLE_BD_ADDR 0x304 |
Device Address read from the controller (Read-only)
The BDADDR is read, in increasing order of priortiy, from the info page, secondary address from flash, or set from HCI_ReadBDADDRCmd
size: uint8_t[6]
default: BDADDR from info page
range: 0x000000000000 – 0xFFFFFFFFFFFE
| #define GAPROLE_BD_ADDR_TYPE 0x31C |
| #define GAPROLE_CONN_BD_ADDR 0x315 |
Address of connected device (Read-only)
size: uint8_t[6]
range: 0x000000000000 – 0xFFFFFFFFFFFD
| #define GAPROLE_CONN_INTERVAL 0x316 |
Connection Interval (n x 1.25 ms) of current connection (Read-only)
size: uint16_t
range: 6 - 3200
| #define GAPROLE_CONN_LATENCY 0x317 |
Slave Latency of current connection (Read-only)
size: uint16_t
range: 0 - 499
| #define GAPROLE_CONN_TERM_REASON 0x31D |
Reason of the last connection terminated event.
size: unit8_t
range: error defines in ll.h
| #define GAPROLE_CONN_TIMEOUT 0x318 |
Connection Interval (n x 10 ms) of current connection (Read-only)
size: uint16_t
range: 10 - 3200Current timeout value. Read only. size is uint16_t. Range is 100ms to 32 seconds. Default is 0 (no connection).
| #define GAPROLE_CONNHANDLE 0x30E |
Connection Handle of current connected device (Read-only)
size: uint16_t
range: 0x0000-0xFFFD
| #define GAPROLE_IRK 0x301 |
Identity Resolving Key (Read/Write) Size is uint8_t[KEYLEN].
size: uint8_t[16]
default: 0x00000000000000000000000000000000
range: 0x00000000000000000000000000000000 – 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
| #define GAPROLE_MAX_CONN_INTERVAL 0x312 |
Maximum connection interval (n * 1.25 ms) to use when performing param update (Read/Write)
size: uint16_t
default: 3200
range: GAPROLE_MIN_CONN_INTERVAL - 3200
| #define GAPROLE_MIN_CONN_INTERVAL 0x311 |
Minimum connection interval (n * 1.25 ms) to use when performing param update (Read/Write)
size: uint16_t
default: 6
range: 6 - GAPROLE_MAX_CONN_INTERVAL
| #define GAPROLE_PARAM_UPDATE_ENABLE 0x310 |
Whether to request a connection parameter update upon connection (Read/Write)
size: uint8_t
default: TRUE
range: TRUE (do request) or FALSE (don't request)
| #define GAPROLE_PARAM_UPDATE_REQ 0x319 |
Used to send a Parameter Update Request (Write-only)
size: uint8_t
range: TRUE (send the update)
| #define GAPROLE_PROFILEROLE 0x300 |
This parameter will return GAP Role type (Read-only)
size: uint8_t
range: when using the Peripheral GAPRole, this will always be GAP_PROFILE_PERIPHERAL
| #define GAPROLE_SCAN_RSP_DATA 0x308 |
Scan Response Data (Read/Write)
size: a uint8_t array of up to 31 bytes
default: all 0x00's
| #define GAPROLE_SIGNCOUNTER 0x303 |
Sign Counter (Read/Write)
size: uint32_t
default: 0x0000
range: 0x0000 - 0xFFFF
| #define GAPROLE_SLAVE_LATENCY 0x313 |
Slave latency to use when performing param update (Read/Write)
size: uint16_t
default: 0
range: 0 - 499
| #define GAPROLE_SRK 0x302 |
Signature Resolving Key (Read/Write)
size: uint8_t[16]
default: 0x00000000000000000000000000000000
range: 0x00000000000000000000000000000000 – 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
| #define GAPROLE_STATE 0x31A |
Current Peripheral GAPRole state (Read-only)
size: uint8_t
default: GAPROLE_INIT
range: gaprole_States_t
| #define GAPROLE_TIMEOUT_MULTIPLIER 0x314 |
Supervision timeout (n x 10 ms) to use when performing param update (Read/Write)
size: uint16_t
default: 1000
range: 10-3200
