FAQ Program Arduino nie działa. I co dalej?

[Gieneq]

Zarys treści

• rozwiązanie problemów z bibliotekami
• rozwiązanie częstych problemów niepoprawnej kompilacji
• sposób szukania przyczyny braku kompilacji lub niepoprawnego działania sprzętu
• "debugowanie" z użyciem portu szeregowego i flag LED
• przykład bezpiecznej metody testowania i nabudowywania układu
• podstawowe narzędzia do testowania układu
• sposób zadawania pytań na forum (umieszczanie ilustracji i kodu źródłowego)

Wstęp

Z Arduino można wykonać wiele ciekawych projektów i bywa, że początkujący po zakupie Arduino dla testu wgrywa przykłady z Arduino IDE i gdy wszystko działa jak należy, idzie krok dalej i pyta wujka Googla jak zrealizować swój wymarzony projekt. Dość szybko trafia na poradnik, pobiera zipa z kodem, wgrywa i... właśnie. Albo kod się nie kompiluje, albo kod po wgraniu nie działa. I co teraz? 🤷‍♂️

Przyjrzyjmy się temu bliżej. Jakie mogą być przyczyny niewłaściwego działania? Kod programu z internetów niekoniecznie musi być niepoprawny, bo w końcu ktoś to kiedyś uruchomił. Jest jednak kilka typowych sytuacji i sposobów poradzenia sobie.

Niekompatybilne biblioteki

Jeżeli program się nie kompiluje, a w logu mamy sporo błędów dotyczących brakujących lub powtarzających się bibliotek, to trzeba doprowadzić do stanu, gdzie nie będzie tego problemu. Otwieramy menadżer bibliotek i instalujemy brakujące, jeżeli ich nie ma to szukamy na githubie (najpewniej tam będą). Jeżeli problem polega na wykryciu wielu bibliotek o tej samej nazwie to zaglądamy do katalogu libraries i sprawdzamy czy nie ma tam tego samego co w katalogu projektu.

Znaleziono wiele bibliotek w "Servo.h"
Wykorzystane: C:\Users\Piotr Adamczyk\Documents\Arduino\libraries\Servo
Niewykorzystane: C:\Program Files\WindowsApps\ArduinoLLC.ArduinoIDE_1.8.42.0_x86__mdqgnx93n4wtt\libraries\Servo
Znaleziono wiele bibliotek w "LiquidCrystal.h"

Najlepiej usunąć to co jest w katalogu libraries, bo może tam być starsza wersja, choć niektórzy kombinatorzy mogą umieścić zmodyfikowane biblioteki, które mają identyczną nazwę ale specyficzne działanie. Tu trzeba wykazać się rozeznaniem.

Nie kompiluje się

Tu już może być wiele opcji, najlepiej zajrzeć do loga na dole ekranu, jeżeli nie ma tam nic ciekawego to warto, a nawet powinno się ustawić więcej szczegółów podczas kompilacji (w tym przypadku nadmiar na pewno nie zaszkodzi, a może oszczędzić czasu i zmartwień):

Często może chodzić o drobiazgi: brakujący nawias, nawiązanie do biblioteki lokalnej (przy include zamiast <> mamy ""). Możliwe też że mamy wybraną płytkę niekompatybilną (np. ESP32) lub o innej liczbie wyprowadzeń przez co niektóre piny zwyczajnie nie istnieją i w wyniku mamy błąd.

Jeżeli mamy podaną linię, w której jest błąd trzeba rozejrzeć się w jej pobliżu w poszukiwaniu czegoś kancerogennego. Jeżeli mimo to nie wiemy co jest nie tak trzeba przejść do innej metody.

Divide et impera

Z łac. "Dziel i zwyciężaj", metoda stosowana przez programistów podkradnięta starożytnym Rzymianom. Jeżeli nie wiesz jak ugryźć cały temat to podziel go na mniejsze, rozwiąż pomniejsze problemy i scal ich wyniki. Jeżeli jednak nie da się rozwiązać pomniejszego problemu, to podziel go i tak rekurencyjnie aż do uzyskania wyniku.

