coinespy API calls: Interface and board information¶

open_comm_interface¶

Sets the communication interface between board and PC to USB or Serial.

coinesboard.open_comm_interface(interface=CommInterface.USB, arg=None) -> ErrorCodes

For the definition of CommInterface, refer to 11.3.6.3.

close_comm_interface¶

Disposes the resources used by the USB/serial/BLE communication.

coinesboard.close_comm_interface(arg=None) -> ErrorCodes

get_board_info¶

Obtains board specific information.

BoardInfo = coinesboard.get_board_info()
# Return:
BoardInfo.HardwareId # Hardware ID
BoardInfo.SoftwareId # Firmware version information
BoardInfo.Board # Board type
BoardInfo.ShuttleID # ID of shuttle, in case a shuttle is detected

scan_ble_devices¶

This API is used to connect to BLE Adapter and return list of BLE peripherals found during BLE scan.

ble_info, peripheral_count = coinesboard.scan_ble_devices(scan_timeout_ms=0) -> Tuple[list, int]

For the definition of parameters, refer to 6.8.29.

echo_test¶

This API is used to test the communication.

coinesboard.echo_test(data: List[int]) -> ErrorCodes

Arguments:

data: Data to be sent for testing.