Aprender

Como depurar código Arduino, de prints na Serial a breakpoints

Iniciante

Ou veja todas as aulas.

  • 526componentes na bancada
  • 46placas rodando agora
  • 1.00xtempo real, em todas as placas
Arduino Uno: um potenciômetro e um LEDao vivo0.000 s 0.00x
Clique para abrir no editor
Um potenciômetro em A0 controla um LED no pino 9. Abra, cole o exemplo resolvido e gire o potenciômetro com o monitor serial aberto.

Um Arduino não tem tela, então quando um sketch se comporta mal você não consegue ver o que ele está pensando. O Uno e o Nano clássicos também não podem ser executados passo a passo na IDE do Arduino: o depurador da IDE suporta certas placas mais novas, e não as placas AVR que a maioria das turmas e kits usa. Então a maioria das pessoas depura com Serial.print, e isso funciona bem quando você usa com intenção.

Esta página é um método para reduzir um bug e depois três ferramentas: imprimir, plotar e parar a placa numa linha. O circuito acima é um Uno com um potenciômetro em A0 e um LED no pino 9, o suficiente para mostrar as três, incluindo um bug real que só acontece num Uno.

Deixe o bug pequeno antes de persegui-lo

Escreva o que você esperava e o que aconteceu, em uma frase cada. "O LED deveria ficar mais brilhante conforme eu giro o potenciômetro, e ele fica claro, depois escuro, depois claro" é um bug que dá para testar; "não funciona", não.

Depois encolha o problema. Confira a ligação com os números dos pinos no código primeiro, porque isso pega uma boa parte dos bugs. Comente tudo que não está envolvido ou copie o componente suspeito para um sketch novo. Mude uma coisa por vez e rode de novo. Um bug que sobrevive em dez linhas é um bug que você vai encontrar; o mesmo bug em trezentas é chute.

Serial.print, de propósito

Inicie a porta em setup() com Serial.begin e, numa placa real, configure o monitor serial na mesma taxa de baud, senão aparecem caracteres sem sentido. Imprima algo uma vez no fim do setup(). Se essa linha aparecer de novo e de novo, a placa está reiniciando, o que geralmente significa que um motor ou servo está derrubando a alimentação.

Rotule cada valor, então botão: pressionado em vez de um 0 solto. Imprima quando algo muda, não a cada passada pelo loop(), o que inunda o monitor rápido demais para ler. E coloque as impressões numa macro, para poderem ser desligadas em um só lugar em vez de apagadas e redigitadas quando o bug voltar.

Impressões rotuladas, na mudança, atrás de um só interruptor
#define DEBUG 1

#if DEBUG
#define DEBUG_PRINT(x) Serial.print(x)
#define DEBUG_PRINTLN(x) Serial.println(x)
#else
#define DEBUG_PRINT(x)
#define DEBUG_PRINTLN(x)
#endif

const int BUTTON_PIN = 2;
int lastState = HIGH;

void setup() {
  Serial.begin(115200);
  pinMode(BUTTON_PIN, INPUT_PULLUP);
  DEBUG_PRINTLN("setup done");  // printed again on every reset
}

void loop() {
  int state = digitalRead(BUTTON_PIN);
  if (state != lastState) {  // print on a change, not on every pass
    DEBUG_PRINT("button: ");
    DEBUG_PRINTLN(state == LOW ? "pressed" : "released");
    lastState = state;
  }
}

Abrir este sketch no editorSó o código: o editor posiciona a placa e os componentes que ele consegue ler do sketch.

Imprimir leva tempo

Cada caractere leva cerca de um milissegundo para enviar a 9600 baud, então uma linha de 20 caracteres custa cerca de 20 milissegundos. Um Uno real esconde os primeiros 64 bytes num buffer de transmissão, mas um sketch que imprime a cada passada enche o buffer rápido e depois espera por cada caractere. Use 115200 baud, que é doze vezes mais rápido, e imprima menos.

É também por isso que adicionar um print às vezes faz um bug sumir. Se desacelerar o sketch conserta, o bug é de tempo: uma leitura de botão rápida demais, uma leitura de sensor antes de estar pronta ou uma interrupção corrida com o loop principal. Isso é uma pista, não uma correção. Não imprima dentro de um handler de interrupção; defina uma flag ali e imprima do loop().

Um exemplo resolvido: a média que fica negativa

