Aprender

Enum no Arduino, em um temporizador Pomodoro que sabe em qual sessão está

Iniciante

Ou veja todas as aulas.

  • 526componentes na bancada
  • 46placas rodando agora
  • 1.00xtempo real, em todas as placas
Arduino Uno: um temporizador Pomodoro com a sessão em um enumao vivo0.000 s 0.00x
Aperte Rodar e depois aperte o botão de pular
Aperte pular para avançar o enum: Foco, uma pausa curta, Foco de novo.

enum Phase { FOCUS, SHORT_BREAK, LONG_BREAK }; dá nomes aos números inteiros 0, 1 e 2, e faz de Phase um tipo que guarda um deles. Uma variável desse tipo diz em que estado um programa está, com palavras em vez de números, e um switch sobre ela dá a cada estado o seu próprio bloco.

O circuito acima é um temporizador Pomodoro em um Uno: um display TM1637, uma lâmpada vermelha de foco, uma lâmpada verde de pausa e dois botões. O sketch dele guarda a sessão em Phase phase. Aperte Rodar e depois aperte o segundo botão, pular. O monitor serial imprime "Skipped" e "Short break (1 session done)", e a lâmpada verde substitui a vermelha. Pule de novo e ele imprime "Focus (1 session done)".

Abaixo está como os nomes correspondem aos números, imprimir um enum pelo nome, enum com switch, enum class, e os erros que um enum dá, cada um rodado em um Uno com o que imprimiu.

O enum do temporizador

Here are the two lines from the sketch running above. : uint8_t stores a Phase in one byte; without it an enum on the Uno takes 2, the size of an int. The sketch then reads like the method it follows: if (phase == FOCUS), phase = LONG_BREAK. Nothing at run time knows the names. They are for you and for the compiler, which now refuses a phase that is not one of the three.

firmware/uno/examples/pomodoro (o enum rodando acima)
enum Phase : uint8_t { FOCUS, SHORT_BREAK, LONG_BREAK };
Phase phase = FOCUS;

Os números por trás dos nomes

O primeiro nome é 0 e cada nome depois dele é um a mais, a não ser que você dê um valor a ele. Abaixo, Serial.println(c) com c definido como BLUE imprimiu 2, e FAST imprimiu 50 porque recebeu 50. sizeof(Color) imprimiu 2. Os valores são úteis quando os números significam algo fora do sketch, como uma velocidade ou um byte de comando.

Dois nomes podem compartilhar um valor, e um nome pode receber o valor de outro mais um, MEDIUM = SLOW + 15. Nomes deixados sem valor continuam a contagem do último que tem um, então depois de SLOW = 10, um FASTER simples seria 11. Mantenha a lista em um só lugar no topo do sketch, onde todos os estados possíveis do programa ficam fáceis de ler de relance.

Nomes são números
enum Color { RED, GREEN, BLUE };
enum Speed { SLOW = 10, MEDIUM = 25, FAST = 50 };

void setup() {
  Serial.begin(9600);
  Color c = BLUE;
  Serial.println(c);
  Serial.println(FAST);
  Serial.println(sizeof(Color));
}

void loop() {
}

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

Imprimindo um enum pelo nome

Serial.println() imprime o número, nunca o nome. Para imprimir o nome, guarde os nomes em um array na mesma ordem e use o enum como índice: o sketch abaixo imprimiu "green". O sketch do Pomodoro faz isso com uma função que retorna "Focus", "Short break" ou "Long break", o que é mais seguro quando os valores são dados à mão, porque aí os nomes não correspondem mais às posições em um array.

Um enum como índice
enum Color { RED, GREEN, BLUE };
const char *colorNames[] = {"red", "green", "blue"};

void setup() {
  Serial.begin(9600);
  Color c = GREEN;
  Serial.println(colorNames[c]);
}

void loop() {
}

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

enum e switch