Ważne jest zrozumienie działania programu, pośpiech nie jest korzystny. 🚫🚗 Jeżeli nie umiesz programować, zatrzymaj się i skorzystaj, np. z kursów Arduino.

W przypadku Arduino można spróbować przetestować funkcje pojedynczej biblioteki zamiast wszystkich jednocześnie. Załóżmy, że w kodzie używam biblioteki do obsługi kart SD i wyświetlacza LCD, obie stosują SPI i celem jest wyświetlenie obrazka z karty SD na LCD. Coś nie działa, więc:

1. zaznajamiam się z każdą z bibliotek z osobna, w tym celu otwieram przykłady Arduino IDE, które zazwyczaj się dołączone do bibliotek, wgrywam i testuję (może zajść potrzeba zmiany numerów wyprowadzeń tak by pasowały do naszego układu). Uwaga: w tym procesie należy też wymontować część elektroniki tak by w danej iteracji (czyli danej próbie) testowany był tylko kod biblioteki danego elementu i ten element. 
2. jeżeli wszystko działa jak powinno robię kopię programu, który nie działa i staram się wyizolować funkcje. Można wybrać jedną bibliotekę i jej obiekty i zakomentować wszystko co tyczy się pozostałych, a jako informację zwrotną wypisać wyniki na port szeregowy.
3. jeżeli jedna z bibliotek działa, np. da się coś odczytać z karty SD, to odkomentuję etap dotyczący wyświetlania, kompiluję, wgrywam i patrzę na wyniki. I tak krok po kroku aż do odkrycia całego kody. Ważne jest aby poruszać się nie zgodnie z numeracją wierszy w kodzie, lecz zgodnie z logiką kodu - wywołaniami funkcji. W ten sposób w końcu trafię na moment, w którym coś jest nie tak.

Przykładowo, niech w tym kodzie elektronicznej konewki (zaczerpniętym z internetu) nie działa coś z LCD. Zakomentowałem wszystko dotyczące LCD i sprawdzam czy działa serwo. Zamiast wypisywania tekstu na LCD wypisuję go na monitorze portu szeregowego:

//#include<LiquidCrystal.h>
//LiquidCrystal lcd(12,11,5,4,3,2);
#include<Servo.h>
Servo watervalve;

void setup() {
  //  lcd.begin(16,2);
  pinMode(8, OUTPUT); //red
  pinMode(9, OUTPUT); //green
  watervalve.attach(10);
}

void loop() {
  int mlevel;
  mlevel = analogRead(A0);
  mlevel = map(mlevel, 0, 1023, 100, 0);
  //  lcd.clear();
  //  lcd.print("mois level=");
  //  lcd.print(mlevel);
  //  lcd.print("%");

  //red green indicator
  if (mlevel < 60) {
    digitalWrite(8, HIGH);
    digitalWrite(9, LOW);

  } else {
    digitalWrite(9, HIGH);
    digitalWrite(8, LOW);
  }

  if (mlevel < 60) {
    int valpos;
    valpos = map(mlevel, 0, 60, 180, 0);
    watervalve.write(valpos);
    delay(100);
  } else {
    watervalve.write(0);
  }
  //  lcd.setCursor(0,1);
  if (mlevel < 60) {
    //    lcd.print("watering");
    Serial.println("watering");
  } else {
    //    lcd.print("not watering");
    Serial.println("not watering");
  }
  delay(500);
}

Jeżeli na monitorze portu szeregowego wszystko będzie OK, to najpierw wypiszę przykładowy tekst gdzieś w bloku setup(), a gdy ten zadziała to przejdę dalej.

Jeżeli jednak w powyższym kodzie serwo niezabardzo działa, to może okazać się, że serwomechanizm jest OK, a problem leży w czujniku. Warto zatem zamiast przetworzonych danych wypisać czysty pomiar ADC i wyciągnąć wnioski. Może okazać się że czujnik jest wadliwy, albo cos nie styka.

