OPROGRAMOWANIE FIRMWARE INTERFEJSU ETHERNETOWEGO 1. Cechy Oprogramowanie firmware dla Interfejsu ethernetowego UNIV 3.102.0.x. Moduł jest przeźroczysty dla wszystkich wiadomości transmitowanych z magistrali do portu ethernetowego i vice versa oprócz ramek skierowanych bezpośrednio do modułu. Nadawczy (42 wiadomości) i odbiorczy (128 wiadomości) bufor FIFO dla wiadomości CAN Odbiorczy (42 wiadomości) bufor FIFO dla wiadomości Ethernet Obsługa zegara czasu rzeczywistego RTC z podtrzymaniem zasilania Możliwość zaprogramowania 128 wiadomości CAN, które zostaną wysłane w zdefiniowanym czasie Okresowe (co 1min) wysyłanie wiadomości zawierającej aktualną datę i godzinę. Wiadomość ta może wysterować inne moduły w sieci 2. Kompatybilność Firmware dla aplikacji UNIV 3.102.0.x Firmware można wgrać do urządzeń z bootloaderem w wersji 3.0 i kompatybilnymi. 3. Wersja oprogramowania firmware UNIV 3. 102. 0. 1 wersja firmware wersja aplikacji typ aplikacji (interfejs ethernetowy) wersja procesora procesor uniwersalny 4. Działanie interfejsu Wszystkie wiadomości przesyłane po magistrali CAN przekierowywane są do portu ethernetowego interfejsu. Zanim zostaną wysłane w ramce ethernetowej zostają obudowane bajtem startu, stopu i sumy kontrolnej (Rysunek 1). Również wiadomość z magistrali CAN skierowana bezpośrednio do modułu interfejsu zostanie przesłana do portu ethernetowego. Moduł ethernetowy wykona polecenie i wyśle odpowiedź na magistralę CAN. Port ethernetowy Interfejs ethernetowy UNIV 3.102.0.x Magistrala HAPCAN START SUM STOP WIADOMOŚĆ HAPCAN Rysunek 1. Przesyłane wiadomości z magistrali CAN do portu ethernetowego Wszystkie wiadomości przesłane do portu ethernetowego, ale nie skierowane do samego interfejsu, zostaną przesłane na magistralę CAN. Wiadomości przesłane do portu ethernetowego muszą zawierać bajty startu, stopu i sumy kontrolnej (Rysunek 2). Moduł rozpoznaje wiadomości skierowane bezpośrednio do niego, wykonuje polecenie i wysyła odpowiedź. Wiadomość skierowana bezpośrednio do modułu nie zostanie przesłana na magistralę CAN. 2015 hapcan.com univ_3-102-0-1c_pl.pdf - strona 1 / 7
START SMKTRL STOP Port ethernetowy Interfejs ethernetowy UNIV 3.102.0.x Magistrala HAPCAN START SUM STOP WIADOMOŚĆ HAPCAN Rysunek 2. Przesyłane wiadomości z portu ethernetowego do magistrali CAN 4. Budowa wiadomości HAPCAN Wiadomości HAPCAN to wiadomości CAN, które widziane są od strony portu ethernetowego interfejsu. Są one nieznacznie zmodyfikowane w interfejsie (z oryginalnych wiadomości CAN). Ramka HAPCAN zbudowana jest z 12 bajtów. 4 pierwsze to identyfikator ramki CAN, a pozostałe 8 to bajty danych. Różnica pomiędzy ramką na magistrali CAN i ramką HAPCAN przesłaną do portu ethernetowego polega na przesunięciu bitów IDENTYFIKATORA RAMKI (Tabela 1). Ponadto ramka przesyłana z magistrali CAN do portu ethernetowego, jest powiększona w interfejsie o bajty startu stopu i sumy kontrolnej. Port ethernetowy Interfejs ethernetowy UNIV 3.102.0.x MODUŁ UNIV 3 CPU Magistrala HAPCAN WIADOMOŚĆ HAPCAN Rysunek 3. HAPCAN i CAN wiadomości Bajt 1 Bajt 2 Bajt 3 Bajt 4 Bajt 5 Bajt 6 Bajt 7 Bajt 8 Bajt 9 Bajt 10 Bajt 11 Bajt 12 CAN IDENTYFIKATOR RAMKI POLE DANYCH 0 0 0 ID28 ID27 ID26 ID25 ID24 ID23 ID22 ID21 ID20 ID19 ID18 ID17 ID16 ID15 ID14 ID13 ID12 ID11 ID10 ID9 ID8 ID7 ID6 ID5 ID4 ID3 ID2 ID1 ID0 D0 D1 D2 D3 D4 D5 D6 D7 HAPCAN TYP RAMKI FLAGI NR MODUŁU NR GRUPY POLE DANYCH ID28 ID27 ID26 ID25 ID24 ID23 ID22 ID21 ID20 ID19 ID18 ID17 0 0 0 ID16 ID15 ID14 ID13 ID12 ID11 ID10 ID9 ID8 ID7 ID6 ID5 ID4 ID3 ID2 ID1 ID0 D0 D1 D2 D3 D4 D5 D6 D7 START - Bajt o wartości 0xAA sygnalizujący początek ramki TYP RAMKI - Typ ramki danych definiujący znaczenie bajtów w POLU DANYCH FLAGA ID16 - Flaga odpowiedzi. Jeśli ramka zostaje wysłana jako odpowiedź na otrzymane zapytanie to FLAGA ODP=1. W innym przypadku ODP=0. Pozostałe flagi są nieużywane i zawsze równe 0. NR MODUŁU - Numer modułu nadającego NR GRUPY - Numer grupy modułu nadającego POLE DANYCH - 8 bajtów danych. Znaczenie tych bajtów zależne jest od TYPU RAMKI SMKTRL - suma kontrolna ramki. Jest to suma wartości bajtów od 1 do 12 STOP - Bajt o wartość 0xA5 sygnalizujący koniec ramki Tabela 1. Różnice pomiędzy ramką CAN i HAPCAN 5. Wiadomości skierowane do portu ethernetowego Moduł odpowiada na wszystkie wiadomości skierowane do bootloadera procesora oraz dodatkowo na poniższe. 5.1. Pytanie o status Tabela 2. PYTANIE O STATUS (0x109) port ethernetowy 0xAA 0x109 0x0 SUMKTRL 0xA5 0x1090 Ramka PYTANIE O STATUS - bajt dowolnej wartości 2015 hapcan.com univ_3-102-0-1c_pl.pdf - strona 2 / 7
Na pytanie o status moduł odpowiada ramką zegara RTC zawierającą aktualną datę i czas. Tabela 3. Ramka odpowiedzi na PYTANIE O STATUS - port ethernetowy 0xAA 0x300 0x1 0xFF SUMKTRL 0xA5 0x3001 - ramka zegara czasu rzeczywistego jako odpowiedź na PYTANIE O STATUS - numer modułu interfejsu - numer grupy moduł interfejsu - numer roku (0-99) w formacie BCD, <7:4>-cyfra dziesiątek, <3:0>-cyfra jednostek (0x00-0x99) - numer miesiąca (1-12) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek (0x01-0x12) - numer dnia miesiąca (1-31) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek (0x01-0x31) - numer dnia tygodnia (0x01-Pn, 0x02-Wt, 0x03-Śr, 0x04-Cz, 0x05-Pt, 0x06-So, 0x07-Ni) - numer godziny (0-23) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek (0x00-0x23) - numer minuty (0-59) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek (0x00-0x59) - numer sekundy (0-59) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek (0x00-0x59) 5.2. Pytanie o uptime Moduł odpowiada na pytanie o czas jaki upłynął od startu (up time). Tabela 4. PYTANIE O UPTIME (0x113) port ethernetowy 0xAA 0x113 0x0 SUMKTRL 0xA5 0x1130 Ramka PYTANIE O UPTIME - bajt dowolnej wartości Tabela 5. Ramka odpowiedzi na PYTANIE O UPTIME- port ethernetowy 0xAA 0x113 0x1 0xFF 0xFF 0xFF 0xFF UPTIME3 UPTIME2 UPTIME1 UPTIME0 SUMKTRL 0xA5 0x1131 - ramka odpowiedzi na PYTANIE O UPTIME - numer modułu interfejsu - numer grupy moduł interfejsu UPTIME (UPTIME3*256 3 +UPTIME2*256 2 +UPTIME1*256 1 +UPTIME0*256 0 ) w sekundach 5.3. Ramka sterująca Moduł umożliwia ustawienie daty i godziny. Instrukcje sterujące zebrano w Tabela 7. Tabela 6. RAMKA STERUJĄCA (0x10A) port ethernetowy 0xAA 0x10A 0x0 INSTR1 INSTR2 INSTR3 INSTR4 INSTR5 INSTR6 INSTR7 INSTR8 SUMKTRL 0xA5 0x10A0 Ramka STERUJĄCA INSTR - instrukcja sterująca - bajt dowolnej wartości 5.4. Instrukcje sterujące W tabeli zebrano instrukcje wykonywane przez moduł. Tabela 7. Kodowanie instrukcji sterujących modułem Instrukcja Kod Instrukcji INSTR1 INSTR2 INSTR3 INSTR4 INSTR5 INSTR6 INSTR7 INSTR8 USTAW CZAS 0x00 USTAW DATĘ 0x01 Opis Ustawia bieżący czas. Bajty, i muszą być podane w kodzie BCD tj <7:4>-cyfra dziesiątek, <3:0>-cyfra jednostek. Zakres bajta : (00 23), bajta : (0 59), bajta : (0-59) Ustawia bieżącą datę. Bajty,, i muszą być podane w kodzie BCD tj <7:4>-cyfra dziesiątek, <3:0>-cyfra jednostek. Oznaczają one odpowiednio rok, miesiąc, dzień miesiąca i dzień tygodnia (1-Pn, 2-Wt, 3-Śr itd.). Zakres bajta : (00-99), bajta : (1 12), bajta : (1-31) i bajta : (1-7) 5.5. Budowa ramki zegara RTC Moduł umożliwia wysyłanie okresowe (co 1 minutę) ramki zawierającej aktualną datę i czas. 2015 hapcan.com univ_3-102-0-1c_pl.pdf - strona 3 / 7
Tabela 8. Ramka zegara RTC - port ethernetowy 0xAA 0x300 0x0 0xFF SUMKTRL 0xA5 0x3000 - ramka zegara czasu rzeczywistego - numer modułu interfejsu - numer grupy moduł interfejsu - numer roku (0-99) w formacie BCD, <7:4>-cyfra dziesiątek, <3:0>-cyfra jednostek (0x00-0x99) - numer miesiąca (1-12) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek (0x01-0x12) - numer dnia miesiąca (1-31) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek (0x01-0x31) - numer dnia tygodnia (0x01-Pn, 0x02-Wt, 0x03-Śr, 0x04-Cz, 0x05-Pt, 0x06-So, 0x07-Ni) - numer godziny (0-23) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek (0x00-0x23) - numer minuty (0-59) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek (0x00-0x59) - numer sekundy (0-59) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek (0x00-0x59) 6. Wiadomości skierowane z magistrali CAN Moduł odpowiada na wszystkie wiadomości skierowane do bootloadera procesora oraz dodatkowo na poniższe. 6.1. Pytanie o status Tabela 9. Ramka PYTANIE O STATUS (0x109) z magistrali CAN 0x109 0x0 KOMP ID2 0x1090 Ramka PYTANIE O STATUS KOMP ID2 Na pytanie o status moduł odpowiada ramką zegara RTC zawierającą aktualną datę i czas. Tabela 10. Ramka odpowiedzi na PYTANIE O STATUS z magistrali CAN 0x300 0x1 0xFF 0x3001 Ramka odpowiedzi na PYTANIE O STATUS - numer grupy modułu pytanego - numer roku (0-99) w formacie BCD, <7:4>-cyfra dziesiątek, <3:0>-cyfra jednostek - numer miesiąca (1-12) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek - numer dnia miesiąca (1-31) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek - numer dnia tygodnia (1-7) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek - numer godziny (0-23) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek - numer minuty (0-59) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek - numer sekundy (0-59) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek 6.2. Pytanie o UPTIME Moduł odpowiada na pytanie o czas jaki upłynął od startu (up time). Tabela 11. Ramka PYTANIE O UPTIME (0x113) z magistrali CAN 0x113 0x0 KOMP ID2 0x1130 Ramka PYTANIE O UPTIME KOMP ID2 Tabela 12. Ramka odpowiedzi na PYTANIE O UPTIME z magistrali CAN 0x113 0x1 0xFF 0xFF 0xFF 0xFF UPTIME3 UPTIME2 UPTIME1 UPTIME0 0x1131 Ramka odpowiedzi na PYTANIE O UPTIME - numer grupy modułu pytanego UPTIME - (UPTIME3*256 3 +UPTIME2*256 2 +UPTIME1*256 1 +UPTIME0*256 0 ) w sekundach 2015 hapcan.com univ_3-102-0-1c_pl.pdf - strona 4 / 7
6.3. Pytanie o STAN ZDROWIA modułu Moduł odpowiada na pytanie o jego kondycję. Tabela 13. Ramka STAN ZDROWIA PYTANIE O STATUS (0x115) z magistrali CAN 0x115 0x0 KOMP ID2 0x01 0x1150 Ramka STAN ZDROWIA KOMP ID2 0x01 - pytanie o status Tabela 14. Ramki odpowiedzi na STAN ZDROWIA PYTANIE O STATUS z magistrali CAN 0x115 0x1 0x01 RXCNT TXCNT RXCNTMX TXCNTMX CANINTCNT RXERRCNT TXERRCNT 0x1151 Ramka odpowiedzi na STAN ZDROWIA PYTANIE O STATUS - numer grupy modułu pytanego 0x01 RXCNT TXCNT RXCNTMX TXCNTMX CANINTCNT RXERRCNT TXERRCNT - ramka 1 (stany od ostatniego włączenia) - aktualny poziom zajętości bufora odbiorczego FIFO - aktualny poziom zajętości bufora nadawczego FIFO - maksymalny poziom zajętości bufora odbiorczego FIFO od czasu włączenia modułu - maksymalny poziom zajętości bufora nadawczego FIFO od czasu włączenia modułu - ilość restartów interfejsu CAN - aktualny rejestr błędów odbioru interfejsu CAN - aktualny rejestr błędów nadawania interfejsu CAN 0x115 0x1 0x02 0xFF 0xFF RXCNTMXE TXCNTMXE CANINTCNTE RXERRCNTE TXERRCNTE 0x1151 Ramka odpowiedzi na PYTANIE O STAN ZDROWIA - numer grupy modułu pytanego 0x02 RXCNTMXE - ramka 2 (maksymalne zarejestrowane stany i zapisane w pamięci eeprom) - maksymalny zarejestrowany w pamięci nieulotnej poziom zajętości bufora odbiorczego FIFO TXCNTMXE - maksymalny zarejestrowany w pamięci nieulotnej poziom zajętości bufora nadawczego FIFO od czasu włączenia modułu CANINTCNTE - maksymalna zarejestrowana w pamięci nieulotnej ilość restartów interfejsu CAN RXERRCNTE TXERRCNTE - maksymalny zarejestrowany w pamięci nieulotnej rejestr błędów odbioru interfejsu CAN - maksymalny zarejestrowany w pamięci nieulotnej rejestr błędów nadawania interfejsu CAN Aby wyzerować wartości maksymalne zapisane w pamięci eeprom modułu, należy wysłać ramkę jak w Tabela 15. Moduł nie odpowiada na tę ramkę. Tabela 15. Ramka STAN ZDROWIA PYTANIE O WYZEROWANIE (0x115) z magistrali CAN 0x115 0x0 KOMP ID2 0x02 0x1150 Ramka STAN ZDROWIA KOMP ID2 0x02 - pytanie o wyzerowanie 2015 hapcan.com univ_3-102-0-1c_pl.pdf - strona 5 / 7
6.4. Sterowanie Moduł umożliwia ustawienie daty i godziny. Instrukcje sterujące zebrano w Tabela 7. Tabela 16. Ramka STEROWANIA (0x10A) 0x10A 0x0 KOMP ID2 INSTR1 INSTR2 INSTR3 INSTR4 INSTR5 INSTR6 0x10A0 ramka zawierająca instrukcję do wykonania KOMP ID2 INSTR1-6 - numer modułu, który jest sterowany - numer grupy modułu, który jest sterowany - 6 bajtów instrukcji do wykonania 6.5. Budowa ramki zegara RTC Moduł umożliwia wysyłanie okresowe (co 1 minutę) ramki zawierającej aktualną datę i czas. Ramka ta może zmieniać stan innych modułów w sieci. Tabela 17. Ramka zegara RTC z magistrali CAN 0x300 0x0 0xFF 0x3000 Ramka odpowiedzi na PYTANIE O STATUS - numer grupy modułu pytanego - numer roku (0-99) w formacie BCD, <7:4>-cyfra dziesiątek, <3:0>-cyfra jednostek - numer miesiąca (1-12) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek - numer dnia miesiąca (1-31) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek - numer dnia tygodnia (1-7) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek - numer godziny (0-23) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek - numer minuty (0-59) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek - numer sekundy (0-59) w formacie BCD, <7:4>- cyfra dziesiątek, <3:0>- cyfra jednostek 7. Konfiguracja Konfigurację wykonuje się używając oprogramowania HAPCAN Programator. 7.1. Identyfikator Każdemu modułowi w sieci HAPCAN musi być przypisany unikalny numer. Numer ten składa się z dwóch bajtów, numeru modułu (1 bajt) i numeru grupy (1 bajt). 7.2. Opis modułu Moduł może zostać opisany 16 znakami w celu ułatwienia użytkownikowi identyfikowania. 7.3. Kalibracja zegara Zegar może być kalibrowany w zakresie od -2,75min do +5,5min na miesiąc (31 dni). 7.4. Cykliczne wysyłanie czasu Możliwa jest konfiguracja cyklicznego (co 1 minutę) wysyłania ramki zegara czasu rzeczywistego do portu ethernetowego i/lub magistrali CAN. 7.5. Harmonogram zdarzeń Możliwe jest dowolne zdefiniowanie 128 wiadomości CAN, które zostaną wysłane na magistralę o określonym czasie i dniu. Wiadomości te mogą być wysyłane cykliczne lub jednorazowo i mogą zmienić stan innych modułów w sieci. 7.6. Notatki tekstowe W pamięci modułu można zapisać 1024 znaki tekstowe. 7.7 Reset ustawień. Po zainstalowaniu firmware aktywny staje się jumper JP1, który umożliwia skasowanie wszystkich ustawień (w tym hasła dostępu) modułu Tibbo. Procedura została opisana w dokumencie Firmware modułu Tibbo Interfejsu ethernetowego. Od wersji hardware revision 3, jumper JP1 jest aktywny nawet bez zainstalowanego oprogramowania firmware. 2015 hapcan.com univ_3-102-0-1c_pl.pdf - strona 6 / 7
8. Licencja Oprogramowanie sprzętowe Projektu Automatyki Domowej HAPCAN, Copyright (C) 2015 hapcan.com To jest wolne oprogramowanie. Możesz je modyfikować i rozprowadzać na warunkach licencji GNU General Public License, opublikowanej przez Free Software Foundation, w wersji 3 lub (według Twojego wyboru) w jakiejkolwiek wersji późniejszej. Niniejsza oprogramowanie rozpowszechniane jest z nadzieją, iż będzie one użyteczne, jednak BEZ JAKIEJKOLWIEK GWARANCJI, również bez gwarancji PRZYDATNOŚCI HANDLOWEJ albo PRZYDATNOŚCI DO OKREŚLONYCH CELÓW. W celu uzyskania bliższych informacji zobacz pełną treść licencji GNU GPL. Powinieneś był otrzymać licencję GNU GPL razem z oprogramowaniem. Jeśli nie spójrz na <http://www.gnu.org/licenses/>. 9. Wersja dokumentu Plik Opis Data univ_3-102-0-1a_pl.pdf Wersja oryginalna Listopad 2013 univ_3-102-0-1b_pl.pdf Poprawki w tabeli 7 Maj 2014 univ_3-102-0-1c_pl.pdf Zwiększono rozmiar CAN RX FIFO w rev2 Październik 2015 2015 hapcan.com univ_3-102-0-1c_pl.pdf - strona 7 / 7