To start the Serial GUI, follow installation instructions to deploy the bundle in the OSGi framework, and start it.

In addition to the serial-gui artifact, it is required to install the Serial Implementation artifact implementing access to the serial port. To do so, follow instructions here

When the bundle starts, it will create an empty window where we will be able to open a SerialConnection with a local port or a remote TCP port wrapping a SerialConnection.

On that window with the open serial port, it is possible to write data and monitor trafic (incoming and outgoing) data through the serial port. Selecting any text on the monitor windows (ascii or hexadecimal), will highlight the same content on the corresponding window (hexadecimal or ascii).

To write any command, simply type the desired text on the "Command" field and click "Send" button or hit ENTER key. It is possible to configure if we want to append a line terminator to the text introduced, that will be sent with the message.

The tool is much ZigBee oriented, so a list with Zigbee Commands templates is available for selection. Note: it is planned to replace that fixed list for a file-based approach that allows using custom templates.

Sending binary data

It is possible to append binary data to the message to write, by typing the desired hexadecimal code on the lower field and clicking the "Add Hexadecimal" button, or directly writing the hexadecimal string starting and ending with "!" characters. For example, writing the following string on the Command field:

AT+UCASTB:5,000D6F000086F533!0D 00 0A BB CC DD!

will write the text


through the serial port, plus the binary array:

{0D, 00, 0A, BB, CC, DD}

The parser will discard any non hexadecimal character [0123456789ABCDEF] among hexadecimal tokens ("!"), i.e. the following strings:

"!0D, 00, 0A, BB, CC, DD!"
"!x0D, x00, x0A, xBB, xCC, xDD!"
"![0D], [00], [0A], [BB], [CC], [DD]!"

will lead to the same byte array:

{0D, 00, 0A, BB, CC, DD}

Note that "!" char is not allowed to be sent by direct writing. In such a case that char "!" is required to be sent, the hexadecimal code (0×33) can be used, writing the string "!33!" on the command field.

Using aliases

It is also possible using aliases, wich ease sending commands that use variable data. For example, we can define an "address" alias on the "Aliases" box, by typping address=000D6F000086F533. Then, the following text on the Command field:


will write through the serial port the string: