Documentation de Beam Bench

Utiliser la CLI

Inspecter et modifier l’application en cours d’exécution via son API locale, ou exporter directement du G-code.

Le binaire beambench-cli est distribué avec l’application de bureau. La plupart des commandes de projet, de conception, de machine, de profil et d’état sont des clientes de l’API locale de l’application. Elles nécessitent que l’application soit en cours d’exécution avec Settings > General > Local API activé.

Désactivez Allow network devices to connect pour les scripts exécutés sur le même ordinateur. La CLI lit le port API configuré dans les paramètres de l’application ; la valeur par défaut est 5900.

Trouver les commandes disponibles

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

L’aide fonctionne sans l’application. Les capacités et l’état en direct utilisent l’API. Exécutez une sous-commande avec --help pour voir ses paramètres pour la version installée.

Ouvrir et inspecter un projet

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

L’ouverture d’un projet modifie le projet dans l’application de bureau. Enregistrez votre travail avant d’exécuter des scripts qui le remplacent ou le modifient.

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

Effectuer le rendu et exporter

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

Ces commandes utilisent le projet de l’application en cours via l’API. Le rendu de la conception ne nécessite pas de canevas visible, mais il nécessite toujours le serveur.

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

Le rendu de la superposition de caméra nécessite également que l’interface de l’application traite la requête de rendu. Il ne s’agit pas d’un remplacement sans interface de la procédure de caméra.

Commandes fonctionnant sans l’application

L’énumération des ports série, l’aide et l’exportation G-code positionnelle disposent de chemins locaux directs :

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

L’exportation G-code autonome utilise un profil machine enregistré localement ainsi que les contrôles de planification et de sortie de l’application de bureau. Elle ne peut pas lire la position en direct de la machine. Consultez Sortie G-code pour connaître les exigences relatives au profil et au placement.

Automatisation et conflits

Les transactions de conception utilisent la révision actuelle du projet. Si une autre modification, un changement de projet ou une fermeture invalide le projet capturé, la transaction est rejetée. Actualisez l’état et réévaluez l’opération avant de réessayer ; n’écrasez pas les modifications simultanées de l’utilisateur avec un ancien instantané.

Les commandes qui peuvent déplacer la machine, déclencher le laser, envoyer du G-code brut ou modifier l’assistance d’air nécessitent leurs indicateurs de confirmation correspondants. Consultez l’aide de la commande et l’action prévue avant de les fournir.

La CLI ne sélectionne pas les outils du canevas, ne réorganise pas les panneaux et ne déclenche pas les raccourcis. Ce sont des actions de l’interface de bureau.

Pages associées

On this page