K8055-MARIE : Příkazy a řízení

Příkazy a řízení

Komunikace mezi řídicí webovou stránkou a aplikací K8055-MARIE je realizována pomocí javascriptového modulu XMLHttpRequest a řízení samotné využívá tzv. metody AJAX. Jedná se o kombinaci využívání javascriptového modulu, který je implementován do moderních internetových prohlížečů, na straně klienta a podpůrných PHP skriptů běžících na straně serveru. Díky tomuto způsobu řízení není třeba na straně klienta instalovat žádné potřebné rozšíření např. prostředí JAVA pro běh appletů, či prvky různých rozšíření ActiveX.

Vzdálené řízení je realizováno klasickou webovou stránkou psanou v HTML jazyce, rozšířenou o příkazy JavaScriptu ke komunikaci s deskou K8055 (viz obr. 1). Tyto příkazy jsou uloženy v externím souboru K8055.js, který se k dané webové stránce připojí stejně jako každý jiný javascriptový soubor. Z důvodů zachování kompatibility pro jednotlivé verze a typy internetových prohlížečů, je metoda AJAX zprostředkována standardní JavaScriptovou knihovnou jQuery, ta celé komunikaci dodává bezpečnost a spolehlivost.

schéma komunikace strany klienta a serveru při instalaci na dvou rozdílných PC

obr. 1 - Schéma komunikace strany klienta a serveru.

Rozšiřující JavaScriptové příkazy pro K8055

Knihovna příkazů K8055.js

Knihovnu javascriptových příkazů k řídicí webové stránce připojíme přilinkováním souborů jQuery.js a K8055.js v sekci <head>...</head> dané webové stránky. V ukázkovém demo-souboru jsou tyto soubory uloženy ve složce jvs.

Kód ukázkovém souboru K8055-MARIE_demo.htm pak vypadá následovně:


		<!DOCTYPE html>

		<html>

		<head>

		<meta http-equiv="content-type" content="text/html; charset=UTF-8">

		<!-- BEGIN - JavaScripts for Remote Control -->
		
		<script src="jvs/jquery.min.js"></script>

		<script>

		   var MARIE_URL = 'http://K8055-MARIE_IP:PORT';

		</script>

		<script src="jvs/K8055.js"></script>

		<script>

		   SetCurrentDevice(K8055-ADR);

		</script>

		
		<!-- END - JavaScripts for Remote Control -->

		:

		atd./etc.

Soubor jquery.min.js je knihovna jQuery, která rozšiřuje HTML stránku o obecné příkazy komunikace AJAX. Soubor K8055.js pak stránku rozšiřuje o příkazy vzdáleného řízení karty K8055. Do proměnné MARIE_URL je třeba ještě před načtením knihovny K8055.js uložit IP adresu (nebo URL) počítače, na kterém je spuštěna aplikace K8055-MARIE (včetně nastaveného portu). Zde je tato hodnota označena formálním http://K8055-MARIE_IP:PORT. Pokud není proměnná MARIE_URL nastavena, je do ní knihovnou K8055.js vložena výchozí hodnota http://127.0.0.1:80 - což odpovídá tzv. localhost. Po načtení knihovny K8055.js je dobré nastavit adresu USB desky K8055, kterou chceme ovládat. To provedeme příkazem SetCurrentDevice(), jehož parametrem (zde označen K8055-ADR) je hodnota 0-3 - dle adresy použité desky (naspaveno pomocí přepínači switch přímo na desce).

Řídicí příkazy lze vyvolávat standardními událostmi JavaScriptu (např. načtení stránky, kliknutí na prvek, vypršení časovače… apod.). Vytvoření řídicí webové stránky je pak plně v kompetenci jejího tvůrce.

Příklad: Ukázka kódu webového prvku (tlačítka), které po kliknutí nastaví všechny digitálních výstupy desky K8055 na hodnoty logické 1:
<input type="BUTTON" value="Zapni výstupy" onClick="SetAllDigital();">

