cuewire.serial_link

Generic Python ↔ Arduino serial link.

Classes

ArduinoSerial(port[, baud, timeout, ...])

Generic integer-command bridge to a PARROTard Arduino.

Exceptions

CommTestError

Raised when the Arduino fails to reply with 50 1337.

class cuewire.serial_link.ArduinoSerial(port: str | _SerialLike, baud: int = 9600, timeout: float = 0.1, comm_test_on_open: bool = True)

Bases: object

Generic integer-command bridge to a PARROTard Arduino.

Use as a context manager:

with ArduinoSerial(“/dev/ttyUSB0”) as ard:

ard.set_write_out(True) ard.reset_clock()

Parameters:

• port – Device path or pyserial-compatible object.

• baud – Serial baud rate.

• timeout – Read timeout in seconds.

• comm_test_on_open – Run the 50 1337 handshake on enter.

close() → None

comm_test() → bool

Run the 50 1337 handshake; raise CommTestError on failure.

flush_all() → None

Flush output and reset both buffers.

read_buffer() → str

Drain the input buffer; useful for diagnostics.

read_line() → str

Read one newline-terminated line, stripped of CR/LF.

reset_clock(settle_s: float = 0.0) → None

Reset the firmware’s clockVar to zero.

send_command(name: str, settle_s: float = 0.0) → None

Send a named command (looked up in COMMAND_IDS).

send_command_verbose(name: str, settle_s: float = 1.0) → str

Send a named command and read the next single-line response.

send_command_with_follow_float(name: str, follow: float, settle_s: float = 0.0) → None

Send a command followed by a float parameter.

send_command_with_follow_int(name: str, follow: int, settle_s: float = 0.0) → None

Send a command followed by an integer parameter.

set_write_out(enabled: bool, settle_s: float = 0.0) → None

Toggle the Arduino’s continuous serial write-out.

write_float(value: float, settle_s: float = 0.0) → None

Send a float (encoded as ASCII).

write_int(value: int, settle_s: float = 0.0) → None

Send an integer (encoded as ASCII).

exception cuewire.serial_link.CommTestError

Bases: RuntimeError

Raised when the Arduino fails to reply with 50 1337.