W ten sposób może wyjść na jaw, który moment powoduje problemy, ale także może wyjść na to, że jakiś element nie działa lub coś było źle podłączone.

Debugowanie DIY

Niestety Arduino na 8 bitowych AVR nie posiada debugera, 🐛🚫 lecz można zrobić własne – najłatwiej wypisać coś na port szeregowy. Dajmy na to, że mam funkcję którą podejrzewam, że działa niepoprawnie, bo coś się zawiesza, ale nie wiem w którym momencie coś się dzieje. Mogę posłużyć się taką metodą:

void funkcjacosrobiaca() {
  instrukcjaA();
  Serial.print("A jest ok");
  instrukcjaB();
  Serial.print("B jest ok");
  instrukcjaC();
  Serial.print("C jest ok");
}

Po każdej z instrukcji wstawiam tzw. flagę informującą że kod został wykonany do tego mementu i opuścił instrukcję. Jeżeli w wyniku otrzymam:

A jest ok
B jest ok

 

No to wiem, że program zawisł na instrukcjiC i tam trzeba sprawdzić co jest nie tak.

Jeżeli jednak nie mam z jakiegoś powodu dostępu do portu szeregowego (np. programuję Attiny13) to mogę posłużyć się LED w roli wskaźnika, informującego do jakiego momentu kod programu został wykonany.

Program wygrywa się ale nie działa

Trzeba sprecyzować co nie działa. Niestety ale hasło "Kod Arduino nie działa" jest dość częstym tematem wpisów, a problem może leżeć gdzieś indziej. Znowu najlepiej podzielić problem na pomniejsze, przetestować każdy funkcjonalny blok i powoli scalać.

Jeżeli nie znam układów, nie testowałem ich to złym pomysłem jest montowanie całego układu i odpalanie wszystkiego jednocześnie.

W przypadku podzespołów których nie znam, najlepiej jest najpierw zaznajomić się z nimi – podłączyć każdy z osobna, wgrać program testowy. Następnie stopniowo dokładać funkcjonalność. W ten sposób uniknie się wielu problemów:

• nie spalimy wszystkiego jednocześnie, 🔥
• poruszając się bezpiecznym szlakiem będziemy mieć kontrolę nad błędami i szybko je zniwelujemy (gdyby podłączyć jednoczenie 10 nowych elementów, a jeden z nich będzie miał odwrotnie połączone zasilanie i zacznie się grzać, to zanim do niego dojdziemy będzie już zniszczony).

Dokładając stopniowo elementy może okazać się, że trafimy na bardzo prozaiczny problem - wadliwe połączenie (uszkodzony kabelek/sfatygowane złącze płytki stykowej), znalezienie tego przy rozruchu kompletnego układu może być problemem, a tak od razu na to trafimy.

Dobrym tego przykładem jest dość skomplikowany układ czujnika odległości z kursu elektroniki 2. Składa się z 2 funkcjonalnych bloków:

• nadajnika podczerwieni,
• odbiornika z układu TSOP.

Jego budowa została przedstawiona tak, że najpierw montowany jest jeden blok, a następnie kolejny, tak że można je rozróżnić na płytce:

Multimetr

Ważnym narzędziem jest multimetr. 🧰 W przypadku próby dojścia co jest nie tak można sprawdzić:

• napięcie w różnych miejscach układu – czarną sondę stawiam na masie, a czerwoną sprawdzam napięcia zaczynając od zasilania, a kończąc na sygnałach wolnozmiennych (sprawdzenie miernikiem magistrali I2C nic nam nie powie).
• prąd płynący w gałęziach układu – rozwieram dane bloki i sprawdzam pobór prądu, jak gdzieś będzie zbyt wysoki niż domniemany to coś jest nie tak. Może okazać się, że jakiś regulator jest zepsuty, zamiast 3,3 V mam 5V i coś zaczyna się przypalać.
• ciągłość – sprawdzam czy to co ma być połączone jest połączone (może jakiś kabelek nie styka), a to co rozłączone takie pozostaje (nie ma zwarć na liniach zasilania).

