Documentación de Beam Bench

Usar la CLI

Inspeccione y edite la aplicación en ejecución mediante su API local, o exporte 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é ejecutándose con Configuración > General > API local habilitada.

Mantenga desactivada la opción Permitir que los dispositivos de red se conecten para los scripts que se ejecuten en la misma computadora. 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 usan la API. Ejecute un subcomando con --help para ver sus parámetros correspondientes a 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 en la aplicación de escritorio. Guarde el trabajo antes de ejecutar scripts que lo reemplacen o editen.

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

Renderizar y exportar

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

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

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

La renderización de la superposición de cámara también requiere que el frontend de la aplicación atienda la solicitud de renderización. No es un reemplazo sin interfaz del flujo de trabajo de cámara.

Comandos que funcionan sin la aplicación

La lista de puertos serie, la ayuda y la exportación posicional de G-code 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 usa un perfil de máquina guardado localmente y las comprobaciones de planificación y salida del escritorio. No puede leer la posición de una máquina en tiempo real. Lea Salida de G-code para conocer los requisitos de perfil y colocación.

Automatización y conflictos

Las transacciones de diseño usan 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. Actualice el estado y vuelva a evaluar la operación antes de intentarlo de nuevo; no sobrescriba 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 indicadores de confirmación correspondientes. Revise la ayuda del comando y la acción prevista antes de proporcionarlos.

La CLI no selecciona herramientas del lienzo, reorganiza paneles ni activa accesos directos. Esas son acciones de la interfaz de escritorio.

Relacionado

On this page