User's Guide
Table Of Contents
- 1. Introduction
- 2. Getting Started
- 3. Operational Examples
- 3.1 System Setup Examples
- 3.2 Cable Replacement Examples with CYSPP
- 3.3 Remote Control Examples with CYCommand
- 3.4 GAP Peripheral Examples
- 3.5 GAP Central Examples
- 3.6 GATT Server Examples
- 3.7 GATT Client Examples
- 3.8 Security and Encryption Examples
- 3.9 Beacon Examples
- 3.10 Performance Testing Examples
- 3.11 Device Firmware Update Examples
- 4. Application Design Examples
- 5. Host API Library
- 6. Troubleshooting
- 7. API Protocol Reference
- 8. GPIO Reference
- 9. Cypress GATT Profile Reference
- 10. Configuration Example Reference
- Revision History
API Protocol Reference
EZ-Serial BLE Firmware Platform User Guide, Doc. No. 002-11259 Rev. *E 150
Data Type
Name
Text
Description
uint8 mode M
Security level setting reported to peer:
• 0x10 = Mode 1, Level 1 – No security
• 0x11 = Mode 1, Level 2 – Unauthenticated pairing with encryption (no MITM,
factory default)
• 0x12 = Mode 1, Level 3 – Authenticated pairing with encryption (with MITM)
• 0x13 = Mode 1, Level 4 – LE Secure Connections (reported by remote peers only, not
locally implemented in current EZ-Serial firmware)
• 0x21 = Mode 2, Level 2 – Unauthenticated pairing with data signing (no MITM)
• 0x22 = Mode 2, Level 3 – Authenticated pairing with data signing (with MITM)
uint8 bonding B
Bond during pairing process:
• 0 = Do not bond (exchange keys and encrypt only)
• 1 = Bond (permanently store exchanged encryption data)
uint8 keysize K
Encryption key size (7-16), value ignored if pairing initiated by slave device
• NOTE: Factory default is 16 bytes (0x10)
uint8 pairprop P
Pairing properties:
• Bit 0 (0x01): MITM enabled for Secure Connections (SC)
• NOTE: Factory default is 0x00 (no bits set)
Response Parameters:
None.
Related Commands:
• smp_send_pairreq_response (/PR, ID=7/5) – Use when remote device initiates pairing and auto-accept flag bit is not disabled
• smp_send_passkeyreq_response (/PE, ID=7/6) – Use if MITM protection is enabled and pairing requires passkey entry
• smp_set_security_parameters (SSBP, ID=7/11) – Use to configure default security settings
Related Events:
• smp_pairing_requested (P, ID=7/2) – Occurs when remote device initiates pairing
• smp_pairing_result (PR, ID=7/3) – Occurs when pairing process completes (success or failure)
• smp_encryption_status (ENC, ID=7/4) – Occurs when encryption status changes during a pairing process
• smp_passkey_display_requested (PKD, ID=7/5) – Occurs when pairing process requires displaying a passkey to the user
• smp_passkey_entry_requested (PKE, ID=7/6) – Occurs when pairing process requires the user to enter a passkey
7.2.7.4 smp_query_random_address (/QRA, ID=7/4)
Request the current local random address.
When peripheral or central privacy is enabled with the smp_set_privacy_mode (SPRV, ID=7/9) API command, the
Bluetooth connection address visible to remote devices while advertising or scanning will be random (private) instead of
the fixed (public) Bluetooth address that can be configured or obtained using the system_set_bluetooth_address (SBA,
ID=2/13) and system_get_bluetooth_address (GBA, ID=2/14) API commands. This type of privacy helps to avoid profiling
by a passive eavesdropper.
Binary Header:
Type
Length
Group
ID
Notes
CMD
C0
00
07
04
None.
RSP
C0
08
07
04
None.
Text Info:
Text Name
Response Length
Category
Notes
/QRA
0x0019
ACTION
None.
Command Arguments:
None.
Response Parameters:
Data Type
Name
Text
Description
macaddr
address
A
Random address