Aqui está um bug de verdade. O sketch faz a média de 64 leituras do potenciômetro para suavizá-las. Com o circuito do dimmer acima e o botão em 100, ele imprime total:6400 average:100, o que está certo. Gire o botão até o meio, 512, e ele imprime total:-32768 average:-512. No topo, 1023, ele imprime total:-64 average:-1.

As impressões deixam a causa visível: o total está errado, então a média não é o problema. Em um Uno, um int tem 16 bits e guarda no máximo 32.767, e 64 leituras de 1023 somam 65.472, então o total dá a volta e fica negativo. O mesmo sketch funciona em um ESP32, onde um int tem 32 bits, que é exatamente o tipo de diferença que faz um bug parecer aleatório. A correção é long total = 0;. Sem imprimir o total, você só veria uma média errada e provavelmente procuraria no lugar errado.

O bug e sua correção de uma palavra no comentário
const int SENSOR_PIN = A0;

void setup() {
  Serial.begin(115200);
}

void loop() {
  int total = 0;  // the bug: make this long
  for (int i = 0; i < 64; i++) {
    total += analogRead(SENSOR_PIN);
  }
  Serial.print("total:");
  Serial.print(total);
  Serial.print(" average:");
  Serial.println(total / 64);
  delay(250);
}

Abrir este sketch no editorSó o código: o editor posiciona a placa e os componentes que ele consegue ler do sketch.

Plote números em vez de lê-los

Um valor que muda com o tempo é mais fácil de avaliar como uma linha. O Serial Plotter da IDE do Arduino e a aba Plot do Mokxi leem o mesmo formato: números em uma linha separados por espaços ou vírgulas, cada um opcionalmente rotulado como name:value. O exemplo prático acima já imprime nesse formato, então abra a aba Plot e gire o botão, e você verá o total virar para números negativos na metade do curso.

Imprimir um limite ao lado de uma leitura, como reading:512 threshold:600, desenha o limite como uma linha reta, então você vê exatamente quando um sensor o cruza e o quanto ele é ruidoso perto da borda. Isso responde de uma vez "por que minha luz pisca ao anoitecer".

Pare a placa em uma linha

No Mokxi você pode parar qualquer placa com um breakpoint, incluindo o Uno, porque o chip é simulado em vez de conectado por USB. Clique na sarjeta à esquerda de um número de linha e um ponto vermelho aparece; aperte Rodar, e a placa para antes de executar essa linha. O circuito inteiro para junto, então um LED fica exatamente tão brilhante quanto estava e millis() não salta enquanto você observa.

A aba Debug então mostra onde a placa parou, seus registradores e uma lista de observação das variáveis globais. O Step over executa uma linha por vez. A lista de observação lê apenas globais, então, durante a depuração, pode ajudar tornar global a variável que interessa. No ESP32 e no ESP8266, Pausar e a lista de observação funcionam, mas breakpoints não, porque o compilador do navegador não consegue compilar para esses dois chips. O exemplo de breakpoint abaixo percorre isso em um ESP32-C3.

Abra este circuito no editor. Arduino Uno: um potenciômetro e um LED, ligados como está rodando no topo desta página. Troque um componente ou um valor e rode de novo.

Abrir o circuito

Perguntas

Dá para depurar um Arduino Uno com breakpoints?

Não com o depurador da IDE do Arduino, que não suporta as placas AVR. O ATmega328P tem uma interface de depuração de um fio, a debugWIRE, mas ela precisa de um depurador de hardware separado. No Mokxi, os breakpoints funcionam diretamente no Uno simulado.

Por que meu monitor serial mostra caracteres estranhos?

Em uma placa de verdade, o baud rate do monitor não corresponde ao de Serial.begin. Defina ambos para o mesmo número, como 115200.

Por que adicionar Serial.print faz meu bug sumir?

Imprimir deixa o sketch mais lento, então o bug depende de tempo: uma leitura que acontece cedo demais, um debounce faltando ou uma variável compartilhada com uma interrupção.

Devo deixar mensagens de depuração em um sketch pronto?

Desligue-as em vez de apagá-las, com uma macro DEBUG como a de cima. Elas custam tempo e memória quando ligadas, e nada quando desligadas.

Monte isto de verdade

Abra o editor, mude um valor e veja o número mudar junto. Nada para instalar, e não precisa de conta.