gronod
b2435a88b3
- Implement spectro/instlist standalone discovery utility using new_icompaths() - Emit structured JSON array to stdout with port, name, and instrument type - Support -h, -?, --help, -v, and -D command-line switches - Add instlist to spectro/Jamfile build targets - Add doc/instlist.html and register in doc/MinorTools.html
40 lines
1.9 KiB
HTML
40 lines
1.9 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<title>instlist</title>
|
|
<meta http-equiv="content-type" content="text/html;
|
|
charset=windows-1252">
|
|
<meta name="author" content="Graeme Gill">
|
|
</head>
|
|
<body>
|
|
<h2><b>spectro/instlist</b></h2>
|
|
<br>
|
|
Enumerate connected instrument communication ports (USB and Serial) and output the list in JSON format.<br>
|
|
<h3>Usage</h3>
|
|
<small><span style="font-family: monospace;"> instlist [-options]</span><br style="font-family: monospace;">
|
|
<span style="font-family: monospace;"> -h, -?, --help Show help information</span><br style="font-family: monospace;">
|
|
<span style="font-family: monospace;"> -v Verbose diagnostics to stderr</span><br style="font-family: monospace;">
|
|
<span style="font-family: monospace;"> -D [level] Print debug diagnostics to stderr</span><br style="font-family: monospace;">
|
|
</small><br>
|
|
<h3><b>Output</b></h3>
|
|
The output is emitted to <code>stdout</code> as a JSON object containing an array of discovered device objects:<br>
|
|
<pre>
|
|
{
|
|
"event": "instruments",
|
|
"devices": [
|
|
{
|
|
"port": 1,
|
|
"name": "usb:/bus0/dev1 (X-Rite i1Pro)",
|
|
"type": "i1Pro"
|
|
}
|
|
]
|
|
}
|
|
</pre>
|
|
<h3>Comments</h3>
|
|
This tool is designed to allow graphical user interfaces and external automation scripts to discover available spectrophotometers and colorimeters across Windows, macOS, and Linux without needing to parse interactive usage output.<br>
|
|
<br>
|
|
The <code>port</code> number directly corresponds to the <code>-c</code> parameter accepted by tools such as <a href="chartread.html">chartread</a>, <a href="spotread.html">spotread</a>, and <a href="dispread.html">dispread</a>.<br>
|
|
<br>
|
|
</body>
|
|
</html>
|