Documentación de Beam Bench

Usar la CLI

Inspecciona y edita la aplicación en ejecución mediante su API local, o exporta G-code directamente.

El binario beambench-cli se distribuye junto con la aplicación de escritorio. La mayoría de los comandos de proyecto, diseño, máquina, perfil y estado son clientes de la API local de la aplicación. Requieren que la aplicación esté en ejecución con Settings > General > Local API habilitado.

Mantén desactivada la opción Allow network devices to connect para los scripts que se ejecuten en el mismo ordenador. La CLI lee el puerto de API configurado en los ajustes de la aplicación; el valor predeterminado es 5900.

Buscar comandos disponibles

beambench-cli --help
beambench-cli agent capabilities --json
beambench-cli agent guide --json

La ayuda funciona sin la aplicación. Las capacidades y el estado en tiempo real utilizan la API. Ejecuta un subcomando con --help para ver sus parámetros en la versión instalada.

Abrir e inspeccionar un proyecto

beambench-cli project open /abs/path/project.lzrproj
beambench-cli agent state --json

Abrir un proyecto cambia el proyecto de la aplicación de escritorio. Guarda el trabajo antes de ejecutar scripts que lo sustituyan o editen.

beambench-cli project save
beambench-cli project save-as /abs/path/copy.lzrproj

Representar y exportar

beambench-cli design render --png /tmp/design.png --pixels-per-mm 4
beambench-cli export svg --path /tmp/design.svg

Estos comandos utilizan el proyecto de la aplicación en ejecución mediante la API. La representación de diseños no requiere que el lienzo sea visible, pero sí requiere el servidor.

beambench-cli camera overlay render --output /tmp/overlay.png --view fit

La representación de la superposición de cámara también requiere que el frontend de la aplicación atienda la solicitud de representación. No sustituye sin interfaz el flujo de trabajo de la cámara.

Comandos que funcionan sin la aplicación

El listado de puertos serie, la ayuda y la exportación de G-code con argumentos posicionales tienen rutas locales directas:

beambench-cli ports
beambench-cli export gcode /abs/path/project.lzrproj /abs/path/out.gcode

La exportación independiente de G-code utiliza un perfil de máquina guardado localmente y las comprobaciones de planificación y salida del escritorio. No puede leer la posición actual de la máquina. Lee Salida de G-code para consultar los requisitos de perfil y colocación.

Automatización y conflictos

Las transacciones de diseño utilizan la revisión actual del proyecto. Si otra edición, un cambio de proyecto o un cierre invalida el proyecto capturado, la transacción se rechaza. Actualiza el estado y reevalúa la operación antes de volver a intentarlo; no sobrescribas las ediciones simultáneas del usuario con una instantánea antigua.

Los comandos que pueden mover la máquina, activar el láser, enviar G-code sin procesar o cambiar la asistencia de aire requieren sus correspondientes indicadores de confirmación. Inspecciona la ayuda del comando y la acción prevista antes de proporcionarlos.

La CLI no selecciona herramientas del lienzo, reorganiza paneles ni activa atajos. Son acciones de la interfaz de escritorio.

Relacionado

On this page