Do listy narzędzi można dodać inne, bardziej wyrafinowane, ale takimi nie posługują się początkujący elektronicy.

Dalej nie działa

Podzespoły sprawdzone, napięcia pomierzone, kabelki zwierają, nic nie płonie ale nic nie działa. Co jest nie tak? W tym momencie forum spełnia swoje zadanie, nietypowy problem, brak pomysłu, pomożemy! Ale trzeba mieć do tego podstawowe informacje.

Odkładając na bok szklaną kulę (do której niektórzy szydercy zwykli powracać 🚫🔮), załóż temat o nazwie opisującej rodzaj problemu, hasło "Nie działa" nie jest wystarczające i informuje o tym notka na górze okna nowego tematu:

umieść w swojej wiadomości kod programu ładnie zwarty znacznikami kodu programu:

poniżej umieść schemat i zdjęcie swojego dzieła 🖼️ (schemat w pliku png/jpg, pdfa ani zipa nikt nie ruszy mając otwartą wersję mobilną forum.

Możesz też dodać wynik kompilacji z loga jeżeli ta nie przechodzi:

W ten sposób każdy będzie miał komplet informacji, z których będzie w stanie pomóc Ci dojść do tego co jest nie tak.

Podsumowanie

Aby dojść do przyczyny problemu należy:

1. przeanalizować treść logu,
2. przetestować każdy z modułów/funkcyjnych bloków/ bibliotek osobno,
3. zdebugować kod możliwymi sposobami,
4. sprawdzić napięcia, prądy, ciągłość w układzie,
5. zapytać na forum w sposób dający możliwość pomocy 🙂 

Mam nadzieję, że artykuł ten pomoże początkującym. Jest to jeden z często powtarzających się tematów, więc zachęcam też innych doświadczonych użytkowników forum do zaproponowania swoich metod rozwiązywania problemów z niesforną płytką Arduino.

Edytowano Grudzień 18, 2020 przez Gieneq

[ethanak]

2 godziny temu, Gieneq napisał:

warto ustawić więcej szczegółów podczas kompilacji

Ja bym to ujął inaczej: bezwzględnie konieczne jest ustawienie "więcej szczegółów podczas kompilacji" i "pokazuj wszystkie ostrzeżenia kompilatora".

Osobiście do początkujących raczej nie należę ale nie wyobrażam sobie jakiegokolwiek sensownego działania z mojej strony, jeśli nie widzę wszystkiego co mi wypisuje kompilator. A co do ostrzeżeń - warto też je poczytać, bo czasem jest tak że co prawda składniowo i semantycznie wszystko wydaje się w porządku, ale kompilator coś podejrzewa (na przykład niezainicjalizowaną zmienną).

Przykład - krótki program w C++:

#include <stdio.h>
int main(void)
{
   int m,n;
   n=m;
   printf("%d\n", m);
}

Program bez włączenia ostrzeżeń pięknie się skompiluje bo przecież żadnych błędów nie zawiera... tymczasem po włączeniu ostrzeżeń mamy:

programik.cpp: In function ‘int main()’:
programik.cpp:4:10: warning: variable ‘n’ set but not used [-Wunused-but-set-variable]
    4 |    int m,n;
      |          ^
programik.cpp:5:5: warning: ‘m’ is used uninitialized in this function [-Wuninitialized]
    5 |    n=m;
      |    ~^~

Czyli trzeba!

A poza tym świetnie że coś takiego napisałeś, będzie do czego linkować 🙂

[Gieneq]

To cieszę się i dzięki za uwagi, racja dopiszę. Dobrze byłoby przygotować więcej takich artykułów i zebrać je w formie FAQ, bo jednak wiele z tych tematów się powtarza. Ostatni, który napisałem kilka razy już podlinkowałem, myślę że i ten będzie przydatny.

[ethanak]

1 godzinę temu, Gieneq napisał:

Dobrze byłoby przygotować więcej takich artykułów i zebrać je w formie FAQ

Świetny pomysł! Lepiej dla wszystkich - bo jak debiutant trafi na FAQ to pewnie będzie wiedział gdzie szukać, a parę osób tu obecnych ma serdecznie dość odpowiadania po raz fafnasty na to samo pytanie...

W czymś trzeba pomóc? Czasu mam niewiele, ale może parę minut wyskrobię...

[Polecacz 101]

Produkcja i montaż PCB - wybierz sprawdzone PCBWay!
   • Darmowe płytki dla studentów i projektów non-profit
   • Tylko 5$ za 10 prototypów PCB w 24 godziny
   • Usługa projektowania PCB na zlecenie
   • Montaż PCB od 30$ + bezpłatna dostawa i szablony
   • Darmowe narzędzie do podglądu plików Gerber
Zobacz również » Film z fabryki PCBWay

[Treker (Damian Szymański)]

Od jakiegoś czasu chodzi mi po głowie organizacja pewnej zabawy/konkursu, która polegałaby na tworzeniu modelowych odpowiedzi. Konkretnie widziałem to w taki sposób, że na podstawie tego co pojawia się na forum zbieramy listę częstych pytań. Następnie zakładam konto "bota", który zadaje po jednym pytaniu dziennie (jako nowy temat konkursowy). Każdy może w tym temacie udzielić swoją modelową odpowiedź na takie pytanie (tzn. wyjaśnienie tematu i rozwiązanie problemu). Później takie dyskusje zbieramy w formie FAQ, a osoba, która np. odpowie najlepiej na największą liczbę pytań wygrywa. 

Co o tym myślicie? 😉

[ethanak]

25 minut temu, Treker napisał:

na podstawie tego co pojawia się na forum zbieramy listę częstych pytań

Ja mogę podać najczęstsze bez przeglądania forum 🙂

Cytat

Dlaczego mój program nie chce się wgrać na płytkę? Błąd to:

Błąd kompilacji dla płytki Arduino UNO

Ktoś wie?

Podejrzewam jednak, że większość odpowiedzi na to pytanie musiałaby być dostępna wyłącznie po oświadczeniu o pełnoletniości potwierdzonym notarialnie 🙂

[SOYER]

Świetny artykuł👍. Fajnie poczytać, że mój sposób samouka na podłączanie i kodowanie każdego podzespołu osobno i po kolei, który daje możliwość szybkiego wyłapania problemu, jest dobrą praktyką:). 

