Expresii / limbaj de scripting

TapHome are un singur limbaj de scripting pentru smart rules, notificări și integrările dispozitivelor. Sintaxa și funcțiile sunt aceleași peste tot; doar variabilele, constantele și funcțiile disponibile depind de locul în care rulează scriptul. Aplicația evidențiază sintaxa în editorul de scripturi.

Unde se folosesc scripturile

Același limbaj de scripting rulează în smart rules, în notificări și în integrările Modbus și Packet parser:

Context	Ce face scriptul	Specific contextului
Smart rule Ecuație	O singură expresie peste valorile dispozitivelor. `TRUE` execută acțiunile pentru adevărat, `FALSE` acțiunile pentru fals.	`LastState`, `TriggerName`
Smart rule Formulă	Calculează o valoare care se scrie în fiecare dispozitiv de ieșire.	`LastState`, `TriggerName`
Smart rule Script	Citește valorile dispozitivelor și atribuie valori noi; fiecare atribuire devine o acțiune a dispozitivului.	Variabile de citire/scriere, `TriggerName`
Condiția de limitare Formulă	Decide dacă smart rule poate rula.	`TRUE` permite rularea regulii
Titlul și mesajul notificării	Compune textul notificării.	Trebuie să returneze text; constantele notificării
Scriptul de citire al modulului Modbus	Interoghează modulul, de regulă pentru a semnala erori ale dispozitivelor.	Funcțiile `MODBUS*`
Scripturile de citire și scriere ale dispozitivului Modbus	Convertesc registrele în valoarea dispozitivului și valoarea cerută înapoi în registre.	Rezultatul citirii devine valoarea dispozitivului
Scriptul de inițializare Modbus	Rulează o singură dată după conectarea modulului.	De regulă `MODBUSWNE`
Scripturile de citire și scriere Packet parser	Trimit o cerere sau o comandă prin HTTP, FTP, TCP, UDP sau MQTT; la HTTP și FTP prelucrează și răspunsul.	`SENDHTTPREQUEST`, `SENDDATA`, `MQTTPUBLISH`
Scriptul listener Packet parser	Tratează fiecare pachet TCP sau UDP primit și fiecare mesaj MQTT.	`RECEIVEDMSG`
Atribute și acțiuni de service (Modbus, Packet parser)	Rânduri de diagnostic și butoane cu parametri în aplicație.	Parametrii acțiunii după abrevierea lor

SLEEP este respins în smart rules și în notificări (excepția este condiția de limitare Formulă). ADDERROR, ADDWARNING și ADDINFO funcționează doar în scripturile dispozitivelor. Ce transmite fiecare smart rule scriptului său se găsește pe pagina Scripturi în smart rules și notificări; integrările au paginile lor proprii, Funcții Modbus și Funcții Packet parser.

Rezultatul scriptului

Un script este o listă de instrucțiuni. Valoarea ultimei instrucțiuni evaluate este rezultatul scriptului. RETURN încheie scriptul mai devreme cu valoarea dată.

VAR a := 1;
VAR b := 2;
a + b;
# Result: 3

Rezultatul scriptului de citire al unui dispozitiv trebuie să corespundă valorii dispozitivului, altfel scriptul eșuează cu Return value 'X' does not match required return type constraint:

Valoarea dispozitivului	Rezultat permis
Starea întrerupătorului, contact reed	`TRUE` sau `FALSE` (se acceptă și numere), `NaN`, `Null`
Starea comutatorului cu mai multe valori	Număr (un număr întreg selectează starea; o valoare zecimală nu este respinsă), `NaN`, `Null`
Orice altă valoare	Număr, `NaN`, `Null`

NaN înseamnă „valoarea este necunoscută", Null înseamnă „nu există nicio valoare". Cum se comportă cele două în expresii este descris în Null și NaN.

Paginile acestei secțiuni

Referința limbajului de scripting are patru grupe de pagini: un ghid al limbajului, funcțiile pe domenii, funcțiile integrărilor și listele de referință.

Ghid

Sintaxă și controlul fluxului — instrucțiuni, comentarii, literali, IF, SWITCH, buclele WHILE și DO, RETURN.
Tipuri de date — numere, text, tipuri structurate și enumerări, colecții, .Type, promovarea tipurilor, Null și NaN.
Variabile și constante — variabilele dispozitivelor, valorile grupurilor, variabilele modulului, VAR și declarațiile cu tip, proprietăți, constantele contextului.
Statistici și Value info — statisticile unui dispozitiv, Value info cu momentul ultimei modificări, valoarea anterioară și valorile perioadelor încheiate.
Operatori — lista operatorilor, precedența, evaluarea prin scurtcircuitare, echivalentele din Excel.
Scripturi în smart rules și notificări — Ecuație, Formulă, Script, condiția de limitare Formulă și notificările.

Funcții

