Documentação do Beam Bench

Usando a CLI

Inspecione e edite o app em execução por meio da API local ou exporte G-code diretamente.

O binário beambench-cli é distribuído junto com o app para desktop. A maioria dos comandos de projeto, design, máquina, perfil e estado são clientes da API local do app. Eles exigem que o app esteja em execução com Configurações > Geral > API local ativada.

Mantenha Permitir que dispositivos de rede se conectem desativado para scripts executados no mesmo computador. A CLI lê a porta da API configurada nas configurações do app; o padrão é 5900.

Encontrar comandos disponíveis

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

A ajuda funciona sem o app. Os recursos e o estado em tempo real usam a API. Execute um subcomando com --help para ver seus parâmetros na versão instalada.

Abrir e inspecionar um projeto

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

Abrir um projeto altera o projeto no app para desktop. Salve o trabalho antes de executar scripts que o substituam ou editem.

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

Renderizar e exportar

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

Esses comandos usam o projeto do app em execução por meio da API. A renderização de Design não exige uma tela de desenho visível, mas ainda exige o servidor.

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

A renderização da sobreposição da câmera também exige que o frontend do app processe a solicitação de renderização. Ela não substitui o fluxo de trabalho da câmera sem interface.

Comandos que funcionam sem o app

A listagem de portas seriais, a ajuda e a exportação posicional de G-code têm caminhos locais diretos:

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

A exportação autônoma de G-code usa um perfil de máquina salvo localmente e as verificações de planejamento e saída do desktop. Ela não consegue ler a posição atual da máquina. Leia Saída de G-code para conhecer os requisitos de perfil e posicionamento.

Automação e conflitos

As transações de design usam a revisão atual do projeto. Se outra edição, troca de projeto ou fechamento invalidar o projeto capturado, a transação será rejeitada. Atualize o estado e reavalie a operação antes de tentar novamente; não substitua edições simultâneas do usuário com um instantâneo antigo.

Os comandos que podem mover a máquina, disparar o laser, enviar G-code bruto ou alterar a assistência de ar exigem suas respectivas flags de confirmação. Consulte a ajuda do comando e a ação pretendida antes de fornecê-las.

A CLI não seleciona ferramentas da tela de desenho, reorganiza painéis nem aciona atalhos. Essas são ações da interface do desktop.

Relacionado

On this page