Použití HTTP API

Ovládejte Beam Bench z libovolného HTTP klienta. Stejné operace jako CLI, vhodné pro integraci.

HTTP / WebSocket API Beam Bench je stejné rozhraní, se kterým komunikuje CLI. Pokud máte případ použití, který vyžaduje Beam Bench v prostředí bez CLI, například webové aplikaci, integračním serveru nebo mobilní aplikaci, použijte přímo HTTP API.

Co potřebujete

Nainstalovaný Beam Bench.
Povolené Local API v Úpravy → Nastavení → Obecné. Ve výchozím nastavení se dodává vypnuté.
HTTP klienta (curl, HTTP knihovnu vašeho jazyka, Postman atd.).

Ověření, že je API povoleno

Výchozí hodnoty v aktuálním sestavení jsou záměrně uzamčené:

Local API: vypnuto.
Port API: 5900.
Povolit připojení síťových zařízení: vypnuto. Dokud zůstane vypnuté, server přijímá připojení pouze z tohoto počítače.

Otevřete desktopovou aplikaci, přejděte do Úpravy → Nastavení → Obecné a zapněte Local API. Pro skripty spuštěné na stejném počítači ponechte Povolit připojení síťových zařízení vypnuté. Nastavení se projeví okamžitě.

Před připojením k síti ve sdílené Wi-Fi si přečtěte stránku HTTP API. API nemá ověřování a může pohybovat strojem i zapnout laser.

Základní URL

http://localhost:5900/api/v1

(Nebo IP adresu LAN vašeho stroje místo localhost, když je zapnuto Povolit připojení síťových zařízení.)

Postup

1. Ověřte, že API běží

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

Vrátí schéma schopností. (Pokud jste ho změnili, nahraďte 5900 nakonfigurovaným portem.)

2. Zkontrolujte stav

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

3. Otevřete projekt

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

4. Vykreslete návrh prostřednictvím spuštěného serveru

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. Získejte stav kamery

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

6. Vykreslete překrytí kamery prostřednictvím frontendu aplikace

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}'

Dostupné skupiny koncových bodů

Úplné rozhraní najdete v části Reference API, až bude naplněna. Hlavní skupiny:

/agent, schopnosti, stav, průvodce.
/camera, zařízení, stav, zachycení, překrytí (zobrazení, transformace, vykreslení), kalibrace, zarovnání.
/design, popis, vykreslení, transakce.
/projects, otevření, uložení, zavření, vrstvy, objekty, zpět/znovu, import.
/export, svg, dxf, pdf, eps, ai.

Zabezpečení

Server API nemá ověřování. Předpokládá, že síť, ve které se nachází, je důvěryhodná.

Vazba pouze na localhost omezuje vystavení na místní počítač.
Síťová vazba je samostatná volitelná funkce a zpřístupní API komukoli ve stejné LAN. Povolte ji pouze v důvěryhodné síti.

Ověřte, že vše funguje

curl agent/capabilities vrátí JSON.
Volání vykreslení vytvoří požadovaný soubor.