Logică și diagnostic — ISNULL, ISNAN, EQUALS, SLEEP, ADDERROR, ADDWARNING, ADDINFO, DEBOUNCE.
Funcții matematice — MIN, MAX, AVG (omit valorile necunoscute, variantele …STRICT nu), ABS, SIGN, SQRT, POWER, MOD, LOG, LN, DEWPOINT.
Rotunjire și numere aleatoare — ROUND, CEIL, FLOOR, RAND, RANDINT.
Interpolare și praguri — LINEAR transpune o valoare dintr-un interval în altul (de exemplu o curbă de reglare a intensității), HYSTERESIS.
Operații pe biți — GETBIT, GETBITS, SETBIT, SETBITS, GETBYTE, SETBYTE, TOBCD, FROMBCD.
Text și colecții — LENGTH, GETAT, SETAT, APPEND, INSERT, REMOVEAT, COPY, INDEXOF, REPLACE, SPLIT, COMPARE, BYTECOLLECTION, UINT16COLLECTION, BOOLCOLLECTION.
Sortare — ORDER, ORDERINDEX și variantele lor descrescătoare și stricte.
Data și ora — NOW, DATETIME, DATETIMEADD, TIMESPAN, LOCALTIMEZONE.
Conversii de tipuri de date — TOSTRING, TODOUBLE, TOBYTES, ENCODE, DECODE.
Culori — HSVTORGB, RGBTOHSV.
Funcții de parsare — PARSETEXT, PARSEJSON (citește o valoare din JSON după calea ei), PARSEXML.
Date binare — PACKVALUE, UNPACKVALUE.
Criptare și hash-uri — AESENCRYPT, AESDECRYPT, HASH, HMAC, RANDBYTES.
Codificări de octeți și sume de control — TOBASE64, FROMBASE64, TOHEX, FROMHEX, CRC16, CRC32.

Integrări

Funcții Modbus — tipuri de registre, MODBUSR, MODBUSW, MODBUSWNE, MODBUSRBLOCK, MODBUSWBLOCK, MODBUSWBLOCKNE.
Tipuri de date Modbus — tipurile de date ale funcțiilor Modbus, variantele ordinii octeților, tipuri pe 64 de biți, text.
Scripturi Modbus și prefetch — ce scripturi au un modul și un dispozitiv Modbus, când rulează, prefetch și memorarea în cache.
Funcții Packet parser — HTTPREQUEST, SENDHTTPREQUEST, SENDDATA, MQTTPUBLISH, FTPDOWNLOAD, FTPUPLOAD, COMPLETESERVICEATTRIBUTE, COMPLETESERVICEACTION.
Scripturi listener — scriptul listener al unui modul Packet parser, RECEIVEDMSG și RECEIVEDBYTES.

Referință

Exemple de scripturi — scripturi complete din șabloane reale de dispozitive.
Erori de script și depanare — mesajele de eroare la parsare și la rulare și cum se remediază.
Cerințe de versiune pentru scripturi — versiunea Core de care are nevoie fiecare funcție.
Funcții de script A–Z — fiecare funcție cu o propoziție și un link.

Sintaxă și controlul fluxului

Sintaxa limbajului de scripting TapHome: instrucțiuni și punct și virgulă, comentarii, literali, IF în formă de funcție și de bloc, SWITCH, buclele WHILE și DO, BREAK, CONTINUE și RETURN.

Tipuri de date

Tipurile de date ale limbajului de scripting TapHome: numere, text, tipuri structurate și enumerări, colecții, proprietatea .Type, promovarea tipurilor în aritmetică și comportamentul lui Null și NaN.

Variabile și constante

Variabilele din scripturile TapHome: valorile dispozitivelor după abreviere, valorile grupurilor, variabilele modulului și ale dispozitivului, VAR și declarațiile cu tip, atribuirea, proprietățile și constantele contextului.

Statistici și Value info

Statistici și Value info în scripturile TapHome: valoarea unei statistici, momentul ultimei modificări, valoarea anterioară și ultima valoare cunoscută și valorile perioadelor încheiate.

Operatori

Operatorii limbajului de scripting TapHome: aritmetici, de comparație, pe biți și logici, cele 10 niveluri de precedență, capcana a & 1 > 0, evaluarea prin scurtcircuitare și echivalentele din Excel.

Scripturi în smart rules și notificări

Ce transmit unui script smart rules Ecuație, Formulă și Script, condiția de limitare Formulă și scripturile notificărilor și ce fac cu rezultatul lui: LastState, TriggerName, ieșiri, erori și SLEEP.

Logică și diagnostic

Funcțiile de script TapHome pentru valori necunoscute și diagnosticul dispozitivelor: ISNULL, ISNAN, EQUALS, SLEEP, ADDERROR, ADDWARNING, ADDINFO și DEBOUNCE.

Funcții matematice

Funcțiile matematice ale scripturilor TapHome — MIN, MAX, AVG și variantele lor STRICT, ABS, SIGN, SQRT, POWER, MOD, LOG, LN și DEWPOINT.

Rotunjire și numere aleatoare

Funcțiile de script TapHome pentru rotunjire și numere aleatoare — ROUND, CEIL și FLOOR cu multiplu de rotunjire, RAND și RANDINT.

Interpolare și praguri

