Iot GitHub Frame - śledź na żywo popularność dowolnego repozytorium

[Sqra]

Witajcie.

Chciałbym Wam przedstawić prosty sposób wykorzystania modułu ESP-32, który użyłem do stworzenia urządzenia, za pomocą którego możecie śledzić poziom zainteresowania wybranym repozytorium GitHub. Dzięki wbudowanym dwóm wyświetlaczom, będziecie na bieżąco informowani o:

• aktualnej liczbie gwiazdek
• dziennej liczbie gwiazdek
• aktualnej liczbie obserwujących
• aktualnej liczbie forków

Początkowo chciałem skorzystać ze starszego modułu ESP8266 12-F,  jednak napotkałem problem który objawiał się przy wykonywaniu requesta do api GitHub. Podczas oczekiwania na odpowiedź z serwera, na wyświetlaczach zanikały wszystkie cyfry i wyglądało to jakby coś było nie tak z urządzeniem. Z pomocą przyszedł układ ESP-32, który oparty jest na dwóch rdzeniach. Była to świetna okazja aby zapoznać się z tym modułem, ponieważ wcześniejsze projekty wykonywałem na ESP8266. Użycie nowszej odsłony ESP, pozwoliło mi wysyłać requesty asynchronicznie.

Do działania ramki wymagane jest połączenie z siecią poprzez WiFi. Tutaj świetnie sprawdziła się biblioteka "WiFi Manager", która umożliwiła mi szybkie podłączenie ramki do dowolnej sieci. Jeżeli chodzi o zasilanie to jest to napięcie 5V, które podaje poprzez wtyki USB.

W obudowie ramki znajdują się trzy przyciski. Pierwszy służy jako włącznik. Pozostałe dwa to włączniki chwilowe. Po wciśnięciu pierwszego na wyświetlaczu prezentowany jest adres IP, który wykorzystujemy przy konfiguracji. Natomiast drugi przycisk resetuje liczbę gwiazdek z dnia.

Do układu podłączona jest 3 kolorowa dioda LED, która informuje nas o stanie połączenia:

• CZERWONY – brak sieci, błąd podczas pobierania danych
• ZIELONY – połączenie sieciowe ustanowione, dane pobrane poprawnie
• NIEBIESKI – tryb access pointu ( zanik sieci )

Domyślnie odświeżanie danych odbywa się co 90 sekund. Oczywiście interwał można zmienić. Ale należy uważać, aby nie wykonywać do api GitHub więcej niż 60 requestów na godzinę, ponieważ serwer ma ustawiony RateLimit. Po przekroczeniu ilości zapytań zostaniemy zablokowani na godzinę.

Jak już wspomniałem wyżej, pod adresem IP jaki przydzielony został do urządzenia działa prosty web server, który serwuje nam stronę z konfiguracją, gdzie musimy wprowadzić nazwę użytkownika repozytorium oraz nazwę repozytorium które chcemy obserwować. Po zapisaniu konfiguracji w pamięci EEPROM urządzenie jest restartowane i gotowe do użycia.

Dodatkowym atutem urządzenia jest automatyczna aktualizacja oprogramowania poprzez HTTPS OTA. Sprawdzanie wersji następuje podczas uruchomienia oraz po północy.

Urządzenie jest w pełni bezobsługowe. Gdy wystąpi zanik sieci, ESP cały czas będzie próbowało nawiązać połączenie za pośrednictwem zapamiętanych poświadczeń. Jeśli sieć nie będzie dostępna, przełączy się w tryb access pointu ( ssid: "GITHUB-FRAME"). Jeśli nie zostanie wybrana nowa sieć w menadżerze sieci, to po czasie 3 minut, nastąpi restart i proces się powtórzy.

Tak pokrótce, wygląda zasada działania całego układu. Poniżej przedstawię Wam główne etapy budowy całej ramki. A więc zaczynamy.

LISTA ELEMENTÓW:

1. ESP-32 WROOM DevKit 1.0 – 1 szt.
2. Wyświetlacz LED 4-Cyfrowy TM1637 – 0.56" – 1 szt.
3. Wyświetlacz LED 4-Cyfrowy TM1637 - 0.36" – 1 szt.
4. 4-pinowy przewód, żeński – żeński – raster 2.54 – 4 szt.
5. Gniazdo + wtyk, JST – JST – 2 szt.
6. Gniazdo + wtyk, mikro JST – mikro JST – 2 szt.
7. Płytka uniwersalna PCB 50x70mm PI-01 – 1 szt.
8. Rezystor węglowy – 220 ohm – 5 szt.
9. Rezystor węglowy – 2,2k ohm – 3 szt.
10. Zworki do płytek stykowych - 1 zestaw
11. Wtyk goldpin kątowy 4 pinowy, raster 2,54mm – 4 szt.
12. Dioda LED 5mm RGB wsp. Anoda – 1 szt.
13. Dioda LED 3mm biała – 3 szt.
14. Przełącznik chwilowy okrągły – 10mm – 2 szt.
15. Przełącznik kołyskowy ON-OFF – 1 szt.
16. Kabel USB A – USB micro – 1 szt.
17. Zasilacz 5V z gniazdem USB A – 1 szt.
18. Rurki termokurczliwe - 1 szt.
19. Ramka IKEA RIBBA – 21x30cm ( ważne żeby była dość głęboka, aby zmieścić elektronkę ) – 1 szt.
20. Papier samoprzylepny do drukarki – 1 szt.
21. Rura elektroinstalacyjna RLM 16 – 1 szt.

