muxit 0.1.0__tar.gz

muxit-0.1.0/.gitignore

@@ -0,0 +1,99 @@
+## .NET build output
+MuxitServer/bin/
+MuxitServer/obj/
+MuxitServer.Tests/bin/
+MuxitServer.Tests/obj/
+drivers/**/bin/
+drivers/**/obj/
+# Vendored third-party SDKs ship source, not binaries. ~130 .dll/.pdb/.exe files
+# under references/fairino-sdk were tracked (the only tracked build output in the
+# repo, most of its 15 MB) until they were untracked.
+references/**/bin/
+references/**/obj/
+tools/**/bin/
+tools/**/obj/
+
+## Web UI build output (generated by `node build.js ui`)
+MuxitServer/wwwroot/assets/
+MuxitServer/wwwroot/index.html
+MuxitServer/wwwroot/logs.html
+MuxitServer/wwwroot/logs.js
+
+
+## Docs site build output (generated by `node build.js docs`)
+MuxitServer/wwwroot/docs/
+
+## Node.js
+node_modules/
+web-ui/node_modules/
+docs-site/node_modules/
+docs-site/.vitepress/cache/
+docs-site/.vitepress/dist/
+# Astro's generated content/type cache. Six of these files were tracked until
+# they were untracked; `astro dev` and `astro build` rewrite them every run.
+website/.astro/
+website/dist/
+
+# Lockfiles are committed. Every npm project here has one tracked, so `npm ci`
+# is reproducible everywhere. There is deliberately no ignore rule: the old one
+# ignored package-lock.json globally with a single `!tests/` exception while five
+# of them were force-added anyway, so the rule and the repo disagreed.
+
+## NuGet
+*.nupkg
+*.snupkg
+
+## Visual Studio
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+.vs/
+
+## Dev license keys (NEVER commit — devkeys.txt was tracked until it was removed)
+devkeys*
+
+## Driver signing keys (NEVER commit private keys)
+muxit-driver-private.xml
+*-private.xml
+*-private.pem
+
+## Local secrets for the dev console (Lemon Squeezy API key, etc.)
+dev-console/.dev-keys.json
+
+## Dev console caches (e.g. cloned driver-registry for the publish wizard)
+.cache/
+
+## Release testing
+publish/
+test-install/
+
+## Build output (driver packages)
+dist/
+
+## Development workspace (runtime only, not tracked — use workspace-template/ for examples)
+workspace/
+
+## OS files
+Thumbs.db
+desktop.ini
+.DS_Store
+
+.dev.vars
+
+## Python (driver SDK + Tier 2 drivers)
+__pycache__/
+*.pyc
+*.pyo
+# `pip install -e drivers/py` (documented in docs-site/reference/driver-sdk-python.md)
+*.egg-info/
+# Per-driver venvs the host creates from a driver's requirements.txt
+drivers/py/*/.venv/
+
+## Claude Code — personal overrides (never commit)
+.claude/settings.local.json
+
+*.csproj.lscache
+
+# Simulated license tier for local dev (node muxit.js → t)
+.muxit-dev.json

muxit-0.1.0/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog — muxit (Python client)
+
+The Python client versions on its own, separately from Muxit itself. Changes to the
+server that it depends on are in Muxit's revision history.
+
+## 0.1.0 — unreleased
+
+First preview.
+
+- `muxit.connect()` with host, port, password and token, each falling back to
+  `MUXIT_HOST` / `MUXIT_PORT` / `MUXIT_PASSWORD` / `MUXIT_TOKEN` / `MUXIT_TIMEOUT`.
+  On the Muxit computer itself the startup token is found automatically from Muxit's
+  workspace catalog.
+- Connectors as objects: `psu.voltage = 3`, `psu.voltage`, `psu.reset()`; explicit
+  `read` / `write` / `call`; snake_case aliases; tab completion and a property table in
+  Jupyter; spelling suggestions; read-only writes refused before anything is sent.
+- `muxit.SimulatedWarning` when the Observe safety level simulated a write or action;
+  calls that wait for a confirmation in the Muxit UI print a notice and do not time out.
+- Exceptions with the server's error code and a hint: `ConnectionFailed`,
+  `AuthenticationFailed`, `NotFound` / `UnknownName`, `ReadOnly`, `SafetyBlocked`,
+  `LimitReached`, `Timeout`.
+- `python -m muxit doctor | list | get | set | call | demo`.
+- Works with any Muxit that serves the WebSocket API. The simulated warning, the
+  confirmation notice and the `client:python-…` label in the audit log need the first
+  Muxit release after 0.45.0; an older server simply sends none of them.

muxit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Muxit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

muxit-0.1.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.5
+Name: muxit
+Version: 0.1.0
+Summary: Drive the instruments you set up in Muxit from Python and Jupyter: psu.voltage = 3.
+Project-URL: Homepage, https://muxit.io
+Project-URL: Documentation, https://docs.muxit.io/guides/python-client
+Author: Muxit
+License-Expression: MIT
+License-File: LICENSE
+Keywords: instrument control,jupyter,lab automation,muxit,scpi,test and measurement
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.9
+Requires-Dist: websockets>=12
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == 'test'
+Description-Content-Type: text/markdown
+
+# muxit — Muxit for Python
+
+Set up your instruments once in [Muxit](https://muxit.io). Use them from Python, the dashboard
+and AI at the same time.
+
+```python
+import muxit
+
+m = muxit.connect()            # Muxit on this computer
+psu = m.connector("psu")
+
+psu.voltage = 3.0              # write a property
+print(psu.voltage)             # read it back from the device
+psu.reset()                    # call an action
+```
+
+No VISA install, no SCPI strings, no COM ports on the machine that runs Python: the
+connection details live in the Muxit connector. The client talks only to the Muxit server you
+point it at. It sends nothing anywhere else.
+
+## Install
+
+```bash
+pip install muxit
+```
+
+Python 3.9 or newer. The only dependency is [`websockets`](https://pypi.org/project/websockets/).
+You also need Muxit running, on this computer or another one on your network.
+
+## Check the connection first
+
+```bash
+python -m muxit doctor
+```
+
+It shows where the client looks for Muxit, whether Muxit answers, the license tier, the
+safety level and the connectors. It ends with the line to paste into Python. `python -m
+muxit demo` reads and writes the built-in test device, so it works without hardware.
+
+## Connecting
+
+```python
+m = muxit.connect()                                   # 127.0.0.1:8765
+m = muxit.connect("192.168.1.20")                     # another computer, default port
+m = muxit.connect("192.168.1.20", port=9000)
+m = muxit.connect("192.168.1.20", password="...")     # Muxit with remote access on
+m = muxit.connect("ws://lab-pc.local:8765/ws")        # a full URL works too
+
+with muxit.connect() as m:                            # closes the connection at the end
+    ...
+```
+
+Each setting comes from the argument first, then the environment variable, then the
+default:
+
+| Setting  | Argument   | Environment      | Default     |
+|----------|------------|------------------|-------------|
+| Host     | 1st / `host` | `MUXIT_HOST`   | `127.0.0.1` |
+| Port     | `port`     | `MUXIT_PORT`     | `8765`      |
+| Password | `password` | `MUXIT_PASSWORD` | —           |
+| Token    | `token`    | `MUXIT_TOKEN`    | —           |
+| Timeout  | `timeout`  | `MUXIT_TIMEOUT`  | `10` s      |
+
+With the environment variables set, a notebook holds no address or password and can be
+shared. No password is needed on the Muxit computer itself. From another computer, Muxit
+needs remote access on and a password set (Settings › Remote access).
+
+## Connectors, properties and actions
+
+```python
+m.connectors()                 # ['psu', 'dmm', 'test-device']
+
+psu = m.connector("psu")
+psu = m["bk-psu"]              # a name with a dash
+psu = m.bk_psu                 # ...or with the dash as underscore
+
+psu.voltage = 3.0              # write
+v = psu.voltage                # read (Muxit's latest polled value)
+psu.output = True
+psu.reset()                    # action
+robot.moveAbsolute([100, 200, 50])
+robot.move_absolute([100, 200, 50])   # snake_case works when the name is free
+
+psu.read("voltage")            # explicit forms, for names in a variable
+psu.write("voltage", 3.0)
+psu.call("moveAbsolute", [100, 200, 50])
+
+print(psu.describe())          # every property and action, with units
+```
+
+The client fetches each connector's list of properties and actions on first use. So
+`psu.voltge` fails at once with `Did you mean 'voltage'?`, writing a read-only property is
+refused before anything is sent, and Tab completes names in Jupyter.
+
+**Reads are Muxit's latest value.** Muxit polls the properties of a driver
+continuously, every 200 ms by default (`polling.connectorRate`). Straight after a write, a
+read can still show the old value for one poll interval. In a sweep, wait for the device
+to settle (`time.sleep(...)`) before you read, as you would anyway. Properties that the
+connector file defines itself are read live.
+
+Values come back as plain Python: numbers, `True`/`False`, strings, lists and dicts. numpy
+values can be sent directly.
+
+## When something goes wrong
+
+Everything raised is a `muxit.MuxitError` with a message that says what to do.
+`.code` holds the server's error code.
+
+| Exception | When |
+|-----------|------|
+| `muxit.ConnectionFailed` | Muxit is not reachable, or the connection dropped |
+| `muxit.AuthenticationFailed` | wrong or missing password or token |
+| `muxit.NotFound` | no such connector, property or action (also an `AttributeError`) |
+| `muxit.ReadOnly` | writing a property that can only be read |
+| `muxit.SafetyBlocked` | Muxit's safety gate refused the write or action |
+| `muxit.LimitReached` | a license limit or the per-connection call rate |
+| `muxit.Timeout` | no answer within the timeout |
+
+**`muxit.SimulatedWarning`.** On the *Observe* safety level Muxit simulates writes and
+actions instead of sending them. A new Free installation starts on Observe. The client
+then warns that nothing reached the device. Pick another level with the safety chip in the
+Muxit window.
+
+**Confirmations.** If the connector asks for a confirmation before a write, the call waits
+for someone to click it in the Muxit window. While it waits it prints `Waiting for
+confirmation in the Muxit UI`, and it does not time out.
+
+## Good to know
+
+- Every read and write is a round trip to the server, about a millisecond locally plus the
+  device's own time. That is fine for setpoints and measurements, but not for kHz control
+  loops.
+- Muxit allows 50 calls per second per connection by default
+  (`security.rateLimit.callsPerSec`).
+- Stopping scripts in the Muxit window does not stop your Python program. Use Ctrl+C.
+- Free runs 3 connectors. Per-connector safety limits (`safety.limits`) are a Lab feature.
+  They apply to calls from Python too.
+
+## License
+
+MIT. See [`LICENSE`](LICENSE). Muxit itself is licensed separately.

muxit-0.1.0/README.md

@@ -0,0 +1,141 @@
+# muxit — Muxit for Python
+
+Set up your instruments once in [Muxit](https://muxit.io). Use them from Python, the dashboard
+and AI at the same time.
+
+```python
+import muxit
+
+m = muxit.connect()            # Muxit on this computer
+psu = m.connector("psu")
+
+psu.voltage = 3.0              # write a property
+print(psu.voltage)             # read it back from the device
+psu.reset()                    # call an action
+```
+
+No VISA install, no SCPI strings, no COM ports on the machine that runs Python: the
+connection details live in the Muxit connector. The client talks only to the Muxit server you
+point it at. It sends nothing anywhere else.
+
+## Install
+
+```bash
+pip install muxit
+```
+
+Python 3.9 or newer. The only dependency is [`websockets`](https://pypi.org/project/websockets/).
+You also need Muxit running, on this computer or another one on your network.
+
+## Check the connection first
+
+```bash
+python -m muxit doctor
+```
+
+It shows where the client looks for Muxit, whether Muxit answers, the license tier, the
+safety level and the connectors. It ends with the line to paste into Python. `python -m
+muxit demo` reads and writes the built-in test device, so it works without hardware.
+
+## Connecting
+
+```python
+m = muxit.connect()                                   # 127.0.0.1:8765
+m = muxit.connect("192.168.1.20")                     # another computer, default port
+m = muxit.connect("192.168.1.20", port=9000)
+m = muxit.connect("192.168.1.20", password="...")     # Muxit with remote access on
+m = muxit.connect("ws://lab-pc.local:8765/ws")        # a full URL works too
+
+with muxit.connect() as m:                            # closes the connection at the end
+    ...
+```
+
+Each setting comes from the argument first, then the environment variable, then the
+default:
+
+| Setting  | Argument   | Environment      | Default     |
+|----------|------------|------------------|-------------|
+| Host     | 1st / `host` | `MUXIT_HOST`   | `127.0.0.1` |
+| Port     | `port`     | `MUXIT_PORT`     | `8765`      |
+| Password | `password` | `MUXIT_PASSWORD` | —           |
+| Token    | `token`    | `MUXIT_TOKEN`    | —           |
+| Timeout  | `timeout`  | `MUXIT_TIMEOUT`  | `10` s      |
+
+With the environment variables set, a notebook holds no address or password and can be
+shared. No password is needed on the Muxit computer itself. From another computer, Muxit
+needs remote access on and a password set (Settings › Remote access).
+
+## Connectors, properties and actions
+
+```python
+m.connectors()                 # ['psu', 'dmm', 'test-device']
+
+psu = m.connector("psu")
+psu = m["bk-psu"]              # a name with a dash
+psu = m.bk_psu                 # ...or with the dash as underscore
+
+psu.voltage = 3.0              # write
+v = psu.voltage                # read (Muxit's latest polled value)
+psu.output = True
+psu.reset()                    # action
+robot.moveAbsolute([100, 200, 50])
+robot.move_absolute([100, 200, 50])   # snake_case works when the name is free
+
+psu.read("voltage")            # explicit forms, for names in a variable
+psu.write("voltage", 3.0)
+psu.call("moveAbsolute", [100, 200, 50])
+
+print(psu.describe())          # every property and action, with units
+```
+
+The client fetches each connector's list of properties and actions on first use. So
+`psu.voltge` fails at once with `Did you mean 'voltage'?`, writing a read-only property is
+refused before anything is sent, and Tab completes names in Jupyter.
+
+**Reads are Muxit's latest value.** Muxit polls the properties of a driver
+continuously, every 200 ms by default (`polling.connectorRate`). Straight after a write, a
+read can still show the old value for one poll interval. In a sweep, wait for the device
+to settle (`time.sleep(...)`) before you read, as you would anyway. Properties that the
+connector file defines itself are read live.
+
+Values come back as plain Python: numbers, `True`/`False`, strings, lists and dicts. numpy
+values can be sent directly.
+
+## When something goes wrong
+
+Everything raised is a `muxit.MuxitError` with a message that says what to do.
+`.code` holds the server's error code.
+
+| Exception | When |
+|-----------|------|
+| `muxit.ConnectionFailed` | Muxit is not reachable, or the connection dropped |
+| `muxit.AuthenticationFailed` | wrong or missing password or token |
+| `muxit.NotFound` | no such connector, property or action (also an `AttributeError`) |
+| `muxit.ReadOnly` | writing a property that can only be read |
+| `muxit.SafetyBlocked` | Muxit's safety gate refused the write or action |
+| `muxit.LimitReached` | a license limit or the per-connection call rate |
+| `muxit.Timeout` | no answer within the timeout |
+
+**`muxit.SimulatedWarning`.** On the *Observe* safety level Muxit simulates writes and
+actions instead of sending them. A new Free installation starts on Observe. The client
+then warns that nothing reached the device. Pick another level with the safety chip in the
+Muxit window.
+
+**Confirmations.** If the connector asks for a confirmation before a write, the call waits
+for someone to click it in the Muxit window. While it waits it prints `Waiting for
+confirmation in the Muxit UI`, and it does not time out.
+
+## Good to know
+
+- Every read and write is a round trip to the server, about a millisecond locally plus the
+  device's own time. That is fine for setpoints and measurements, but not for kHz control
+  loops.
+- Muxit allows 50 calls per second per connection by default
+  (`security.rateLimit.callsPerSec`).
+- Stopping scripts in the Muxit window does not stop your Python program. Use Ctrl+C.
+- Free runs 3 connectors. Per-connector safety limits (`safety.limits`) are a Lab feature.
+  They apply to calls from Python too.
+
+## License
+
+MIT. See [`LICENSE`](LICENSE). Muxit itself is licensed separately.

muxit-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "muxit"
+dynamic = ["version"]
+description = "Drive the instruments you set up in Muxit from Python and Jupyter: psu.voltage = 3."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+authors = [{ name = "Muxit" }]
+keywords = ["lab automation", "instrument control", "scpi", "test and measurement", "jupyter", "muxit"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator",
+    "Topic :: System :: Hardware",
+]
+dependencies = ["websockets>=12"]
+
+[project.optional-dependencies]
+test = ["pytest>=7"]
+
+[project.urls]
+Homepage = "https://muxit.io"
+Documentation = "https://docs.muxit.io/guides/python-client"
+
+[project.scripts]
+muxit = "muxit.__main__:main"
+
+[tool.hatch.version]
+path = "src/muxit/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/muxit"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests/unit"]

muxit-0.1.0/src/muxit/__init__.py

@@ -0,0 +1,46 @@
+"""Drive the instruments you set up in Muxit from Python.
+
+    import muxit
+
+    m = muxit.connect()            # Muxit on this computer
+    psu = m.connector("psu")
+    psu.voltage = 3.0              # write
+    print(psu.voltage)             # read (Muxit's latest polled value)
+    psu.reset()                    # action
+
+Docs: https://docs.muxit.io/guides/python-client
+"""
+
+from ._version import __version__
+from .client import Muxit, Settings, connect
+from .connector import Connector
+from .errors import (
+    AuthenticationFailed,
+    ConnectionFailed,
+    LimitReached,
+    MuxitError,
+    NotFound,
+    ReadOnly,
+    SafetyBlocked,
+    SimulatedWarning,
+    Timeout,
+    UnknownName,
+)
+
+__all__ = [
+    "__version__",
+    "connect",
+    "Muxit",
+    "Connector",
+    "Settings",
+    "MuxitError",
+    "ConnectionFailed",
+    "AuthenticationFailed",
+    "NotFound",
+    "UnknownName",
+    "ReadOnly",
+    "SafetyBlocked",
+    "LimitReached",
+    "Timeout",
+    "SimulatedWarning",
+]