def create_interface(serial, reset=True, poll_flush=True):
print('Sleeping to allow interface time to wake up...')
time.sleep(3)
interface = SerialInterface(serial)
if reset:
print('Resetting interface...')
version = interface.reset()
print(f'Firmware version is {version}')
if poll_flush:
print('POLLing...')
count = 0
poll_response = poll(interface, receive_timeout=1)
while poll_response:
poll_ack(interface)
count += 1
poll_response = poll(interface, receive_timeout=1)
print(f'ACK\'d {count} POLL responses')
return interface
def setUp(self):
self.serial = Mock()
self.serial.timeout = None
self.interface = SerialInterface(self.serial)
self.interface._write_message = Mock()
self.interface._read_message = Mock(return_value=bytes.fromhex('01 01 02 03'))
class SerialInterfaceReadMessageTestCase(unittest.TestCase):
def setUp(self):
self.serial = Mock()
self.interface = SerialInterface(self.serial)
self.interface.slip_serial = Mock()
def test(self):
# Arrange
self.interface.slip_serial.recv_msg = Mock(
return_value=bytes.fromhex('00 04 01 02 03 04 00 00'))
# Act
message = self.interface._read_message()
# Assert
self.assertEqual(message, bytes.fromhex('01 02 03 04'))
def test_protocol_error_is_handled_correctly(self):
# Arrange
self.interface.slip_serial.recv_msg = Mock(
side_effect=sliplib.ProtocolError)
# Act and assert
with self.assertRaisesRegex(InterfaceError, 'SLIP protocol error'):
self.interface._read_message()
def test_invalid_message_length_is_handled_correctly(self):
# Arrange
self.interface.slip_serial.recv_msg = Mock(
return_value=bytes.fromhex('00'))
# Act and assert
with self.assertRaisesRegex(InterfaceError,
'Invalid response message'):
self.interface._read_message()
def test_message_length_mismatch_is_handled_correctly(self):
# Arrange
self.interface.slip_serial.recv_msg = Mock(
return_value=bytes.fromhex('00 05 01 02 03 04 00 00'))
# Act and assert
with self.assertRaisesRegex(InterfaceError,
'Response message length mismatch'):
self.interface._read_message()
def test_empty_message_is_handled_correctly(self):
# Arrange
self.interface.slip_serial.recv_msg = Mock(
return_value=bytes.fromhex('00 00 00 00'))
# Act and assert
with self.assertRaisesRegex(InterfaceError, 'Empty response message'):
self.interface._read_message()
class SerialInterfaceWriteMessageTestCase(unittest.TestCase):
def setUp(self):
self.serial = Mock()
self.interface = SerialInterface(self.serial)
self.interface.slip_serial = Mock()
def test(self):
# Act
self.interface._write_message(bytes.fromhex('01 02 03 04'))
# Assert
self.interface.slip_serial.send_msg.assert_called_with(bytes.fromhex('00 04 01 02 03 04 00 00'))
def _create_interface(args):
with Serial(args.serial_port, 115200) as serial:
serial.reset_input_buffer()
serial.reset_output_buffer()
# Allow the interface firmware time to start, this is only required for the
# original Arduino Mega based interface.
if 'COAX_FAST_START' not in os.environ:
time.sleep(3)
interface = SerialInterface(serial)
interface.reset()
yield interface
def setUp(self):
self.serial = Mock()
self.interface = SerialInterface(self.serial)
self.interface.slip_serial = Mock()
class SerialInterfaceResetTestCase(unittest.TestCase):
def setUp(self):
self.serial = Mock()
self.serial.timeout = None
self.interface = SerialInterface(self.serial)
self.interface._write_message = Mock()
self.interface._read_message = Mock(
return_value=bytes.fromhex('01 32 70'))
def test_message_is_sent(self):
# Act
self.interface.reset()
# Assert
self.interface._write_message.assert_called_with(bytes.fromhex('01'))
def test_non_legacy_response_is_handled_correctly(self):
# Act
self.interface.reset()
# Assert
self.assertFalse(self.interface.legacy_firmware_detected)
self.assertIsNone(self.interface.legacy_firmware_version)
def test_legacy_response_is_handled_correctly(self):
# Arrange
self.interface._read_message = Mock(
return_value=bytes.fromhex('01 01 02 03'))
# Act
self.interface.reset()
# Assert
self.assertTrue(self.interface.legacy_firmware_detected)
self.assertEqual(self.interface.legacy_firmware_version, '1.2.3')
def test_timeout_is_restored_after_reset(self):
# Arrange
self.serial.timeout = 123
# Act
self.interface.reset()
# Assert
self.assertEqual(self.serial.timeout, 123)
def test_invalid_message_length_is_handled_correctly(self):
# Arrange
self.interface._read_message = Mock(
return_value=bytes.fromhex('01 01'))
# Act and assert
with self.assertRaisesRegex(InterfaceError, 'Invalid reset response'):
self.interface.reset()
def test_error_is_handled_correctly(self):
# Arrange
self.interface._read_message = Mock(
return_value=bytes.fromhex('02 01'))
# Act and assert
with self.assertRaisesRegex(InterfaceError, 'Invalid request message'):
self.interface.reset()
def test_error_with_description_is_handled_correctly(self):
# Arrange
self.interface._read_message = Mock(return_value=bytes.fromhex(
'02 01 45 72 72 6f 72 20 64 65 73 63 72 69 70 74 69 6f 6e'))
# Act and assert
with self.assertRaisesRegex(
InterfaceError, 'Invalid request message: Error description'):
self.interface.reset()