NARZĘDZIA:

1. Lutownica
2. Cyna
3. Obcążki
4. Wiertarka lub wkrętarka
5. Wiertła: 7, 10, 13
6. Pistolet do kleju na gorąco
7. Nóż
8. Drukarka

ZAŁOŻENIA:

• Stabilność działania
• Intuicyjna obsługa
• Szybka adaptacja w miejscu instalacji
• Estetyka
• Plan

Początkowo ramka miała powstać pod konkretnie wybrane repozytorium i wyświetlać tylko liczbę gwiazdek. Ale stwierdziłem, że i tak pobieram inne dane z endpointa api to czemu miałbym ich nie wyświetlić. Postanowiłem, że dodam dwa nowe klucze: "forks" oraz "watchers" i wyświetlać je kolejno w 5 sekundowym odstępie czasowym. Jeżeli chodzi o repozytorium, to dając możliwość wprowadzenia własnych ustawień url-a, zwiększyłem tym samym skalowalność przedsięwzięcia. Do tego doszły automatycznie aktualizacje software-u. Więc taką ramkę może stworzyć każda osoba, która chociaż trochę ma pojęcie o informatyce i niekoniecznie zna się na programowaniu.

BUDOWA

Prace nad ramką rozpocząłem od budowy prototypu metodą na "pająka". W tym celu skorzystałem z płytki prototypowej, przycisków typu "tact switch", paru zworek oraz kilkunastu przewodów do połączenia wszystkiego w całość. Całe oprogramowanie zostało napisane za pośrednictwem Arduino IDE czyli w języku C.

Gdy miałem już działający prototyp, rozpocząłem prace nad przeniesieniem całości na uniwersalną płytkę PCB. Zadanie wydawałoby się proste ale wymagało procesu planowania. W tym celu wykorzystałem oprogramowanie Fritzing. Oprogramowanie to umożliwia stworzenie całej dokumentacji projektu. Na tę chwilę wykorzystałem tylko narzędzie do stworzenia szkicu płytki prototypowej.

Mając gotowy już projekt z rozlokowaniem wszystkich elementów i połączeń. Mogłem przystąpić do lutowania. Jak widać na zdjęciach, podczas montażu elementów używałem uchwytu, który stabilnie trzyma płytkę w miejscu. Bardzo ułatwił mi pracę.

Po przylutowaniu wszystkich elementów elektronicznych, wlutowałem przewody z gniazdami, dzięki którym będę mógł odłączyć układ od samej konstrukcji ramki

Teraz przyszedł czas na najtrudniejszy etap jakim było dostosowanie drewnianej ramki do potrzeb projektu. W programie Photoshop stworzyłem szablon do wiercenia i wycinania potrzebnych otworów. Szablony te znajdziecie również w repozytorium projektu. Po wydrukowaniu szablonu przykleiłem kartkę do “pleców ramki” i wyciąłem wszystkie otwory. Trochę trzeba się do tego przyłożyć i mieć sporo cierpliwości. Cięcie, pasowanie, cięcie, pasowanie aż do skutku.

Ufff. W końcu mogłem przystąpić do zamontowania wyświetlaczy oraz diod LED. Z pomocą przyszedł mi klej na gorąco. Trzyma mocno i pewnie, wystarczająco do tego typu prac. Trzy diody LED umieściłem w przyciętych krążkach z białej rury pcv ( tych do prowadzenia przewodów po ścianach ) a górę zaślepiłem kawałkiem plastiku w którym zamocowałem diody.

A tak całość prezentuje się od frontu

Za pomocą 4 żyłowych przewodów zakończonych wtykami żeńskimi, połączyłem wszystkie elementy z główną płytką. W celu szybszej identyfikacji przewodów, oznaczyłem każde połączenie za pomocą lakierów do paznokci ( pozdrawiam swoją żonę Magdalenę ). Główny układ przykleiłem do pleców ramki również za pomocą kleju na gorąco.

Na koniec pomalowałem cały front na biało farbą emulsyjną, ponieważ papier który używa się w drukarkach ma małą gramaturę co sprawia, że jest półprzezroczysty. Dzięki podbiciu koloru tła biel będzie intensywniejsza. W ostatecznej wersji grafikę wydrukowałem na papierze fotograficznym, który jest na tyle gruby, że malowanie okazało się być zbędne.

SOFTWARE