Ja każdy kolejny element podłączam i koduje osobno jednak pamiętając oczywiście jakie konkretnie funkcje będzie pełnił w gotowym programie. Kiedy mam działający kod do obsługi każdego osobnego podzespołu, zaczynam dopiero pisać kod całego programu. Najpierw najważniejszy element i tylko on, działa to ok, potem dopisuję biblioteki i kod z kolejnego podzespołu i sprawdzam czy działa, itd... 

Wtedy szybko wyłapuje się gryzące się biblioteki i inne błędy. Przy poprawkach staram się zapisywać kolejne wersje programu z opisem w nazwie data i godzina, co zrobiłem, zmieniłem itp. Wtedy na pierwszy rzut oka widać która wersja co zawiera i co w niej działa, a co nie bardzo. 

Patent z Serial.print przy dziwnym zachowaniu programu jest oczywiście niezawodny i pozwala łatwo wyłapać np. moje proste błędy nowicjusza. 

To mnie zainteresowało:

7 godzin temu, Gieneq napisał:

nawiązanie do biblioteki lokalnej (przy include zamiast <> mamy "")

co to biblioteka lokalna, a jaka to nie lokalna? 

Edytowano Grudzień 17, 2020 przez SOYER

[ethanak]

17 minut temu, SOYER napisał:

To mnie zainteresowało:

7 godzin temu, Gieneq napisał:

nawiązanie do biblioteki lokalnej (przy include zamiast <> mamy "")

co to biblioteka lokalna, a jaka to nie lokalna? 

