Labs · Sensors and cameras

APS storage-ring machine parameters (apstools, read only)

APS storage-ring machine parameters (apstools, read only), adapted from bcda-aps/apstools. It reads current, machine_status, operating_mode, shutter_status and 4 more. A hardware driver: the market serves its fake backend, so no instrument is needed.

hardwareRisk R0BSD-3-Clausecontract_checkedserved on the fake backend
openai4s lab add labs/bcda-aps__apstools

Install

Three ways to run this device. Each one serves its fake backend: no instrument, no simulator install and no upstream checkout.

OpenAI4S (one command)

shell
openai4s lab add labs/bcda-aps__apstools

Installs the device into the OpenAI4S Lab on its fake backend and starts it. First time? See setup below.

Or, in the workbench, open the Lab tab → Market → Install.

Standalone MHS endpoint

shell
git clone --depth 1 https://github.com/PKU-YuanGroup/OpenMHS.git && cd OpenMHS
PYTHONPATH=MHS/sdk/src python3 -m mhs serve labs/bcda-aps__apstools --port 7400
# in a second terminal, from the same directory:
PYTHONPATH=MHS/sdk/src python3 -m mhs describe --endpoint http://127.0.0.1:7400

Serves the device as an MHS endpoint on port 7400 from an OpenMHS clone (Python 3.10 or later, standard library only); describe prints what it offers.

Any MCP host (Claude Desktop, Cursor, …)

mcp configuration
{
  "mcpServers": {
    "apstools": {
      "command": "python3",
      "args": [
        "-m",
        "mhs",
        "serve",
        "labs/bcda-aps__apstools",
        "--mcp"
      ],
      "env": {
        "PYTHONPATH": "/path/to/OpenMHS/MHS/sdk/src"
      }
    }
  }
}

Add this server to the host's MCP configuration and replace /path/to/OpenMHS with the path of your OpenMHS clone. The host starts the server and talks to it on stdin and stdout.

What it does

Measures

  • current
  • machine_status
  • operating_mode
  • shutter_status
  • shutters_open
  • fill_number
  • orbit_correction
  • read_ring_current

Adjusts

Nothing declared.

Actions

No actions declared: this device is read and set through its values only.

Names as the driver declares them. Units, limits and the safety declaration are in the package's REFERENCE.md.

First-time setup

The OpenAI4S workbench with the OpenMHS lab, from a source checkout:

shell
# OpenAI4S workbench with the OpenMHS lab (source checkout)
git clone --recursive https://github.com/PKU-YuanGroup/OpenAI4S.git
cd OpenAI4S && ./setup.sh && source .venv/bin/activate
openai4s lab add labs/bcda-aps__apstools
openai4s serve        # open the Lab tab

The standalone endpoint and the MCP server need only an OpenMHS clone and Python 3.10 or later. More in the market's getting-started guide and on the OpenAI4S host page.

Source and evidence

Pinned commit
6250dbaa2f04
Licence
BSD-3-Clause
Stars
19
Evidence
contract_checked on the fake backend
Backends
fake, hardware

The driver package MHS/drivers/labs/bcda-aps__apstools wraps the upstream code at the pinned commit. Its REFERENCE.md documents the full contract: every value, action, unit, limit and the safety declaration.