1. Cechy Oprogramowanie sterownika RGB LED Sterowanie napięciem (regulacja PWM) w 256 krokach (0-255) dla każdego kanału Kanał MASTER regulowany również w 256 krokach Wartość minimalna i maksymalna dla każdego kanału Pamięć ostatniego stanu. Regulowany czas ściemniania dla każdego kanału 37 instrukcji sterujących modułem 3 instrukcje blokujące 4 timer-y (1 dla każdego kanału) 1s-24h opóźniających wykonanie niektórych instrukcji Umożliwia zdefiniowanie 128 wiadomości CAN, które odebrane przez moduł mogą zmienić jego stan Umożliwia określenie stanów początkowych kanałów po włączeniu zasilania modułu. Pomiar czasu od włączenia urządzenia Monitorowanie stanu zdrowia modułu Nadawczy (42 wiadomości) i odbiorczy (42 wiadomości) bufor FIFO do i z magistrali 2. Kompatybilność Firmware dla modułu UNIV 3.8.0.x Firmware można wgrać do urządzeń z bootloaderem w wersji 3.1 i kompatybilnymi. 3. Wersja firmware UNIV 3. 8. 0. 0 wersja firmware wersja aplikacji typ aplikacji (sterownik RGB LED) wersja procesora procesor uniwersalny 4. Ramki komunikacyjne (wiadomości) 4.1. Budowa ramki sterownika RGB LED Moduł wysyła na magistralę jedną wiadomość dla każdego kanału w chwili, gdy zmieni się ich stan. Poniższa tabela pokazuje znaczenie poszczególnych bajtów w ramce. Tabela 1. RAMKA STEROWNIKA RGB LED (0x308). 0x308 3 2 1 0 0xFF 0xFF KANAŁ STAN PRZEK INSTR1 INSTR2 TIMER 0x308 moduł uniwersalny, sterownik RGB LED 3 - - flaga nieużywana o wartości zawsze 0 2 - - flaga nieużywana o wartości zawsze 0 1 - - flaga nieużywana o wartości zawsze 0 0 ODP - flaga odpowiedzi. Jeśli ramka została wysłana w skutek zapytania o stan to ODP = 1, inaczej ODP = 0. ODP = 0 informuje, że stan modułu właśnie się zmienił. - numer modułu wysyłającego wiadomość - numer grupy modułu wysyłającego wiadomość KANAŁ STAN PRZEK - numer kanału sterownika (0x01 czerwony, 0x02 zielony, 0x03 niebieski, 0x04 - MASTER) - aktualny stan kanału od 0x00 do 0xFF - aktualny stan wszystkich kanałów (0x00 - jeśli żaden kanał nie jest włączony, 0xFF - jeśli kanał MASTER i któryś z kanałów koloru jest włączony) ten bajt można użyć do sterownia przekaźnikiem, który włącza zasilanie dla LED. Bajt ten jest dostępny tylko w ramce kanału MASTER 2014 hapcan.com univ_3-8-0-0a_pl.pdf - strona 1 / 6
INSTR1 INSTR2 - instrukcja, która oczekuje na wykonanie, lub wartość 0xFF, jeśli żadna nie oczekuje - drugi bajt instrukcji oczekującej na wykonanie, lub 0xFF TIMER - czas opóźnienia instrukcji oczekującej na wykonanie dla danego kanału, lub 0x00, jeśli żadna nie oczekuje 4.2. Pytanie o status Stan modułu może być sprawdzony poprzez wysłanie ramki PYTANIE O STATUS (0x109) (Tabela 2). Tabela 2. Ramka PYTANIE O STATUS (0x109). 0x109 0x0 KOMP ID2 0x1090 Ramka PYTANIE O STATUS W odpowiedzi moduł prześle ramki statusu (jedną dla każdego kanału) (Tabela 3). Znaczenie bajtów jest identyczne jak dla Tabeli 1. Tabela 3. Odpowiedź na PYTANIE O STATUS. 0x308 0x1 0xFF 0xFF 0x01 STAN 0xFF INSTR1 0x01 TIMER1 0x308 0x1 0xFF 0xFF 0x02 STAN 0xFF INSTR1 0x02 TIMER2 0x308 0x1 0xFF 0xFF 0x03 STAN 0xFF INSTR1 0x04 TIMER3 0x308 0x1 0xFF 0xFF 0x04 STAN PRZEK INSTR1 0x08 TIMER4 4.3. Pytanie o UPTIME Moduł odpowiada na pytanie o czas jaki upłynął od startu (up time). Tabela 4. Ramka PYTANIE O UPTIME (0x113). 0x113 0x0 KOMP ID2 0x1130 Ramka PYTANIE O UPTIME Tabela 5. Ramka odpowiedzi na PYTANIE O UPTIME (0x113). 0x113 0x1 0xFF 0xFF 0xFF 0xFF UPTIME3 UPTIME2 UPTIME1 UPTIME0 0x1131 Ramka odpowiedzi na PYTANIE O UPTIME - numer modułu sterownika - numer grupy modułu sterownika UPTIME - (UPTIME3*256 3 +UPTIME2*256 2 +UPTIME1*256 1 +UPTIME0*256 0 ) w sekundach 2014 hapcan.com univ_3-8-0-0a_pl.pdf - strona 2 / 6
4.4. Pytanie o STAN ZDROWIA modułu Moduł odpowiada na pytanie o jego kondycję. Tabela 6. Ramka STAN ZDROWIA PYTANIE O STATUS (0x115). 0x115 0x0 KOMP ID2 0x01 0x1150 Ramka STAN ZDROWIA 0x01 - pytanie o status Tabela 7. Ramki odpowiedzi na STAN ZDROWIA PYTANIE O STATUS (0x115). 0x115 0x1 0x01 RXCNT TXCNT RXCNTMX TXCNTMX CANINTCNT RXERRCNT TXERRCNT 0x1151 Ramka odpowiedzi na STAN ZDROWIA PYTANIE O STATUS - numer modułu sterownika - numer grupy modułu sterownika 0x01 RXCNT TXCNT - ramka 1 (stany od ostatniego włączenia) - aktualny poziom zajętości bufora odbiorczego FIFO - aktualny poziom zajętości bufora nadawczego FIFO RXCNTMX - maksymalny poziom zajętości bufora odbiorczego FIFO od czasu włączenia modułu TXCNTMX - maksymalny poziom zajętości bufora nadawczego FIFO od czasu włączenia modułu CANINTCNT - ilość restartów interfejsu CAN RXERRCNT - aktualny rejestr błędów odbioru interfejsu CAN TXERRCNT - 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 modułu sterownika - numer grupy modułu sterownika 0x02 - ramka 2 (maksymalne zarejestrowane stany i zapisane w pamięci eeprom) RXCNTMXE - 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 - maksymalny zarejestrowany w pamięci nieulotnej rejestr błędów odbioru interfejsu CAN TXERRCNTE - 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 Tabeli 8. Moduł nie odpowiada na tę ramkę. Tabela 8. Ramka STAN ZDROWIA PYTANIE O WYZEROWANIE (0x115). 0x115 0x0 KOMP ID2 0x02 0x1150 Ramka STAN ZDROWIA 0x02 - pytanie o wyzerowanie 2014 hapcan.com univ_3-8-0-0a_pl.pdf - strona 3 / 6
Bezpośr. Pośred. OPROGRAMOWANIE STEROWNIKA RGB LED 5. Sterowanie Moduł może być sterowany bezpośrednio z komputera, lub pośrednio - przez inne moduły. W obu przypadkach można wykorzystać opisane poniżej instrukcje sterujące. 5.1. Instrukcje sterujące W tabeli zebrano instrukcje wykonywane przez moduł. Niektóre instrukcje są wykonywane tylko przy sterowaniu bezpośrednim (np z PC) lub pośrednim (przez inne moduły). Tabela 9. Kodowanie instrukcji sterujących modułem Kod Instrukcji Sterowanie Instrukcja INSTR1 INSTR2 INSTR3 INSTR4 INSTR5 INSTR6 INSTR7 INSTR8 Opis USTAW LED1 (R) NA 0x00 STAN TIMER USTAW LED2 (G) NA 0x01 STAN TIMER Ustawia natychmiast stan kanału na poziom określony przez bajt STAN (0-255). Instrukcje mogą być opóźnione USTAW LED3 (B) NA 0x02 STAN TIMER jeśli wartość TIMER jest różna od zera. USTAW MASTER NA 0x03 STAN TIMER ZANEGUJ LED1 0x04 TIMER Jeśli kanał jest włączony to zostanie wyłączony. Jeśli jest ZANEGUJ LED2 0x05 TIMER wyłączony to zostanie włączony na wartość maksymalną ZANEGUJ LED3 0x06 TIMER lub ostatnio zapamiętaną (jeśli w konfiguracji ustawiono pamięć stanu dla danego kanału). Instrukcje mogą być ZANEGUJ MASTER 0x07 TIMER opóźnione jeśli wartość TIMER jest różna od zera. ŚCIEMNIJ LED1 O 0x08 WART TIMER ŚCIEMNIJ LED2 O 0x09 WART TIMER ŚCIEMNIJ LED3 O 0x0A WART TIMER ŚCIEMNIJ MASTER O 0x0B WART TIMER ROZJAŚNIJ LED1 O 0x0C WART TIMER ROZJAŚNIJ LED2 O 0x0D WART TIMER ROZJAŚNIJ LED3 O 0x0E WART TIMER ROZJAŚNIJ MASTER O 0x0F WART TIMER USTAW PŁYNNIE LED1 NA 0x10 STAN TIMER USTAW PŁYNNIE LED2 NA 0x11 STAN TIMER USTAW PŁYNNIE LED3 NA 0x12 STAN TIMER USTAW PŁYNNIE MASTER NA 0x13 STAN TIMER STOP LED1 0x14 STOP LED2 0x15 STOP LED3 0x16 STOP MASTER 0x17 START LED1 0x18 START LED2 0x19 START LED3 0x1A START MASTER 0x1B USTAW PRĘDKOŚĆ LED1 NA 0x1C WART USTAW PRĘDKOŚĆ LED2 NA 0x1D WART USTAW PRĘDKOŚĆ LED3 NA 0x1E WART USTAW PRĘDKOŚĆ MASTER NA.. 0x1F WART Stan kanału zostanie zmniejszony o wartość wskazaną przez bajt WART Stan kanału zostanie zwiększony o wartość wskazaną przez bajt WART Wartość określona przez bajt STAN zostanie ustawiona w sposób płynny. Oznacza to, że kanał zostanie płynnie rozjaśniony lub ściemniony w zależności od jego stanu początkowego. STOP zatrzymuje instrukcje, które są w trakcie wykonywania, np. instrukcję START lub USTAW PŁYNNIE NA... Instrukcja START rozpoczyna specyficzny proces sterowania kanałem. Jeśli w ciągu 400ms od otrzymania instrukcji START zostanie odebrana instrukcja STOP to kanał zmieni stan na przeciwny (tak jak instrukcja ZANEGUJ). Jeżeli po tym czasie instrukcja STOP nie zostanie odebrana to kanał zacznie ściemnianie (jeśli stan początkowy był max), lub rozjaśnianie (jeśli stan początkowy był min lub 0). W efekcie końcowym działa to w ten sposób, że przyciśnięcie na chwilę <400ms np. przycisku pilota spowoduje włączenie lub wyłączenie, a jego przytrzymanie ściemnianie lub rozjaśnianie kanału. Ustawia czas ściemniania dla poszczególnych kanałów. Bajt WART określa czas w jakim kanał ma zmienić stan od wartości 0 do 255. Bajt ten może mieć wartość od 0 do 255, co odpowiada 1s 256s. USTAW RGB NA 0x20 STAN1 STAN2 STAN3 TIMER Ustawia natychmiast wartości trzech kanałów jednocześnie. Instrukcja może być opóźniona jeśli wartość TIMER jest różna od zera. Ustawia płynnie wartości trzech kanałów jednocześnie. USTAW PŁYNNIE RGB NA 0x21 STAN1 STAN2 STAN3 TIMER Instrukcja może być opóźniona jeśli wartość TIMER jest różna od zera. Ustawia czas ściemniania kanałów 1, 2 i 3. Bajt WART USTAW PRĘDKOŚĆ RGB NA 0x22 WART określa czas w jakim kanały mają zmienić stan od wartości 0 do 255. Bajt ten może mieć wartość od 0 do 255, co odpowiada 1s 256s. ZWIĘKSZ PRĘDKOŚĆ RGB 0x23 Zmienia czas ściemniania dla wszystkich kanałów na kolejną mniejszą wartość ZMNIEJSZ PRĘDKOŚĆ RGB 0x24 Zmienia czas ściemniania dla wszystkich kanałów na kolejną większą wartość 0x00 Zatrzymuje wykonywany program Program1 każde wywołanie programu powoduje zmianę cykliczną kolorów w sekwencji: 1- czerwony 2- zielony 0x01 3- niebieski 4- żółty PROGRAM 0x25 5- cyjan 6- fioletowy 7- biały Program 2 pierwsze wywołanie programu uruchamia automatyczną zmianę kolorów z aktualná prędkością 0x02 rozpoczynając od koloru czerwonego. Drugie wywołanie programu zatrzymuje zmianę na wybranym kolorze. Kolejne uruchamia zmianę, ale w przeciwnym kierunku. ODBLOKUJ BOKS 0xDD BoksX BoksY Odblokuje wybrane boksy boksy zostaną sprawdzone przy odebraniu kolejnej wiadomości z magistrali ZABLOKUJ BOKS 0xDE BoksX BoksY Zablokuje wybrane boksy boksy zostaną pominięte przy odebraniu kolejnej wiadomości z magistrali Zaneguje blokadę tzn. zablokuje boksy jeśli były ZANEGUJ BLOKADĘ 0xDF BoksX BoksY odblokowane i vice versa bajt może mieć dowolną wartość BoksX 0x00 - od Boksu 1 0x01 - od Boksu 2 0x7F - od Boksu 128 Opis 2014 hapcan.com univ_3-8-0-0a_pl.pdf - strona 4 / 6
0 5 10 15 20 25 30 35 40 45 50 55 60 65 70 75 80 85 90 95 100 105 110 115 120 125 130 135 140 145 150 155 160 165 170 175 180 185 190 195 200 205 210 215 220 225 230 235 240 245 250 Czas opóźnienia [s] OPROGRAMOWANIE STEROWNIKA RGB LED BoksY 0x00 + 0 -(i żaden inny) 0x01 + 1 -(i jeden następny) 0x7F +127 -(i 127 następnych) Opis 5.2. Timer Wykonanie niektórych instrukcji może być opóźnione wykorzystując timer-y. Każdy kanał posiada własny niezależny timer. Czas opóźnienia może być ustawiony w zakresie 1s - 24h. Poniższy wykres pokazuje zależność czasu opóźnienia od wartości rejestru TIMER. 100000 24h, krok 15min 10000 60min, krok 1min 1000 100 5min, krok 5s 60s, krok 1s 10 1 wartość rejestru TIMER Rysunek 1. Zależność czasu opóźnienia od wartości rejestru TIMER. 5.3. Sterowanie bezpośrednie Sterując bezpośrednio należy wysłać na magistralę, ciąg bajtów jak w Tabeli 10. W odpowiedzi moduł wyśle ramki (0x109) aktualnych stanów. Tabela 10. Ramka STEROWANIE BEZPOŚREDNIE (0x10A) 0x10A 0x0 KOMP ID2 INSTR1 INSTR2 INSTR3 INSTR4 INSTR5 INSTR6 0x10A0 ramka zawierająca instrukcję do wykonania INSTR1-6 - numer modułu, który jest sterowany - numer grupy modułu, który jest sterowany - 6 bajtów instrukcji do wykonania 5.4. Sterowanie pośrednie Przy sterowaniu pośrednim moduł będzie reagował na wiadomości wysłane przez inne moduły w sieci. To, które wiadomości mają oddziaływać na moduł, określa się podczas konfiguracji zależności komunikacyjnych. Zależności te zdefiniowane są w 128 boksach (komórkach pamięci). Sterowanie pośrednie posiada możliwość ustawienia prostych warunków wykonania instrukcji. Wykorzystuje się do tego instrukcje blokujące jak w Tabeli 9. Instrukcji blokujących nie można użyć w sterowaniu bezpośrednim. 6. Konfiguracja Poniższe parametry modułu mogą być konfigurowane w tej wersji firmware. - Identyfikator modułu (numer modułu i numer grupy); - Opis modułu (16 znaków); - Wartości minimum i maksimum; - Prędkość ściemniania po włączeniu zasilania; - Stany początkowe LED po włączeniu zasilania; - Notatka tekstowa; - Zależności komunikacyjne; Proces konfiguracji wykonuje się używając oprogramowania HAPCAN Programator. 6.1. Identyfikator modułu 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). Przynależność modułu do konkretnej grupy może mieć znaczenie przy programowaniu systemu. Na przykład niektóre urządzenia mogą reagować na wiadomość wysłaną przez dowolny moduł w danej grupie. 2014 hapcan.com univ_3-8-0-0a_pl.pdf - strona 5 / 6
6.2. Opis modułu W celu ułatwienia użytkownikowi identyfikowania modułu w sieci, może on zostać opisany 16 znakami. 6.3. Wartości minimum i maksimum Istnieje możliwość zaprogramowania wartości minimalnej i maksymalnej dla każdego kanału, których sterownik nie przekroczy podczas normalnej pracy. 6.4. Prędkość ściemniania po włączeniu zasilania Określa jak szybko stan kanału zmieni się od wartości 0 do wartość 255. Czas ten można zmieniać w granicach 1s - 256s, z krokiem co 1s. Jest t 6.5 Stany początkowe LED po powrocie zasilania Dla każdego kanału indywidualnie można określić stan, jaki przyjmie po włączeniu zasilania (np. po zaniku napięcia). Można wybrać wartości 0-255, lub przyjąć ostatni stan zapisany w nieulotnej pamięci. Zapis stanu kanału do nieulotnej pamięci następuje po 6s od wykonania instrukcji. 6.6. Pamięć ostatniego stanu. Istnieje możliwość wyboru trybu pracy z pamięcią stanu lub bez pamięci dla każdego kanału. Po włączeniu kanału instrukcjami START lub ZANEGUJ, w trybie pamięci stanu, ustawia się on na wartość przed wyłączeniem. W trybie bez pamięci ustawia się na wartość maksymalną. 6.7. Notatka tekstowa. Do 1024 znaków tekstowych może być zapisanych do pamięci procesora. Mogą to być np. uwagi do konfiguracji modułu 6.8. Zależności komunikacyjne Moduł posiada 128 boksów (komórek pamięci), do których można wpisać wiadomości CAN, na jakie moduł ma reagować, kiedy odbierze je z magistrali. Każdy boks zawiera informację o tym, jaka wiadomość ma zainicjować działanie oraz jaka instrukcja ma być wykonana kiedy ta wiadomość zostanie odebrana. Moduł może reagować na konkretne urządzenie lub na grupę urządzeń, dzięki możliwości ustawienia, które bajty wiadomości CAN mają być sprawdzane jako warunek wykonania instrukcji. 7. Licencja Oprogramowanie sprzętowe Projektu Automatyki Domowej HAPCAN, Copyright (C) 2014 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/>. 8. Wersja dokumentu Plik Opis Data univ_3-8-0-0a_pl.pdf Wersja oryginalna Styczeń 2014 2014 hapcan.com univ_3-8-0-0a_pl.pdf - strona 6 / 6