Um switch sobre um enum é o formato usual de uma máquina de estados: um case por estado, cada um fazendo o seu trabalho e escolhendo o próximo estado. Deixe um estado de fora e o compilador percebe. O sketch abaixo tem três luzes e apenas dois cases; o clang avisou enumeration value 'YELLOW' not handled in switch, e o sketch imprimiu "red" e "green" e depois nada, porque chegou em YELLOW e não tinha case para ele. Adicione o case, ou um default: de propósito.

Um switch com um estado faltando
enum Light { RED, GREEN, YELLOW };
Light light = RED;

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

void loop() {
  switch (light) {
    case RED:
      Serial.println("red");
      light = GREEN;
      break;
    case GREEN:
      Serial.println("green");
      light = YELLOW;
      break;
  }
  delay(100);
}

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

enum class: nomes que ficam na própria caixa

Os nomes de um enum simples pertencem ao sketch inteiro, e eles viram ints sem que você perceba. enum class impede as duas coisas: escreva o tipo antes de cada nome, Mode::Blink, e compare apenas com outros Modes. O sketch abaixo imprimiu "blinking", e (int)m imprimiu 1.

O preço é que ele não passa por um número. Serial.println(m) parou com no matching member function for call to 'println', e if (m == 1) com invalid operands to binary expression ('Mode' and 'int'), com o clang não adicionando conversão implícita para scoped enum. O GCC diz no match for 'operator=='. Faça um cast, como (int)m, quando você realmente quiser o número.

enum class
enum class Mode { Off, Blink, On };

void setup() {
  Serial.begin(9600);
  Mode m = Mode::Blink;
  if (m == Mode::Blink) {
    Serial.println("blinking");
  }
  Serial.println((int)m);
}

void loop() {
}

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

Os erros que um enum dá

Um nome que o Arduino já usa: enum Level { LOW, MEDIUM, HIGH }; parou com expected identifier, duas vezes, porque LOW e HIGH já estão definidos como 0 e 1 antes do seu sketch começar. Escolha outros nomes, como LEVEL_LOW, ou use enum class.

O mesmo nome em dois enums: OFF em um enum Light e em um enum Fan deu redefinition of enumerator 'OFF'; o GCC diz 'OFF' conflicts with a previous declaration. Nomes de enum simples compartilham um único espaço, então use prefixos ou enum class.

Percorrendo o enum: c++ em um Color parou com cannot increment expression of enum type 'Color', e Color c = 2; com cannot initialize a variable of type 'Color' with an rvalue of type 'int'; o GCC diz invalid conversion from 'int' to 'Color'. Avance com um cast, c = (Color)((c + 1) % 3);, que foi 0, 1, 2 e voltou a 0.

Abra este circuito no editor. Arduino Uno: um temporizador Pomodoro com a sessão em um enum, ligado como roda no topo desta página. Mude um componente ou um valor e rode de novo.

Abrir o circuito

Perguntas

O que é um enum no Arduino?

Uma lista de nomes para números inteiros que também cria um novo tipo. É assim que um sketch dá nomes aos seus estados, modos ou itens de menu, para que o código diga FOCUS em vez de 0.

Como imprimo o nome de um enum?

Guarde os nomes em um array const char * na mesma ordem e imprima colorNames[c], ou escreva uma função com um switch que retorna o nome. Serial.println() sozinho imprime o número.

Enum é melhor que #define para estados?

Sim. Um enum dá um tipo de verdade, então o compilador pode recusar um valor que não é um estado e avisar quando um switch deixa um de fora. Nomes feitos com #define são só texto trocado antes de compilar.

Qual é a diferença entre enum e enum class?

Os nomes de um enum simples ficam visíveis em todo lugar e viram ints por conta própria. Já um enum class mantém seus nomes atrás do seu tipo, Mode::On, e precisa de um cast para virar número, então dois enums podem ter um OFF cada um.

Fontes

De onde vêm as informações desta página

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.