A HTTP API használata: BeamBench

A Beam Bench vezérlése bármely HTTP-kliensből. Ugyanazok a műveletek, mint a CLI esetén, integrációbarát módon.

A Beam Bench HTTP / WebSocket API-ja ugyanaz a felület, amelyhez a CLI kapcsolódik. Ha olyan használati esete van, amelyhez a Beam Bench nem CLI-környezetben szükséges, például webalkalmazásban, integrációs szerveren vagy mobilalkalmazásban, használja közvetlenül a HTTP API-t.

Amire szüksége van

Telepített Beam Bench.
A Helyi API engedélyezve az Edit → Settings → General menüben. Alapértelmezés szerint ki van kapcsolva.
HTTP-kliens, például curl, a programozási nyelv HTTP-könyvtára, Postman stb.

Ellenőrizze, hogy a API engedélyezve van-e

Az aktuális összeállítás alapértelmezései szándékosan korlátozottak:

Helyi API: ki.
API-port: 5900.
Hálózati eszközök csatlakozásának engedélyezése: ki. Amíg ki van kapcsolva, a szerver csak erről a számítógépről fogad kapcsolatokat.

Nyissa meg az asztali alkalmazást, lépjen az Edit → Settings → General menübe, és kapcsolja be a Helyi API lehetőséget. Az ugyanazon a számítógépen futó szkriptekhez hagyja kikapcsolva a Hálózati eszközök csatlakozásának engedélyezése lehetőséget. A beállítások azonnal érvénybe lépnek.

Olvassa el a HTTP API oldalát, mielőtt megosztott Wi-Fi-hálózaton hálózati kötést hoz létre. Az API nem használ hitelesítést, és képes mozgatni a gépet, valamint elsütni a lézert.

Alap URL

http://localhost:5900/api/v1

(Vagy a localhost helyett a gép LAN-IP-címe, ha a Hálózati eszközök csatlakozásának engedélyezése be van kapcsolva.)

Lépések

1. Ellenőrizze, hogy az API működik-e

curl -s http://localhost:5900/api/v1/agent/capabilities | jq .

Visszaadja a képességsémát. (Ha módosította, cserélje le az 5900 értéket a beállított portra.)

2. Állapot vizsgálata

curl -s http://localhost:5900/api/v1/agent/state | jq .

3. Projekt megnyitása

curl -s -X POST http://localhost:5900/api/v1/projects/open \
  -H 'Content-Type: application/json' \
  -d '{"path":"/abs/path/to/file.lzrproj"}'

4. A terv renderelése a futó szerveren keresztül

curl -s -X POST http://localhost:5900/api/v1/design/render \
  -H 'Content-Type: application/json' \
  -d '{"format":"png","pixels_per_mm":4,"output_path":"/tmp/out.png"}'

5. Kamerarendszer állapotának lekérése

curl -s http://localhost:5900/api/v1/camera/state | jq .

6. Kamerafelület renderelése az alkalmazás előfelületén keresztül

curl -s -X POST http://localhost:5900/api/v1/camera/overlay/render \
  -H 'Content-Type: application/json' \
  -d '{"output_path":"/tmp/overlay.png","view":"fit","keep":true}'

Elérhető végpontcsoportok

A teljes felületért tekintse meg az API-referencia szakaszt, amikor feltöltötték. Főbb csoportok:

/agent, capabilities, state, guide.
/camera, devices, state, capture, overlay (display, transform, render), calibration, alignment.
/design, describe, render, transactions.
/projects, open, save, close, layers, objects, undo/redo, import.
/export, svg, dxf, pdf, eps, ai.

Biztonság

Az API-szerver nem használ hitelesítést. Feltételezi, hogy a hálózat, amelyen működik, megbízható.

A csak localhosthoz kötés a helyi gépre korlátozza a kitettséget.
A hálózati kötés külön engedélyezhető, és az API-t megnyitja ugyanazon a LAN-on bárki számára. Csak megbízható hálózaton engedélyezze.

Ellenőrizze, hogy működött-e

A curl agent/capabilities JSON-t ad vissza.
Egy renderelési hívás létrehozza a kért fájlt.

A HTTP API használata