Příkazy knihovny K8055.js

Příkazy se snaží svou syntaxí korespondovat s originálními příkazy použitými v DLL knihovně příkazů firmy Velleman. Pro potřeby rozšířeného a rychlejšího vzdáleného řízení byly od verze 2.00 přidány další příkazy. Přehled příkazů knihovny K8055.js je uveden v tabulce níže.

K8055D.DLL v5.0.0.0 - Technická příručka - česky

Popis funkcí a procedur obsažených v DLL knihovně K8055D.DLL pro přímé řízení USB desky K8055 (český překlad, anglický originál na webu firmy Velleman).

Následující tabulka zobrazuje seznam příkazů javascriptové knihovny K8055.js včetně jejich popisu:

K8055-MARIE (ver. 1.00 → x.xx)

Příkaz

Popis příkazu

ReadAnalogChannel(Channel)

Funkce vrací celé číslo (0-255) odpovídající napětí na analogovém vstupu. Proměnná Channel udává zda jde o vstup 1 či 2

Příklad: (načtení analogovém vstupu 1 do proměnné AD1)

var AD1 = ReadAnalogChannel(1);

ReadAllAnalog()

Funkce vrací řetězec znaků složený z dvojice čísel odpovídající napětím na analogových vstupech. Obě hodnoty jsou odděleny znakem |.

Příklad: (převod výstupního řetězce do číselných proměnných hod1 a hod2)

var vyst = ReadAllAnalog(); var hod = new Array(2); hod = vyst.split('|'); var hod1 = parseInt(hod[0]); var hod2 = parseInt(hod[1]);

OutputAnalogChannel(Channel, Data)

Nastavení analogového výstupu - proměnná Channel určuje zda se jedná o výstup 1 či 2. Číselná proměnná Data (rozmezí 0-255) určuje hodnotu výstupního napětí (resp. šířky modulovaného signálu)

Funkce vrací hodnotu true při úspěšném nastavení výstupu (resp. false při nezdaru).

SetAnalogChannel(Channel)

Nastaví zadaný analogový výstup (proměnná Channel) na maximální hodnotu 255.

Funkce vrací hodnotu true při úspěšném nastavení výstupu (resp. false při nezdaru).

Pozn.:
Totéž jako funkce OutputAnalogChannel(Channel, 255)

ClearAnalogChannel(Channel)

Nastaví zadaný analogový výstup (proměnná Channel) na minimální hodnotu 0.

Funkce vrací hodnotu true při úspěšném nastavení výstupu (resp. false při nezdaru).

Pozn.:
Totéž jako funkce OutputAnalogChannel(Channel, 0)

OutputAllAnalog(Data1, Data2)

Nastaví oba analogové výstupy na zadané hodnoty proměnných Data1 a Data2.

Funkce vrací hodnotu true při úspěšném nastavení výstupů (resp. false při nezdaru).

SetAllAnalog()

Nastaví oba analogové výstupy na maximální hodnotu 255.

Funkce vrací hodnotu true při úspěšném nastavení výstupů (resp. false při nezdaru).

Pozn.:
Totéž jako funkce OutputAllAnalog(255, 255)

ClearAllAnalog()

Nastaví oba analogové výstupy na minimální hodnotu 0.

Funkce vrací hodnotu true při úspěšném nastavení výstupů (resp. false při nezdaru).

Pozn.:
Totéž jako funkce OutputAllAnalog(0, 0)

SetDigitalChannel(Channel)

Nastaví zadaný bit (proměnná Channel) z osmice výstupních digitálních linek na hodnotu logické 1 (tj. na výstupní svorkovnici stav sepnuto).

Funkce vrací hodnotu true při úspěšném nastavení výstupu (resp. false při nezdaru).

ClearDigitalChannel(Channel)

