labrat-lab 0.1.0__tar.gz

labrat_lab-0.1.0/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

labrat_lab-0.1.0/NOTICE

@@ -0,0 +1,4 @@
+LABRAT
+Copyright 2026 Reinhard Jansen van Vuuren and the LABRAT contributors
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).

labrat_lab-0.1.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: labrat-lab
+Version: 0.1.0
+Summary: A universal interface for lab automation: a nest server, rats at the bench, one message API over HTTP and MCP
+Author: Reinhard Jansen van Vuuren
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/reinhardjvv/labrat
+Project-URL: Documentation, https://github.com/reinhardjvv/labrat/tree/main/docs
+Project-URL: Issues, https://github.com/reinhardjvv/labrat/issues
+Project-URL: Changelog, https://github.com/reinhardjvv/labrat/blob/main/CHANGELOG.md
+Keywords: laboratory automation,instrument control,SCPI,GPIO,MCP,Raspberry Pi,test and measurement
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Education
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: System :: Hardware
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: zeroconf>=0.131
+Provides-Extra: serial
+Requires-Dist: pyserial>=3.5; extra == "serial"
+Provides-Extra: gpio
+Requires-Dist: gpiod>=2.1; extra == "gpio"
+Provides-Extra: i2c
+Requires-Dist: smbus2>=0.4; extra == "i2c"
+Provides-Extra: mqtt
+Requires-Dist: paho-mqtt>=2.0; extra == "mqtt"
+Provides-Extra: rat
+Requires-Dist: labrat-lab[gpio,i2c,serial]; extra == "rat"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: build>=1; extra == "dev"
+Requires-Dist: pyserial>=3.5; extra == "dev"
+Requires-Dist: pre-commit>=3; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/labrat-dark.svg">
+    <img alt="LABRAT, Remote Automated Testing" src="docs/assets/labrat-light.svg" width="600">
+  </picture>
+</p>
+
+<h3 align="center">A universal interface for lab automation</h3>
+
+<p align="center"><i>Let the rat run the maze.</i></p>
+
+<p align="center">
+  Control oscilloscopes, signal generators, VNAs, spectrum analysers, power supplies, cameras and more through one API.
+</p>
+
+<p align="center">
+  <a href="https://github.com/reinhardjvv/labrat/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/reinhardjvv/labrat/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="LICENSE"><img alt="Licence" src="https://img.shields.io/badge/licence-Apache--2.0-blue"></a>
+</p>
+
+> [!NOTE]
+> LABRAT is in early development. The message API and the configuration may still change before 1.0, and
+> each change is listed in the [changelog](CHANGELOG.md).
+
+<p align="center">
+  <a href="#quick-start"><b>Quick start</b></a> ·
+  <a href="docs/install.md"><b>Install</b></a> ·
+  <a href="docs/api.md"><b>API</b></a> ·
+  <a href="docs/mcp.md"><b>MCP</b></a> ·
+  <a href="docs/drivers.md"><b>Drivers</b></a> ·
+  <a href="CONTRIBUTING.md"><b>Contributing</b></a>
+</p>
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/terminal-dark.svg">
+    <img alt="labrat in a terminal: the devices, a voltage set, a supply described with its live values and limits, a refused value, and stop" src="docs/assets/terminal-light.svg" width="100%">
+  </picture>
+</p>
+
+## Quick start
+
+```bash
+pipx install git+https://github.com/reinhardjvv/labrat.git
+labrat demo                       # start a demo lab with simulated instruments
+```
+
+In a second terminal, with the token the demo prints:
+
+```bash
+export LABRAT_URL=http://127.0.0.1:8780 LABRAT_TOKEN=<token>
+labrat describe psu
+labrat shell                      # an interactive prompt with tab completion
+```
+
+Connect Claude, or any MCP client, to the same lab:
+
+```bash
+claude mcp add labrat -e LABRAT_URL=$LABRAT_URL -e LABRAT_TOKEN=$LABRAT_TOKEN -- labrat mcp
+```
+
+Every client sends the same message, so curl works too:
+
+```bash
+curl -s $LABRAT_URL/api/v1/message -H "Authorization: Bearer $LABRAT_TOKEN" \
+     -d '{"op": "set", "device": "psu", "name": "VoltageLevel", "channel": "1", "value": 5}'
+```
+
+## Ask your agent
+
+With LABRAT connected over MCP, Claude or another agent works the bench the way a person would:
+
+```text
+Start an experiment called filter-check. Sweep the generator from 1 to 20 MHz in 1 MHz steps, take a scope
+trace at each step, and tell me where the response is 3 dB down.
+```
+
+The agent finds the instruments, locks them, opens an experiment in your folder, runs the sweep and reads its
+own data back. The lab's limits, locks and approvals apply to every request, and every command is logged
+under the agent's token. Give it as much freedom as you want ([MCP](docs/mcp.md)).
+
+## The nest and the rats
+
+<img alt="" src="docs/assets/rat-dark.svg#gh-dark-mode-only" width="110" align="right">
+<img alt="" src="docs/assets/rat-light.svg#gh-light-mode-only" width="110" align="right">
+
+A lab has one **nest** and any number of **rats**. The nest is the server everyone talks to. It holds the
+tokens, the limits, the locks and the audit log. The rats sit at the benches next to the equipment, and each
+one serves whatever is plugged into it. A rat can be any Linux computer, from a single-board computer to the
+PC already beside an instrument, or a microcontroller that speaks the [rat protocol](docs/rat-protocol.md).
+A small lab can run the nest alone, with its devices plugged straight in.
+
+```mermaid
+flowchart TB
+    clients["<b>clients</b><br/>Python · MATLAB · curl"] -- HTTP --> nest
+    agents["<b>AI agents</b><br/>Claude and others"] -- MCP --> nest
+    nest["<b>nest</b><br/>central server"]
+    nest --> rat1["<b>rat</b> · bench PC<br/>scopes · supplies"]
+    nest --> rat2["<b>rat</b> · Raspberry Pi<br/>cameras · SLMs"]
+    nest --> rat3["<b>rat</b> · ESP32<br/>relays · sensors"]
+    nest --> store[("<b>storage</b><br/>NAS or disk")]
+```
+
+## What it works with
+
+| Equipment | Connected by |
+| --- | --- |
+| Oscilloscopes, signal and function generators, VNAs, spectrum analysers, power supplies, multimeters, source meters and other bench instruments | Ethernet, USB or RS-232, through their standard SCPI commands |
+| Cameras: USB webcams, PoE and network cameras, machine-vision cameras such as Allied Vision, Basler and FLIR | USB, RTSP, MJPEG, GigE Vision or USB3 Vision |
+| Spatial light modulators, DMDs and projectors | HDMI |
+| Relays, shutters, interlocks, switches and sensors | GPIO pins on a rat |
+| Sensors, ADCs, DACs and port expanders | I2C on a rat |
+| Pumps, stages, controllers and Arduino boards with their own commands | serial, or a serial server on the network |
+| Smart lights and plugs, ESP32 boards and anything on a broker or a web API | MQTT or HTTP |
+| Uninterruptible power supplies | Network UPS Tools |
+| Anything else with a programming interface | a driver of a few dozen lines of Python |
+
+A bench instrument needs no code. Its commands go in a few lines of configuration
+([drivers](docs/drivers.md)), and simulated devices let you try everything without hardware.
+
+## Use it from
+
+| | |
+| --- | --- |
+| **Python** | `Client().set("bench-rat/psu", "VoltageLevel", 3.3, channel="1")` ([clients](docs/clients.md#python)) |
+| **MATLAB** | `webwrite` with a bearer token, or [`examples/matlab/labrat.m`](examples/matlab/labrat.m) ([clients](docs/clients.md#matlab)) |
+| **AI agents** | `claude mcp add labrat -- labrat mcp` ([MCP](docs/mcp.md)) |
+| **Anything else** | one HTTP endpoint and JSON ([message API](docs/api.md)) |
+
+## Set up a lab
+
+| Step | Where | Command |
+| --- | --- | --- |
+| 1 | the server | `sudo ./packaging/install.sh nest` ([install](docs/install.md#the-nest)) |
+| 2 | each bench computer | `sudo ./packaging/install.sh rat` ([install](docs/install.md#a-rat)) |
+| 3 | anywhere | `labrat find` lists the rats on the network |
+| 4 | anywhere | `labrat adopt <rat>` adds one to the nest, with the key the rat shows |
+
+Any 64-bit Linux runs a nest or a rat. Good defaults are Ubuntu Server LTS or Debian for the nest, and
+Raspberry Pi OS Lite (64-bit), DietPi or Armbian for rats on single-board computers
+([which computer and which OS](docs/install.md#choosing-hardware-and-an-operating-system)).
+
+## Questions
+
+**Does it replace PyVISA, LabVIEW or my scripts?** No. LABRAT sits between them and the equipment, so every
+script, notebook and agent sees the same instruments through the same limits and locks. LabVIEW and MATLAB
+talk to it over HTTP.
+
+**Do I need a Raspberry Pi?** No. A small lab runs the nest alone on one computer, with its instruments on the
+network or plugged in. Rats are for equipment that is spread over benches or needs local USB, GPIO or I2C.
+
+**Is it safe to let an agent drive real equipment?** The guardrails are yours to set: limits on every
+setting, locks, requests that wait for a person, and one stop that puts the whole lab in its safe state. A
+rat that loses the nest does the same by itself.
+
+**Is there a web dashboard?** Not yet. The terminal, the Python client and MCP cover everything today, and a
+dashboard will use the same API.
+
+**Can two people use the same instrument?** Not at the same time, if they lock it. `labrat lock` makes a
+device yours until you let go, `labrat who` shows who holds what, and `require_lock` makes a lock necessary
+before any change. People are added with `labrat user add`, with no restart.
+
+**Where does my data go?** Wherever you point it: a local disk or a NAS, in a folder per person and
+experiment ([experiments](docs/experiments.md)).
+
+## Documentation
+
+| | |
+| --- | --- |
+| [Architecture](docs/architecture.md) | the nest, rats, messages and how they find each other |
+| [Install](docs/install.md) | hardware, operating systems, the nest and the rats |
+| [Configuration](docs/configuration.md) | `nest.toml`, `rat.toml`, devices, limits and tokens |
+| [Message API](docs/api.md) | every operation, error code and route |
+| [Rat protocol](docs/rat-protocol.md) | what firmware must do to be a rat, for ESP32 and other boards |
+| [Clients](docs/clients.md) | Python, MATLAB, curl, JavaScript and LabVIEW |
+| [MCP](docs/mcp.md) | AI agents through the Model Context Protocol |
+| [Drivers](docs/drivers.md) | the built-in drivers and how to write one |
+| [Recordings](docs/recordings.md) | readings, waveforms and streams written to storage on a schedule |
+| [Experiments](docs/experiments.md) | each person's work in their own folder, with its commands, settings, notes and recordings |
+| [Names and selectors](docs/naming.md) | ids, identities, the standard kinds, and finding devices by type, maker or serial |
+| [Safety and security](docs/safety.md) | limits, safe states, the watchdog, tokens and the network |
+| [Roadmap](docs/roadmap.md) | what comes next |
+
+## Contributing
+
+Drivers, client libraries, documentation and bug reports are all welcome. [CONTRIBUTING.md](CONTRIBUTING.md)
+explains the workflow and the house rules. A maintainer reviews every pull request, with an automated review
+as advice on branches of this repository. Report security issues privately, as [SECURITY.md](SECURITY.md) describes.
+
+## Licence
+
+LABRAT is released under the [Apache License 2.0](LICENSE).

labrat_lab-0.1.0/README.md

@@ -0,0 +1,192 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/labrat-dark.svg">
+    <img alt="LABRAT, Remote Automated Testing" src="docs/assets/labrat-light.svg" width="600">
+  </picture>
+</p>
+
+<h3 align="center">A universal interface for lab automation</h3>
+
+<p align="center"><i>Let the rat run the maze.</i></p>
+
+<p align="center">
+  Control oscilloscopes, signal generators, VNAs, spectrum analysers, power supplies, cameras and more through one API.
+</p>
+
+<p align="center">
+  <a href="https://github.com/reinhardjvv/labrat/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/reinhardjvv/labrat/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="LICENSE"><img alt="Licence" src="https://img.shields.io/badge/licence-Apache--2.0-blue"></a>
+</p>
+
+> [!NOTE]
+> LABRAT is in early development. The message API and the configuration may still change before 1.0, and
+> each change is listed in the [changelog](CHANGELOG.md).
+
+<p align="center">
+  <a href="#quick-start"><b>Quick start</b></a> ·
+  <a href="docs/install.md"><b>Install</b></a> ·
+  <a href="docs/api.md"><b>API</b></a> ·
+  <a href="docs/mcp.md"><b>MCP</b></a> ·
+  <a href="docs/drivers.md"><b>Drivers</b></a> ·
+  <a href="CONTRIBUTING.md"><b>Contributing</b></a>
+</p>
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/terminal-dark.svg">
+    <img alt="labrat in a terminal: the devices, a voltage set, a supply described with its live values and limits, a refused value, and stop" src="docs/assets/terminal-light.svg" width="100%">
+  </picture>
+</p>
+
+## Quick start
+
+```bash
+pipx install git+https://github.com/reinhardjvv/labrat.git
+labrat demo                       # start a demo lab with simulated instruments
+```
+
+In a second terminal, with the token the demo prints:
+
+```bash
+export LABRAT_URL=http://127.0.0.1:8780 LABRAT_TOKEN=<token>
+labrat describe psu
+labrat shell                      # an interactive prompt with tab completion
+```
+
+Connect Claude, or any MCP client, to the same lab:
+
+```bash
+claude mcp add labrat -e LABRAT_URL=$LABRAT_URL -e LABRAT_TOKEN=$LABRAT_TOKEN -- labrat mcp
+```
+
+Every client sends the same message, so curl works too:
+
+```bash
+curl -s $LABRAT_URL/api/v1/message -H "Authorization: Bearer $LABRAT_TOKEN" \
+     -d '{"op": "set", "device": "psu", "name": "VoltageLevel", "channel": "1", "value": 5}'
+```
+
+## Ask your agent
+
+With LABRAT connected over MCP, Claude or another agent works the bench the way a person would:
+
+```text
+Start an experiment called filter-check. Sweep the generator from 1 to 20 MHz in 1 MHz steps, take a scope
+trace at each step, and tell me where the response is 3 dB down.
+```
+
+The agent finds the instruments, locks them, opens an experiment in your folder, runs the sweep and reads its
+own data back. The lab's limits, locks and approvals apply to every request, and every command is logged
+under the agent's token. Give it as much freedom as you want ([MCP](docs/mcp.md)).
+
+## The nest and the rats
+
+<img alt="" src="docs/assets/rat-dark.svg#gh-dark-mode-only" width="110" align="right">
+<img alt="" src="docs/assets/rat-light.svg#gh-light-mode-only" width="110" align="right">
+
+A lab has one **nest** and any number of **rats**. The nest is the server everyone talks to. It holds the
+tokens, the limits, the locks and the audit log. The rats sit at the benches next to the equipment, and each
+one serves whatever is plugged into it. A rat can be any Linux computer, from a single-board computer to the
+PC already beside an instrument, or a microcontroller that speaks the [rat protocol](docs/rat-protocol.md).
+A small lab can run the nest alone, with its devices plugged straight in.
+
+```mermaid
+flowchart TB
+    clients["<b>clients</b><br/>Python · MATLAB · curl"] -- HTTP --> nest
+    agents["<b>AI agents</b><br/>Claude and others"] -- MCP --> nest
+    nest["<b>nest</b><br/>central server"]
+    nest --> rat1["<b>rat</b> · bench PC<br/>scopes · supplies"]
+    nest --> rat2["<b>rat</b> · Raspberry Pi<br/>cameras · SLMs"]
+    nest --> rat3["<b>rat</b> · ESP32<br/>relays · sensors"]
+    nest --> store[("<b>storage</b><br/>NAS or disk")]
+```
+
+## What it works with
+
+| Equipment | Connected by |
+| --- | --- |
+| Oscilloscopes, signal and function generators, VNAs, spectrum analysers, power supplies, multimeters, source meters and other bench instruments | Ethernet, USB or RS-232, through their standard SCPI commands |
+| Cameras: USB webcams, PoE and network cameras, machine-vision cameras such as Allied Vision, Basler and FLIR | USB, RTSP, MJPEG, GigE Vision or USB3 Vision |
+| Spatial light modulators, DMDs and projectors | HDMI |
+| Relays, shutters, interlocks, switches and sensors | GPIO pins on a rat |
+| Sensors, ADCs, DACs and port expanders | I2C on a rat |
+| Pumps, stages, controllers and Arduino boards with their own commands | serial, or a serial server on the network |
+| Smart lights and plugs, ESP32 boards and anything on a broker or a web API | MQTT or HTTP |
+| Uninterruptible power supplies | Network UPS Tools |
+| Anything else with a programming interface | a driver of a few dozen lines of Python |
+
+A bench instrument needs no code. Its commands go in a few lines of configuration
+([drivers](docs/drivers.md)), and simulated devices let you try everything without hardware.
+
+## Use it from
+
+| | |
+| --- | --- |
+| **Python** | `Client().set("bench-rat/psu", "VoltageLevel", 3.3, channel="1")` ([clients](docs/clients.md#python)) |
+| **MATLAB** | `webwrite` with a bearer token, or [`examples/matlab/labrat.m`](examples/matlab/labrat.m) ([clients](docs/clients.md#matlab)) |
+| **AI agents** | `claude mcp add labrat -- labrat mcp` ([MCP](docs/mcp.md)) |
+| **Anything else** | one HTTP endpoint and JSON ([message API](docs/api.md)) |
+
+## Set up a lab
+
+| Step | Where | Command |
+| --- | --- | --- |
+| 1 | the server | `sudo ./packaging/install.sh nest` ([install](docs/install.md#the-nest)) |
+| 2 | each bench computer | `sudo ./packaging/install.sh rat` ([install](docs/install.md#a-rat)) |
+| 3 | anywhere | `labrat find` lists the rats on the network |
+| 4 | anywhere | `labrat adopt <rat>` adds one to the nest, with the key the rat shows |
+
+Any 64-bit Linux runs a nest or a rat. Good defaults are Ubuntu Server LTS or Debian for the nest, and
+Raspberry Pi OS Lite (64-bit), DietPi or Armbian for rats on single-board computers
+([which computer and which OS](docs/install.md#choosing-hardware-and-an-operating-system)).
+
+## Questions
+
+**Does it replace PyVISA, LabVIEW or my scripts?** No. LABRAT sits between them and the equipment, so every
+script, notebook and agent sees the same instruments through the same limits and locks. LabVIEW and MATLAB
+talk to it over HTTP.
+
+**Do I need a Raspberry Pi?** No. A small lab runs the nest alone on one computer, with its instruments on the
+network or plugged in. Rats are for equipment that is spread over benches or needs local USB, GPIO or I2C.
+
+**Is it safe to let an agent drive real equipment?** The guardrails are yours to set: limits on every
+setting, locks, requests that wait for a person, and one stop that puts the whole lab in its safe state. A
+rat that loses the nest does the same by itself.
+
+**Is there a web dashboard?** Not yet. The terminal, the Python client and MCP cover everything today, and a
+dashboard will use the same API.
+
+**Can two people use the same instrument?** Not at the same time, if they lock it. `labrat lock` makes a
+device yours until you let go, `labrat who` shows who holds what, and `require_lock` makes a lock necessary
+before any change. People are added with `labrat user add`, with no restart.
+
+**Where does my data go?** Wherever you point it: a local disk or a NAS, in a folder per person and
+experiment ([experiments](docs/experiments.md)).
+
+## Documentation
+
+| | |
+| --- | --- |
+| [Architecture](docs/architecture.md) | the nest, rats, messages and how they find each other |
+| [Install](docs/install.md) | hardware, operating systems, the nest and the rats |
+| [Configuration](docs/configuration.md) | `nest.toml`, `rat.toml`, devices, limits and tokens |
+| [Message API](docs/api.md) | every operation, error code and route |
+| [Rat protocol](docs/rat-protocol.md) | what firmware must do to be a rat, for ESP32 and other boards |
+| [Clients](docs/clients.md) | Python, MATLAB, curl, JavaScript and LabVIEW |
+| [MCP](docs/mcp.md) | AI agents through the Model Context Protocol |
+| [Drivers](docs/drivers.md) | the built-in drivers and how to write one |
+| [Recordings](docs/recordings.md) | readings, waveforms and streams written to storage on a schedule |
+| [Experiments](docs/experiments.md) | each person's work in their own folder, with its commands, settings, notes and recordings |
+| [Names and selectors](docs/naming.md) | ids, identities, the standard kinds, and finding devices by type, maker or serial |
+| [Safety and security](docs/safety.md) | limits, safe states, the watchdog, tokens and the network |
+| [Roadmap](docs/roadmap.md) | what comes next |
+
+## Contributing
+
+Drivers, client libraries, documentation and bug reports are all welcome. [CONTRIBUTING.md](CONTRIBUTING.md)
+explains the workflow and the house rules. A maintainer reviews every pull request, with an automated review
+as advice on branches of this repository. Report security issues privately, as [SECURITY.md](SECURITY.md) describes.
+
+## Licence
+
+LABRAT is released under the [Apache License 2.0](LICENSE).