This commit is contained in:
Thomas Ales
2026-09-05 20:29:53 -05:00
parent ff68901c57
commit aeac5fe4d6
2 changed files with 279 additions and 35 deletions
+119 -35
View File
@@ -92,44 +92,124 @@ class HeliosLaser:
logger.error(f"Failed to send command '{command}': {e}")
return False
# A reply can run to more than one line. Every status-register query
# answers with the value and then a decode line:
#
# LCE = 2
# Bit 15..0: 0000 0000 0000 0010
#
# At 9600 baud those trailing ~30 characters are still on the wire when
# read_until() returns the first line, so reset_input_buffer() cannot
# drop them. Left there they become the next query's "answer", and
# every reply after that is one line behind — a register read reported
# as a "Bit 15..0" string, and the reads around it timing out on a
# leading blank line. So: match a reply to the command that asked for
# it, and read off the rest of it before the next command goes out.
TRAILING_QUIET_S = 0.05 # the line counts as idle after this long
MAX_REPLY_LINES = 8
def _read_line(self) -> Optional[str]:
"""One CR-terminated line without its framing; None if nothing came."""
raw = self.serial.read_until(b'\r')
if not raw:
return None
return raw.decode('ascii', errors='replace').strip()
def _read_pending_lines(self) -> List[str]:
"""Every further line the controller sends before the line goes quiet."""
lines: List[str] = []
deadline = time.monotonic() + self.TRAILING_QUIET_S
while True:
if self.serial.in_waiting:
line = self._read_line()
if line:
lines.append(line)
deadline = time.monotonic() + self.TRAILING_QUIET_S
continue
if time.monotonic() >= deadline:
return lines
time.sleep(0.005)
@staticmethod
def _value_in(line: str, mnemonic: str) -> Optional[str]:
"""The value `line` holds for `mnemonic`, or None if it isn't its reply.
The controller answers "LDF = 20000 ns". A line naming a different
mnemonic is the tail of an earlier reply, and "Bit 15..0: ..." is a
status register's decode line; neither is an answer to this query.
A line naming nothing is taken as the value — that is how the serial
numbers come back.
"""
head, sep, tail = line.partition('=')
if sep:
named = head.split()
if named and named[0].upper() != mnemonic:
return None
fields = tail.split() # drop the unit suffix ("ns", "mA", "m°C")
return fields[0] if fields else None
if line.lower().startswith("bit"):
return None
fields = line.split()
if fields and fields[0].upper() == mnemonic:
return fields[1] if len(fields) > 1 else None
return line
def _query(self, command: str) -> Optional[str]:
"""Send a query and return the value from its response.
Reads until the CR terminator rather than sleeping a fixed interval:
the device usually answers in a few ms, so the old unconditional
0.05 + 0.2 s cost ~250 ms per query and made an 8-query status poll
take ~2 s — longer than the 1 s interval that scheduled it.
Reads until this command's reply arrives rather than sleeping a fixed
interval: the device usually answers in a few ms, so the old
unconditional 0.05 + 0.2 s cost ~250 ms per query and made an 8-query
status poll take ~2 s — longer than the 1 s interval that scheduled
it.
"""
fields = command.split()
mnemonic = fields[0].upper() if fields else ""
try:
# Clear any stale bytes so a previous timed-out reply can't be
# mistaken for this command's response.
# Anything volunteered while the port was idle answers no command.
self.serial.reset_input_buffer()
if not self._send_command(command):
return None
response = self.serial.read_until(b'\r').decode('ascii', errors='replace').strip()
if not response:
logger.warning(f"Query '{command}' timed out after {self.timeout}s")
return None
logger.debug(f"Query '{command}' response: {response}")
deadline = time.monotonic() + self.timeout
for _ in range(self.MAX_REPLY_LINES):
line = self._read_line()
if line is None:
break # nothing arrived within the timeout
if line:
logger.debug(f"Query '{command}' line: {line!r}")
value = self._value_in(line, mnemonic)
if value is not None:
for extra in self._read_pending_lines():
logger.debug(f"Query '{command}' trailing: {extra!r}")
return value
if time.monotonic() >= deadline:
break
# Helios format: "COMMAND = VALUE UNIT" — take just the value
if '=' in response:
parts = response.split('=')
if len(parts) >= 2:
value_part = parts[1].strip()
# Strip the unit suffix if present (e.g. "ns", "mA", "mW")
fields = value_part.split()
if fields:
return fields[0]
return response
logger.warning(f"Query '{command}' timed out after {self.timeout}s")
self._read_pending_lines()
return None
except Exception as e:
logger.error(f"Failed to read response for '{command}': {e}")
return None
def _write_command(self, command: str) -> bool:
"""Send a command with no value to read back, and clear whatever the
controller prints in acknowledgement — left in the buffer, that is
what the next query would read as its own answer.
"""
if not self._send_command(command):
return False
try:
for line in self._read_pending_lines():
logger.debug(f"Command '{command}' reply: {line!r}")
except Exception as e:
# The command went out; only the tidy-up failed.
logger.error(f"Failed to read the reply to '{command}': {e}")
return True
def _query_int(self, command: str) -> Optional[int]:
"""Query a value that should parse as an int; None if absent/unparseable."""
raw = self._query(command)
@@ -156,7 +236,7 @@ class HeliosLaser:
return False
command = f"LDF {period_ns}"
return self._send_command(command)
return self._write_command(command)
def set_current_ma(self, current: int) -> bool:
"""Set pump diode current in mA."""
@@ -165,17 +245,17 @@ class HeliosLaser:
return False
command = f"LDS {current}"
return self._send_command(command)
return self._write_command(command)
def set_pulse_mode(self, mode: PulseMode) -> bool:
"""Set pulse mode."""
command = f"LDG {mode.value}"
return self._send_command(command)
return self._write_command(command)
def set_laser_enable(self, enable: bool) -> bool:
"""Enable or disable laser emission."""
command = f"LDO {1 if enable else 0}"
success = self._send_command(command)
success = self._write_command(command)
if success:
state = "enabled" if enable else "disabled"
@@ -243,11 +323,11 @@ class HeliosLaser:
True if all three commands sent successfully
"""
ok = True
ok = self._send_command("CCE 0") and ok
ok = self._write_command("CCE 0") and ok
time.sleep(0.1)
ok = self._send_command("LCE 0") and ok
ok = self._write_command("LCE 0") and ok
time.sleep(0.1)
ok = self._send_command("LER 0") and ok
ok = self._write_command("LER 0") and ok
if ok:
logger.info("Fault reset sequence sent")
return ok
@@ -258,7 +338,11 @@ class HeliosLaser:
return None if value is None else value == 1
def send_raw_command(self, command: str) -> Optional[str]:
"""Send a raw command and return the unparsed response (diagnostics)."""
"""Send a raw command and return its whole unparsed reply (diagnostics).
Every line comes back, the "Bit 15..0: ..." decode line included:
seeing the entire reply is the point of the raw console.
"""
if not self.is_connected or not self.serial:
logger.error("Not connected to laser")
return None
@@ -266,10 +350,10 @@ class HeliosLaser:
self.serial.reset_input_buffer()
if not self._send_command(command):
return None
raw = self.serial.read_until(b'\r')
if not raw:
raw = self.serial.read(self.serial.in_waiting)
return raw.decode('ascii', errors='replace').strip()
first = self._read_line()
lines = [first] if first else []
lines += self._read_pending_lines()
return "\n".join(lines)
except Exception as e:
logger.error(f"send_raw_command error: {e}")
return None
@@ -277,7 +361,7 @@ class HeliosLaser:
def set_remote_enable(self, enable: bool) -> bool:
"""Set the remote enable state (LRE - utility connector pin 8)."""
command = f"LRE {1 if enable else 0}"
return self._send_command(command)
return self._write_command(command)
# No __del__: it used to call disconnect(), which disables the laser and
# writes to the serial port from the garbage collector at an