API console

The API console allows you to communicate with radio modules running in API or API escaped operating mode. To display the API console, switch to Consoles working mode and select a radio module configured with either API or API escaped operating mode. For more information, see API operating mode and API escaped operating mode.

XCTU uses API frames to communicate with radio modules running in API mode. An API frame is an array of bytes with a specific structure defined by the API Frame Specifications. For more information, see API frames.

API console view

Frames log

The Frames log is XCTU's API frames traffic monitor. When API frames are sent or received by the module, they are added to the Frames log. Depending on whether the frame is sent or received, the color of the frame fields is blue or red, respectively.

Button	Name	Description
	Configure filters	Opens the Frames filtering configuration dialog.
	Load console session	Opens the embedded Load console session tool. For details, see Load console session tool.
	Save console session	Saves the active console session in a Console log files.
	Lock scroll	Toggles the scroll behavior of the data box. If Lock scroll is enabled, the Frames log will not automatically scroll when a new frame is sent or received.
	Clear data	Clears the list of sent and received API frames.

The Frames log displays the following properties of the transmitted and received API frames:

Field	Description
Icon	Displays as a right blue arrow if the API frame is sent, and as a left red arrow if it is received.
ID	Lists a numeric value given by XCTU to identify the API frame. When the list of frames is cleared, this value is reset to 0.
Time	Displays the time at which the API frame was sent or received.
Length	Contains the number of bytes of the API frame.
Frame	Displays the API frame type.

Frame details

Frame details appear next to the API frames table and display the decoded contents of the selected API frame.

Send frames

The Send frames section of the API Console allows you to add, manage, and send an API frame or sequence of frames.

Button	Name	Description
	Add new frame	Adds a new API frame to the list of frames to send
	Edit selected frame	Changes the name or contents of a frame
	Remove selected frame	Removes a frame from the list
	Move up / move down	Changes the order of frames in the list
	Save frames list	Saves the list of frames to be used in future sessions or on another computer
	Load frames list	Loads a saved list of frames
	Clear the list of frames	Clears the entire frames list

The Send sequence dialog contains the following fields:

Field	Description
Transmit interval	Amount of time, in milliseconds, to pause between frames. The minimum value is 0 ms and the maximum value is 60000 ms (1 minute).
Repeat times	Number of times the sequence should be repeated or sent. By default, this value is 1.
Loop infinitely	Sends the sequence of frames in an infinite loop.