Aj, bo @Gieneq żyje w świecie Javy i Pythona 🙂

Uściślę: jeśli argument #include jest ujęty w cudzysłów a ścieżka do pliku nie jest bezwzględna, kompilator będzie go szukał w katalogu w którym znajduje się plik, który go włącza (czyli lokalnie). Jeśli tam nie znajdzie, będzie szukał w miejscach w których powinny znajdować się pliki nagłówkowe bibliotek. Jeśli natomiast będzie ujęty w nawiasy kątowe, będzie go szukać wyłącznie w plikach nagłówkowych bibliotek.

Chodziło prawdopodobnie o sytuację, kiedy pliki biblioteki są umieszczone w folderze szkicu (czyli z punktu widzenia Arduino IDE lokalnie), lub w katalogu Arduino/libraries (czyli jak mniemam nielokalnie). Ot i cała filozofia, tyle że terminologia rodem z innego świata 🙂

Do poczytania: https://gcc.gnu.org/onlinedocs/cpp/Include-Syntax.html

A najlepiej takie rzeczy czytać przed zadawaniem pytań 😉

 

@Treker - to był przykład zadania pytania przed przeczytaniem podręcznika

[SOYER]

Może ja lubię zadawać pytania dla podtrzymania dialogu, sprowokowania do ciekawych wypowiedzi, szukania nowego spojrzenia. 

Pamiętaj, że garstka ludzi chce słuchać, a większość chce być słuchana;)

 

[ethanak]

1 godzinę temu, SOYER napisał:

Może ja lubię zadawać pytania dla podtrzymania dialogu

No przecież domyśliłem się że nie zadajesz takiego pytanie bo tego nie wiesz 🙂

 

[bjrk]

Artykuł świetny, pomysł z konkursem też dobry. Jako nagrodę dla zwycięzcy funduję duże dobre piwo (lub dwa, ale nie jestem na bieżąco z cenami - ostatnio jak byłem to lany speedway stout mniej więcej tyle kosztował), w dobrym pubie, wymiennie na 100zł kupon podarunkowy w Botlandzie.  Jeśli takowego brak, to mam nadzieję że da się to jakoś zorganizować.

[SOYER]

9 minut temu, ethanak napisał:

No przecież domyśliłem się że nie zadajesz takiego pytanie bo tego nie wiesz 🙂

sarkazm niepotrzebny, choć oczywiście domyślam się, że w Twoim przypadku zupełnie niezamierzony😁

[ethanak]

6 minut temu, SOYER napisał:

sarkazm niepotrzebny

A emoticona na końcu zdania widziałeś? Ja uznałem, że błąd popełnił @Gieneq wprowadzając jakąś dziwną terminologię...

8 minut temu, bjrk napisał:

w dobrym pubie,

Oj, to chyba zwycięzca zdąży zapomnieć o swoim zwycięstwie zanim puby otworzą 😞

 

[bjrk]

Nim się konkurs skończy to nas wszystkich zaszczepią, a jeśli nie to zaproponowałem rozwiązanie awaryjne.😷

[Gieneq]

12 godzin temu, SOYER napisał:

kodowanie każdego podzespołu osobno i po kolei, który daje możliwość szybkiego wyłapania problemu, jest dobrą praktyką:). 

@SOYER dzięki! Na pewno jest to bezpieczne podejście, gdyby to było pisanie kodu bez sprzętu to błędów można narobić ile się uda, nawet niektóre metody bazują na rozpoczynaniu od błędnego kodu, albo przynajmniej takiego, który nie przechodzi testów obrazujących jego funkcjonalność (TDD czy jakoś tak). Ale kto słyszał o testach w Arduino 😄 pewnie ktoś słyszał.

9 godzin temu, bjrk napisał:

zwycięzcy funduję duże dobre piwo

@bjrk trzymam za słowo 😉 a pandemia nie przeszkadza, niedawno dostałem ciekawą przesyłkę. Pudełko po butach z 2 butelkami ipy domowej produkcji, także jest możliwe.