Contas e planos

A linha de comando do mokxi

Guarde um projeto numa pasta sua, sincronize com o Mokxi e rode-o de um terminal.

O mokxi é uma pequena ferramenta de linha de comando sem outras dependências. Ele precisa do Node.js 18 ou mais recente. Rode com npx @mokxi/cli, ou instale uma vez com npm install -g @mokxi/cli.

Entrar

npx @mokxi/cli login

It shows a short code and opens mokxi.com/device. Aprove ali, e a ferramenta recebe um token próprio. Para colar um token que você criou em Settings > Developer instead, run npx @mokxi/cli login --paste.

O token é salvo na pasta de configurações do seu usuário (~/.config/mokxi/config.json, ou sob XDG_CONFIG_HOME), legível só por você. O npx @mokxi/cli logout o esquece; revogue-o em Configurações > Developer quando terminar de usá-lo.

Comandos

Comando O que faz
mokxi list seus projetos, com seus ids
mokxi new <board> [dir] cria um projeto para uma placa, como mokxi new uno blink
mokxi pull <id or link> [dir] grava o projeto como arquivos (veja abaixo)
mokxi pull dentro de uma pasta baixada com pull: pega a versão mais recente
mokxi push [dir] envia a pasta para o Mokxi, criando o projeto na primeira vez
mokxi run [dir] [--timeout 10s] compila e roda no seu próprio computador e imprime a saída serial conforme ela chega
mokxi test [dir] roda os cenários do mokxi.test.yaml da pasta e relata cada um
mokxi run --cloud [dir] roda nos servidores do Mokxi em vez disso
mokxi open [dir or id] abre o projeto no seu navegador
mokxi upload [dir] --firmware FILE guarda uma compilação (um .elf do arduino-cli) com o projeto
mokxi boards as placas que o Mokxi simula

mokxi --help lista todas as opções.

Os arquivos

O mokxi pull grava o mesmo layout de Salvar no GitHub no editor: o sketch como uma pasta do Arduino IDE (Blink/Blink.ino e suas abas), o projeto inteiro como diagram.mokxi.json, um README com um selo Abrir no Mokxi e configurações e tarefas de .vscode/. Veja Mokxi, VS Code e GitHub para saber o que é cada arquivo.

Então um começo típico é:

npx @mokxi/cli pull https://mokxi.com/p/abc123 blink
cd blink
git init && git add . && git commit -m "From Mokxi"

Depois edite, npx @mokxi/cli push, e faça commit como faria com qualquer código. Um clone do repositório encontra seu projeto em .vscode/settings.json, então o mokxi push também funciona lá.

Sincronização segura

O .mokxi/project.json lembra o que foi sincronizado por último (ele está no .gitignore).

  • O mokxi push se recusa quando o projeto mudou no Mokxi desde seu último pull ou push, então nunca sobrescreve trabalho feito no navegador. O --force sobrescreve mesmo assim.
  • O mokxi pull se recusa quando você mudou arquivos que ainda não enviou com push. O --force os substitui.
  • Uma aba apagada no Mokxi é apagada da pasta no próximo pull, a não ser que você tenha mudado esse arquivo.

O mokxi push --new cria um projeto novo a partir da pasta em vez de atualizar o projeto de origem.

Rodando

O mokxi run compila o sketch com o mesmo compilador que o editor usa e roda no mesmo simulador, no seu próprio computador. Não precisa de conta e não custa nada: o compilador é baixado uma vez (cerca de 80 MB) e guardado numa pasta de cache. Uma pasta pode ser um projeto do Mokxi baixado, um projeto do Wokwi com seu diagram.json e wokwi.toml, ou um sketch comum do Arduino.

npx @mokxi/cli run --timeout 10s --expect-serial "Ready" --fail-on "panic"

Esse passa assim que o sketch imprime Ready, falha no momento em que imprime panic, e sai com 1 se 10 segundos de tempo simulado passarem antes, que é o que um job de CI quer. O mokxi test roda arquivos de cenário que apertam botões, giram sensores e checam pinos e LEDs. Testes de simulação em CI tem tudo isso, com uma GitHub Action.

O mokxi run --cloud roda nos servidores do Mokxi em vez disso, e conta nos minutos de API do seu plano. Enquanto a pasta corresponder ao que foi sincronizado por último, ele roda o projeto salvo, incluindo a compilação que o editor guarda depois que você aperta Rodar. Com mudanças locais, ele envia os arquivos da pasta, e os servidores do Mokxi não compilam: compile com arduino-cli e passe --firmware build/Blink/Blink.ino.elf, ou faça push e aperte Rodar no editor uma vez. O run --cloud aceita as mesmas verificações do mokxi simulate.

Limites do plano

Enviar um projeto novo conta no limite de projetos do seu plano como qualquer outro projeto. Quando isso acontece, o mokxi push imprime a mesma mensagem que o editor mostra e sai com 3.

Códigos de saída

0 quando tudo funcionou, 1 quando uma rodada falhou numa verificação (ou estourou o tempo, ou não compilou), 2 para um erro no comando, e 3 quando o Mokxi disse não (desconectado, um limite do plano, um conflito) ou um download falhou.