Cały program opiera się na dwóch pętlach. Pierwsza pętla Task1, sprawdza czy użytkownik wprowadził url repozytorium z którego mają zostać pobrane dane. Jeżeli konfiguracja została wprowadzona, program wywołuje funkcję getData(), która odpowiedzialna jest za pobranie danych z API. Interwał tej pętli definiuje zmienna requestInterval, która domyślnie posiada wartość 90 ( czyli 90 sekund). Druga pętla Task2, służy do wyświetlania odpowiednich danych na wyświetlaczach oraz podświetlania ikon. Tutaj również sprawdzany jest stan na pinach 27 i 15 ( przyciski BUTTON_IP oraz BUTTON_RESET_TODAY). Interwał tej pętli to około 15 sekund.
Po północy następuje sprawdzenie dostępności nowszej wersji oprogramowania oraz resetowany jest licznik gwiazdek otrzymanych w ciągu całego dnia.

Poniżej znajdziecie link do repozytorium z projektem:
OPROGRAMOWANIE + SZABLONY DO DRUKU

PODSUMOWANIE

Przyznam się szczerze, że prototyp urządzenia miałem już gotowy rok temu. Ale ze względu na gruntowny remont mieszkania musiałem odsunąć hobby na dalszy plan. Rozciągnięcie projektu w czasie sprawiło, że przy każdym powrocie zawsze coś zmieniałem, rozbudowywałem. Wszystko wtedy można przemyśleć kilka razy i na spokojnie zastanowić się nad rozwiązaniem jakiegoś problemu.

Na co dzień zajmuję się programowaniem front-endu, ale dzięki takim projektom mogę połączyć moje główne zainteresowania: majsterkowanie, elektronikę, grafikę i jak już wcześniej wspomniałem, programowanie i stworzyć coś namacalnego i cieszącego oko. Zachęcam wszystkich do twórczego działania i poszerzania swojej wiedzy. Tego typu projekty dadzą Wam satysfakcję, świetną zabawę oraz sporo nauczą. Także klawiatury,  lutownice, piły, śrubokręty, wiertarki w dłoń i do działania! Instrukcję już macie 😀

 

  

Do następnego projektu! 🤘
Pozdrawiam.

[Treker (Damian Szymański)]

Właśnie zaakceptowałem Twój opis, możesz go teraz zgłosić do akcji rabatowej umieszczając link w temacie zbiorczym. Dziękuję za przedstawienie ciekawego projektu, zachęcam do prezentowania kolejnych DIY oraz aktywności na naszym forum 🙂

Świetny projekt, bardzo lubię takie klimaty! Tutaj dla porównania moje "analogowe" statystyki Forbota (liczba osób online + odsłony z całego dnia):

[Sqra]

Najs. Fajna obudowa i te retro wskaźniki. Masz maszynę do wycinania czy zamawiasz cięcie? Ja chyba zakupię jakąś drukarkę 3d. Bo zawsze mam problem z dopasowaniem obudowy. A tak bym miał szyte na wymiar. Co do wskaźników to ostatnio gdzieś widziałem zegar z ich użyciem. Muszę coś podziałać w tej kwestii. Szkoda że dzień jest taki krótki. Ehhh.

[Treker (Damian Szymański)]

Niestety nie mam, więc zleciłem wycięcie na laserze. Mam drukarkę 3D, ale jakoś do tego projektu lepiej pasowała mi "drewniana" obudowa. Ja z kolei teraz podziałam chyba coś w kierunku Twojego projektu 😉

[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

[Sqra]

No i o to tu chodzi. Trzeba się nawzajem inspirować. Powodzenia.

[Masterpc96]

Ogromny szacun za jakość wykonania i za pomysł 👏

Nie myślałem że na forum spotkam kogoś z mojego miasta 😉  

Edytowano Marzec 28, 2019 przez Masterpc96

[Sqra]

Dzięki. Miło poznać. 😊 Uważam, że najważniejsze w tego typu projektach jest właśnie odpowiednie podanie. Projekt powinien być nie tylko funkcjonalny, ale i estetyczny. To moim zdaniem znacznie podnosi szanse na powodzenie całego przedsięwzięcia. 

[Gieneq]

Super projekt, wykonanie naprawdę estetyczne!

Niedawno kupiłem klawiaturkę ms surface i zaciekawiła mnie ukryta dioda, która widać dopiero gdy świeci, ale nie wiedziałem jak można to wykorzystać, a tu taka inspiracja 😁

Może licznik odsłon mnie nie do końca interesuje ale potrzebowałbym ramkę, która wyświetla tekst z API. Masz pomysł jak można wyświetlać litery które prześwitywałyby przez papier? 

Jak przyłożyłem dla testu kartkę papieru do monitora IPS to nie prześwituje, może napisy z OLEDa na wygaszonym tle byłyby widoczne?

[Sqra]

Dziękuję. Wydaje mi się ze fajnym rozwiązaniem byłoby wykorzystanie do tego celu LED matrix. 

 

Edytowano Marzec 29, 2019 przez Sqra