USB transport

class chess_link_usb.Transport(que, protocol_dbg=False)

ChessLink transport implementation for USB connections.

This class does automatic hardware detection of any ChessLink board connected via USB and support Linux, macOS and Windows.

This transport uses an asynchronous background thread for hardware communcation. All replies are written to the python queue que given during initialization.

__init__(que, protocol_dbg=False)

Initialize with python queue for event handling. Events are strings conforming to the ChessLink protocol as documented in magic-link.md.

Parameters

• que – Python queue that will eceive events from chess board.

• protocol_dbg – True: byte-level ChessLink protocol debug messages

event_worker_thread(que)

Background thread that sends data received via usb to the queue que.

get_name()

Get name of this transport.

Returns

‘chess_link_usb’

is_init()

Check, if hardware connection is up.

Returns

True on success.

open_mt(port)

Open an usb port to a connected ChessLink board.

Returns

True on success.

quit()

Initiate worker-thread stop

search_board(iface=None)

Search for ChessLink connections on all USB ports.

Parameters

iface – not used for USB.

Returns

Name of the port with a ChessLink board, None on failure.

test_board(port)

Test an usb port for correct answer on get version command.

Returns

Version string on ok, None on failure.

usb_port_check(port)

Check usb port for valid ChessLink connection

Returns

True on success, False on failure.

usb_port_search()

Get a list of all usb ports that have a connected ChessLink board.

Returns

array of usb port names with valid ChessLink boards, an empty array if none is found.

usb_read_synchr(usbdev, cmd, num)

Synchronous reads for initial hardware detection.

write_mt(msg)

Encode and write a message to ChessLink.

Parameters

msg – Message string. Parity will be added, and block CRC appended.

BLE transport

class chess_link_bluepy.Transport(que, protocol_dbg=False)

ChessLink transport implementation for Bluetooth LE connections using bluepy.

This class does automatic hardware detection of any ChessLink board using bluetooth LE and supports Linux and Raspberry Pi.

This transport uses an asynchronous background thread for hardware communcation. All replies are written to the python queue que given during initialization.

For the details of the Chess Link protocol, please refer to: magic-link.md.

__init__(que, protocol_dbg=False)

Initialize with python queue for event handling. Events are strings conforming to the ChessLink protocol as documented in magic-link.md.

Parameters

• que – Python queue that will eceive events from chess board.

• protocol_dbg – True: byte-level ChessLink protocol debug messages

get_name()

Get name of this transport.

Returns

‘chess_link_bluepy’

is_init()

Check, if hardware connection is up.

Returns

True on success.

open_mt(address)

Open a bluetooth LE connection to ChessLink board.

Parameters

address – bluetooth address

Returns

True on success.

quit()

Initiate worker-thread stop

search_board(iface=0)

Search for ChessLink connections using Bluetooth LE.

Parameters

iface – interface number of bluetooth adapter, default 1.

Returns

Bluetooth address of ChessLink board, or None on failure.

test_board(address)

Test dummy.

Returns

Version string “1.0” always.

worker_thread(log, address, wrque, que)

Background thread that handles bluetooth sending and forwards data received via bluetooth to the queue que.

write_mt(msg)

Encode and asynchronously write a message to ChessLink.

Parameters

msg – Message string. Parity will be added, and block CRC appended.