User's Guide

API Protocol Reference
EZ-Serial BLE Firmware Platform User Guide, Doc. No. 002-11259 Rev. *E 181
Data Type
Name
Text
Description
uint8 security S
CYCommand security requirement to allow writing API protocol data from a client:
• 0 = No security required (factory default)
• 1 = Encryption required
• 2 = Bonding required
• 3 = Encryption and bonding required
uint8a secret R
CYCommand secret (0-20 bytes)
NOTE: uint8a data type requires one prefixed “length” byte before binary parameter payload
Response Parameters:
None.
Related Commands:
• p_cycommand_get_parameters (.CYCOMGP, ID=11/2)
Related Events:
• p_cycommand_status (.CYCOM, ID=11/1)
Example Usage:
• Section
3.3 Remote Control Examples with CYCommand)
7.2.11.2 p_cycommand_get_parameters (.CYCOMGP, ID=11/2)
Obtain current CYCommand remote configuration channel behavior.
Binary Header:
Type
Length
Group
ID
Notes
CMD
C0
00
0B
02
None.
RSP
C0
0A-1E
0B
02
Variable-length response payload, minimum of 10 (0x0A), maximum of 30 (0x1E).
Text Info:
Text Name
Response Length
Category
Notes
.CYCOMGP
0x0031-0x0059
GET
Variable-length response payload, minimum of 49 (0x31), maximum of 89 (0x59)
Command Arguments:
None.
Response Parameters:
Data Type
Name
Text
Description
uint8 enable E
Enable CYCommand profile:
• 0 = Disable
• 1 = Enable (factory default)
uint8 hostout H
Host output while CYCommand data channel is active:
• 0 = Responses and events suppressed
• 1 = Responses shown, events suppressed
• 2 = Responses suppressed, events shown
• 3 = Responses and events shown (factory default)
uint16 timeout T
Access timeout after boot, in seconds (always set to 0 in the current release)
• 0 = Disable
uint8 safemode F
Enforce safe mode (no remote lockout)
• 0 = Disable (factory default)
• 1 = Enable
uint8 challenge C
CYCommand challenge type
• 0 = None (factory default)
• 1 = Passphrase