Interpolarea liniară LINEAR și comutarea pe praguri HYSTERESIS pentru maparea valorilor, reglarea intensității luminilor și controlul încălzirii în scripturile TapHome.

Operații pe biți

Manipularea biților și octeților în scripturile TapHome — GETBIT, GETBITS, SETBIT, SETBITS, GETBYTE, SETBYTE, TOBCD, FROMBCD, lățimea în biți după tip și operatorii pe biți cu echivalentele din Excel.

Text și colecții

Funcțiile de script TapHome pentru șiruri de caractere, colecții și tablouri de octeți — LENGTH, GETAT, SETAT, APPEND, INSERT, REMOVEAT, COPY, INDEXOF, REPLACE, SPLIT, COMPARE, BYTECOLLECTION, UINT16COLLECTION, BOOLCOLLECTION.

Sortare

Funcțiile de sortare ale scripturilor TapHome — ORDER, ORDERINDEX și variantele lor STRICT și descrescătoare pentru sortarea valorilor sau returnarea indicilor ordinii de sortare.

Data și ora

Funcțiile de dată și oră ale scripturilor TapHome — NOW, DATETIME, DATETIMEADD, TIMESPAN și LOCALTIMEZONE — și proprietățile valorilor datetime și timespan.

Conversii de tipuri de date

Funcțiile de conversie din scripturile TapHome — TOSTRING cu șiruri de format pentru numere și date, TODOUBLE, TOBYTES și ENCODE / DECODE pentru escaparea XML și Base64.

Culori

Funcțiile de culoare din scripturile TapHome — HSVTORGB și RGBTOHSV — și tipurile de valori rgbcolor și hsvcolor folosite pentru comanda luminilor RGB din scripturile Packet parser și Modbus.

Funcții de parsare

Funcțiile de parsare din scripturile TapHome — PARSETEXT pentru textul dintre șabloane, PARSEJSON cu JSONPath și PARSEXML cu XPath — pentru citirea valorilor din răspunsurile dispozitivelor.

Date binare

Funcțiile de script TapHome PACKVALUE și UNPACKVALUE — citirea și scrierea valorilor cu tip în colecții de registre și de octeți, cu ordinea big-endian, little-endian și inversarea octeților.

Criptare și hash-uri

Funcții de script TapHome pentru protocoale de dispozitive criptate și semnate: AESENCRYPT și AESDECRYPT, HASH și HMAC cu MD5 și SHA, RANDBYTES și un exemplu pentru Bosch KM200.

Codificări de octeți și sume de control

Funcții de script TapHome TOBASE64 și FROMBASE64 (și base64url), TOHEX și FROMHEX, CRC16 și CRC32 — octeți ca text și înapoi și sume de control ale cadrelor.

Funcții Modbus

Funcțiile Modbus din scripturile TapHome — MODBUSR, MODBUSW, MODBUSWNE și funcțiile de bloc MODBUSRBLOCK, MODBUSWBLOCK, MODBUSWBLOCKNE — și tipurile de registre Modbus C, D, H și A.

Scripturi Modbus și prefetch

Scripturile unui modul și ale unui dispozitiv Modbus TapHome — inițializare, citire, citirea valorii, scrierea valorii, atribute de service și acțiuni de service — și cum le influențează prefetch-ul și cache-ul de registre.

Tipuri de date Modbus

Tipurile de date Modbus din scripturile TapHome — Int16, Uint16, Int32, UInt32, Float, Bool, String și tipurile pe 64 de biți Int64, UInt64 și Double — cu variantele big-endian, little-endian și byte-swap.

Funcții Packet parser

Funcțiile Packet parser din scripturile TapHome — HTTPREQUEST, SENDHTTPREQUEST, SENDDATA, MQTTPUBLISH, FTPDOWNLOAD, FTPUPLOAD, COMPLETESERVICEATTRIBUTE și COMPLETESERVICEACTION — pentru HTTP, TCP, UDP, MQTT și FTP.

Scripturi listener

Scripturile listener Packet parser TapHome — prelucrarea mesajelor TCP, UDP și MQTT primite cu RECEIVEDMSG (topic, payload, protocol) și cu colecția de octeți mai veche RECEIVEDBYTES.

Exemple de scripturi

Scripturi TapHome complete: împărțire sigură, 0 în locul unei valori necunoscute, reglarea intensității cu LINEAR, alarme Modbus și atribute de service, HTTP și JSON, script listener MQTT și Wake on LAN.

Erori de script și depanare

Mesajele de eroare ale scripturilor TapHome citate cuvânt cu cuvânt — Division by zero, erori de parsare, erori la rulare și erori de context sau de versiune — cu cauza și remedierea fiecăreia.

Cerințe de versiune pentru scripturi

De ce build TapHome Core are nevoie fiecare funcție și facilitate de script, pe canalele Official și Next, și ce înseamnă notele Disponibilitate din descrierile funcțiilor.

Funcții de script A–Z

Toate funcțiile de script TapHome în ordine alfabetică, fiecare cu un rezumat de un rând și un link către descrierea completă.