Nastaví zadaný bit (proměnná Channel) z osmice výstupních digitálních linek na hodnotu logické 0 (tj. na výstupní svorkovnici stav vypnuto).

Funkce vrací hodnotu true při úspěšném nastavení výstupu (resp. false při nezdaru).

WriteAllDigital(Data)

Nastaví jednotlivé bity osmice výstupních digitálních linek na hodnoty odpovídající binární podobě čísla zadaného proměnnou Data.

Funkce vrací hodnotu true při úspěšném nastavení výstupů (resp. false při nezdaru).

SetAllDigital()

Nastaví všechny výstupní digitální linky na hodnotu logické 1 (tj. na výstupní svorkovnici stav sepnuto).

Funkce vrací hodnotu true při úspěšném nastavení výstupů (resp. false při nezdaru).

Pozn.:
Totéž jako funkce WriteAllDigital(255)

ClearAllDigital()

Nastaví všechny výstupní digitální linky na hodnotu logické 0 (tj. na výstupní svorkovnici stav vypnuto).

Funkce vrací hodnotu true při úspěšném nastavení výstupů (resp. false při nezdaru).

Pozn.:
Totéž jako funkce WriteAllDigital(0)

ReadDigitalChannel(Channel)

Vrací hodnotu true (resp. false) pokud je v okamžiku dotazu stisknutý jeden z pětice (určen proměnnou Channel) digitálních vstupů.

ReadAllDigital()

Vrací celé číslo sestavující se z hodnot stisknutých digitálních vstupů. (první vstup: 1, druhý: 2, třetí: 4, čtvrtý: 8, pátý: 16)

Příklad: (vymaskování stavů digitálních vstupů)

var pom = ReadAllDigital(); if ((pom & 1) != 0) {1. vstup JE stisknut} else {1. vstup NENÍ stisknut}; if ((pom & 2) != 0) {2. vstup JE stisknut} else {2. vstup NENÍ stisknut}; if ((pom & 4) != 0) {3. vstup JE stisknut} else {3. vstup NENÍ stisknut}; if ((pom & 8) != 0) {4. vstup JE stisknut} else {4. vstup NENÍ stisknut}; if ((pom & 16) != 0) {5. vstup JE stisknut} else {5. vstup NENÍ stisknut};

ReadCounter(CounterNr)

Vrací hodnotu (0-65535) jednoho ze dvou čítačů (digitální vstupy 1 a 2). Číslo čítače je určeno proměnnou CounterNr.

Čítač registruje od okamžiku svého vynulování a reaguje jen na pulsy zadané délky (viz dále).

ResetCounter(CounterNr)

Vynulování hodnoty čítače 1 či 2 (určeno proměnnou CounterNr)

Funkce vrací hodnotu true při úspěšném vynulování čítače (resp. false při nezdaru).

SetCounterDebounceTime(CounterNr, TimeDebounceTime)

Nastavení minimální délky impulsů v milisekundách (celočíselná proměnná TimeDebounceTime), která budou registrovány zadaným čítačem 1 nebo 2 (proměnná CounterNr).

Funkce vrací hodnotu true při úspěšném nastavení čítače (resp. false při nezdaru).

Všechny příkazy uvedené v tabulce výše byly (od verze 2.7) rozšířeny o nepovinný parametr callback - je popsán níže. Výše uvedené příkazy jsou ve vyšších verzích zpětně kompatibilní s verzemi nižšími (pochopitelně bez parametru callback).

Příkazy v následující tabulce jsou platné až od verze 2.5 (bez callback) a 2.7 (s callback).

K8055-MARIE (ver. 2.7 → x.xx)

Příkaz

Popis příkazu – Pozn.: Parametr v [ ] je volitelný

SearchDevices([callback])

Vrátí řetězec složený z adres (0-3) USB desek K8055 připojených k PC a povolených aplikací K8055-MARIE (Adresy desek jsou oddělené znakem | ).