Usage

The XiBIF Connection package provides an interactive shell through the xibif-connection command line entry point.

usage: xibif-connection [-h] [--ip IP] [--uuid UUID] [--timeout TIMEOUT]
                        [--verbose]

Named Arguments

--ip, -i

IP address of board to connect to

--uuid, -u

UUID of board (decimal or 0x… hex)

--timeout, -t

Connection timeout in seconds

--verbose

Enable verbose output

Default: False

Examples

Start the shell without connecting:

xibif-connection

Start the shell and connect immediately:

xibif-connection --ip 192.168.1.10 --uuid 0xDEAD_CAFE --timeout 5

Available commands

The available commands of the shell are as follows:

• clear: Clear the terminal screen.

• connect: Connect to a XiBIF board.

• disconnect: Disconnect from a XiBIF board.

• exit: Quit the shell.

• ping: Ping a XiBIF board.

• quit: Quit the shell.

• read: Read one or multiple values from a hardware register.

• regmap: Operate on the register map of a XiBIF board.

• reset: Reset the PL system of the XiBIF board.

• status: Read and print board status.

• unwatch: Stop watching a register.

• watch: Observe a register.

• write: Write values to a hardware register.

Typical workflow

$ xibif-connection
xibif> connect 192.168.1.10 0xDEAD_CAFE
Connected to 192.168.1.10
xibif> read my_register
0x00000001
xibif> write my_register.my_field 3
xibif> quit
Bye.