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 95
Binary Header:
Type
Length
Group
ID
Notes
CMD
C0
00
02
05
None.
RSP
C0
02
02
05
None.
Text Info:
Text Name
Response Length
Category
Notes
/RFAC
0x000B
ACTION
None.
Command Arguments:
None.
Response Parameters:
None.
Related Events:
• system_factory_reset_complete (RFAC, ID=2/3) – Occurs after the settings are reset
• system_boot (BOOT, ID=2/1) – Occurs after the system reboots
Example Usage:
• Section 3.1.6.2 (Factory Reset via API Command)
7.2.2.6 system_query_firmware_version (/QFV, ID=2/6)
Query EZ-Serial firmware version info.
This command provides the same version details that the system_boot (BOOT, ID=2/1) event contains.
Binary Header:
Type
Length
Group
ID
Notes
CMD
C0
00
02
06
None.
RSP
C0
0D
02
06
None.
Text Info:
Text Name
Response Length
Category
Notes
/QFV
0x002C
ACTION
None.
Command Arguments:
None.
Response Parameters:
Data Type
Name
Text
Description
uint32
app
E
Application version number (0x0100010E = 1.0.1 build 14)
uint32
stack
S
BLE stack version number (0x030200FA = 3.2.0 build 250)
uint16
protocol
P
API protocol version number (0x0101 = 1.1)
uint8 hardware H
Hardware identifier:
• 0x01 = CYBLE-01201X-X0
• 0x02 = CYBLE-014008-00
• 0x03 = CYBLE-022001-00
• 0x04 = CYBLE-2X20XX-X1
• 0x05 = CYBLE-2120XX-X0
• 0x06 = CYBLE-212020-01
• 0x07 = CYBLE-214009-00
• 0x08 = CYBLE-214015-01
• 0x09 = CYBLE-222005-00
• 0x0A = CYBLE-222014-01
• 0x0B = CYBLE-224110-00
• 0x0C = CYBLE-224116-01