TEHNOLOGIJA VAGANJA · VLASTITI RAZVOJ · PODRŠKA
+386 2 320 33 46info@preciz.si

NEUTRON APPENGINE · UPUTE ZA PROGRAMERE

Neutron AppEngine — razvoj JavaScript aplikacija

Razvoj JavaScript aplikacija za CloudScaleLink Neutron i CloudScale Neutron NS: izvršno okruženje, vaganje, digitalni ulazi/izlazi, postavke, pohrana, komunikacijski moduli i upravljanje aplikacijama. Upute 1.0 · Neutron AppEngine 1.0.0 · API 1 · Datum objave: 16. studenoga 2026.

1. Namjena i opseg

Neutron AppEngine dostupan je za modul CloudScaleLink Neutron i module za vaganje CloudScale Neutron NS s firmwareom verzije 2.7 ili novije.

Neutron AppEngine omogućuje razvoj vlastitih JavaScript aplikacija izravno na modulima CloudScaleLink Neutron i modulima za vaganje Neutron. Aplikacije mogu čitati mjerenja, izvoditi operacije vage, upotrebljavati vremenske funkcije i povezivati se s vanjskim sustavima putem podržanih komunikacijskih modula (MQTT, TCP, WebSocket, REST, RS-232 i RS-485).
Ove su upute namijenjene programerima, integratorima i sustavima umjetne inteligencije koji pripremaju aplikacije za upotrebu s Neutronom.
Ove upute opisuju profil neutron-js-1, apiVersion: 1, na dan 16. studenoga 2026. Verzija uputa je 1.0, a verzija interpretera Neutron AppEngine 1.0.0. Sve ovdje opisane implementirane funkcije, događaji, svojstva i operacije dostupni su od verzije 1.0.0. Sama verzija firmwarea ne potvrđuje podršku za svaku funkciju: provjerite app.capabilities() na uređaju i testirajte svoju aplikaciju.
Tablica 1

Područje

Status

Sučelje

Izvršavanje JavaScripta

Implementirano

Interpreter Neutron AppEngine; jedna trajno pohranjena korisnička aplikacija

Izvršno okruženje i dijagnostika

Implementirano

app.capabilities(), app.stop(), console

Vremenske funkcije

Implementirano

setTimeout, setInterval, otkazivanje putem ID-a

Vaga

Implementirano

Čitanje mase, tariranje, nuliranje, postavljanje tare i slanje CSCP naredbi metodom scale.cmd()

TCP klijent / poslužitelj

Implementirano

Preuzimanje postojećeg TCP sučelja, obrada događaja i slanje podataka

MQTT

Implementirano

Neovisni korisnički posrednik; mqtt, mqtts, ws i wss

RS-232 / RS-485

Implementirano

serial.rs232 i serial.rs485; preuzimanje, konfiguracija putem SMD-a, događaji i slanje

Instalacija

Implementirano

BLE, interni HTTP/HTTPS i MQTT putem postojećeg kanala APP

Digitalni ulazi/izlazi

Implementirano

io.input(1..6), io.output(1..6); konfiguracija, događaji, preuzimanje izlaza i brojači

Parametri i aplikacija za brojanje komada

Putem podržanih CSCP naredbi

scale.cmd() izvršava naredbe koje uređaj podržava; zaseban JavaScript API counting.* još nije dostupan.

Postavke modula

Implementirano

device.cmd za RMD/SMD; device.settings.read/list/write

Datoteke i lokalna baza podataka

Implementirano

storage; openRecords i indeksirano pretraživanje po ključu

REST/HTTP iz JavaScripta

Implementirano

fetch za HTTP/HTTPS; status, zaglavlja, tekst, JSON i binarni odgovori

Datoteka je obična skripta .js u kodiranju UTF-8. Njezina se veličina mjeri u bajtovima, a ne u redcima ili znakovima, i ograničena je na najviše 131 072 bajta. Nije ES modul: import/export, await na najvišoj razini, Node.js, npm i DOM nisu dostupni. Upotrebljavajte globalThis, standardne JavaScript objekte, Promise, async/await, Map, JSON i Uint8Array. API-ji preglednika TextEncoder/TextDecoder nisu dio ovog profila.

2. Vaša prva aplikacija

Sljedeći kod spremite kao first-application.js, prenesite ga i odaberite Run. Svake sekunde povećava brojač i ispisuje njegovu vrijednost u konfigurirani kanal za otklanjanje pogrešaka. Postavljanje vage ili komunikacije nije potrebno.
let counter = 0;
setInterval(() => {
    counter += 1;
    console.log("Counter:", counter);
}, 1000);

U lokalnom HTTP/HTTPS sučelju ili na BLE stranici otvorite JS application ili App, odaberite datoteku, unesite naziv i verziju te odaberite Upload. Nakon provjere odaberite Run. Zaustavite aplikaciju opcijom Stop, a opcijom Refresh provjerite njezin status i posljednju pogrešku. Auto run omogućite tek nakon testiranja.

Za asinkronu inicijalizaciju definirajte i pozovite funkciju. start proizvoljan je korisnički naziv bez posebnog značenja za izvršno okruženje.
async function start() {
    const caps = app.capabilities();
    if (caps.apiVersion !== 1) {
        throw new Error("Unsupported API version");
    }
    console.info("Application ready", caps.runtime);
}
start().catch(error => {
    console.error(error.code || "START_FAILED", error.message);
    app.stop();
});

3. Izvršno okruženje, događaji i životni ciklus

Izbjegavajte blokiranje: nemojte upotrebljavati while (true), aktivno čekanje, duboku rekurziju ili beskonačne lance Promise. Izvršno okruženje dopušta približno 1 s aktivnog vremena po koraku obrade; mirovanje do događaja ne troši taj proračun. Prekoračenje vremena ili reda može zaustaviti aplikaciju; nemojte to upotrebljavati kao uobičajen upravljački mehanizam.
Priprema okruženja i prevođenje aplikacije imaju odvojena vremenska ograničenja do 5 sekundi po fazi. Ograničenje prevođenja jednako je pri prijenosu i pokretanju. Početno izvršavanje korisničkog koda zatim dobiva novi rok od jedne sekunde; isto ograničenje vrijedi za obradu događaja i vremenskih funkcija. Čekanje mrežnih odgovora ili vremenskih funkcija ne uračunava se u to ograničenje. TIMEOUT navodi fazu i ograničenje, na primjer TIMEOUT during application startup (limit 1000 ms). Prekid izvršavanja ne pokreće modul automatski ponovno.
Tablica 2

Korak

Ponašanje

Instalacija

Izvorni kod i atributi pohranjuju se u memoriju uređaja. Integritet i sintaksa provjeravaju se bez izvršavanja korisničkog koda.

Pokretanje

Svako pokretanje stvara novi JavaScript kontekst. Početna skripta izvršava se jednom; varijable iz prethodnog pokretanja ne zadržavaju se.

Čekanje

Nakon povratka početne skripte izvršno okruženje ostaje aktivno i čeka sljedeći vremenski poziv ili događaj. Kada nema posla, Neutron AppEngine čeka bez izvršavanja korisničkog koda.

Događaj

Događaj podržanog modula, istek vremena ili rezultat operacije pokreće odgovarajuću obradu u Neutron AppEngineu. Promise na čekanju razrješava se ili odbija.

Zaustavljanje ili pogreška

Vremenski pozivi i kontekst uklanjaju se. Zaustavljanje ne poništava učinke već izvršenih operacija.

Ponovno pokretanje

Najprije zaustavite prethodno izvršavanje i pričekajte busy: false. Instalacija nove verzije također zahtijeva zaustavljenu aplikaciju.
Neutron AppEngine izvršava povratne pozive redom. Brzo obrađujte događaje i ne stvarajte neograničen broj operacija na čekanju. await prepušta izvršavanje, pa se tijekom čekanja mogu izvršavati drugi povratni pozivi. Asinkroni povratni poziv stoga nije transakcija koja blokira druge događaje.

4. API aplikacije

4.1 app.capabilities()

Dostupno od: Neutron AppEngine 1.0.0
const capabilities = app.capabilities();
Namjena. Provjerite podržane značajke i ograničenja prije upotrebe API-ja.
Opis. Sinkrono vraća novi objekt s podacima o podršci, verzijama i ograničenjima. Ne inicijalizira pojedinačne module i ne jamči njihovu trenutačnu spremnost.

Parametri

Nema parametara.

Rezultat

Objekt prikazan u nastavku. features svojstva označavaju podršku modula. Postavke i ograničenja za svaki modul objašnjeni su u njegovom poglavlju.

Pogreške i posebnosti

Ne vraća Promise. Nemojte zaključivati o podršci značajki samo iz naziva uređaja ili verzije aplikacije.

Primjer

const c = app.capabilities();
if (c.apiVersion !== 1) throw new Error("Neustrezen API");
console.info(c.interpreter, c.interpreterVersion, c.apiVersion);
const capabilities = {
  apiVersion: 1,
  runtime: "neutron-js-1",
  interpreter: "Neutron AppEngine",
  interpreterVersion: "1.0.0",
  features: {
    timers: true, scale: true, tcp: true,
    io: true, mqtt: true, serial: true, files: true, records: true, settings: true, http: true, websocket: true
  },
  scaleOperations: ["tare", "zero", "clearTare", "setPresetTare", "cmd"],
  tcp: { configuredMode: 1, requiresClaim: true },
  http: {
    protocols: ["http", "https"], methods: ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD"],
    maxActiveRequests: 1, maxQueuedRequests: 4, maxRequestBytes: 4096, maxResponseBytes: 4096,
    maxHeaderBytes: 2048, maxHeaders: 32, maxUrlBytes: 512, maxOptionsBytes: 4096,
    maxTimeoutMs: 60000, redirect: "manual", certificateProfiles: true, compression: false
  },
  settings: { maxKeysPerRequest: 16, maxPageKeys: 32, maxCommandBytes: 2048, maxValueBytes: 1024, automaticReboot: false },
  storage: {
    quotaBytes: 524288, reserveBytes: 131072, maxFileBytes: 262144,
    maxChunkBytes: 4096, maxFiles: 64, maxFindScanBytes: 65536,
    maxFindNeedleBytes: 128, maxDatabases: 8, maxOpenDatabases: 2,
    maxRecords: 2048, maxRecordBytes: 2048, maxRecordDepth: 16, maxKeyBytes: 64, indexedFields: 1
  },
  io: {
    available: true, inputCount: 6, outputCount: 6, indexBase: 1,
    inputFunctions: [{ id: 0, name: "disabled" } /* celoten seznam na napravi */],
    outputFunctions: [{ id: 0, name: "disabled" } /* celoten seznam na napravi */],
    maxListenersPerPin: 32, maxDebounceMs: 60000, maxGlitchUs: 12,
    counterType: "bigint", maxCounterValue: "9223372036854775807",
    requiresOutputClaim: true, defaultSafeState: false
  },
  mqtt: {
    transports: ["mqtt", "mqtts", "ws", "wss"], protocolVersion: "3.1.1",
    maxConnections: 1, qos: [0, 1], maxMessageBytes: 4096,
    maxTopicBytes: 192, maxSubscriptions: 16, maxListeners: 32,
    maxConfigurationBytes: 4096, maxPendingOperations: 8,
    maxOperationTimeoutMs: 60000, certificateProfiles: true
  },
  serial: {
    ports: ["rs232", "rs485"], requiresClaim: true, requiresDisabled: true,
    dataBits: [7, 8], stopBits: [1, 2], parity: ["none", "even", "odd"],
    minBaudRate: 300, maxBaudRate: 1000000, maxMessageBytes: 4096,
    maxLineBytes: 4096, maxListenersPerPort: 32,
    maxWriteTimeoutMs: 180000, maxDrainTimeoutMs: 60000
  },
  limits: {
    maxTimers: 16, maxPendingOperations: 8,
    maxTcpMessageBytes: 4096, maxLineBytes: 4096,
    maxHeapBytes: 1048576, callbackTimeoutMs: 1000,
    maxScaleCommandBytes: 2048, maxScaleResponseBytes: 4096, maxScaleCommandTimeoutMs: 60000
  }
}
Verziju pročitajte putem app.capabilities().interpreterVersion, a naziv putem app.capabilities().interpreter. interpreterVersion označava verziju proizvoda Neutron AppEngine, apiVersion ugovor API-ja, a runtime profil. Ti se podaci razlikuju od verzije korisničke aplikacije i verzije firmwarea uređaja. Trenutačne verzije: Neutron AppEngine 1.0.0, API 1 i upute 1.0.
console.info(app.capabilities().interpreter, app.capabilities().interpreterVersion);
Pri pokretanju uređaja na razini INFO bilježi se Neutron AppEngine interpreter v1.0.0. Vidljivost ovisi o postavkama kanala i razini otklanjanja pogrešaka. Provjerite podatke u korisničkoj aplikaciji metodom capabilities.

4.2 app.stop()

Dostupno od: Neutron AppEngine 1.0.0
app.stop();
Namjena. Uobičajeno zaustavite korisničku aplikaciju.
Opis. Zahtijeva zaustavljanje izvršavanja i sprječava daljnje povratne pozive. Ne resetira modul. Oslobađa resurse koje je aplikacija preuzela; ponašanje pojedinačnih resursa opisano je u odgovarajućem poglavlju o modulu.

Parametri

Nema parametara.

Rezultat

undefined. Ovo je zahtjev, a ne Promise kojim se potvrđuje isključivanje. Koristite status APP za vanjsku potvrdu.

Pogreške i posebnosti

Ne poništava već izvršene operacije. Upotrijebite return nakon poziva ako se sljedeće naredbe u trenutačnoj funkciji ne smiju izvršiti. Korisnički povratni poziv pri zaustavljanju nije dostupan.

Primjer

if (app.capabilities().apiVersion !== 1) {
    console.error("API version is not supported");
    app.stop();
}

5. Dijagnostika i konzola

Konzola šalje ispis u Neutronov sustav za otklanjanje pogrešaka, a ne u konzolu preglednika. Postojeće postavke DI i DL određuju izlaz i razinu. Poruke dobivaju prefiks [JS:application name]. Trenutačne postavke prijenosa i veza određuju gdje su poruke vidljive.

5.1 console.log(...)

Dostupno od: Neutron AppEngine 1.0.0
console.log(...values);
Namjena. Bilježite mjerenja ili stanje.
Opis. Spaja argumente razmacima. Za objekte pokušava primijeniti JSON.stringify, a za druge vrijednosti pretvorbu u tekst. Upravljačke znakove zamjenjuje razmacima. Sve metode konzole dijele isto ograničenje bilježenja.

Parametri

Tablica 3

Parametar

Tip / obveznost

Opis

values

proizvoljne JavaScript vrijednosti / neobvezno

Nula ili više argumenata. Izbjegavajte velike objekte i kružne strukture.

Rezultat

undefined; Dnevnik INFO, vidljiv s DL ≥ 3 i odgovarajućim DI.

Pogreške i posebnosti

Bilježenje samo po sebi ne zaustavlja aplikaciju, uključujući console.error(). Zajedničko ograničenje je 10 poziva/s i približno 512 bajtova sadržaja po pozivu, isključujući prefiks. Višak izlaza se odbija ili skraćuje; može se pojaviti dodatno upozorenje o ograničenju brzine. Pogreške konverzije ili memorije mogu izazvati JavaScript iznimku.

Primjer

console.log("Stanje aplikacije", { ready: true, counter: 5 });

5.2 console.info(...)

Dostupno od: Neutron AppEngine 1.0.0
console.info(...values);
Namjena. Prijavite podatke o pokretanju ili stanju.
Opis. Spaja argumente razmacima. Za objekte pokušava primijeniti JSON.stringify, a za druge vrijednosti pretvorbu u tekst. Upravljačke znakove zamjenjuje razmacima. Sve metode konzole dijele isto ograničenje bilježenja.

Parametri

Tablica 4

Parametar

Tip / obveznost

Opis

values

proizvoljne JavaScript vrijednosti / neobvezno

Nula ili više argumenata. Izbjegavajte velike objekte i kružne strukture.

Rezultat

undefined; Dnevnik INFO, vidljiv s DL ≥ 3 i odgovarajućim DI.

Pogreške i posebnosti

Bilježenje samo po sebi ne zaustavlja aplikaciju, uključujući console.error(). Zajedničko ograničenje je 10 poziva/s i približno 512 bajtova sadržaja po pozivu, isključujući prefiks. Višak izlaza se odbija ili skraćuje; može se pojaviti dodatno upozorenje o ograničenju brzine. Pogreške konverzije ili memorije mogu izazvati JavaScript iznimku.

Primjer

console.info("Stanje aplikacije", { ready: true, counter: 5 });

5.3 console.warn(...)

Dostupno od: Neutron AppEngine 1.0.0
console.warn(...values);
Namjena. Zabilježite upozorenje ili obrađeni problem.
Opis. Spaja argumente razmacima. Za objekte pokušava primijeniti JSON.stringify, a za druge vrijednosti pretvorbu u tekst. Upravljačke znakove zamjenjuje razmacima. Sve metode konzole dijele isto ograničenje bilježenja.

Parametri

Tablica 5

Parametar

Tip / obveznost

Opis

values

proizvoljne JavaScript vrijednosti / neobvezno

Nula ili više argumenata. Izbjegavajte velike objekte i kružne strukture.

Rezultat

undefined; Dnevnik WARN, vidljiv s DL ≥ 2 i odgovarajućim DI.

Pogreške i posebnosti

Bilježenje samo po sebi ne zaustavlja aplikaciju, uključujući console.error(). Zajedničko ograničenje je 10 poziva/s i približno 512 bajtova sadržaja po pozivu, isključujući prefiks. Višak izlaza se odbija ili skraćuje; može se pojaviti dodatno upozorenje o ograničenju brzine. Pogreške konverzije ili memorije mogu izazvati JavaScript iznimku.

Primjer

console.warn("Stanje aplikacije", { ready: true, counter: 5 });

5.4 console.error(...)

Dostupno od: Neutron AppEngine 1.0.0
console.error(...values);
Namjena. Opišite pogrešku.
Opis. Spaja argumente razmacima. Za objekte pokušava primijeniti JSON.stringify, a za druge vrijednosti pretvorbu u tekst. Upravljačke znakove zamjenjuje razmacima. Sve metode konzole dijele isto ograničenje bilježenja.

Parametri

Tablica 6

Parametar

Tip / obveznost

Opis

values

proizvoljne JavaScript vrijednosti / neobvezno

Nula ili više argumenata. Izbjegavajte velike objekte i kružne strukture.

Rezultat

undefined; Dnevnik ERROR, vidljiv s DL ≥ 1 i odgovarajućim DI.

Pogreške i posebnosti

Bilježenje samo po sebi ne zaustavlja aplikaciju, uključujući console.error(). Zajedničko ograničenje je 10 poziva/s i približno 512 bajtova sadržaja po pozivu, isključujući prefiks. Višak izlaza se odbija ili skraćuje; može se pojaviti dodatno upozorenje o ograničenju brzine. Pogreške konverzije ili memorije mogu izazvati JavaScript iznimku.

Primjer

console.error("Stanje aplikacije", { ready: true, counter: 5 });

5.5 console.debug(...)

Dostupno od: Neutron AppEngine 1.0.0
console.debug(...values);
Namjena. Bilježite pojedinosti tijekom razvoja.
Opis. Spaja argumente razmacima. Za objekte pokušava primijeniti JSON.stringify, a za druge vrijednosti pretvorbu u tekst. Upravljačke znakove zamjenjuje razmacima. Sve metode konzole dijele isto ograničenje bilježenja.

Parametri

Tablica 7

Parametar

Tip / obveznost

Opis

values

proizvoljne JavaScript vrijednosti / neobvezno

Nula ili više argumenata. Izbjegavajte velike objekte i kružne strukture.

Rezultat

undefined; Dnevnik DEBUG, vidljiv s DL ≥ 4 i odgovarajućim DI.

Pogreške i posebnosti

Bilježenje samo po sebi ne zaustavlja aplikaciju, uključujući console.error(). Zajedničko ograničenje je 10 poziva/s i približno 512 bajtova sadržaja po pozivu, isključujući prefiks. Višak izlaza se odbija ili skraćuje; može se pojaviti dodatno upozorenje o ograničenju brzine. Pogreške konverzije ili memorije mogu izazvati JavaScript iznimku.

Primjer

console.debug("Stanje aplikacije", { ready: true, counter: 5 });

Razina otklanjanja pogrešaka može filtrirati ispis. Nemojte upotrebljavati konzolu kao pouzdan prijenosni kanal za poslovne podatke. Za pouzdanu razmjenu podataka upotrijebite odgovarajući podržani komunikacijski modul.

6. Vremenske funkcije

Vremenska funkcija određuje najranije predviđeno vrijeme izvršavanja. Ovo JavaScript okruženje ne jamči strogo izvršavanje u stvarnom vremenu: mjerenje, komunikacija, prethodni povratni pozivi i raspoređivanje mogu odgoditi izvršavanje. Propušteni intervali ne stvaraju neograničen red nadoknadnih poziva.

Periodični povratni poziv async može još čekati u trenutku sljedećeg intervala. Upotrijebite oznaku zauzetosti ili zakažite sljedeći setTimeout nakon dovršetka operacije. Isto vrijedi za događaje bilo kojeg modula: ako obrada mora biti uzastopna, uvedite ograničen red čekanja ili odbijajte novi posao dok prethodna operacija ne završi.

6.1 setTimeout()

Dostupno od: Neutron AppEngine 1.0.0
const id = setTimeout(callback, delayMs = 0, ...args);
Namjena. Izvršite funkciju jednom nakon odgode.
Opis. Odmah se vraća; povratni poziv izvršava se kasnije. Vremenski poziv uklanja se iz aktivnog skupa prije pozivanja povratne funkcije, pa ona može zakazati novo izvršavanje.

Parametri

Tablica 8

Parametar

Tip / obveznost

Opis

callback

function / obvezno

Funkcija; kod naveden kao niz nije podržan.

delayMs

number / neobvezno, zadano 0

Pretvara se u broj i cijeli broj. Nevaljane, negativne ili nulte odgode postaju najmanje 1 ms. Najviše: 2 147 483 647 ms.

...args

proizvoljne vrijednosti / neobvezno

Argumenti koje izvršno okruženje prosljeđuje povratnom pozivu.

Rezultat

Brojčani ID koji prihvaća clearTimeout. Vrijedi samo tijekom trenutačnog izvršavanja aplikacije.

Pogreške i posebnosti

Sinkrono INVALID_ARGUMENT ako povratni poziv nije funkcija; QUOTA_EXCEEDED ako su 16 mjerači vremena već aktivni. Neobrađeni izuzetak ili odbijanje povratnog poziva može zaustaviti aplikaciju.

Primjer

const id = setTimeout(message => {
    console.info(message);
}, 2000, "Two seconds after scheduling");

6.2 setInterval()

Dostupno od: Neutron AppEngine 1.0.0
const id = setInterval(callback, delayMs = 0, ...args);
Namjena. Periodično čitajte ili šaljite podatke.
Opis. Prvi poziv događa se nakon odgode. Daljnji povratni pozivi zakazuju se periodično; izvršno okruženje ne čeka objekte Promise koje vraćaju asinkroni povratni pozivi. Odgode ne uzrokuju neograničeno nadoknađivanje propuštenih poziva.

Parametri

Tablica 9

Parametar

Tip / obveznost

Opis

callback

function / obvezno

Funkcija; kod naveden kao niz nije podržan.

delayMs

number / neobvezno, zadano 0

Pretvara se u broj i cijeli broj. Nevaljane, negativne ili nulte odgode postaju najmanje 1 ms. Najviše: 2 147 483 647 ms.

...args

proizvoljne vrijednosti / neobvezno

Argumenti koje izvršno okruženje prosljeđuje povratnom pozivu.

Rezultat

Brojčani ID koji prihvaća clearInterval. Interval ostaje aktivan do otkazivanja ili zaustavljanja aplikacije.

Pogreške i posebnosti

Iste sinkrone pogreške kao setTimeout. Zaštitite asinkroni rad od preklapanja i uhvatite odbijanja unutar funkcije async.

Primjer

let working = false;
let counter = 0;
const id = setInterval(async () => {
    if (working) return;
    working = true;
    try {
        // Example asynchronous step; Promise yields execution.
        const next = await Promise.resolve(counter + 1);
        counter = next;
        console.info("Completed step:", counter);
    } catch (error) {
        console.warn(error.code || error.name, error.message);
    } finally {
        working = false;
    }
}, 1000);

6.3 clearTimeout()

Dostupno od: Neutron AppEngine 1.0.0
clearTimeout(id);
Namjena. Otkažite buduće izvršavanje vremenskog poziva.
Opis. Obje funkcije upotrebljavaju isti registar vremenskih poziva i mogu otkazati bilo koju njihovu vrstu. Preporučuje se upotreba odgovarajućeg para set/clear.

Parametri

Tablica 10

Parametar

Tip / obveznost

Opis

id

number / obvezno

ID koji vraća setTimeout ili setInterval. Pretvara se pomoću Number(id).

Rezultat

undefined. Nepoznati ID nema učinka.

Pogreške i posebnosti

Ne prekida povratni poziv ili asinkronu operaciju koja je već započela. Pretvaranje neprikladne vrijednosti JavaScript u broj može izazvati standardnu iznimku JavaScript.

Primjer

const id = setTimeout(() => console.info("Pozneje"), 1000);
clearTimeout(id);

6.4 clearInterval()

Dostupno od: Neutron AppEngine 1.0.0
clearInterval(id);
Namjena. Otkažite buduće izvršavanje vremenskog poziva.
Opis. Obje funkcije upotrebljavaju isti registar vremenskih poziva i mogu otkazati bilo koju njihovu vrstu. Preporučuje se upotreba odgovarajućeg para set/clear.

Parametri

Tablica 11

Parametar

Tip / obveznost

Opis

id

number / obvezno

ID koji vraća setTimeout ili setInterval. Pretvara se pomoću Number(id).

Rezultat

undefined. Nepoznati ID nema učinka.

Pogreške i posebnosti

Ne prekida povratni poziv ili asinkronu operaciju koja je već započela. Pretvaranje neprikladne vrijednosti JavaScript u broj može izazvati standardnu iznimku JavaScript.

Primjer

const id = setInterval(() => console.info("Interval"), 1000);
clearInterval(id);

7. API vage

7.1 scale.read()

Dostupno od: Neutron AppEngine 1.0.0
const measurement = scale.read();
Namjena. Pročitajte posljednju dostupnu snimku stanja vage bez čekanja na stabilnost.
Opis. Sinkrono vraća posljednju dostupnu snimku podataka vage. Ne pokreće novo mjerenje. Pročitajte jedan objekt i upotrebljavajte njegova polja zajedno za usklađene vrijednosti neto mase, bruto mase i tare.

Parametri

Nema parametara.

Rezultat

Objekt s poljima u nastavku. Kada mjerenje nije dostupno, net, gross i tare su NaN, a stable je false. unit i status ostaju dijagnostički podaci.

Pogreške i posebnosti

Nedostupna vaga prijavljuje se kao available=false umjesto iznimkom NO_MEASUREMENT. available=true ne znači stable=true. Sinkroni poziv može uzrokovati iznimku ako je JavaScript memorija iscrpljena.

Primjer

const m = scale.read();
if (m.available && Number.isFinite(m.net)) {
    console.log(m.net, m.gross, m.tare, m.unit, m.stable);
} else {
    console.warn("Ni veljavne meritve", m.status);
}
Tablica 12

Polje

Tip

Značenje

available

boolean

Vaga je dostupna, sučelje za vaganje omogućeno je i mjerenje je valjano.

net

number

Neto masa izračunata iz bruto mase i tare, zaokružena na konfigurirani broj decimalnih mjesta.

gross

number

Bruto masa u konfiguriranoj jedinici.

tare

number

Trenutačna tara u konfiguriranoj jedinici.

stable

boolean

Valjano mjerenje stabilno je prema trenutačnoj konfiguraciji vage.

unit

string

Trenutačna jedinica vage, primjerice kg ili g. Nije nužno kg.

status

number

Trenutačna vrijednost statusa vage. JavaScript profil ne pruža zaseban imenovani enumeracijski tip; nemojte izmišljati preslikavanja kodova.

sequence

number

32-bitni brojač objavljenih mjerenja; prelijeva se pri prekoračenju. Nije trajni ID zapisa vaganja.

timeMs

number

Vrijeme posljednje objave mjerenja u milisekundama od pokretanja uređaja. Nije UTC; ovaj 32-bitni brojač može se preliti.

Prečaci scale.net, scale.gross i scale.available živi su pristupnici koji pri svakom pristupu čitaju novu snimku. scale.tare je funkcija; brojčanu taru dohvatite iz scale.read().tare. Nemojte upotrebljavati dva odvojena pristupnika za par bruto/neto koji mora dijeliti istu snimku.

7.2 scale.tare()

Dostupno od: Neutron AppEngine 1.0.0
const measurement = await scale.tare();
Namjena. Tarirajte trenutačnim opterećenjem.
Opis. Izvodi odgovarajuću funkciju vage bez zaobilaženja stabilnosti, raspona, zaštite, istodobnih naredbi ili konfiguracije. Izvršava naredbu vaganja T; to nije trenutačno tariranje naredbom TI.

Parametri

Nema parametara.

Rezultat

Promise<Measurement>: nakon uspješnog odgovora čita novi Snimak JavaScript sa strukturom scale.read(). Ovo ne jamči da je sljedeće mjerenje stiglo; pratite naknadna mjerenja kako biste potvrdili učinak.

Pogreške i posebnosti

BUSY, OUT_OF_MEMORY, NO_MEASUREMENT, PERMISSION_DENIED, SCALE_REJECTED ili TIMEOUT. Obradite odbijena obećanja s await/try/catch. Zaustavljanje uništava kontekst; Promise nastavak nije zajamčen.

Primjer

async function apply() {
    try {
        const m = await scale.tare();
        console.info("Operation successful", m.net, m.tare, m.unit);
    } catch (error) {
        console.warn(error.code || "SCALE_FAILED", error.message);
    }
}
apply();

7.3 scale.zero()

Dostupno od: Neutron AppEngine 1.0.0
const measurement = await scale.zero();
Namjena. Nulirajte vagu.
Opis. Izvodi odgovarajuću funkciju vage bez zaobilaženja stabilnosti, raspona, zaštite, istodobnih naredbi ili konfiguracije. Izvršava Z, što se razlikuje od tariranja. Uspjeh ovisi o radnim uvjetima i dopuštenom rasponu nuliranja.

Parametri

Nema parametara.

Rezultat

Promise<Measurement>: nakon uspješnog odgovora čita novi Snimak JavaScript sa strukturom scale.read(). Ovo ne jamči da je sljedeće mjerenje stiglo; pratite naknadna mjerenja kako biste potvrdili učinak.

Pogreške i posebnosti

BUSY, OUT_OF_MEMORY, NO_MEASUREMENT, PERMISSION_DENIED, SCALE_REJECTED ili TIMEOUT. Obradite odbijena obećanja s await/try/catch. Zaustavljanje uništava kontekst; Promise nastavak nije zajamčen.

Primjer

async function apply() {
    try {
        const m = await scale.zero();
        console.info("Operation successful", m.net, m.tare, m.unit);
    } catch (error) {
        console.warn(error.code || "SCALE_FAILED", error.message);
    }
}
apply();

7.4 scale.clearTare()

Dostupno od: Neutron AppEngine 1.0.0
const measurement = await scale.clearTare();
Namjena. Izbrišite taru.
Opis. Izvodi odgovarajuću funkciju vage bez zaobilaženja stabilnosti, raspona, zaštite, istodobnih naredbi ili konfiguracije. Izvršava TAC za zahtjev za uklanjanje trenutačne tare.

Parametri

Nema parametara.

Rezultat

Promise<Measurement>: nakon uspješnog odgovora čita novi Snimak JavaScript sa strukturom scale.read(). Ovo ne jamči da je sljedeće mjerenje stiglo; pratite naknadna mjerenja kako biste potvrdili učinak.

Pogreške i posebnosti

BUSY, OUT_OF_MEMORY, NO_MEASUREMENT, PERMISSION_DENIED, SCALE_REJECTED ili TIMEOUT. Obradite odbijena obećanja s await/try/catch. Zaustavljanje uništava kontekst; Promise nastavak nije zajamčen.

Primjer

async function apply() {
    try {
        const m = await scale.clearTare();
        console.info("Operation successful", m.net, m.tare, m.unit);
    } catch (error) {
        console.warn(error.code || "SCALE_FAILED", error.message);
    }
}
apply();

7.5 scale.setPresetTare(value)

Dostupno od: Neutron AppEngine 1.0.0
const measurement = await scale.setPresetTare(value);
Namjena. Postavite unaprijed zadanu taru.
Opis. Izvodi odgovarajuću funkciju vage bez zaobilaženja stabilnosti, raspona, zaštite, istodobnih naredbi ili konfiguracije. Izvršava TA s brojčanom tarom u trenutačnoj jedinici vage. Vrijednosti se ne pretvaraju automatski iz druge jedinice.

Parametri

Tablica 13

Parametar

Tip / obveznost

Opis

value

number / obvezno

Konačan broj ≥ 0 unutar kapaciteta vage, u jedinici scale.read().unit. Nizovi, NaN i Infinity nisu dopušteni.

Rezultat

Promise<Measurement>: nakon uspješnog odgovora čita novi Snimak JavaScript sa strukturom scale.read(). Ovo ne jamči da je sljedeće mjerenje stiglo; pratite naknadna mjerenja kako biste potvrdili učinak.

Pogreške i posebnosti

Nevažeći tip, negativna ili ne-konačna vrijednost odbija se s INVALID_ARGUMENT; vrijednosti iznad kapaciteta odbijaju s OUT_OF_RANGE. Ostale pogreške: BUSY, OUT_OF_MEMORY, NO_MEASUREMENT, PERMISSION_DENIED, SCALE_REJECTED ili TIMEOUT. Obradite odbijanje s await/try/catch. Zaustavljanje uništava kontekst; Promise nastavak nije zajamčen.

Primjer

async function apply() {
    try {
        const m = await scale.setPresetTare(2.5);
        console.info("Operation successful", m.net, m.tare, m.unit);
    } catch (error) {
        console.warn(error.code || "SCALE_FAILED", error.message);
    }
}
apply();

Operacija vaganja čeka konfigurirano vremensko razdoblje naredbe vage i približno još 2 sekunde za obradu. Ove JavaScript operacije nemaju parametar vremenskog ograničenja za pojedinačni poziv. Vaga koja obrađuje drugu naredbu može vratiti BUSY. Ovisne naredbe izvršavajte uzastopnim pozivima await umjesto neograničenim Promise.all.

7.6 scale.cmd()

Dostupno od: Neutron AppEngine 1.0.0
const response = await scale.cmd(command, { timeoutMs });
Namjena. Izvršite jednu CSCP naredbu i pročitajte njezin izvorni odgovor.
Opis. Putem CSCP-a pristupajte naredbama vage, konfiguraciji i drugim funkcijama koje uređaj podržava. Primjenjuju se postojeća provjera parametara i pravila zaštite podataka. RSD i konfiguracijski upiti ne zahtijevaju valjano mjerenje. S i SX čekaju stabilno mjerenje; SI i SXI upituju odmah.

Parametri

Tablica 14

Parametar

Tip / obveznost

Opis

command

string / obvezno

Jedna CSCP naredba, najviše 2048 UTF-8 bajtova nakon uklanjanja okolnih razmaka i neobveznog završnog CRLF-a. Prazne naredbe, NUL, ugrađeni CR/LF i drugi upravljački znakovi zabranjeni su. Sintaksa i veličina slova slijede CSCP.

options

object / neobvezno, zadano {}

Opcije čekanja. Jedinicu, stabilnost i dopuštenja određuju naredba i postavke vage.

options.timeoutMs

integer / neobvezno

1–60000 ms. Zadano je konfigurirano vrijeme čekanja vage i 2 sekunde za obradu. Ne produžuje unutarnje čekanje naredbe na stabilnost.

Rezultat

Promise<string> s izvornim CSCP odgovorom, najviše 4096 UTF-8 bajtova. Jedan završni CRLF uklanja se; unutarnji višeredni završeci ostaju. Niz nije objekt Measurement i ne analizira se automatski. S I, ES, FT L i ERRAUTH valjani su CSCP rezultati i ne odbijaju Promise. Uspjeh naredbe odredite pomoću njezine CSCP reference.

Pogreške i posebnosti

INVALID_ARGUMENT za netočnu upotrebu; MESSAGE_TOO_LARGE za preveliku naredbu; UNSUPPORTED_COMMAND za naredbe s više odgovora/bez odgovora ili resetiranje; BUSY za zauzetu vagu ili ograničenje istodobnih operacija; TIMEOUT za predugo čekanje; NO_RESPONSE kada naredba završi bez odgovora; RESPONSE_TOO_LARGE za prevelik odgovor; OUT_OF_MEMORY za nedovoljno memorije. Odgovori se nikada tiho ne skraćuju. Stop prekida izvršavanje na čekanju; njegov Promise ne nastavlja se u uništenom kontekstu.

Primjer

async function start() {
    try {
        const stable = await scale.cmd("S", { timeoutMs: 10000 });
        console.info("CSCP weight:", stable);
        const settings = await scale.cmd("RSD");
        console.info("Configuration length:", settings.length);
        const result = await scale.cmd("FT=512");
        console.info("CSCP filter:", result);
    } catch (error) {
        console.warn(error.code || error.name, error.message);
    }
}
start();

Istodobno može čekati samo jedna naredba vaganja. Upotrijebite await za uzastopno izvršavanje. Novi zahtjev prima BUSY dok druga naredba čeka; nema skrivenog reda naredbi. To vrijedi i pri kombiniranju scale.cmd() s tare/zero/clearTare/setPresetTare. Otkazivanje ili istek vremena ne poništava već promijenjene postavke. Zakašnjeli odgovor ne dodjeljuje se sljedećem zahtjevu.

Funkcija vraća jedan odgovor. SIR, SR, SXIR, RAS, RASI, CAL, RST, CWRESULTA i CWDEBUG odbijaju se prije izvršavanja, uključujući naredbe koje sadrže polje vjerodajnice P=. Dopušten je višeredni sadržaj unutar jednog odgovora, primjerice I0. Za ponovljeno mjerenje upotrijebite vremenski poziv i scale.read(); scale.cmd() ne otvara tok odgovora.

Naredba može sadržavati podržane parametre i CSCP vjerodajnicu; funkcija ne zaobilazi zaštitu vage. Slijedite CSCP sintaksu kada zaštićena naredba zahtijeva vjerodajnice. Obradite ERRAUTH i ERRLOCK u vraćenom tekstu. Naredbe za instalaciju aplikacije i drugi upravljački kanali ne pripadaju u scale.cmd().

Provjerite podršku pomoću app.capabilities().scaleOperations.includes("cmd"). Ograničenja su objavljena kao limits.maxScaleCommandBytes, limits.maxScaleResponseBytes i limits.maxScaleCommandTimeoutMs. Dostupno od Neutron AppEngine 1.0.0; zastavice features opisuju namjenske module. io.* dokumentiran je u zasebnom poglavlju o ulazima/izlazima. Postavke modula i pohrana podataka imaju vlastita poglavlja te zasebne API-je device i storage.

Tablica 15

Poziv

Rezultat / ponašanje

scale.cmd("S")

Sljedeće stabilno mjerenje ili CSCP odgovor o neuspjehu, primjerice S I.

scale.cmd("SI")

Trenutačan odgovor s trenutačnom masom.

scale.cmd("RSD")

Podaci i konfiguracija vage kao niz; radi i bez dostupne mase.

scale.cmd("FT=?")

Trenutačna postavka filtra, primjerice FT A 512.

scale.cmd("FT=512")

Mijenja i sprema filtar prema CSCP-u; pregledajte vraćeni odgovor.

scale.cmd("UNKNOWN")

Obično ES kao rezultat razriješenog objekta Promise, a ne JavaScript odbijanje.

scale.cmd("SIR")

Odbijanje UNSUPPORTED_COMMAND; kontinuirani tok ne započinje.

7.7 Pogreške modula vage

Tablica 16

Kod

Značenje za vagu

NO_MEASUREMENT

Operacija vage bez valjanog mjerenja ili dostupne vage.

OUT_OF_RANGE

Unaprijed zadana tara premašuje kapacitet.

PERMISSION_DENIED

Naredba vage odbijena zbog zaštite/autorizacije.

SCALE_REJECTED

Vaga je odbila operaciju; provjerite message i uvjete vage.

7.8 Periodično bilježenje mase

Samostalna .js datoteka bez zahtjeva za TCP. Bilježi valjano mjerenje jednom u sekundi. Za zaustavljanje upotrijebite Stop u upravitelju aplikacije.

// Runtime stays active until Stop. No overlap: this callback is synchronous.
console.info(app.capabilities());
setInterval(() => {
    const measurement = scale.read();
    if (measurement.available) {
        console.log("Neto:", measurement.net, "Bruto:", measurement.gross, measurement.unit);
    }
}, 1000);

8. Digitalni ulazi i izlazi

Modul io nadzire šest ulaza i šest izlaza, konfigurira njihove funkcije, izravno upravlja preuzetim izlazima i čita brojače ulaza. Indeksi su uvijek 1–6. Sve funkcije, svojstva i događaji u ovom poglavlju dostupni su od Neutron AppEngine 1.0.0. Podrška API-ja: app.capabilities().features.io; dostupnost fizičkih ulaza/izlaza: app.capabilities().io.available.

Čitanje stanja i praćenje događaja ne zahtijevaju preuzimanje. Možete pratiti izlaz kojim upravlja sistemska funkcija; prije izravnog pisanja izričito onemogućite njegovu funkciju i preuzmite ga. Modul dijeli obradu ulaza/izlaza uređaja, pa ista pravila vlasništva vrijede i putem drugih sučelja.

io.input(index) / io.output(index)

Dostupno od: Neutron AppEngine 1.0.0
const input = io.input(1);
const output = io.output(1);
Namjena. Dohvatite objekt za fizički ulaz ili izlaz.
Opis. Ponovljeni pozivi za isti priključak vraćaju isti objekt. Ne mijenja konfiguraciju, ne registrira događaje i ne prebacuje izlaz.

Parametri

Tablica 17

Parametar

Tip / obveznost

Opis

index

integer / obvezno

1..6. Nizovi, nula, razlomljene vrijednosti i indeksi iznad 6 odbijaju se.

Rezultat

Ulazni ili izlazni objekt. Oba podržavaju read, configure, on, once i off. Izlazi dodaju claim, write i release; ulazi dodaju counter i resetCounter.

Pogreške i posebnosti

INVALID_ARGUMENT za nevaljani indeks. Objekt se može dobiti bez ploče ulaza/izlaza; provjerite read().available.

Primjer

const input = io.input(1);
const output = io.output(2);
console.info(input.read().available, output.read().value);

input.read() / output.read()

Dostupno od: Neutron AppEngine 1.0.0
const inputState = io.input(1).read();
const outputState = io.output(1).read();
Namjena. Sinkrono pročitajte posljednju snimku stanja i konfiguracije.
Opis. Čitanje ne zahtijeva preuzimanje i ne šalje događaj promjene. Snimka se osvježava zajedničkom obradom uređaja i pri promjenama; read ne obavlja dodatno fizičko uzorkovanje. Nakon uspješnog await configure/write snimka uključuje rezultate odgovarajuće operacije.

Parametri

Nema parametara.

Rezultat

Unos: {index, available, value, functionId, function, mode, debounceMs, glitchUs, pull, counter}. Izlaz: {index, available, value, functionId, function, claimed}. Vrste i značenja navedeni su u nastavku.

Pogreške i posebnosti

value je null za nedostupne ulaze/izlaze i ulaze u načinu disabled ili counter. counter je BigInt samo za dostupan brojački ulaz; inače null. Izlazna vrijednost predstavlja naređeno stanje; potvrda stvarnog prebacivanja vanjskog kontaktora ili uređaja zahtijeva povratni signal na ulazu.

Primjer

const s = io.input(1).read();
console.info(s.mode, s.value, s.function);
if (s.counter !== null) console.info(s.counter.toString());
Tablica 18

Polje od Neutron AppEngine 1.0.0

Tip

Značenje

index

number

Broj priključka 1..6.

available

boolean

Uređaj ima ulaze/izlaze.

value

boolean | null

true znači logičku 1, false logičku 0. Na ulaznim vrijednostima uklanja se odskakivanje kontakata; null znači da digitalna vrijednost nije dostupna.

functionId / function

number / string

Postojeći broj funkcije i njezin naziv u JavaScript API-ju. unknown označava nepodržani pohranjeni broj.

mode

string / samo ulaz

disabled, digital ili counter.

debounceMs

number / samo ulaz

Vrijeme potvrde digitalne promjene u milisekundama.

glitchUs

number / samo ulaz

Filtar kratkih impulsa brojača u mikrosekundama. Upotrebljava se u načinu counter.

pull

string / samo ulaz

none, up ili down.

counter

bigint | null / samo ulaz

Najnovija vrijednost brojača bez gubitka preciznosti velikog cijelog broja.

claimed

boolean / samo izlaz

Izlaz preuzima korisnička aplikacija. Ne znači da je izlaz uključen.

input.configure(options)

Dostupno od: Neutron AppEngine 1.0.0
await io.input(1).configure({ mode: "digital", function: "disabled", debounceMs: 20, pull: "down" });
Namjena. Konfigurirajte i spremite način rada, funkciju i obradu odabranog ulaza.
Opis. Mijenja navedena svojstva, a druga zadržava gdje su kompatibilna s odabranim načinom rada. Sprema i primjenjuje konfiguraciju bez ponovnog pokretanja putem postojećeg zajedničkog postupka konfiguriranja ulaza. Načini disabled i counter onemogućuju sistemsku funkciju ulaza. Inicijalizacija novog načina ne šalje change i ne broji početno aktivnu razinu kao novi pritisak.

Parametri

Tablica 19

Parametar

Tip / obveznost

Opis

options.mode

string / neobvezno

disabled, digital ili counter. Ako se izostavi, zadržava trenutni način rada.

options.function

string | integer / neobvezno

Naziv ili ID iz tablice ulaznih funkcija. Aktivna funkcija dopuštena je samo u načinu digital.

options.debounceMs

integer / neobvezno

0..60000 ms, samo način digital. Postojeća početna postavka je 20 ms; izričito navedite željenu vrijednost pri prelasku iz drugog načina rada.

options.pull

string / neobvezno

none, up ili down; samo način digital.

options.glitchUs

integer / neobvezno

0..12 µs, samo način counter. 0 onemogućuje filtriranje. Pri prelasku na counter bez navođenja filtra upotrebljava prethodni filtar koji nije nula ili 5 µs.

Rezultat

Promise<InputState> sa strukturom read(). Postavke ostaju nakon Stop i ponovnog pokretanja uređaja.

Pogreške i posebnosti

INVALID_ARGUMENT za nevažeće vrste ili nekompatibilna svojstva, NOT_AVAILABLE, RESOURCE_IN_USE tijekom aktivnog doziranja ili kontrolnog vaganja, CONFIGURE_FAILED ako primjena ili spremanje ne uspije, i BUSY. Način rada brojača može biti odbijen ako odabrani ulaz nema dostupnih resursa brojanja. Nemojte konfigurirati u brzoj periodičnoj petlji.

Primjer

await io.input(1).configure({ mode: "digital", function: "tare", debounceMs: 30, pull: "down" });
// For independent JavaScript handling of the same input:
await io.input(1).configure({ function: "disabled" });

output.configure(options)

Dostupno od: Neutron AppEngine 1.0.0
await io.output(1).configure({ function: "disabled" });
Namjena. Odaberite i spremite sistemsku funkciju izlaza ili je onemogućite.
Opis. Promjena funkcije ne prebacuje izravno izlaz. Aktivna funkcija upravlja njegovim stanjem prema pravilima uređaja. disabled omogućuje ručno upravljanje i preuzimanje iz JavaScripta; ne isključuje automatski trenutačnu izlaznu razinu.

Parametri

Tablica 20

Parametar

Tip / obveznost

Opis

options.function

string | integer / obvezno

Naziv ili ID iz tablice izlaznih funkcija.

Rezultat

Promise<OutputState>. Postavka je trajna i primjenjuje se bez ponovnog pokretanja.

Pogreške i posebnosti

RESOURCE_IN_USE ako je izlaz preuzet ili je aktivno doziranje/kontrolno vaganje. Pozovite release(), zatim configure(). Drugi kanali također ne mogu promijeniti funkciju preuzetog izlaza. Ostale pogreške: INVALID_ARGUMENT, NOT_AVAILABLE, CONFIGURE_FAILED, BUSY.

Primjer

await io.output(2).configure({ function: "inTolerance" });
// Monitoring is allowed even when the system controls the output.
io.output(2).on("change", e => console.info(e.value));

Nazivi funkcija i ID-ovi

Tablica 21

ID ulaza

JavaScript naziv od Neutron AppEngine 1.0.0

Značenje

0

disabled

Bez sistemske funkcije

1

zero

Nuliranje

2

tare

Tariranje

3

clearTare

Brisanje tare

4

dosingStart

Početak doziranja

5

dosingPause

Pauza doziranja

6

dosingStop

Zaustavljanje doziranja

7

checkweigherSensor

Senzor proizvoda

8

checkweigherStart

Pokretanje kontrolnog vaganja

9

checkweigherPause

Pauza kontrolnog vaganja

10

checkweigherStop

Zaustavljanje kontrolnog vaganja

11

checkweigherReset

Ponovno postavljanje kontrolnog vaganja

12

checkweigherEnable

Omogućivanje CONS-a

13

checkweigherTrigger

Aktiviranje izbacivanja

Tablica 22

ID izlaza

JavaScript naziv od Neutron AppEngine 1.0.0

Značenje

0

disabled

Bez sistemske funkcije

1

inTolerance

U granicama tolerancije

2

underTolerance

Ispod tolerancije

3

overTolerance

Iznad tolerancije

4

dosingActive

Doziranje aktivno

5

dosingFast

Grubo doziranje

6

dosingMedium

Srednje doziranje

7

dosingFine

Fino doziranje

8

dosingFly

Čeka se priljev

9

dosingUnloading

Pražnjenje

10

dosingInTolerance

Doziranje unutar tolerancije

11

dosingOutOfTolerance

Doziranje izvan tolerancije

12

dosingEnd

Doziranje završeno

13

dosingError

Greška u doziranju

14

checkweigherBelt

Pokretna traka

15

checkweigherLow

Izbacivanje prelaganog proizvoda

16

checkweigherHigh

Izbacivanje preteškog proizvoda

17

checkweigherGood

Impuls prihvatljive mase

18

checkweigherCommon

Zajedničko izbacivanje / pogreška

19

checkweigherActive

Aktivno kontrolno vaganje

20

checkweigherAlarm

Alarm

21

checkweigherBuffer

Upozorenje za lijevak

Funkcionalnost uređaja određuje stvarna pravila ovih sistemskih funkcija. Registracija change ne onemogućuje funkciju: ulaz dodijeljen tariranju može pokrenuti i sistemsko tariranje i JavaScript događaj. Ako će JavaScript izvesti operaciju, najprije postavite function="disabled" kako biste izbjegli dvostruko izvođenje. Popisi ID-jeva/naziva dostupni su i u capabilities.io.inputFunctions i outputFunctions.

output.claim(options?)

Dostupno od: Neutron AppEngine 1.0.0
await io.output(1).claim({ safeState: false });
Namjena. Preuzmite isključivo ručno upravljanje izlazom za trenutačno izvršavanje aplikacije.
Opis. Dopušteno samo uz function=disabled. Ne onemogućuje automatski dodijeljenu sistemsku funkciju i ne mijenja trenutačnu razinu. Ista aplikacija može ponovno preuzeti isti izlaz radi ažuriranja safeState.

Parametri

Tablica 23

Parametar

Tip / obveznost

Opis

options.safeState

boolean / false

Stanje izlaza pri release() ili završetku aplikacije. Vrijedi za trenutačno izvršavanje; ne sprema se kao početno stanje uređaja.

Rezultat

Promise<OutputState> s claimed=true.

Pogreške i posebnosti

RESOURCE_IN_USE za aktivnu sistemsku funkciju ili drugog vlasnika. NOT_AVAILABLE, INVALID_ARGUMENT, BUSY. Preuzeti izlazi odbijaju vanjska pisanja i promjene funkcija, uključujući putem drugih kanala. Praćenje change ostaje dopušteno.

Primjer

const out = io.output(1);
await out.configure({ function: "disabled" });
await out.claim({ safeState: false });
await out.write(true);

output.write(value)

Dostupno od: Neutron AppEngine 1.0.0
await io.output(1).write(true);
Namjena. Postavite preuzeti izlaz na traženo logičko stanje.
Opis. Piše putem zajedničke obrade ulaza/izlaza. Stvarna promjena šalje change; ponovno pisanje iste vrijednosti ne šalje događaj. Stanje se ne sprema pri svakom prebacivanju. Promise i događaj change zasebne su obavijesti; nemojte se oslanjati na njihov međusobni redoslijed.

Parametri

Tablica 24

Parametar

Tip / obveznost

Opis

value

boolean / obvezno

true uključuje, false isključuje; 0, 1 i nizovi nisu dopušteni.

Rezultat

Promise<OutputState> nakon pisanja upravljačkog izlaza.

Pogreške i posebnosti

NOT_OWNER prije preuzimanja ili nakon oslobađanja. NOT_AVAILABLE, INVALID_ARGUMENT, RESOURCE_IN_USE, BUSY. Potvrda ne dokazuje fizički rad vanjskog uređaja.

Primjer

const out = io.output(1);
await out.claim();
await out.write(true);
await out.write(false);

output.release()

Dostupno od: Neutron AppEngine 1.0.0
await io.output(1).release();
Namjena. Postavite izlaz na safeState i oslobodite vlasništvo.
Opis. Automatsko oslobađanje događa se i u servisnoj obradi nakon Stop, neobrađene pogreške ili zamjene aplikacije. Prethodna sistemska funkcija ne vraća se automatski: configure je izričita trajna promjena. Oslobađanje izlaza koji nije preuzet u trenutačnom izvršavanju nema učinka.

Parametri

Nema parametara.

Rezultat

Promise<undefined>. Ako safeState promijeni razinu, change se šalje dok aplikacija još radi.

Pogreške i posebnosti

NOT_OWNER za drugog vlasnika, NOT_AVAILABLE, BUSY. Dostava završnog događaja nije zajamčena pri završetku aplikacije. Nakon resetiranja hardvera vrijedi uobičajeno početno stanje izlaza uređaja (isključeno), a ne prethodni safeState. To nije zamjena za hardverski sigurnosni krug.

Primjer

await io.output(1).release();
// A system function can now be assigned again:
await io.output(1).configure({ function: "inTolerance" });

pin.on() / pin.once() / pin.off()

Dostupno od: Neutron AppEngine 1.0.0
pin.on("change", callback);
pin.once("change", callback);
pin.off("change", callback);
Namjena. Pratite promjene na odabranom ulazu ili izlazu.
Opis. on prati sljedeće promjene. once uklanja registraciju prije prve sljedeće promjene, koja može biti uključivanje ili isključivanje. off uklanja registracije iste funkcije. Sama registracija ne šalje početni događaj. Podržani događaj je change, s najviše 32 slušatelja po priključku.

Parametri

Tablica 25

Parametar

Tip / obveznost

Opis

eventName

string / obvezno

Samo "change".

callback

function / obvezno

Prima {index, value, previousValue, timeMs}. off zahtijeva istu referencu funkcije.

Rezultat

Vraća isti objekt priključka za ulančavanje. Događaji su neovisni o izvoru promjene: JavaScript, CSCP, druga upravljačka sučelja ili sistemska funkcija.

Pogreške i posebnosti

INVALID_ARGUMENT, QUOTA_EXCEEDED. Ulazi šalju događaje nakon uklanjanja odskakivanja kontakata. Digitalni događaji nisu dostupni u načinu counter ili disabled. Izlazi šalju događaje samo kada se naređena razina stvarno promijeni. Iznimka ili neobrađeni odbijeni Promise u povratnom pozivu može zaustaviti aplikaciju prema pravilima izvršnog okruženja. Bez slušatelja događaji tog priključka ne šalju se JavaScriptu.

Primjer

const onInput = event => {
    console.info(event.index, event.previousValue, "->", event.value, event.timeMs);
    if (event.value) console.info("Input activated");
};
io.input(1).on("change", onInput);
io.output(2).once("change", e => console.info("First output change:", e.value));
// Later: io.input(1).off("change", onInput);
Tablica 26

Polje događaja od Neutron AppEngine 1.0.0

Tip

Značenje

index

integer

1..6 za priključak sa slušateljem.

value

boolean

Novo stanje: true je logično 1, false je logično 0.

previousValue

boolean

Prethodno potvrđeno stanje.

timeMs

number

Monotono vrijeme promjene u milisekundama od pokretanja uređaja; može biti razlomljeno. Nije datum, UTC vrijeme ili vrijeme dostave povratnog poziva. Za ulaze je to vrijeme potvrde nakon uklanjanja odskakivanja kontakata.

Primjer trajanja aktivacije ne zahtijeva periodično provjeravanje. timeMs počinje ispočetka nakon ponovnog pokretanja uređaja. Promjene konfiguracije i početni uzorci u novom načinu nisu događaji fizičke promjene.

let activatedAt;
io.input(1).on("change", event => {
    if (event.value) activatedAt = event.timeMs;
    else if (activatedAt !== undefined) {
        console.info("Active duration:", event.timeMs - activatedAt, "ms");
        activatedAt = undefined;
    }
});

input.counter()

Dostupno od: Neutron AppEngine 1.0.0
const count = io.input(1).counter();
Namjena. Vraćanje zadnjeg ukupnog broja otkrivenih pozitivnih impulsa na ulazu brojača.
Opis. Brojanje koristi postojeći mehanizam uređaja bez pozivanja JavaScript za svaki impuls. BigInt čuva preciznost iznad 2^53. Maksimalno: 9223372036854775807; vrijednost se zasićuje na ovoj granici. Normalna postojanost brojača uređaja ostaje aktivna; iznenadni gubitak struje može izgubiti impulse koji još nisu spremljeni.

Parametri

Nema parametara.

Rezultat

bigint. Ista se vrijednost pojavljuje u input.read().counter. Koristite count.toString() za JSON; JSON.stringify ne može izravno serijalizirati BigInt.

Pogreške i posebnosti

INVALID_MODE ako unos nije u načinu brojača; NOT_AVAILABLE ako I/O nema. Ovo je snimka, a ne jamstvo da tijekom očitavanja nije stigao novi puls.

Primjer

await io.input(1).configure({ mode: "counter", glitchUs: 5 });
const count = io.input(1).counter();
console.info(count.toString());
console.info(JSON.stringify({ count: count.toString() }));

input.resetCounter()

Dostupno od: Neutron AppEngine 1.0.0
await io.input(1).resetCounter();
Namjena. Ponovno postavite odabrani brojač i spremite novo polazište.
Opis. Asinkrono; dopušteno samo u načinu counter. Ne šalje digitalni događaj change. Impulsi mogu stići tijekom ili neposredno nakon ponovnog postavljanja.

Parametri

Nema parametara.

Rezultat

Promise<bigint> koji sadrži najnoviju snimku brojača nakon izvršenje. Novi impulsi znače da možda više nije 0n.

Pogreške i posebnosti

INVALID_MODE, NOT_AVAILABLE, WRITE_FAILED, BUSY. Neuspješno spremanje može se dogoditi nakon resetiranja brojača u memoriji; pogreška ne poništava taj učinak. Nemojte resetirati u brzoj petlji.

Primjer

await io.input(1).resetCounter();
console.info(io.input(1).counter().toString());

Kompletan primjer: ulaz kontrolira izlaz

Primjer izričito sprema konfiguraciju ulaza 1 i onemogućuje sistemsku funkciju izlaza 1. Zatim preuzima izlaz sa safeState=false, nadzire ulaz 1 i zasebno prati izlaz 2. Ograničava preklapanje asinkronih pisanja i primjenjuje najnovije stanje ulaza nakon završetka pisanja.

// Input 1 controls output 1; output 2 is only monitored.
// configure() settings persist. The active system function on output 1
// is explicitly disabled; during dosing/checkweighing the call is rejected.
const input = io.input(1);
const output = io.output(1);
let ready = false;
let updating = false;
let dirty = false;

// Bounded change coalescing: apply the latest state after a slow write.
async function updateOutput() {
    if (!ready) return;
    dirty = true;
    if (updating) return;
    updating = true;
    try {
        while (dirty) {
            dirty = false;
            await output.write(input.read().value);
        }
    } catch (error) {
        console.error(error.code || error.name, error.message);
        app.stop();
    } finally {
        updating = false;
    }
}

input.on("change", event => {
    console.info("Input", event.index, event.value, "timeMs:", event.timeMs);
    updateOutput(); // The function handles its own errors.
});

io.output(2).on("change", event => {
    // Also works when a CSCP command or system function switches output 2.
    console.info("Output", event.index, event.previousValue, "->", event.value);
});

async function start() {
    const caps = app.capabilities();
    if (!caps.features.io || !caps.io.available) throw new Error("I/O unavailable");
    await input.configure({ mode: "digital", function: "disabled", debounceMs: 20, pull: "down" });
    await output.configure({ function: "disabled" });
    await output.claim({ safeState: false });
    ready = true;
    await updateOutput(); // Initial state emits no change event.
    console.info("I/O application ready");
}

start().catch(error => {
    console.error(error.code || error.name, error.message);
    app.stop(); // Stopping sets the claimed output to safeState.
});

Testiranje I/O aplikacije

Tablica 27

Test

Očekivani rezultat

Početno stanje

read vraća vrijednost; registracija on/once ne šalje događaj.

Uključite i isključite ulaz 1

Dva događaja change nakon uklanjanja odskakivanja kontakata, sa suprotnim previousValue/value i odgovarajućim timeMs.

Kratki kontaktni odskok

Nema duplih događaja za jednu potvrđenu promjenu.

Vanjski SOT za nepreuzeti izlaz 2

JavaScript događaj change pri svakoj stvarnoj promjeni; ponavljanje iste vrijednosti ne šalje događaj.

Izlaz 2 kontrolira funkcija sustava

JavaScript može pratiti promjene bez preuzimanja.

Vanjski SOT/SOF ili promjena funkcije preuzetog izlaza 1

Odbijeno bez prepisivanja izlaza aplikacije.

Stop ili pogreška aplikacije s uključenim preuzetim izlazom

Prijelaz na safeState i oslobađanje tijekom servisne obrade.

Brojač i velike vrijednosti

BigInt bez gubitka preciznosti; bez digitalnog događaja change pri svakom impulsu.

Nedostupan I/O ili nevažeći indeks

available=false ili INVALID_ARGUMENT; bez pristupa drugom priključku.

9. Postavke modula: RMD i SMD

Modul device upravlja postavkama Neutrona. Odvojen je od modula scale, koji upravlja vaganjem, i aplikacijskih podataka u storage. Sve funkcije i svojstva u ovom poglavlju dostupni su od Neutron AppEngine 1.0.0. Podrška: app.capabilities().features.settings.

Promjene upotrebljavaju postojeću provjeru i pohranu SMD-a. Poštuju zauzeta sučelja i preuzete izlaze. Postavke koje se mogu primijeniti tijekom rada upotrebljavaju postojeće mehanizme primjene tijekom rada. Druge prijavljuju da je potrebno ponovno pokretanje. API nikada automatski ne pokreće uređaj ponovno.

device.cmd(command)

Dostupno od: Neutron AppEngine 1.0.0
const raw = await device.cmd("RMD");
const result = await device.cmd("SMD;S0B=19200;S0P=0;");
Namjena. Izvršite podržanu upravljačku naredbu RMD ili SMD.
Opis. RMD vraća tekstualni popis postavki i osnovnih stanja u postojećem formatu. SMD koristi isti rezultat kao settings.write(). Ostale upravljačke naredbe kao što je REB ovdje nisu podržane. Ne ponavljajte SMD između pojedinačnih postavki.

Parametri

Tablica 28

Parametar

Tip / obveznost

Opis

command

string / obvezno

RMD ili SMD;KEY=value;... . Najviše 2048 UTF-8 bajtova; bez upravljačkih znakova. SMD prihvaća do 16 različitih ključeva.

Rezultat

RMD: Promise<string>. SMD: Promise<SettingsWriteResult>, opisano u nastavku.

Pogreške i posebnosti

INVALID_ARGUMENT, UNSUPPORTED_COMMAND, BUSY, NO_RESPONSE, RESPONSE_TOO_LARGE. RMD može premašiti 4096 bajtova; koristite settings.read za odabrane ključeve ili settings.list za označavanje stranica. API ne čita lozinke, PIN-ove ili privatne podatke certifikata. Upravljajte certifikatima kroz postojeći postupak dodjele certifikata.

Primjer

try {
    const raw = await device.cmd("RMD");
    console.info(raw);
} catch (error) {
    if (error.code !== "RESPONSE_TOO_LARGE") throw error;
    console.info("Use device.settings.list() for paged settings");
}

device.settings.read(keys)

Dostupno od: Neutron AppEngine 1.0.0
const values = await device.settings.read(["S0B", "S0P"]);
Namjena. Čita odabrane pohranjene postavke bez velikog odgovora RMD.
Opis. Vraća vrijednosti kao nizove, uključujući brojeve. Ključ koji nedostaje ima vrijednost null. Čitanje ne mijenja stanje ili postavke uređaja i ne jamči da je primjena na hardveru dovršena.

Parametri

Tablica 29

Parametar

Tip / obveznost

Opis

keys

string[] / obvezno

1..16 ključeva. Nazivi sadrže 1..15 znakova: A–Z, 0–9 ili _.

Rezultat

Promise<object>, na primjer {S0B:"19200", S0P:"0", UNKNOWN:null}.

Pogreške i posebnosti

INVALID_ARGUMENT, PERMISSION_DENIED za zaštićene podatke, RESPONSE_TOO_LARGE, BUSY. Nemojte izmišljati API-je koristeći nepoznate ključeve; podržane postavke definira uređaj i njegova dokumentacija.

Primjer

const values = await device.settings.read(["S0B", "S0I", "S0P", "S0S"]);
const baudRate = values.S0B === null ? null : Number(values.S0B);
console.info(baudRate);

device.settings.list(options?)

Dostupno od: Neutron AppEngine 1.0.0
const page = await device.settings.list({ cursor: null, limit: 16 });
Namjena. Čitanje javno dostupnih pohranjenih postavki na stranicama.
Opis. Ključevi su poredani uzlazno. cursor je posljednji ključ prethodne stranice, isključen iz nove stranice. Odgovor može zbog ograničenja veličine sadržavati manje od limit ključeva. Stranice nisu jedna snimka: postavke se mogu mijenjati između poziva.

Parametri

Tablica 30

Parametar

Tip / obveznost

Opis

options.cursor

string | null / izostavljeno

nextCursor iz prethodnog odgovora; null ili izostavljanje počinje na početku.

options.limit

integer / 16

1..32 ključa po stranici; ograničenje odgovora ostaje 4096 bajtova.

Rezultat

Promise<{values:object, nextCursor:string|null}>. null označava kraj.

Pogreške i posebnosti

INVALID_ARGUMENT, RESPONSE_TOO_LARGE za jednu preveliku vrijednost, BUSY. Popis sadrži pohranjene ključeve; dinamička RMD stanja nisu nužno pohranjene postavke. Povjerljivi podaci su izostavljeni.

Primjer

let cursor = null;
do {
    const page = await device.settings.list({ cursor, limit: 16 });
    console.info(page.values);
    cursor = page.nextCursor;
} while (cursor !== null);

device.settings.write(values)

Dostupno od: Neutron AppEngine 1.0.0
const result = await device.settings.write({ S0B: "19200", S0P: "0" });
Namjena. Spremite grupu postavki kroz postojeću obradu SMD.
Opis. Provjerava cjelokupni format prije pokretanja. Pojedinačna provjera valjanosti i kvarovi hardvera tada slijede postojeća pravila SMD. Grupa nije transakcija: jedna greška ne poništava ostale spremljene vrijednosti. Provjerite result.ok i result.errors čak i nakon što await uspije.

Parametri

Tablica 31

Parametar

Tip / obveznost

Opis

values

object / obvezno

1..16 ključeva. Vrijednosti mogu biti nizovi, logičke vrijednosti (0/1) ili cijeli brojevi u rasponu −2147483648..4294967295. Decimalne vrijednosti navedite kao nizove u formatu postavke. Najviše 1024 UTF-8 bajta po vrijednosti; bez točaka sa zarezom, upravljačkih znakova ili posebne vrijednosti ?. Cijeli zahtjev mora stati u 4096 bajtova.

Rezultat

Promise<{ok:boolean, applied:string[], errors:object, rebootRequired:boolean, applyPending:boolean}>. applied navodi ključeve bez trenutačne pogreške spremanja; nije neovisna potvrda spremnosti fizičkog sučelja. Konačna pogreška primjene može imati zaseban ključ u errors.

Pogreške i posebnosti

Nevaljani format odbija se s INVALID_ARGUMENT ili MESSAGE_TOO_LARGE. Pogreške pojedinačnih postavki vraćaju ok=false i errors, primjerice CHECKWEIGHER_BUSY ili INVALID_OR_WRITE_FAILED. applyPending označava primjenu serijskog sučelja na čekanju; pratite stanje sučelja ili uređaja. rebootRequired nikada ne pokreće automatsko ponovno pokretanje. Nemojte pisati trajne postavke u brzoj mjernoj petlji.

Primjer

const result = await device.settings.write({ S0B: "19200", S0I: "1", S0P: "0", S0S: "1" });
if (!result.ok) console.warn("Some settings failed:", result.errors);
if (result.rebootRequired) console.info("A device restart is required");
if (result.applyPending) console.info("Serial configuration is still being applied");

Primjer čitanja postavki

async function start() {
    if (!app.capabilities().features.settings) throw new Error("Settings API is unavailable");
    console.info("Selected settings:", await device.settings.read(["S0B", "S0I", "S0P", "S0S"]));
    // Changes persist. Uncomment only the desired keys before use.
    // const result = await device.settings.write({ S0B: "19200", S0I: "1", S0P: "0", S0S: "1" });
    // console.info(result.ok, result.errors, result.rebootRequired, result.applyPending);
    // Equivalent: await device.cmd("SMD;S0B=19200;S0I=1;S0P=0;S0S=1;");
    // Use pagination for more settings; complete RMD may exceed 4096 bytes.
    const page = await device.settings.list({ limit: 8 });
    console.info("First settings page:", page.values);
}
start().catch(error => { console.error(error.code || error.name, error.message); app.stop(); });

10. Pohrana i datoteke

Modul storage osigurava trajnu pohranu podataka aplikacije. Sve funkcije u ovom poglavlju dostupne su od Neutron AppEngine 1.0.0. Podrška: app.capabilities().features.files. Aplikacijske datoteke odvojene su od sistemskih datoteka, certifikata i koda instalirane aplikacije. API ne može pristupiti ničemu izvan ovog podatkovnog prostora.

Nazivi datoteka sadrže 1..64 znaka. Prvi mora biti A–Z/a–z ili znamenka; sljedeći mogu uključivati i _, - ili točku. Uzastopne točke, kose crte, podmape i apsolutne putanje zabranjene su. Nazivi razlikuju velika i mala slova. Podaci ostaju nakon Stop, ponovnog pokretanja i uobičajene zamjene aplikacije. Instalirana aplikacija dijeli jedan podatkovni prostor; nova verzija ili druga aplikacija na uređaju može upotrebljavati iste podatke. Vraćanje tvorničkih postavki briše korisničke datoteke i lokalne baze podataka. Uobičajeni Delete aplikacije ne briše ih.

Operacije su asinkrone i koriste ograničeni servisni red. Nemojte učitavati cijelu veliku datoteku u JavaScript, stvarati neograničene redove pisanja ili slati sve dijelove bez await. Zaustavljanjem se ne poništava već započeto pisanje; njegov rezultat možda više neće doseći zaustavljenu aplikaciju.

storage.info()

Dostupno od: Neutron AppEngine 1.0.0
const info = await storage.info();
Namjena. Izvješće o upotrebi, kvoti i dostupnom prostoru.
Opis. Datoteke i lokalne baze podataka dijele kvotu aplikacije. Stvarna dostupnost također ovisi o drugim podacima uređaja i rezervi sustava. Privremene kopije za atomsku zamjenu ili sažimanje zahtijevaju dodatni fizički prostor.

Parametri

Nema parametara.

Rezultat

{quotaBytes, usedBytes, reserveBytes, freeBytes, availableBytes, maxFileBytes, databases:[{name,bytes}]}. usedBytes je ukupna logička veličina potvrđenih datoteka i baza; freeBytes je ukupni slobodni prostor pohrane. availableBytes procjenjuje mogući rast unutar kvote i rezerve.

Pogreške i posebnosti

NOT_AVAILABLE ili pogreška čitanja. Snimak, a ne rezervacija za buduće pisanje. Dostupnost se ponovno provjerava tijekom operacije.

Primjer

const info = await storage.info();
console.info(info.usedBytes, info.availableBytes, info.databases);

storage.write() / storage.writeText()

Dostupno od: Neutron AppEngine 1.0.0
await storage.write(name, data);
await storage.writeText(name, text);
Namjena. Stvorite datoteku ili zamijenite njezin cijeli sadržaj.
Opis. write prihvaća string ili Uint8Array; writeText prihvaća samo string. Nizovi se spremaju kao UTF-8, a binarni podaci kao točni bajtovi. Ne dodaje novi redak ili NUL. Potpuna zamjena upotrebljava privremeni zapis i zatim zamjenu potvrđene datoteke.

Parametri

Tablica 32

Parametar

Tip / obveznost

Opis

name

string / obvezno

Važeći naziv datoteke.

data / text

string | Uint8Array / obvezno

0..4096 bajtova po pozivu nakon UTF-8 kodiranja. writeText ne prihvaća Uint8Array.

Rezultat

Promise<undefined> nakon uspješnog pisanja i potvrde pohrane. Prazan korisni teret stvara ili prazni datoteku.

Pogreške i posebnosti

INVALID_ARGUMENT, MESSAGE_TOO_LARGE, QUOTA_EXCEEDED, NO_SPACE, WRITE_FAILED, NOT_AVAILABLE, BUSY. Neuspjela zamjena zadržava prethodnu predanu datoteku. Za veći sadržaj, napišite prvi dio, zatim dodajte uzastopno; ova konstrukcija u više koraka nije jedna atomska operacija.

Primjer

await storage.writeText("config.json", JSON.stringify({ target: 25, tolerance: 0.1 }));
await storage.write("data.bin", new Uint8Array([0, 255, 10, 13]));

storage.append() / storage.appendText()

Dostupno od: Neutron AppEngine 1.0.0
await storage.append(name, data);
await storage.appendText(name, text);
Namjena. Dodavanje podataka u datoteku, pogodno za zapise.
Opis. Stvara datoteku koja nedostaje bez prepisivanja prethodnog sadržaja. Dodavanje nije transakcija s više zapisa; pogreške ili gubitak napajanja mogu ostaviti posljednji dodatak nedovršenim. Oblikujte dnevnike tako da otkrivaju takve djelomične završne zapise.

Parametri

Tablica 33

Parametar

Tip / obveznost

Opis

name

string / obvezno

Važeći naziv datoteke.

data / text

string | Uint8Array / obvezno

Najviše 4096 bajtova po pozivu; appendText zahtijeva string. Najveća veličina datoteke: 262144 bajta.

Rezultat

Promise<undefined>. Isporučeni uspjeh potvrđuje pisanje; nedostatak odgovora ne znači da se pisanje nije dogodilo.

Pogreške i posebnosti

MESSAGE_TOO_LARGE, QUOTA_EXCEEDED, NO_SPACE, WRITE_FAILED, BUSY. Dio dodatka možda već postoji nakon pogreške. Ne pokušavajte naslijepo ponoviti poslovnu evidenciju bez jedinstvenog ID ili verifikacije.

Primjer

await storage.appendText("measurements.jsonl", JSON.stringify({ id: 1, net: scale.net }) + "\n");

storage.read() / storage.readText()

Dostupno od: Neutron AppEngine 1.0.0
const bytes = await storage.read(name, { offset: 0, length: 4096 });
const text = await storage.readText(name);
Namjena. Čitanje binarnih bajtova ili UTF-8 teksta.
Opis. read vraća Uint8Array; readText vraća string. offset i length uvijek su u bajtovima. Početak iza kraja vraća prazan rezultat. Čitanje blizu kraja može vratiti manje bajtova od traženih.

Parametri

Tablica 34

Parametar

Tip / obveznost

Opis

name

string / obvezno

Naziv datoteke.

options.offset

integer / 0

0..262144 bajtova od početka.

options.length

integer / neobvezno

0..4096 bajtova. read zadano čita do 4096 bajtova. Bez length, readText zahtijeva da preostali tekst stane u jedan odgovor; inače RESPONSE_TOO_LARGE.

Rezultat

Promise<Uint8Array> ili Promise<string>. read čuva binarni NUL i sve ostale bajtove.

Pogreške i posebnosti

NOT_FOUND, INVALID_ARGUMENT, READ_FAILED, RESPONSE_TOO_LARGE. Poštujte granice višebajtnih znakova kada dijelite tekst UTF-8; neovisno dekodiranje proizvoljnih dijelova može podijeliti znak. readText nije JSON ili JSONL parser; koristite JSON.parse za male JSON dokumente.

Primjer

const config = JSON.parse(await storage.readText("config.json"));
let offset = 0;
for (;;) {
    const part = await storage.read("data.bin", { offset, length: 4096 });
    if (!part.length) break;
    console.info("Read bytes:", part.length);
    offset += part.length;
}

storage.list(options?) / storage.stat(name)

Dostupno od: Neutron AppEngine 1.0.0
const page = await storage.list({ cursor: null, limit: 16 });
const info = await storage.stat("data.bin");
Namjena. Popis datoteka ili dobivanje veličine datoteke.
Opis. list uključuje samo obične aplikacijske datoteke, ne interne datoteke baze podataka. Nazivi su poredani uzlazno; cursor isključuje posljednji već vraćeni naziv. Baze podataka pojavljuju se u storage.info().databases.

Parametri

Tablica 35

Parametar

Tip / obveznost

Opis

options.cursor

string | null / izostavljeno

nextCursor s prethodne stranice.

options.limit

integer / 16

1..32 datoteke.

name za stat

string / obvezno

Valjano ime.

Rezultat

list: {files:[{name,size}], nextCursor:string|null}. stat: {name,size}. Veličina je u bajtovima. null označava kraj popisa.

Pogreške i posebnosti

NOT_FOUND za stat, INVALID_ARGUMENT, READ_FAILED, OUT_OF_MEMORY. Stranice nisu nepromjenjiva snimka tijekom istodobnog dodavanja ili brisanja.

Primjer

let cursor = null;
do {
    const page = await storage.list({ cursor, limit: 16 });
    for (const file of page.files) console.info(file.name, file.size);
    cursor = page.nextCursor;
} while (cursor !== null);

storage.remove(name) / storage.rename(name, to)

Dostupno od: Neutron AppEngine 1.0.0
const removed = await storage.remove("old.jsonl");
await storage.rename("measurements.jsonl", "archive.jsonl");
Namjena. Brisanje ili preimenovanje obične datoteke.
Opis. remove ne može pristupiti internim podacima baze podataka. rename ne prepisuje postojeće odredište; po potrebi ga najprije izričito uklonite.

Parametri

Tablica 36

Parametar

Tip / obveznost

Opis

name

string / obvezno

Naziv izvorne datoteke.

to za rename

string / obvezno

Novo važeće ime bez postojeće datoteke.

Rezultat

remove: Promise<boolean>, false ako ne postoji. rename: Promise<undefined>.

Pogreške i posebnosti

NOT_FOUND za nedostajući izvor rename, ALREADY_EXISTS za postojeće odredište, WRITE_FAILED, INVALID_ARGUMENT. Brisanje se ne može poništiti.

Primjer

await storage.remove("measurements-old.jsonl");
await storage.rename("measurements.jsonl", "measurements-old.jsonl");

storage.findText(name, text, options?)

Dostupno od: Neutron AppEngine 1.0.0
const page = await storage.findText("measurements.jsonl", "ART-001", { offset: 0, limit: 16 });
Namjena. Pronađite točan tekst u običnoj datoteci bez učitavanja cijelog sadržaja u JavaScript.
Opis. Sekvencijalno pretraživanje bajtova UTF-8 koje razlikuje velika i mala slova, a ne regularni izraz. Podržava podudaranja koja se preklapaju. Svaki poziv skenira najviše 65536 bajtova ili se zaustavlja na ograničenju podudaranja. Koristite lokalnu bazu podataka za brzo traženje ključeva umjesto stalnog skeniranja datoteka.

Parametri

Tablica 37

Parametar

Tip / obveznost

Opis

name

string / obvezno

Naziv datoteke.

text

string / obvezno

1..128 UTF-8 bajtova, bez NUL-a.

options.offset

integer / 0

Pomak početnog bajta, 0..262144.

options.limit

integer / 16

1..64 podudaranja po stranici.

Rezultat

{offsets:number[], nextOffset:number|null}. offsets su apsolutni početni položaji podudaranja u bajtovima. Nastavite točno s vraćenim nextOffset; on čuva moguća djelomična podudaranja preko granica stranica. null označava kraj datoteke.

Pogreške i posebnosti

NOT_FOUND, INVALID_ARGUMENT, READ_FAILED, CANCELLED. Nemojte mijenjati datoteku tijekom pretraživanja u više koraka ako su vam potrebni stabilni rezultati. Ukupno vrijeme uzastopnog pretraživanja proporcionalno je veličini datoteke.

Primjer

let offset = 0;
do {
    const page = await storage.findText("measurements.jsonl", "ART-001", { offset, limit: 16 });
    console.info(page.offsets);
    offset = page.nextOffset;
} while (offset !== null);

JSONL zapisnici i rotacija

JSONL pohranjuje jedan nezavisni objekt JSON po retku, bez zareza između redaka ili oko []. Ovo podržava dodavanje mjerenja. Generirajte svaki redak s JSON.stringify(record)+"\n". Otkrijte i zasebno obradite nepotpunu posljednju liniju nakon prekida. JSONL ne omogućuje automatsko indeksiranje niti automatsko brisanje starih mjerenja.

// Size-limited JSONL log with one archive file.
let writing = false;
async function start() {
    if (!app.capabilities().features.files) throw new Error("Storage API is unavailable");
    console.info("Storage:", await storage.info());
    setInterval(async () => {
        if (writing) return;
        writing = true;
        try {
            const m = scale.read();
            if (!m.available) return;
            let size = 0;
            try { size = (await storage.stat("measurements.jsonl")).size; }
            catch (error) { if (error.code !== "NOT_FOUND") throw error; }
            if (size >= 32768) {
                await storage.remove("measurements-old.jsonl");
                await storage.rename("measurements.jsonl", "measurements-old.jsonl");
            }
            await storage.appendText("measurements.jsonl", JSON.stringify({ timeMs: m.timeMs, net: m.net, gross: m.gross, unit: m.unit }) + "\n");
        } catch (error) {
            console.warn(error.code || error.name, error.message);
        } finally {
            writing = false;
        }
    }, 10000);
}
start().catch(error => { console.error(error.code || error.name, error.message); app.stop(); });

Ograničenja dijeljene pohrane

Tablica 38

Ograničenje od Neutron AppEngine 1.0.0

Vrijednost

Zajednička aplikacijska kvota

524288 bajtova za datoteke i baze podataka zajedno.

Rezerva sustava

131072 fizički slobodnih bajtova prije dodatnih pisanja. Ostale funkcije uređaja mogu promijeniti stvarnu dostupnost.

Dnevnik datoteke ili jedne baze podataka

262144 bajtova.

Poziv čitanja / pisanja

4096 bajtova.

Obične datoteke

Najviše 64 imena.

Redoslijed

Zahtjevi za pohranu pokreću se u jednom ograničenom servisnom redu. Višestruki pozivi nisu transakcija.

Zatvaranje aplikacije

Otvoreni objekti baze podataka oslobađaju se; potvrđeni podaci ostaju.

Vraćanje tvorničkih postavki

Također briše aplikacijske datoteke i baze podataka.

11. Jednostavna lokalna baza podataka

Lokalna baza podataka pohranjuje male JSON objekte s jedinstvenim ključem, primjerice šifrom proizvoda, šifrom recepture ili ID-jem poslovnog zapisa. Sve funkcije u ovom poglavlju dostupne su od Neutron AppEngine 1.0.0. Podrška: app.capabilities().features.records. Podaci dijele prostor i kvotu pohrane datoteka, ali interne datoteke baze odvojene su od API-ja za obične datoteke.

Otvaranje provjerava dnevnik zapisa i gradi uređeni indeks ključeva. get upotrebljava indeks i izravni pomak zapisa bez pregledavanja cijele baze. Otvaranje i sažimanje pregledavaju podatke i mogu trajati dulje; otvorite jednom pri pokretanju i ponovno upotrebljavajte objekt. Podržan je jedan indeksirani ključ po bazi. Nema SQL-a, relacija, automatskog sekundarnog indeksiranja ni transakcija s više zapisa.

storage.openRecords(name, options?)

Dostupno od: Neutron AppEngine 1.0.0
const articles = await storage.openRecords("articles", { key: "code" });
Namjena. Stvorite ili otvorite bazu podataka i pripremite njezin indeks.
Opis. Naziv baze podataka i naziv ključnog polja trajno su povezani pri stvaranju. Koristite isti naziv ključnog polja prilikom ponovnog otvaranja. Otvaranje već otvorenog naziva se odbija; ponovno koristiti vraćeni objekt. Objekti su važeći samo tijekom trenutnog izvođenja aplikacije.

Parametri

Tablica 39

Parametar

Tip / obveznost

Opis

name

string / obvezno

1..32 znakovi prema pravilima za naziv datoteke.

options.key

string / "id"

Naziv polja objekta najviše razine. 1..32 ASCII znakovi: prvo slovo ili _, zatim i znamenke. Svaki zapis mora sadržavati ovo polje kao neprazan niz.

Rezultat

Promise<RecordStore> sa svojstvima name i key te metodama put/get/delete/list/stat/compact/close.

Pogreške i posebnosti

SCHEMA_MISMATCH za drugo ključno polje u postojeća baza podataka; ALREADY_OPEN; QUOTA_EXCEEDED; NO_SPACE; CORRUPT; CANCELLED; OUT_OF_MEMORY. Najviše 8 trajne baze podataka i 2 otvaraju se istovremeno. Nepotpuni konačni zapis uklanja se prilikom otvaranja; kvar integriteta u cijelom zapisu odbija otvaranje umjesto tihog brisanja podataka.

Primjer

const articles = await storage.openRecords("articles", { key: "code" });
// Reuse articles in application events and timers.
console.info(await articles.stat());

records.put(record)

Dostupno od: Neutron AppEngine 1.0.0
await articles.put({ code: "ART-001", name: "Flour", target: 25 });
Namjena. Umetanje objekta ili potpuna zamjena zapisa s istim ključem.
Opis. put zamjenjuje cijeli objekt, a ne pojedinačna polja. Podaci se dodaju u dnevnik, a potvrđeni zapis ažurira indeks. Ključevi razlikuju velika i mala slova. Više uzastopnih poziva put nije jedna transakcija.

Parametri

Tablica 40

Parametar

Tip / obveznost

Opis

record

object / obvezno

Objekt koji se može serijalizirati u JSON, najviše 2048 UTF-8 bajtova nakon JSON.stringify i najviše 16 razina ugniježđenih objekata/polja. Ključno polje mora biti niz od 1..64 UTF-8 bajta bez upravljačkih znakova. Brojčane ID-jeve izričito pretvorite pomoću String.

Rezultat

Promise<object> koji sadrži pohranjene JSON objekt.

Pogreške i posebnosti

INVALID_ARGUMENT, MESSAGE_TOO_LARGE, QUOTA_EXCEEDED, NO_SPACE, WRITE_FAILED, CLOSED, CORRUPT. BigInt i kružne reference ne mogu se serijalizirati kao JSON. Neuspjeh predaje može ostaviti rezultat pisanja neizvjesnim; ponovno otvori i provjeri get prije ponovnog pokušaja. Nemojte bilježiti svaki puls bez granica.

Primjer

await articles.put({ code: "ART-001", name: "Flour", target: 25 });
await articles.put({ code: "ART-001", name: "Flour", target: 30 });
// The second call replaces the complete first record with that code.

records.get(key)

Dostupno od: Neutron AppEngine 1.0.0
const article = await articles.get("ART-001");
Namjena. Brzo dohvatite posljednji potvrđeni zapis po jedinstvenom ključu.
Opis. Koristi sortirani indeks: traženje ključa zahtijeva logaritamske usporedbe i čitanje odabranog zapisa. Ne skenira sve objekte. Vraća novi objekt; promjena u JavaScript sama po sebi ne mijenja bazu podataka.

Parametri

Tablica 41

Parametar

Tip / obveznost

Opis

key

string / obvezno

Točan ključ, 1..64 UTF-8 bajtovi, bez kontrolnih znakova.

Rezultat

Promise<object|null>. null znači da ključa nema.

Pogreške i posebnosti

INVALID_ARGUMENT, CLOSED, READ_FAILED, CORRUPT. Ostala polja nisu indeksirana. Ne tretirajte ID-ove nizova kao brojeve: "001" i "1" su različiti ključevi.

Primjer

const article = await articles.get("ART-001");
if (article === null) console.warn("Article not found");
else console.info(article.name, article.target);

records.delete(key)

Dostupno od: Neutron AppEngine 1.0.0
const deleted = await articles.delete("ART-001");
Namjena. Uklonite zapis s aktivnog popisa baze podataka.
Opis. Obično dodaje potvrđeni zapis brisanja; stari podaci mogu ostati do sažimanja. Brisanje nije sigurno brisanje fizičkog medija. Dopušteno je brisanje nepostojećeg ključa.

Parametri

Tablica 42

Parametar

Tip / obveznost

Opis

key

string / obvezno

Ključ slijedi ista pravila kao get.

Rezultat

Promise<boolean>: true ako je zapis postojao, inače false.

Pogreške i posebnosti

INVALID_ARGUMENT, CLOSED, NO_SPACE, WRITE_FAILED, CORRUPT. Na ograničenju dnevnika, brisanje može pokrenuti sažimanje koje zahtijeva privremeni prostor.

Primjer

const deleted = await articles.delete("ART-002");
console.info("Deleted:", deleted);

records.list(options?)

Dostupno od: Neutron AppEngine 1.0.0
const page = await articles.list({ cursor: null, limit: 16 });
Namjena. Čitajte aktivne zapise ključnim redoslijedom, stranicu po stranicu.
Opis. Zapisi slijede bajtni redoslijed ključeva. cursor isključuje posljednji ključ prethodne stranice. Ograničenja veličine odgovora mogu skratiti stranicu ispod limit. Za neindeksirana polja pregledavajte stranice i filtrirajte u JavaScriptu; to nije brzo indeksirano pretraživanje.

Parametri

Tablica 43

Parametar

Tip / obveznost

Opis

options.cursor

string | null / izostavljeno

Vraćeno nextCursor s prethodne stranice.

options.limit

integer / 16

Zapisi 1..32, također ograničeni veličinama objekta i odgovora.

Rezultat

{records:object[], nextCursor:string|null}. null označava kraj. Mijenjanje baze podataka između stranica znači da rezultati nisu nepromjenjiva snimka.

Pogreške i posebnosti

INVALID_ARGUMENT, CLOSED, READ_FAILED, CORRUPT, OUT_OF_MEMORY. Izbjegavajte gomilanje svake stranice u jednom velikom nizu kada je potreban samo jedan rezultat.

Primjer

let cursor = null;
do {
    const page = await articles.list({ cursor, limit: 8 });
    for (const record of page.records) {
        if (record.target >= 25) console.info(record.code, record.target);
    }
    cursor = page.nextCursor;
} while (cursor !== null);

records.stat()

Dostupno od: Neutron AppEngine 1.0.0
const status = await articles.stat();
Namjena. Pročitajte broj aktivnih zapisa, veličinu dnevnika i ključno polje.
Opis. Veličina dnevnika uključuje zamijenjene zapise i brisanja, a ne samo trenutno aktivne objekte.

Parametri

Nema parametara.

Rezultat

{count:number, bytes:number, key:string}.

Pogreške i posebnosti

CLOSED ili CORRUPT. Najviše 2048 aktivnih zapisa po bazi podataka; ograničenja veličine i zajednička kvota mogu smanjiti ostvarivi broj.

Primjer

console.info(await articles.stat());

records.compact()

Dostupno od: Neutron AppEngine 1.0.0
await articles.compact();
Namjena. Uklonite stare verzije i brisanja iz dnevnika da biste oslobodili prostor.
Opis. Kopira samo aktivne zapise u privremenu datoteku, provjerava je i potvrđuje, a zatim zamjenjuje staru bazu. Prekid zadržava staru ili novu potvrđenu bazu. put ili delete također mogu pokrenuti sažimanje kada dnevnik dosegne 262144 bajta.

Parametri

Nema parametara.

Rezultat

Promise<undefined>. Aktivni ključevi i vrijednosti ostaju nepromijenjeni.

Pogreške i posebnosti

NO_SPACE za privremenu kopiju, WRITE_FAILED, READ_FAILED, CANCELLED, CORRUPT, OUT_OF_MEMORY. Može trajati dulje i zauzeti servisni red pohrane; nemojte izvršavati nakon svakog mjerenja. Nakon zajedničkog QUOTA_EXCEEDED izričito sažimanje može ukloniti zastarjeli sadržaj prije ponovnog pisanja.

Primjer

await articles.compact();
console.info("After compaction:", await articles.stat());

records.close()

Dostupno od: Neutron AppEngine 1.0.0
await articles.close();
Namjena. Oslobodite otvoreni objekt i indeks uz zadržavanje podataka.
Opis. Daljnje metode objekta vraćaju CLOSED. Ponovljeni close je bezopasan. Po potrebi ponovno otvorite s istim nazivom baze i ključnim poljem. Završetak aplikacije automatski oslobađa njezine otvorene objekte.

Parametri

Nema parametara.

Rezultat

Promise<undefined>.

Pogreške i posebnosti

BUSY ako je red pun. Operacije u redu prije close mogu se prve dovršiti; upotreba zatvorenog objekta odbija se.

Primjer

try {
    console.info(await articles.get("ART-001"));
} finally {
    await articles.close();
}

storage.removeRecords(name)

Dostupno od: Neutron AppEngine 1.0.0
const removed = await storage.removeRecords("articles");
Namjena. Brisanje cijele lokalne baze podataka i njezine sheme.
Opis. Baza podataka mora biti zatvorena. Nazive pronađite u storage.info().databases. Nakon brisanja isti naziv može se stvoriti s drugim ključnim poljem.

Parametri

Tablica 44

Parametar

Tip / obveznost

Opis

name

string / obvezno

Naziv baze podataka, 1..32 znakova.

Rezultat

Promise<boolean>: true ako postoji, inače false.

Pogreške i posebnosti

RESOURCE_IN_USE za otvorenu bazu podataka, INVALID_ARGUMENT, WRITE_FAILED. Brisanje cijele baze podataka ne može se poništiti.

Primjer

await articles.close();
// Execute only if you want to remove all products:
// await storage.removeRecords("articles");

Kompletan primjer baze podataka o lokalnim proizvodima

// Simple local product database. Data survives Stop and restart.
async function start() {
    if (!app.capabilities().features.records) throw new Error("Local records API is unavailable");
    const articles = await storage.openRecords("articles", { key: "code" });
    try {
        // put inserts or fully replaces the record with the same code.
        await articles.put({ code: "ART-001", name: "Flour", target: 25, tolerance: 0.1 });
        await articles.put({ code: "ART-002", name: "Sugar", target: 10, tolerance: 0.05 });
        const article = await articles.get("ART-001");
        console.info("Article:", article);
        let cursor = null;
        do {
            const page = await articles.list({ cursor, limit: 8 });
            for (const record of page.records) console.info(record.code, record.name);
            cursor = page.nextCursor;
        } while (cursor !== null);
        console.info("Database:", await articles.stat());
        // await articles.delete("ART-002");
        // await articles.compact(); // Reclaim obsolete records after many updates.
    } finally {
        await articles.close();
    }
}
start().catch(error => {
    console.error(error.code || error.name, error.message);
    app.stop();
});

Testiranje postojanosti i oporavka

Tablica 45

Test

Očekivani rezultat

put za istu šifru dvaput

get vraća posljednju potpunu verziju; count se ne povećava.

Stop, novi Run ili uobičajeno ponovno pokretanje

Isto ime i ključ otvaraju pohranjene podatke; indeks je ponovno izgrađen.

Gubitak napajanja tijekom dodavanja

Potpuno potvrđeni zapisi ostaju; nepotpuni završni zapis odbacuje se pri otvaranju. Ishod posljednje nepotvrđene operacije može biti neizvjestan.

Pogreška integriteta u cijelom zapisu

CORRUPT; cijela baza podataka se ne briše automatski.

compact i ponovno otvaranje

Aktivni zapisi ostaju nepromijenjeni; dnevnik se smanjuje ako su postojale stare verzije.

Dosegnuta je kvota

QUOTA_EXCEEDED ili NO_SPACE bez neograničenog rasta podataka.

Vraćanje tvorničkih postavki

Korisničke datoteke i baze podataka se brišu.

Pristup zatvorenom objektu ili onom iz prethodnog pokretanja

CLOSED ili odbijanje zastarjelog zahtjeva.

12. Komunikacijski moduli

Komunikacijski moduli odvojeni su od izvršnog okruženja, modula za vaganje i upravljanja aplikacijom. Svaki ima vlastite zahtjeve, funkcije, događaje, pogreške i ograničenja. Aplikacije bez komunikacijskih modula mogu uobičajeno upotrebljavati izvršno okruženje, dijagnostiku, vremenske funkcije i vagu.

Tablica 46

Modul

Podrška u Neutron AppEngine 1.0.0

Poglavlje

TCP

Provedeno; features.tcp=true

RS-232 / RS-485

Provedeno; features.serial=true

MQTT

Provedeno; features.mqtt=true

HTTP / REST

Provedeno; features.http=true

WebSocket

Provedeno; features.websocket=true

Prijenos aplikacije putem MQTT, HTTP ili BLE je operacija upravljanja. Ne omogućuje taj protokol u korisničkom kodu. Pogledajte Instalacija i APP protokol za postupke upravljanja.

13. TCP komunikacija

configuredMode: 0 onemogućeno, 1 poslužitelj, 2 klijent, 3 oboje. Vrijednost primjera 1 je ilustrativna. maxLineBytes je maksimalno konfigurirano ograničenje; parser zadano postavlja bajtove 1024.

Modul TCP konfigurira postojeći poslužitelj i klijent, preuzima njihove tokove za vlastiti protokol, šalje podatke i prijavljuje događaje veze. Načini: disabled, server, client, both. U načinu both postoje jedan poslužitelj s jednim aktivnim sugovornikom i jedna izlazna klijentska veza. API ne otvara proizvoljan broj utičnica i ne podržava TLS ni DNS nazive; client.host mora biti IPv4. Sve funkcije i događaji u ovom poglavlju dostupni su od Neutron AppEngine 1.0.0.

Prije konfiguriranja mreže ili preuzimanja onemogućite sistemski protokol vaganja na I_TCP te mostove TCP–MQTT i TCP–RS-232/RS-485; inače RESOURCE_IN_USE. Konfiguriranje mreže i preuzimanje odvojeni su: configure sprema i primjenjuje postavke; claim preusmjerava podatke aplikaciji. Nakon uspješnog configure upotrijebite await tcp.claim().

13.1 tcp.configure()

Dostupno od: Neutron AppEngine 1.0.0
const status = await tcp.configure(options);
Namjena. Konfigurirajte TCP uloge, mrežne parametre i uokvirivanje retka teksta.
Opis. Izostavljena polja ostaju nepromijenjena. Mrežne postavke trajno se spremaju putem postojećih atributa modula i primjenjuju bez ponovnog pokretanja uređaja. Promijenjena uloga ponovno se inicijalizira, a druga zadržava vezu. Jednake vrijednosti ne prekidaju ispravne veze. Promjene exclusive utječu na nove veze bez prekidanja veze trenutačnog sugovornika. Promise potvrđuje primjenu postavki, a ne vezu s udaljenim sustavom. Bez mreže postavke ostaju spremljene, a uloga ostaje u waitingNetwork. Pratite state/status za pogreške veze. Lokalne postavke redaka primjenjuju se nakon uspjeha i odbacuju djelomične retke. Navođenje samo delimiter/maxLineBytes primjenjuje ih odmah radi kompatibilnosti, ali i dalje vraća Promise.

Parametri

Tablica 47

Parametar

Tip / obveznost

Opis

options

object / obvezno

Objekt s izbornim poljima; nepoznata polja su odbijena.

options.mode

string / neobvezno

disabled, server, client ili both. CTY: 0, 1, 2, 3. Disabled zaustavlja obje uloge i oslobađa vlasništvo.

options.server

object / neobvezno

Konfiguracija poslužitelja: port i exclusive.

options.server.port

integer / neobvezno

1–65535; postojeći atribut S0C. S0P konfigurira serijski priključak, a ne TCP.

options.server.exclusive

boolean / neobvezno

S0M: true=1, false=0. True odbija nove peere dok je trenutni peer povezan; false dopušta zamjenu novim ravnopravnim uređajem.

options.client

object / neobvezno

Konfiguracija izlazne veze: host i port.

options.client.host

string / neobvezno

IPv4 adresa udaljenog poslužitelja, na primjer 192.168.50.100. atribut SIP; nema vodećih nula u oktetima. 0.0.0.0 i 255.255.255.255 su zabranjeni.

options.client.port

integer / neobvezno

1–65535; SPO atribut.

options.delimiter

string / zadano CRLF

1–8 ASCII bajtova. Primjenjuje se samo na parser trenutne aplikacije; nije spremljeno u atribute.

options.maxLineBytes

integer / zadano 1024

1–4096 bajtovi sadržaja isključujući razdjelnik. Samo trenutna aplikacija.

Rezultat

Promise<object> sa snimkom tcp.status(). Postavke aktivne uloge moraju biti potpune i kada se mijenja samo dio objekta. Djelomična promjena dovoljna je uz postojeću valjanu konfiguraciju. SMD promjene putem BLE-a, MQTT-a, HTTP-a ili device.settings.write upotrebljavaju isti postupak primjene.

Pogreške i posebnosti

INVALID_ARGUMENT za nevažeći ili nepotpune aktivne postavke; JavaScript provjera valjanosti argumenta baca se sinkrono. Mrežni zahtjevi mogu biti odbijeni s RESOURCE_IN_USE, BUSY, WRITE_FAILED, CONFIGURE_FAILED ili OUT_OF_MEMORY. Neke postavke su možda već spremljene nakon neuspjelog pisanja; neuspješno pokretanje poslužitelja zadrži postavke i ponovno pokušaj pokretanje. Provjerite status i otklonite uzrok. CONFIG_CHANGED prekida pisanje na čekanju za promijenjenu ulogu. Prevelika linija podiže MESSAGE_TOO_LARGE prije povratnog poziva linije i zaustavlja aplikaciju; try/catch unutar tog povratnog poziva ne može ga uhvatiti.

Primjer

async function start() {
    await tcp.configure({
        mode: "server", server: { port: 5000, exclusive: true },
        delimiter: "\r\n", maxLineBytes: 512
    });
    await tcp.claim();
    console.info(JSON.stringify(tcp.status()));
}
start().catch(error => { console.error(error.code, error.message); app.stop(); });
// Alternative: outbound connection or both roles.
async function configureClient() {
    await tcp.configure({mode: "client", client: {host: "192.168.50.100", port: 5000}});
    await tcp.claim();
}
// For both roles use mode: "both" and supply server and client.
// The example does not call configureClient() to avoid automatic configuration changes.

13.2 tcp.claim()

Dostupno od: Neutron AppEngine 1.0.0
const result = await tcp.claim();
Namjena. Preuzmite postojeći TCP kanal za vlastiti protokol.
Opis. Zahtijeva prijenos postojećih TCP tokova korisničkoj aplikaciji. Registrirajte povratne pozive prije preuzimanja. Operacija ne jamči da je udaljeni sugovornik povezan.

Parametri

Nema parametara.

Rezultat

Promise<string>, "claimed" pri uspjehu. Podatkovni događaji i slanje dostupni su kada se veza uspostavi. Dijagnostički događaji connection/state dostupni su bez preuzimanja; registrirajte slušatelje prije configure/claim.

Pogreške i posebnosti

NOT_CONFIGURED za onemogućen/nevažeći način TCP, RESOURCE_IN_USE za sukobe protokola sustava ili mosta; također BUSY i OUT_OF_MEMORY.

Primjer

async function start() {
    tcp.configure({ delimiter: "\r\n", maxLineBytes: 512 });
    tcp.on("line", event => console.log(event.connectionId, event.line));
    await tcp.claim();
    console.info("TCP protocol ready; waiting for connection");
}
start().catch(error => { console.error(error.code, error.message); app.stop(); });

13.3 tcp.release()

Dostupno od: Neutron AppEngine 1.0.0
const result = await tcp.release();
Namjena. Vratite preuzeto TCP sučelje firmwareu.
Opis. Zatvara preuzete poslužiteljske/klijentske veze, oslobađa vlasništvo i odbacuje djelomične retke. JavaScript slušatelji i vremenski pozivi ostaju. Konfigurirana usluga ostaje dostupna; sistemski klijent može se ponovno povezati.

Parametri

Nema parametara.

Rezultat

Promise<string>, "released" na uspjehu. Aplikacija nastavlja raditi.

Pogreške i posebnosti

Zajedničke pogreške BUSY i OUT_OF_MEMORY. Otkažite vremenske pozive slanja i obradite pisanja na čekanju prije oslobađanja.

Primjer

async function releaseTcp() {
    try { console.info(await tcp.release()); }
    catch (error) { console.warn(error.code, error.message); }
}
releaseTcp();

13.4 tcp.write()

Dostupno od: Neutron AppEngine 1.0.0
const bytesWritten = await tcp.write(data, { connectionId });
Namjena. Pošaljite tekst ili binarne podatke putem preuzete veze.
Opis. Kodira nizove kao UTF-8 i šalje Uint8Array kao bajtove. Ne dodaje CRLF ili drugi razdjelnik. Slanje je asinkrono; predana pisanja na jednoj vezi zadržavaju redoslijed, ali asinkrona korisnička logika može promijeniti redoslijed predaje.

Parametri

Tablica 48

Parametar

Tip / obveznost

Opis

data

string ili Uint8Array / obavezno

Najviše 4096 bajtova po pozivu. Ograničenja nizova primjenjuju se nakon kodiranja UTF-8.

options

object / neobvezno, zadano {}

Mogućnosti slanja.

options.connectionId

integer / neobvezno

0 ili izostavljeno: odaberite jedinu povezanu ulogu TCP. S više povezanih uloga, koristite ID iz događaja; raspon 0–4 294 967 295.

Rezultat

Promise<number> s bajtovima prihvaćenim za Prijenos TCP. Ne potvrđuje daljinski prijem ili obradu. Definirajte potvrde u svom protokolu ako je potrebno.

Pogreške i posebnosti

Odbija s INVALID_ARGUMENT, MESSAGE_TOO_LARGE, NOT_OWNER, NOT_CONNECTED, CONFIG_CHANGED, BUSY, OUT_OF_MEMORY ili TIMEOUT. Ograničenje čekanja za pisanje je približno 3 s. Neki su podaci možda već bili poslani nakon pogreške; nemojte slijepo ponavljati neidempotentne naredbe. Aktivna pogreška pri pisanju/prekid vremena može zatvoriti vezu. Neispravna upotreba argumenta JavaScript također može dati TypeError.

Primjer

tcp.on("line", async event => {
    try {
        const n = await tcp.write("OK\r\n", { connectionId: event.connectionId });
        console.debug("Bytes sent:", n);
    } catch (error) {
        console.warn("Sending:", error.code, error.message);
    }
});

13.5 tcp.on()

Dostupno od: Neutron AppEngine 1.0.0
tcp.on(eventName, callback);
Namjena. Registrirajte slušatelja događaja TCP.
Opis. Poziva povratnu funkciju za odgovarajuće događaje do off ili završetka aplikacije. Ista funkcija može se registrirati više puta; svaka registracija ulazi u ograničenje.

Parametri

Tablica 49

Parametar

Tip / obveznost

Opis

eventName

string / obvezno

Samo "data", "line", "connection" ili "state".

callback

function / obvezno

Funkcija koja prima jedan objekt događaja. Zadržite istu referencu za off.

Rezultat

Objekt tcp, koji omogućuje ulančavanje registracija.

Pogreške i posebnosti

Sinkroni INVALID_ARGUMENT za nepoznati događaj ili vrijednost koja nije funkcija. Najviše 32 slušatelja on/once zajedno; prekoračenje uzrokuje QUOTA_EXCEEDED. Neobrađena iznimka povratnog poziva ili odbijanje Promise zaustavlja aplikaciju. off nema učinka za nepostojeću registraciju.

Primjer

function receive(event) { console.log(event.line); }
tcp.on("line", receive);

13.6 tcp.once()

Dostupno od: Neutron AppEngine 1.0.0
tcp.once(eventName, callback);
Namjena. Registrirajte jednokratnog slušatelja.
Opis. Uklanja slušatelja prije nego što ga pozove za prvi odgovarajući događaj. Ostaje registriran ako nijedan događaj ne stigne.

Parametri

Tablica 50

Parametar

Tip / obveznost

Opis

eventName

string / obvezno

Samo "data", "line", "connection" ili "state".

callback

function / obvezno

Funkcija koja prima jedan objekt događaja. Zadržite istu referencu za off.

Rezultat

Objekt tcp, koji omogućuje ulančavanje registracija.

Pogreške i posebnosti

Sinkroni INVALID_ARGUMENT za nepoznati događaj ili vrijednost koja nije funkcija. Najviše 32 slušatelja on/once zajedno; prekoračenje uzrokuje QUOTA_EXCEEDED. Neobrađena iznimka povratnog poziva ili odbijanje Promise zaustavlja aplikaciju. off nema učinka za nepostojeću registraciju.

Primjer

tcp.once("connection", event => {
    console.info("Prva sprememba povezave", event.connectionId, event.connected);
});

13.7 tcp.off()

Dostupno od: Neutron AppEngine 1.0.0
tcp.off(eventName, callback);
Namjena. Ukloni slušatelja.
Opis. Uklanja sve registracije iste reference povratnog poziva za odabrani događaj. Ne prekida već započet povratni poziv async. Ne prosljeđujte novu anonimnu funkciju za uklanjanje postojećeg slušatelja.

Parametri

Tablica 51

Parametar

Tip / obveznost

Opis

eventName

string / obvezno

Samo "data", "line", "connection" ili "state".

callback

function / obvezno

Funkcija koja prima jedan objekt događaja. Zadržite istu referencu za off.

Rezultat

Objekt tcp, koji omogućuje ulančavanje registracija.

Pogreške i posebnosti

Sinkroni INVALID_ARGUMENT za nepoznati događaj ili vrijednost koja nije funkcija. Najviše 32 slušatelja on/once zajedno; prekoračenje uzrokuje QUOTA_EXCEEDED. Neobrađena iznimka povratnog poziva ili odbijanje Promise zaustavlja aplikaciju. off nema učinka za nepostojeću registraciju.

Primjer

function receive(event) { console.log(event.line); }
tcp.on("line", receive);
tcp.off("line", receive);

13.8 TCP struktura događaja

Tablica 52

Događaj

Polja

Značenje

data

{ connectionId, data: Uint8Array }

Sirovi dio streama TCP. Jedan događaj nije nužno jedna naredba ili mrežni paket.

line

{ connectionId, line: string }

Cijeli redak dekodiran iz UTF-8 bez razdjelnika. Prazni retci dopušteni su; okolni razmaci ne uklanjaju se automatski.

connection

{ connectionId, connected: boolean, role: "server" | "client", remoteAddress, remotePort, reason, timeMs }

Veza uspostavljena ili izgubljena dok aplikacija radi, neovisno za svaku ulogu. connectionId identificira sesiju; upotrijebite novi ID nakon ponovnog povezivanja.

connection.reason: CONNECTED pri uspjehu, CONFIG_CHANGED nakon promjene adrese/porta/uloge, REPLACED kada se zamijeni ravnopravni poslužitelj, NETWORK_DOWN za gubitak mrežne usluge, CONNECTION_LOST za otkriveni gubitak veze, DISCONNECTED za normalno zatvaranje, APP_STOPPED za otpuštanje nakon završetka aplikacije, RESOURCE_IN_USE za sukobe. Događaji nakon završetka aplikacije se ne isporučuju. timeMs je monotono vrijeme uređaja u milisekundama, a ne datum ili trajanje veze. Udaljeni priključak ravnopravnog poslužitelja obično je prolazan, a ne priključak poslužitelja koji sluša.

state sadrži role, state, connected, connectionId, port, revision, error i timeMs te svojstva uloge iz tcp.status(). Stanja poslužitelja: disabled, waitingNetwork, listening, error. Stanja klijenta: disabled, waitingNetwork, connecting, reconnecting, connected, error. Oslobađanje zbog sukoba može poslati {role:"all",state:"released",reason:"RESOURCE_IN_USE"}. Pokušaji povezivanja klijenta ne blokiraju aplikaciju ili mjerenja; svaki traje približno do 3 s, a sljedeći počinje približno 5 s nakon neuspjeha ili otkrivenog prekida. Neuspjelo pokretanje poslužitelja ponavlja se približno svakih 5 s. Otkrivanje fizičkog prekida nije trenutačno; ovisi o prometu i nadzoru veze.

tcp.on("state", event => console.info("TCP state", JSON.stringify(event)));
tcp.on("connection", event => {
    console.info(event.role, event.connected, event.connectionId,
        event.remoteAddress, event.remotePort, event.reason, event.timeMs);
});
Registracija ne ponavlja povijest događaja. Preuzimanje vas može obavijestiti o već uspostavljenoj vezi. Uvijek odgovarajte pomoću event.connectionId; nikada ga trajno ne spremajte i ne izmišljajte ID-jeve.
TCP je tok. WEIGHT?\r\n može stići u nekoliko dijelova, i nekoliko naredbi u jednom dijelu. Parser zadržava djelomične redove po vezi, spajajući djelomične znakove UTF-8 prije dekodiranja događaja redaka. Razdjelnici i nepotpuni redovi odbacuju se nakon prekida veze.

Uz slušatelja line retci se prvo pripremaju iz dijela toka, zatim se šalje data, a potom pojedinačni povratni pozivi line. Registriranje oba daje dva pogleda na iste podatke; nemojte dvaput obrađivati naredbe. Bez slušatelja line binarni podaci ne nakupljaju se u međuspremniku redaka. Binarni protokoli moraju imati vlastita ograničenja duljine i sastavljanje poruka.

tcp.on("data", async event => {
    // Binary echo example; adds no terminators.
    try { await tcp.write(event.data, { connectionId: event.connectionId }); }
    catch (error) { console.warn(error.code, error.message); }
});

13.9 TCP greške modula

Tablica 53

Kod

Značenje za TCP

NOT_CONFIGURED

TCP nije konfiguriran za rad klijent/poslužitelj.

RESOURCE_IN_USE

Sistemski TCP protokol vaganja ili most u sukobu je s preuzimanjem.

NOT_OWNER

Aplikacija ne posjeduje TCP ili je došlo do sukoba usmjeravanja.

NOT_CONNECTED

Tražena TCP sesija više nije povezana.

MESSAGE_TOO_LARGE

Pisanje premašuje 4096 bajtova ili je primljena linija preduga. Interna pogreška linije zaustavlja aplikaciju.

13.10 Ograničenja TCP modula

Tablica 54

Resurs

Ograničenje

TCP poruka

Najviše 4096 bajtova po pisanju; primljeni tokovi mogu se podijeliti u manje dijelove.

Linije

Zadano 1024; konfigurabilni bajtovi 1–4096 isključujući graničnik; ASCII duljina razdjelnika 1–8 bajtova.

Slušatelji

Najviše 32 registracije on/once zajedno za data, line, connection i state.

13.11 Prilagođeni TCP protokol s CONT / CCONT

Samostalni primjer za konfigurirani TCP poslužitelj ili klijent bez konfliktnog usmjeravanja sustava. Svaki redak završava stvarnim CR LF bajtovima. Vanjski alati moraju poslati te bajtove, a ne četiri doslovna obrnuta kosa crta-r-obrnuta kosa crta-n znaka. U izvoru JavaScript, "\r\n" predstavlja ispravne bajtove terminatora.

Tablica 55

Primljena naredba + CRLF

Odgovor + CRLF

WEIGHT?

net,gross,unit ili ERR,NO_MEASUREMENT

CONT

OK; zatim jedno mjerenje u sekundi za istu vezu. Ponavljanje ne stvara dodatni interval.

CCONT

OK; poništava buduća periodična slanja na ovoj vezi. Već započeto pisanje može se dovršiti.

TARE / ZERO / CLEAR_TARE

OK nakon potvrđene operacije ili ERR,&lt;code&gt;.

PRESET_TARE 2.5

Postavlja taru u trenutno konfiguriranoj jedinici; vraća OK ili ERR,&lt;code&gt;.

Druga naredba

ERR,UNKNOWN_COMMAND

// Disable system TCP protocol and RS-232/RS-485/MQTT bridges.
// On startup this example configures and saves a TCP server on port 5000.
// CONT starts sending each second; CCONT stops it for the same connection.
const streams = new Map();

function weightReply() {
    const m = scale.read();
    return m.available ? m.net + "," + m.gross + "," + m.unit : "ERR,NO_MEASUREMENT";
}

function stopStream(connectionId) {
    const stream = streams.get(connectionId);
    if (!stream) return;
    clearInterval(stream.intervalId);
    streams.delete(connectionId);
}

function startStream(connectionId) {
    if (streams.has(connectionId)) return;
    const stream = { intervalId: 0, sending: false };
    stream.intervalId = setInterval(async () => {
        if (stream.sending) return;
        stream.sending = true;
        try {
            await tcp.write(weightReply() + "\r\n", { connectionId });
        } catch (error) {
            stopStream(connectionId);
            console.warn("Continuous send stopped:", error.code, error.message);
        } finally {
            stream.sending = false;
        }
    }, 1000);
    streams.set(connectionId, stream);
}

tcp.configure({ delimiter: "\r\n", maxLineBytes: 512 });

tcp.on("connection", event => {
    if (!event.connected) stopStream(event.connectionId);
    console.info("TCP", event.connectionId, event.connected ? "connected" : "disconnected");
});

tcp.on("line", async event => {
    let reply;
    try {
        switch (event.line.trim()) {
        case "WEIGHT?": {
            reply = weightReply();
            break;
        }
        case "TARE":
            await scale.tare(); reply = "OK"; break;
        case "ZERO":
            await scale.zero(); reply = "OK"; break;
        case "CLEAR_TARE":
            await scale.clearTare(); reply = "OK"; break;
        case "CONT":
            startStream(event.connectionId);
            reply = "OK";
            break;
        case "CCONT":
            stopStream(event.connectionId);
            reply = "OK";
            break;
        default:
            if (event.line.startsWith("PRESET_TARE ")) {
                await scale.setPresetTare(Number(event.line.substring(12)));
                reply = "OK";
            } else {
                reply = await scale.cmd(event.line.trim());
            }
        }
    } catch (error) {
        reply = "ERR," + (error.code || "FAILED");
    }
    try {
        await tcp.write(reply + "\r\n", { connectionId: event.connectionId });
    } catch (error) {
        console.warn("Reply failed:", error.code, error.message);
    }
});

async function start() {
    await tcp.configure({mode: "server", server: {port: 5000, exclusive: true}});
    await tcp.claim();
    console.info("Custom TCP scale protocol ready");


}

start().catch(error => {
    console.error(error.code || error.name, error.message);
    app.stop();
});

Slušatelj veze uklanja interval pri odspajanju; povremeni neuspjeh pisanja također ga zaustavlja. Oznaka za slanje sprječava preklapanje periodičnih pisanja po vezi. Primjer ne implementira trajni zapisnik, potvrdu daljinske obrade ili ID-ove zahtjeva. Dodajte ograničene ID-ove, odgovore i pravila za ponovni pokušaj kada je to potrebno.

13.12 TCP isključivanje i istovremenost

app.stop() zatvara preuzete TCP veze i oslobađa vlasništvo. Konfigurirani poslužitelj ostaje dostupan, a klijent se može ponovno povezati prema sistemskoj logici. Upotrijebite tcp.release() za vraćanje TCP-a bez zaustavljanja aplikacije. Više primljenih naredbi može uzrokovati preklapanje asinkrone obrade; za strogi redoslijed neka klijent čeka odgovor ili uvedite ograničen red čekanja. clearInterval ne otkazuje već započeto pisanje.

13.13 Testiranje aplikacije TCP

Tablica 56

Test

Očekivani rezultat

Naredba TCP podijeljena na prijeme

Povratni poziv line pokreće se tek nakon cijelog razdjelnika.

CONT dvaput, zatim CCONT dvaput

Jedan interval po vezi; ponovno otkazivanje je bezopasno.

Isključite/ponovno spojite

Stari intervali i ID-ovi se ne koriste ponovno; nova sjednica je neovisna.

Sporo/neuspjelo pisanje TCP

Nema preklapanja povremenog rada ili neograničenog reda čekanja.

13.14 tcp.status()

Dostupno od: Neutron AppEngine 1.0.0
const status = tcp.status();
Namjena. Pročitajte trenutnu konfiguraciju i stanje obje uloge TCP.
Opis. Sinkrona snimka iz posljednjeg servisnog ciklusa. Ne otvara veze, ne preuzima sučelje i ne čita podatke toka. pending znači da spremljene postavke čekaju primjenu u sljedećem servisnom ciklusu. Stanje veze nastavlja se mijenjati nakon configure; upotrijebite događaje connection/state za nastavak nakon povezivanja.

Parametri

Nema parametara.

Rezultat

Objekt: mode (disabled/server/client/both), configuredMode (0/1/2/3), claimed, pending, server i client. Obje uloge sadrže state, connected, connectionId (0 ako nema veze), port, revision i error. server dodatno sadrži listening, exclusive, remoteAddress i remotePort; client sadrži host, remoteAddress i remotePort. Prazan error znači da nema zabilježene pogreške. revision se mijenja pri promjeni krajnje točke/uloge; nije brojač primljenih podataka. Ova informativna snimka može se promijeniti odmah nakon čitanja.

Pogreške i posebnosti

Nema mrežnog zahtjeva. Povezana snimka ne jamči da će kasnije pisanje uspjeti; uvijek rješavati odbijanje pisanja.

Primjer

const status = tcp.status();
console.info(status.mode, status.claimed, status.server.state, status.client.state);
console.info(JSON.stringify(status));

Konfiguracija i osnovni WEIGHT? primjer protokola za obje uloge: odaberite željeni način rada u konfiguraciji i podesite adresu/port. Odgovori koriste primljeni događaj connectionId, tako da rade s objema povezanim ulogama.

// Neutron AppEngine 1.0.0. Disable system TCP protocol and TCP/MQTT/serial bridges.
// Settings persist. Adjust the object below for client/both.
const configuration = {
    mode: "server",
    server: { port: 5000, exclusive: true },
    // mode: "client", client: { host: "192.168.50.100", port: 5000 },
    delimiter: "\r\n",
    maxLineBytes: 512
};

tcp.on("state", event => console.info("TCP state", JSON.stringify(event)));
tcp.on("connection", event => {
    console.info("TCP", event.role, event.connected ? "connected" : "disconnected",
        event.remoteAddress, event.remotePort, event.connectionId, event.reason);
});
tcp.on("line", async event => {
    try {
        const m = scale.read();
        const reply = event.line.trim() === "WEIGHT?"
            ? (m.available ? m.net + "," + m.gross + "," + m.unit : "ERR,NO_MEASUREMENT")
            : "ERR,UNKNOWN_COMMAND";
        await tcp.write(reply + "\r\n", { connectionId: event.connectionId });
    } catch (error) {
        console.warn("TCP reply", error.code, error.message);
    }
});

async function start() {
    console.info("TCP configured", JSON.stringify(await tcp.configure(configuration)));
    await tcp.claim();
    console.info("TCP ready", JSON.stringify(tcp.status()));
}
start().catch(error => {
    console.error(error.code, error.message);
    app.stop();
});

14. RS-232 / RS-485

Priključak je dostupan aplikaciji samo kada je njegova sistemska funkcija Disabled: S0E=0 za RS-232 ili S1E=0 za RS-485. Ne smije biti dodijeljen sistemskom protokolu vaganja, Modbusu, izlazu za otklanjanje pogrešaka ili prosljeđivanju. claim() ne onemogućuje ove funkcije automatski.

Serijski modul pruža dva neovisna objekta: serial.rs232 i serial.rs485 s istim API-jem. Aplikacija može preuzeti jedan ili oba priključka. Drugi komunikacijski modul nije potreban. Sve funkcije i događaji u ovom poglavlju dostupni su od Neutron AppEngine 1.0.0.

const port = serial.rs232; // or serial.rs485

14.1 port.claim()

Dostupno od: Neutron AppEngine 1.0.0
const result = await port.claim();
Namjena. Isključivo preuzmite odabrani serijski priključak.
Opis. Provjerava je li priključak Disabled i slobodan, a zatim ga priprema s pohranjenim fizičkim postavkama. Čeka uspješnu inicijalizaciju. Ponovljeno uspješno preuzimanje dopušteno je bez ponovne inicijalizacije nepromijenjenih postavki.

Parametri

Nema parametara.

Rezultat

Promise<string>, "claimed" pri uspjehu. Po potrebi registrirajte slušatelje prije preuzimanja. Prisutnost udaljenog uređaja ne provjerava se.

Pogreške i posebnosti

RESOURCE_IN_USE za omogućenu sistemsku funkciju ili drugi sukob; BUSY za istodobne upravljačke operacije; RECONFIGURE_FAILED, TIMEOUT ili OUT_OF_MEMORY. Neispravno konfiguriran priključak ne preuzima se tiho.

Primjer

async function start() {
    await serial.rs232.claim();
    console.info("RS-232 prevzet");
}
start().catch(error => console.error(error.code, error.message));

14.2 port.configure()

Dostupno od: Neutron AppEngine 1.0.0
const result = await port.configure(options);
Namjena. Konfigurirajte brzinu prijenosa podataka, format znakova i lokalno analiziranje poruka.
Opis. Asinkrono, dopušteno nakon claim(). Preslikava fizičke parametre na postojeće SMD postavke, provjerava ih i trajno sprema. Ponovno inicijalizira priključak jednom za cijeli zahtjev; Promise se razrješava nakon primjene. Izostavljene postavke ostaju nepromijenjene. Ponovna primjena jednakih uspješno primijenjenih vrijednosti izbjegava nepotrebnu ponovnu inicijalizaciju.

Parametri

Tablica 57

Parametar

Tip / obveznost

Opis

options

object / obvezno

Objekt s neobaveznim poljima u nastavku. Nepoznata polja su odbijena.

baudRate

integer / neobvezno

300–1 000 000 bit/s. Preslikava se na S0B ili S1B.

dataBits

integer / neobvezno

7 ili 8. Preslikavanje S0I/S1I: 0 znači 7 bitova, 1 znači 8 bitova.

stopBits

integer / neobvezno

1 ili 2. Preslikava na S0S/S1S.

parity

string / neobvezno

"none", "even" ili "odd". S0P/S1P mapiranje: 0, 1 ili 2.

delimiter

string / izborno, zadano CRLF

1–8 ASCII znakova, samo za sastavljanje događaja line u trenutačnoj aplikaciji.

maxLineBytes

integer / izborno, zadano 1024

1–4096 bajtovi sadržaja retka isključujući razdjelnik. Samo trenutna aplikacija.

Rezultat

Promise<string>, "configured" pri uspjehu. Fizičke postavke ostaju nakon release(), Stop i ponovnog pokretanja. Delimiter i maxLineBytes ne spremaju se u SMD; vrijede za trenutačni JavaScript parser.

Pogreške i posebnosti

INVALID_ARGUMENT, NOT_OWNER, RESOURCE_IN_USE, BUSY, SETTINGS_FAILED, RECONFIGURE_FAILED, CONFIG_CHANGED, TIMEOUT ili OUT_OF_MEMORY. Neuspjelo spremanje može ostaviti neke fizičke postavke spremljenima; pogreška primjene ne znači da postavke nisu spremljene. Ispravite uzrok i ponovite konfiguriranje/preuzimanje. Konfiguracija lokalnog parsera mijenja se tek nakon uspjeha. Ako drugi kanal promijeni tražene fizičke postavke prije potvrde, poziv se odbija s CONFIG_CHANGED.

Primjer

async function configurePort() {
    const port = serial.rs485;
    await port.claim();
    await port.configure({
        baudRate: 19200, dataBits: 8, parity: "even", stopBits: 1,
        delimiter: "\r\n", maxLineBytes: 512
    });
    console.info("Nastavitve uveljavljene");
}
configurePort().catch(error => console.warn(error.code, error.message));

14.3 Postavke se mijenjaju bez ponovnog pokretanja

Isti postupak primjene obrađuje SMD zahtjeve iz svih upravljačkih kanala. Promjena brzine prijenosa, podatkovnih bitova, stop bitova, pariteta ili funkcije priključka ne zahtijeva ponovno pokretanje Neutrona. Osvježavaju se i sistemski završni znakovi, postavke dodavanja završnih znakova, adresa RS-485 i povezane dodjele priključaka. Drugi priključak ponovno se inicijalizira samo ako promjene utječu na njega.

Tijekom prijelaza nova pisanja privremeno se odbijaju ili zadržavaju. Prethodno predani bajtovi šalju se u ograničenom roku; nepotpuni prijemni okviri odbacuju se. Stari zahtjevi vaganja, kontinuirani sistemski izlaz i sesije pogođenog priključka završavaju. Promjene brzine ili formata prijenosa mogu uzrokovati gubitak podataka, pa ih izvedite tijekom dogovorenog prekida komunikacije. Neuspjeli završetak prijenosa ili otvaranje nove konfiguracije prijavljuje RECONFIGURE_FAILED.

Ako vanjski SMD dodijeli drugu sistemsku funkciju ili izazove sukob dok JavaScript ima vlasništvo, preuzimanje se opoziva. Aplikacija prima state s reason="RESOURCE_IN_USE" i claimed=false; nova pisanja vraćaju NOT_OWNER. Dopuštene promjene fizičkih postavki zadržavaju vlasništvo i šalju RECONFIGURED. Djelomični JavaScript retci odbacuju se; konfigurirani JavaScript razdjelnik ostaje.

Tablica 58

Provjera putem RMD

Značenje

S0APPLY / S1APPLY

PENDING: čeka primjenu; OK: konfiguracija primijenjena; ERROR: primjena nije uspjela.

S0JS / S1JS

1 znači da je aplikacija preuzela priključak; 0 znači da nema JavaScript preuzimanja.

S0REV / S1REV

Brojač primijenjenih promjena stanja priključka; nije trajni ID sesije.

S0STATE / S1STATE

Najnovije stanje: READY, DISABLED, CLAIMED, RECONFIGURED, RELEASED, RESOURCE_IN_USE ili RECONFIGURE_FAILED.

Uobičajeni SMD odgovor potvrđuje spremanje; fizička primjena slijedi u sljedećem ciklusu obrade uređaja. Za vanjsku potvrdu upotrijebite RMD APPLY polja ili dnevnike otklanjanja pogrešaka. port.configure() već čeka primjenu. Ova su RMD polja dijagnostička, nisu zapisive SMD postavke. Ponavljanje jednakog SMD-a nakon neuspjeha ponavlja pokušaj primjene; nakon uspjeha jednake vrijednosti ne otvaraju priključak ponovno.

14.4 port.write()

Dostupno od: Neutron AppEngine 1.0.0
const bytes = await port.write(data, { timeoutMs });
Namjena. Asinkrono slanje teksta ili binarnih bajtova.
Opis. Kodira nizove kao UTF-8; šalje Uint8Array nepromijenjen. Ne dodaje završni znak, adresu RS-485 ili kontrolni zbroj. Pisanja na jednom priključku slijede redoslijed zahtjeva; njihovi objekti Promise ne potvrđuju udaljenu obradu.

Parametri

Tablica 59

Parametar

Tip / obveznost

Opis

data

string ili Uint8Array / obavezno

Najviše 4096 bajtova nakon UTF-8 kodiranja; prazno pisanje je dopušteno.

options

object / neobvezno, zadano {}

Opcije čekanja.

options.timeoutMs

integer / neobvezno

1–180000 ms. Zadana vrijednost se izračunava iz duljine i brzine prijenosa podataka s marginom i minimumom 3 s.

Rezultat

Promise<number> s brojem bajtova prihvaćenih za prijenos. Upotrijebite drain() za čekanje na dovršetak fizičkog prijenosa.

Pogreške i posebnosti

INVALID_ARGUMENT, MESSAGE_TOO_LARGE, NOT_OWNER, BUSY, PORT_UNAVAILABLE, CONFIG_CHANGED, TIMEOUT ili OUT_OF_MEMORY. Neki bajtovi možda su već poslani nakon prekida ili isteka vremena. CONFIG_CHANGED znači da je konfiguracija promijenjena tijekom čekanja; preostali bajtovi starih zahtjeva ne šalju se pod novim postavkama.

Primjer

async function send() {
    await serial.rs232.write("WEIGHT?\r\n");
    await serial.rs232.write(new Uint8Array([0, 1, 255]));
}
send().catch(error => console.warn(error.code, error.message));

14.5 port.drain()

Dostupno od: Neutron AppEngine 1.0.0
await port.drain({ timeoutMs });
Namjena. Pričekajte dovršetak fizičkog prijenosa.
Opis. Čeka iza prethodnih pisanja na istom priključku, a zatim provjerava jesu li poslani bajtovi na čekanju. Izvršno okruženje obrađuje druge događaje tijekom čekanja.

Parametri

Tablica 60

Parametar

Tip / obveznost

Opis

options

object / neobvezno, zadano {}

Opcije čekanja.

options.timeoutMs

integer / izborno, zadano 6000

1–60000 ms.

Rezultat

Promise<undefined>. Ne čeka udaljeni odgovor i ne potvrđuje da je sabirnica RS-485 koju upotrebljavaju drugi uređaji slobodna.

Pogreške i posebnosti

INVALID_ARGUMENT, NOT_OWNER, BUSY, PORT_UNAVAILABLE, CONFIG_CHANGED, TIMEOUT ili OUT_OF_MEMORY. Postavite prikladan komunikacijski rok; istek ne poništava prenesene bajtove.

Primjer

async function sendAndWait() {
    await serial.rs485.write("READ\r\n");
    await serial.rs485.drain({ timeoutMs: 5000 });
}
sendAndWait().catch(error => console.warn(error.code, error.message));

14.6 port.release()

Dostupno od: Neutron AppEngine 1.0.0
const result = await port.release();
Namjena. Oslobodite aplikacijsko preuzimanje odabranog priključka.
Opis. Zaustavlja nova aplikacijska pisanja, dovršava prijelaz i oslobađa vlasništvo. Priključak koji je i dalje sistemski Disabled i nema drugu namjenu zatvara se. Trajno pohranjene fizičke postavke ostaju. Ne onemogućuje sistemsku funkciju koja je u međuvremenu preuzela priključak.

Parametri

Nema parametara.

Rezultat

Promise<string>, "released" pri uspjehu. Ponavljanje je dopušteno. Djelomični lokalni prijem odbacuje se; registrirani povratni pozivi i vremenski pozivi ostaju.

Pogreške i posebnosti

BUSY, RECONFIGURE_FAILED, TIMEOUT ili OUT_OF_MEMORY. Otkažite vremenske pozive slanja prije oslobađanja. Već preneseni bajtovi ne mogu se povući. Stop aplikacije automatski oslobađa oba njezina priključka.

Primjer

async function releasePort() {
    console.info(await serial.rs232.release());
}
releasePort().catch(error => console.warn(error.code, error.message));

14.7 port.on()

Dostupno od: Neutron AppEngine 1.0.0
port.on(eventName, callback);
Namjena. Registrirajte slušatelja serijskih događaja.
Opis. Događaji pripadaju odabranom priključku. once uklanja registraciju prije pozivanja povratne funkcije. off zahtijeva istu referencu funkcije i ne prekida već započeti asinkroni povratni poziv.

Parametri

Tablica 61

Parametar

Tip / obveznost

Opis

eventName

string / obvezno

"data", "line" ili "state".

callback

function / obvezno

Funkcija koja prima jedan objekt događaja.

Rezultat

Odabrani objekt porta; registracija slušatelja može biti lančana.

Pogreške i posebnosti

INVALID_ARGUMENT za nevaljani događaj ili povratni poziv; QUOTA_EXCEEDED iznad 32 slušatelja po priključku. Neobrađene iznimke ili odbijanja povratnih poziva zaustavljaju aplikaciju. off nema učinka za nepostojeću registraciju.

Primjer

function receive(event) { console.info(event.line); }
serial.rs232.on("line", receive);

14.8 port.once()

Dostupno od: Neutron AppEngine 1.0.0
port.once(eventName, callback);
Namjena. Slušajte samo prvi odgovarajući događaj.
Opis. Događaji pripadaju odabranom priključku. once uklanja registraciju prije pozivanja povratne funkcije. off zahtijeva istu referencu funkcije i ne prekida već započeti asinkroni povratni poziv.

Parametri

Tablica 62

Parametar

Tip / obveznost

Opis

eventName

string / obvezno

"data", "line" ili "state".

callback

function / obvezno

Funkcija koja prima jedan objekt događaja.

Rezultat

Odabrani objekt porta; registracija slušatelja može biti lančana.

Pogreške i posebnosti

INVALID_ARGUMENT za nevaljani događaj ili povratni poziv; QUOTA_EXCEEDED iznad 32 slušatelja po priključku. Neobrađene iznimke ili odbijanja povratnih poziva zaustavljaju aplikaciju. off nema učinka za nepostojeću registraciju.

Primjer

function receive(event) { console.info(event.line); }
serial.rs232.once("line", receive);

14.9 port.off()

Dostupno od: Neutron AppEngine 1.0.0
port.off(eventName, callback);
Namjena. Ukloni slušatelja.
Opis. Događaji pripadaju odabranom priključku. once uklanja registraciju prije pozivanja povratne funkcije. off zahtijeva istu referencu funkcije i ne prekida već započeti asinkroni povratni poziv.

Parametri

Tablica 63

Parametar

Tip / obveznost

Opis

eventName

string / obvezno

"data", "line" ili "state".

callback

function / obvezno

Funkcija koja prima jedan objekt događaja.

Rezultat

Odabrani objekt porta; registracija slušatelja može biti lančana.

Pogreške i posebnosti

INVALID_ARGUMENT za nevaljani događaj ili povratni poziv; QUOTA_EXCEEDED iznad 32 slušatelja po priključku. Neobrađene iznimke ili odbijanja povratnih poziva zaustavljaju aplikaciju. off nema učinka za nepostojeću registraciju.

Primjer

function receive(event) { console.info(event.line); }
serial.rs232.off("line", receive);

14.10 Događaji i uokvirivanje poruka

Tablica 64

Događaj

Objekt

Opis

data

{ data: Uint8Array }

Sirovi dio toka; jedan događaj nije nužno jedan paket protokola. NUL i drugi binarni bajtovi ostaju sačuvani.

line

{ line: string }

Sastavljena linija UTF-8 bez graničnika; podijeljeni dijelovi poruka ponovno se sastavljaju. Praznina se ne obrezuje automatski.

state

{ port, claimed, reason, generation }

port je rs232 ili rs485. claimed je boolean; reason označava prijelaz; generation se mijenja pri primjeni stanja priključka.

Uz slušatelja line prijem se sastavlja do razdjelnika. Slušatelj data na istom priključku prima drugi pogled na isti tok; nemojte dvaput obrađivati naredbu. Predugi retci uzrokuju MESSAGE_TOO_LARGE prije povratnog poziva line i mogu zaustaviti aplikaciju. Bez slušatelja line sirovi binarni podaci ne nakupljaju se u međuspremniku redaka. Događaji prije ponovne inicijalizacije ne upotrebljavaju se kao podaci s novom konfiguracijom.

Serijski priključci nemaju događaj connection: odspojeni kabeli ili isključeni uređaji obično se ne mogu pouzdano otkriti. state opisuje vlasništvo i postavke Neutron AppEnginea, a ne fizičku povezanost. Provjerite dostupnost odgovorima i vremenskim ograničenjima svog protokola. Aplikacije RS-485 provode adresiranje, CRC i pravila pristupa zajedničkoj sabirnici; sistemski filtar R4A ne primjenjuje se na sirove podatke dok JavaScript ima vlasništvo.

14.11 Potpuna aplikacija RS-232 / RS-485

Postavite funkciju odabranog priključka na Disabled i uklonite druge dodjele. Aplikacija u nastavku preuzima ga, trajno konfigurira 19200/8N1 i na WEIGHT? odgovara s net,gross,unit. Za drugi priključak promijenite samo odabrani objekt. Konfigurirajte isti format znakova na udaljenom uređaju.

// Neutron AppEngine 1.0.0. Port must be Disabled, with no system protocol,
// Modbus, debug output or BLE forwarding.
async function start() {
    if (!app.capabilities().features.serial) throw new Error("Serial API is unsupported");
    const port = serial.rs232; // For RS-485 use serial.rs485.

    port.on("state", event => {
        console.info(event.port, event.reason, "claimed:", event.claimed);
        if (event.reason === "RESOURCE_IN_USE" || event.reason === "RECONFIGURE_FAILED") {
            app.stop();
        }
    });

    port.on("line", async event => {
        try {
            if (event.line.trim() === "WEIGHT?") {
                const m = scale.read();
                const reply = m.available ? m.net + "," + m.gross + "," + m.unit : "ERR,NO_MEASUREMENT";
                await port.write(reply + "\r\n");
            } else {
                await port.write("ERR,UNKNOWN_COMMAND\r\n");
            }
        } catch (error) {
            console.warn(error.code || error.name, error.message);
        }
    });

    await port.claim();
    // Physical settings persist through the same path as SMD.
    await port.configure({
        baudRate: 19200, dataBits: 8, parity: "none", stopBits: 1,
        delimiter: "\r\n", maxLineBytes: 512
    });
    console.info("Serial protocol ready");
}
start().catch(error => {
    console.error(error.code || error.name, error.message);
    app.stop();
});

14.12 Testiranje integracije

Tablica 65

Test

Očekivani rezultat

Preuzimanje s omogućenom sistemskom funkcijom

RESOURCE_IN_USE; korištenje sustava ostaje nepromijenjeno.

Konfigurirajte putem JavaScript i zasebno putem SMD

Brzina prijenosa/paritet/bitovi primjenjuju se bez ponovnog pokretanja uređaja.

Promijenite jedan port

Drugi priključak zadržava podatke i rad ako nije pogođen.

Vanjsko preuzimanje tijekom rada JavaScript

state RESOURCE_IN_USE, claimed=false; nova pisanja vraćaju NOT_OWNER.

Binarni bajtovi i linija podijeljena preko primanja

Bez gubitka NUL ili dvostrukih graničnika; jedna ispravno sastavljena linija.

Ponovno konfigurirajte tijekom djelomičnog prijema ili pisanja

Stare djelomične linije se odbacuju; preostala stara pisanja ne šalju se pod novim postavkama.

Release / Stop i ponovno preuzimanje

Nema trajno zauzetog priključka; fizičke postavke ostaju.

15. MQTT modul

Ovaj modul ne izvršava automatski CSCP naredbe. Aplikacija definira značenja tema, format sadržaja i dopuštene naredbe. mqtt.connect() povezuje se s korisničkim posrednikom, ne mijenja vezu sustava Scale Monitor i ne zahtijeva claim().
Modul mqtt korisničkoj aplikaciji daje jednu neovisnu vezu s posrednikom, odvojenu od sistemske veze Scale Monitor. Obje mogu raditi istodobno s različitim adresama, identitetima, vjerodajnicama i pretplatama. Aplikacija ne preuzima sistemske teme. Podrška: app.capabilities().features.mqtt === true. Sve funkcije, događaji i svojstva u ovom poglavlju dostupni su od Neutron AppEngine 1.0.0.
Tablica 66

URL

Veza

Primjer

mqtt://

MQTT preko TCP

mqtt://broker.example.com:1883

mqtts://

MQTT s TLS autentifikacijom poslužitelja

mqtts://broker.example.com:8883

ws://

MQTT preko WebSocketa

ws://broker.example.com:8080/mqtt

wss://

MQTT preko sigurnog WebSocketa

wss://broker.example.com/mqtt

Protokol: MQTT 3.1.1; API podržava QoS 0 i 1. WebSocket URL mora upućivati ​​na posrednikovog MQTT slušatelja, a ne proizvoljnog WebSocket poslužitelja. Preduvjeti su pristup mreži, ispravne postavke DNS i dostupan broker. Sat uređaja mora biti točan za provjere valjanosti certifikata.

Životni ciklus veze

Najprije registrirajte slušatelje, a zatim await mqtt.configure(...), await mqtt.connect() i await mqtt.subscribe(...). Konfiguracija traje za trenutno pokretanje aplikacije i odbacuje se po završetku. Uključite ga u pokretanje za automatsko pokretanje aplikacije. Nemojte se ponovno spajati pri svakoj iteraciji mjerača vremena.
Nakon uspješne veze, prekid veze pokreće automatsko ponovno povezivanje prema zadanim postavkama, s ograničenom odgodom koja se udvostručuje do 60 sekundi. Uspješno potvrđene pretplate vraćaju se automatski, asinkrono. connect i završetak connect() potvrđuju vezu, a ne završetak svih obnovljenih pretplata. Neuspjesi obnove emitiraju error. Prije prve uspješne veze, neuspjeli pokušaj se odbija; aplikacija odlučuje hoće li pokušati ponovno.
Eksplicitno disconnect(), neuspjeh provjere autentičnosti ili prekoračenje reda čekanja zaustavlja automatsko ponovno povezivanje. Obični gubitak mreže nakon uspješne veze ponovno se povezuje ako je omogućen. Zaustavljanjem ili zamjenom aplikacije zatvara se samo njezina veza MQTT. Asinkrono uredno zatvaranje ne potvrđuje isporuku konačnih publikacija. Veza sustava nastavlja se neovisno.

mqtt.configure(options)

Dostupno od: Neutron AppEngine 1.0.0
await mqtt.configure(options);
Namjena. Konfigurirajte posrednika i identitet aplikacije.
Opis. Provjerava valjanost i zamjenjuje postavke samo kada korisnički klijent nije povezan, ne povezuje se niti čeka ponovno povezivanje. Pričekajte disconnect() prije nego što ih promijenite. Uspješna nova konfiguracija briše zapamćene pretplate; kvar zadržava prethodnu konfiguraciju.

Parametri

Tablica 67

Parametar

Tip / obveznost

Opis

options

object / obvezno

Svojstva su navedena u nastavku. Nepoznata svojstva su odbijena; vrijednosti moraju koristiti dokumentirane tipove.

Rezultat

Promise<undefined>. Potvrđuje konfiguraciju i učitavanje traženih profila certifikata; ne povezuje se.

Pogreške i posebnosti

INVALID_ARGUMENT, MESSAGE_TOO_LARGE, BUSY, CERTIFICATE_NOT_FOUND, CERTIFICATE_TOO_LARGE, OUT_OF_MEMORY. Nevaljani PEM sadržaj može uzrokovati pogrešku tek tijekom TLS povezivanja.

Primjer

await mqtt.configure({
    url: "mqtts://broker.example.com:8883",
    clientId: "scale-01-app",
    username: "integrator", password: "replace-me",
    keepAlive: 60, cleanSession: true, reconnect: true,
    connectTimeoutMs: 10000, reconnectDelayMs: 1000
});
Tablica 68

Svojstvo options

Tip / zadano

Značenje i granice

url

string / obvezno

Do 512 UTF-8 bajtova. Jedna od četiri sheme. Nema korisničkog imena/lozinke u URL, razmaku ili # fragmentu. Uključite ispravan ws/wss put, kao što je /mqtt.

clientId

string / automatski

Do 64 UTF-8 bajtova. Ako nema ili je prazan, uređaj dodjeljuje stabilan identitet korisničke aplikacije. Dvije istovremene veze s istim brokerom ne smiju dijeliti clientId.

username, password

string / ništa

Najviše 256 odnosno 512 UTF-8 bajtova. Nikad ih nemojte prijavljivati ​​na konzolu; kod aplikacije nije tajni trezor.

keepAlive

integer / 60

Sekunde, 5..3600.

cleanSession

boolean / true

false omogućuje stalnu brokersku sesiju za istu clientId. Aplikacija API i dalje obnavlja svoje potvrđene pretplate; pretplate samo za brokere nisu dio njegovog lokalnog popisa.

reconnect

boolean / true

Automatsko ponovno povezivanje nakon gubitka uspostavljene veze. Ne ponavlja neuspjelu početnu prijavu ili eksplicitni disconnect().

connectTimeoutMs

integer / 10000

1000..60000 ms. Rok za povezivanje klijenta i mrežne operacije.

reconnectDelayMs

integer / 1000

1000..60000 ms. Početna odgoda, udvostručenje pri ponovljenim prekidima veze do 60000 ms i resetiranje nakon uspjeha.

will

object / ništa

{topic, payload, qos?, retain?}. topic je tema objave; payload je string. qos: 0 ili 1, zadano 0; retain: boolean, zadano false. Posrednik objavljuje posljednju poruku nakon neočekivanog prekida veze prema pravilima MQTT-a; nemojte se oslanjati na nju nakon urednog zatvaranja.

tls

object / ništa

samo mqtts/wss. Svojstva: caProfile, clientCertificateProfile, clientKeyProfile. Pogledajte TLS u nastavku.

Cijeli JSON options mora stati u 4096 UTF-8 bajtova, uključujući nazive svojstava i izlazne sekvence. Stvarni kapacitet will.payload zato je manji od 4096 bajtova. Konfiguracijski nizovi ne smiju sadržavati NUL; za binarne podatke upotrijebite publish(). Postavke korisničkog klijenta neovisne su o postavkama sistemskog posrednika.

mqtt.connect(options?)

Dostupno od: Neutron AppEngine 1.0.0
await mqtt.connect({ timeoutMs: 15000 });
Namjena. Povežite se s konfiguriranim posrednikom.
Opis. Promise ispunjava se nakon uspješne potvrde brokerske veze. Već povezani pozivi su uspješni. Drugi istovremeni pokušaj povezivanja odbija se s BUSY.

Parametri

Tablica 69

Parametar

Tip / obveznost

Opis

options.timeoutMs

integer / neobvezno

1..60000 ms; zadano je konfigurirano connectTimeoutMs. Primjenjuje se na pokušaj povezivanja; čekanje servisnog reda i isključivanje klijenta može produžiti ukupno vrijeme.

Rezultat

Promise<undefined>. Podaci o vezi dostupni su i u connect i status().

Pogreške i posebnosti

NOT_CONFIGURED, BUSY, START_FAILED, AUTH_FAILED, CONNECTION_REFUSED, NOT_CONNECTED, TIMEOUT, CANCELLED. Podrobniji mrežni/TLS uzroci mogu se pojaviti u error ili status().lastError. Ograničite ponavljanja neuspjelih početnih pokušaja.

Primjer

try {
    await mqtt.connect({ timeoutMs: 20000 });
    console.info("Broker connected");
} catch (error) {
    console.error(error.code, error.message);
    app.stop();
}

mqtt.disconnect()

Dostupno od: Neutron AppEngine 1.0.0
await mqtt.disconnect();
Namjena. Čisto zatvorite korisničku vezu i zaustavite ponovno povezivanje.
Opis. Otkazuje operacije connect, publish, subscribe i unsubscribe na čekanju; obradite njihove objekte Promise. Konfiguracija i potvrđene pretplate ostaju za sljedeći connect u istom izvršavanju; configure ih zamjenjuje.

Parametri

Nema parametara.

Rezultat

Promise<undefined> nakon zatvaranja klijenta. Već prekinuti pozivi uspješni.

Pogreške i posebnosti

NOT_CONFIGURED prije početne konfiguracije. Prekinute operacije dobivaju CANCELLED. Ne poništava objave koje je broker već prihvatio. Ne šalje automatsku poslovnu izvanmrežnu poruku; objavite i potvrdite jedan prije disconnect() ako je potrebno.

Primjer

if (mqtt.status().connected) {
    await mqtt.publish("scale/status", "offline", { qos: 1, retain: true });
}
await mqtt.disconnect();

mqtt.status()

Dostupno od: Neutron AppEngine 1.0.0
const status = mqtt.status();
Namjena. Vrati trenutni status veze korisnika bez čekanja.
Opis. Vraća kopiju posljednjeg stanja, a ne jamstvo uspjeha sljedeće mrežne operacije. Ne otkriva korisničko ime, lozinku ili certifikate.

Parametri

Nema parametara.

Rezultat

{configured:boolean, connected:boolean, state:string, reconnectAttempts:number, lastError:string}. state: unconfigured, disconnected, connecting, connected, reconnecting. reconnectAttempts broji početke automatskog ponovnog povezivanja od posljednjeg configure. lastError je prazan ili sadrži posljednji kod pogreške; uspješna veza briše ga.

Pogreške i posebnosti

Sinkrono; ne spaja. Stanje mreže može se promijeniti između čitanja i sljedeće operacije.

Primjer

const status = mqtt.status();
console.info(status.state, status.connected, status.lastError);

mqtt.subscribe(topic, options?)

Dostupno od: Neutron AppEngine 1.0.0
await mqtt.subscribe("factory/+/command", { qos: 1, timeoutMs: 10000 });
Namjena. Pretplatite se na temu ili filtar teme.
Opis. Čeka brokera SUBACK; odbijanje brokera nije uspjeh. Potvrđene pretplate pamte se za ponovno povezivanje. Ponavljanje filtra ne koristi dodatni utor; uspješna potvrda zamjenjuje traženi QoS. Broker može odobriti niži QoS.

Parametri

Tablica 70

Parametar

Tip / obveznost

Opis

topic

string / obvezno

1..192 UTF-8 bajta. + mora zauzimati cijelu razinu, # cijelu posljednju razinu; primjerice factory/+/command ili factory/#.

options.qos

integer / 0

0 ili 1.

options.timeoutMs

integer / 10000

1..60000 ms za potvrdu brokera.

Rezultat

Promise<undefined> nakon uspješnog SUBACK. Dolazne objave šalju message.

Pogreške i posebnosti

NOT_CONFIGURED, NOT_CONNECTED, SUBSCRIBE_FAILED, QUOTA_EXCEEDED, BUSY, TIMEOUT. Najviše 16 filtara. Istodobni subscribe/unsubscribe za isti filtar prima BUSY. Zahtjevi bez veze ne spremaju se u red za kasnije.

Primjer

await mqtt.subscribe("factory/scale-01/command", { qos: 1 });

mqtt.unsubscribe(topic, options?)

Dostupno od: Neutron AppEngine 1.0.0
await mqtt.unsubscribe("factory/scale-01/command");
Namjena. Otkažite pretplatu na točan filtar i uklonite ga s popisa za ponovno povezivanje.
Opis. Potvrđeno UNSUBACK. Nepoznati filtri mogu biti otkazani. Ne uklanja već primljene poruke ili druge preklapajuće pretplate.

Parametri

Tablica 71

Parametar

Tip / obveznost

Opis

topic

string / obvezno

Točan filter za odjavu; do 192 UTF-8 bajtova.

options.timeoutMs

integer / 10000

1..60000 ms.

Rezultat

Promise<undefined> nakon UNSUBACK.

Pogreške i posebnosti

NOT_CONFIGURED, NOT_CONNECTED, BUSY, TIMEOUT, CANCELLED. Za zamjenu zapamćenih filtara dok niste povezani, koristite configure; zamjenjuje kompletan lokalni popis, ali ne jamči uklanjanje stare brokerske sesije.

Primjer

await mqtt.unsubscribe("factory/+/command", { timeoutMs: 5000 });

mqtt.publish(topic, payload, options?)

Dostupno od: Neutron AppEngine 1.0.0
await mqtt.publish(topic, payload, { qos: 1, retain: false });
Namjena. Objavljivanje tekstualnih ili binarnih podataka.
Opis. Šalje nizove kao UTF-8 i Uint8Array kao točne bajtove; ne dodaje CR, LF ili NUL. Kopira korisni teret u vrijeme poziva. Slanje počinje iz zasebnog komunikacijskog zadatka nakon obrade zahtjeva. QoS 0 potvrđuje uspješno upisivanje prijenosa; QoS 1 čeka brokera PUBACK. Nijedno ne potvrđuje obradu od strane konačnog pretplatnika.

Parametri

Tablica 72

Parametar

Tip / obveznost

Opis

topic

string / obvezno

1..192 UTF-8 bajtovi, bez + ili #.

payload

string | Uint8Array / obvezno

0..4096 bajtova nakon UTF-8 kodiranja; binarni podaci mogu sadržavati NUL.

options.qos

integer / 0

0 ili 1; QoS 2 nije podržan.

options.retain

boolean / false

Zadržite poruku na brokeru. Prazan korisni teret s retain=true uklanja zadržanu vrijednost teme.

options.timeoutMs

integer / 10000

1..60000 ms. QoS 1 PUBACK rok; QoS 0 ne čeka brokera.

Rezultat

Promise<undefined>; značenje potvrde ovisi o QoS.

Pogreške i posebnosti

NOT_CONNECTED izvan mreže; nema neograničenog izvanmrežnog čekanja. BUSY za puni izlazni red čekanja (32768 bajtova uključujući opterećenje protokola) ili ograničenje operacija na čekanju. MESSAGE_TOO_LARGE, INVALID_ARGUMENT, NETWORK_ERROR, TIMEOUT, CANCELLED. Broker je možda već primio poruku nakon isteka vremena/prekida veze. QoS 1 može duplirati isporuku; koristite ID-ove zahtjeva i deduplikaciju za poslovne operacije.

Primjer

const m = scale.read();
if (m.available && mqtt.status().connected) {
    await mqtt.publish("factory/scale-01/weight", JSON.stringify({
        net: m.net, gross: m.gross, unit: m.unit
    }), { qos: 1 });
}
await mqtt.publish("factory/scale-01/binary", new Uint8Array([0, 10, 255]));

mqtt.on() / mqtt.once() / mqtt.off()

Dostupno od: Neutron AppEngine 1.0.0
mqtt.on(eventName, callback);
mqtt.once(eventName, callback);
mqtt.off(eventName, callback);
Namjena. Registrirajte ili uklonite slušatelja događaja korisničkog posrednika.
Opis. Događaji se izvršavaju uzastopno. Asinkroni povratni poziv prepušta izvršavanje pri await; upotrijebite zaštitu od preklapanja kada je redoslijed važan. once uklanja registraciju prije poziva. off uklanja sve registracije iste funkcije za odabrani događaj.

Parametri

Tablica 73

Parametar

Tip / obveznost

Opis

eventName

string / obvezno

connect, disconnect, message ili error.

callback

function / obvezno

Prima jedan objekt s poljima navedenima u nastavku. Zadržite istu referencu funkcije za off.

Rezultat

Vraća mqtt za ulančavanje. Najviše slušatelja 32 u svim događajima MQTT.

Pogreške i posebnosti

INVALID_ARGUMENT, QUOTA_EXCEEDED. Sam error ne zaustavlja aplikaciju; neobrađena iznimka slušatelja ili odbijeni Promise zaustavlja je prema pravilima izvršnog okruženja. Odbijanje operacije i error zasebne su obavijesti bez zajamčenog međusobnog redoslijeda.

Primjer

mqtt.on("message", async event => {
    try {
        if (event.topic !== "factory/scale-01/request" || event.retain) return;
        const request = JSON.parse(event.text);
        console.info(request.id, request.command);
    } catch (error) {
        console.warn(error.code || error.name, error.message);
    }
});
mqtt.on("error", error => console.warn(error.code, error.message));
Tablica 74

Događaj

Polja od Neutron AppEngine 1.0.0

Značenje

connect

connected: true, reconnected: boolean, sessionPresent: boolean

CONNACK prihvaćeno. reconnected označava raniju uspješnu vezu pod trenutnom konfiguracijom. sessionPresent brokerova je oznaka vraćene sesije, a ne lokalno potvrđeni popis pretplata.

disconnect

connected: false, reason: string

Gubitak uspostavljene veze ili eksplicitni prekid veze. Rukujte Promise za neuspjelo početno povezivanje. Nikakav događaj nije zajamčen po završetku aplikacije.

message

topic: string, data: Uint8Array, text: string, qos: number, retain: boolean

Cijela MQTT poruka, najprije sastavljena od fragmenata. text je UTF-8 pogled; za proizvoljan binarni sadržaj upotrijebite data. qos je QoS primljene poruke (API traži najviše 1, ali posrednik može zadržati starije pretplate).

error

Pogreška s code: string i message: string

Pogreška veze, TLS-a, obnove pretplata, prevelike poruke ili reda čekanja. Aplikacija odlučuje kako nastaviti; pregledajte status() i operacije na čekanju.

TLS i profili certifikata

mqtts i wss provjeravaju ime poslužitelja i povjerenje certifikata. Bez caProfile koristi se ugrađeno javno povjerenje CA. Koristite prilagođeni profil za privatne CA-ove. Onemogućavanje provjere certifikata nije dio API. Postavke brokera sustava i certifikati ne primjenjuju se na korisničke veze.

Tablica 75

tls polje

Pohranjeni profil

Svrha

caProfile: "company-ca"

JCA_company-ca

Pouzdani CA PEM ili lanac CA certifikata.

clientCertificateProfile: "device-01"

JCC_device-01

Certifikat klijenta PEM za međusobni TLS.

clientKeyProfile: "device-01"

JCK_device-01

Privatni ključ klijenta u PEM formatu; obvezan zajedno s certifikatom. Ključevi šifrirani lozinkom nisu podržani u ovoj verziji.

Nazivi profila sadrže 1..48 znakova: A–Z, a–z, 0–9, _ ili -. Svaki normalizirani PEM ima najviše 16384 bajta. Ovlašteni integrator postavlja profile putem postojećeg SMD postupka za certifikate, primjerice JCA_company-ca=<PEM>, s cijelim PEM certifikatom kao vrijednošću. To nije putanja datoteke, javni URL ni sistemski MCA profil. Prazna vrijednost briše profil prema postojećim pravilima certifikata. Aplikacije učitavaju profile tijekom configure; promjena pohranjenih profila ne zamjenjuje certifikate aktivne veze. Izvedite disconnect, configure, pa connect.
await mqtt.configure({
    url: "mqtts://mqtt.company.example:8883",
    clientId: "scale-01-app",
    tls: {
        caProfile: "company-ca",
        clientCertificateProfile: "device-01",
        clientKeyProfile: "device-01"
    }
});
await mqtt.connect();

Ograničenja, pogreške i oporavak

Tablica 76

Ograničenje od Neutron AppEngine 1.0.0

Vrijednost / rukovanje

Veze

Jedna korisnička veza, odvojena od sistemske veze Scale Monitor.

Sadržaj poruke

4096 bajtova po poslanoj ili primljenoj poruci: cijela poruka, ne svaki fragment.

Tema / pretplate / slušatelji

192 UTF-8 bajtovi / 16 potvrđeni filtri / 32 slušatelji.

Operacije na čekanju

Najviše 8 zajedno s drugim asinkronim operacijama izvršnog okruženja. Izlazni red MQTT-a: 32768 bajtova.

Rok

Najviše 60000 ms za potvrdu povezivanja ili brokera. Nije jamstvo za točno vrijeme odziva uređaja.

Predimenzionirana dolazna poruka

Cijela poruka odbačena; pogreška MESSAGE_TOO_LARGE. Djelomične poruke se ne isporučuju.

Prekoračenje reda čekanja usluge

EVENT_OVERFLOW zatvara korisničku vezu i zaustavlja ponovno povezivanje. Izvršno okruženje ima još jedan ograničen red; njegovo prekoračenje zaustavlja aplikaciju.

Isteklo vrijeme potvrde

Operacija na čekanju odbija i ponovno povezivanje slijedi konfigurirana pravila. Druge operacije mogu dobiti NOT_CONNECTED. Zakašnjela potvrda iz stare veze nikada ne potvrđuje novi zahtjev.

Prekini vezu tijekom objavljivanja

Odbijanje nepotvrđenih operacija; aplikacija odlučuje hoće li pokušati ponovno. Već izvedeni efekti se ne poništavaju.

Ključni kodovi: INVALID_ARGUMENT, MESSAGE_TOO_LARGE, NOT_CONFIGURED, NOT_CONNECTED, BUSY, QUOTA_EXCEEDED, OUT_OF_MEMORY, START_FAILED, AUTH_FAILED, CONNECTION_REFUSED, NETWORK_ERROR, TLS_ERROR, SUBSCRIBE_FAILED, CERTIFICATE_NOT_FOUND, CERTIFICATE_TOO_LARGE, TIMEOUT, CANCELLED, EVENT_OVERFLOW, INVALID_MESSAGE. Poruke pogrešaka služe dijagnostici; programske odluke temeljite na code. Za TLS pogreške provjerite vrijeme uređaja, naziv poslužitelja, lanac povjerenja i potreban certifikat klijenta.

Potpuni primjer: objava mase i primanje naredbi

Prilagodite brokerUrl, baseTopic i vjerodajnice prije pokretanja. Svaki uređaj treba vlastiti clientId i teme. Šaljite naredbe na /command bez retain. Primjer periodično objavljuje masu, automatski obnavlja potvrđene pretplate i ne ponavlja tariranje za zadržane naredbe. Za sustave koji ponavljaju QoS 1 zahtjeve dodajte ID-jeve zahtjeva i evidenciju izvršenih naredbi; sam retain ne sprječava dvostruku dostavu.

// Set your broker address and a unique base topic for this device.
// Supports mqtt://, mqtts://, ws:// and wss://.
const brokerUrl = "mqtt://192.168.1.10:1883";
const baseTopic = "factory/scale-01";
let sending = false;
let commandBusy = false;

mqtt.on("error", error => console.warn(error.code, error.message));
mqtt.on("connect", event => console.info("MQTT connected; reconnected:", event.reconnected));
mqtt.on("disconnect", event => console.warn("MQTT disconnected:", event.reason));

mqtt.on("message", async event => {
    if (event.topic !== baseTopic + "/command") return;
    // Do not execute retained commands on every resubscription.
    if (event.retain || commandBusy) return;
    commandBusy = true;
    try {
        let reply;
        switch (event.text.trim()) {
        case "WEIGHT?": reply = JSON.stringify(scale.read()); break;
        case "TARE": await scale.tare(); reply = "OK"; break;
        case "ZERO": await scale.zero(); reply = "OK"; break;
        case "CLEAR_TARE": await scale.clearTare(); reply = "OK"; break;
        default: reply = "ERR,UNKNOWN_COMMAND";
        }
        await mqtt.publish(baseTopic + "/reply", reply, { qos: 1 });
    } catch (error) {
        console.warn("Command failed:", error.code || error.name, error.message);
    } finally {
        commandBusy = false;
    }
});

async function start() {
    if (!app.capabilities().features.mqtt) throw new Error("MQTT API unsupported");
    await mqtt.configure({
        url: brokerUrl,
        clientId: "scale-01-user-app", // Each device needs its own clientId.
        // username: "user", password: "password",
        keepAlive: 60, reconnect: true, reconnectDelayMs: 1000,
        will: { topic: baseTopic + "/status", payload: "offline", qos: 1, retain: true }
        // For a private CA: mqtts/wss in tls: { caProfile: "company-ca" }.
    });
    await mqtt.connect();
    await mqtt.subscribe(baseTopic + "/command", { qos: 1 });
    // The subscription restores automatically after disconnection.
    await mqtt.publish(baseTopic + "/status", "online", { qos: 1, retain: true });
    mqtt.on("connect", async () => {
        try { await mqtt.publish(baseTopic + "/status", "online", { qos: 1, retain: true }); }
        catch (error) { console.warn(error.code, error.message); }
    });
    setInterval(async () => {
        if (sending || !mqtt.status().connected) return;
        sending = true;
        try {
            const m = scale.read();
            if (m.available) await mqtt.publish(baseTopic + "/weight", JSON.stringify({ net: m.net, gross: m.gross, unit: m.unit }), { qos: 1 });
        } catch (error) {
            console.warn("Publish failed:", error.code, error.message);
        } finally {
            sending = false;
        }
    }, 1000);
}

start().catch(error => {
    console.error(error.code || error.name, error.message);
    app.stop();
});

Integracijsko testiranje

Tablica 77

Test

Očekivani rezultat

Povezivanje sustava i broker korisnika istovremeno

Scale Monitor nastavlja se; korisničke teme obrađuje samo aplikacija.

Objavite WEIGHT? na odabrani /command

JSON mjerenja stiže na /reply; /weight se ažurira približno svake sekunde.

Gubitak i obnavljanje mreže

status postaje reconnecting, a zatim connect s reconnected=true i automatskom obnovom pretplata.

Netočna lozinka / CA / naziv poslužitelja

Connect se odbija; error/status pružaju dijagnostiku. Neuspjela provjera autentičnosti ne ponavlja se neograničeno.

Pošaljite 4096 binarne bajtove

Svi bajtovi, uključujući NUL, ostaju nepromijenjeni. Tema se ne ubraja u veličinu sadržaja.

Primite poruku iznad 4096 bajtova

MESSAGE_TOO_LARGE bez djelomičnog događaja message.

Stop aplikacije

Korisnička veza se zatvara; veza sustava ostaje aktivna.

mqtt, mqtts, ws, wss

Testirajte svaki URL prema odgovarajućem slušatelju brokera; ws/wss zahtijeva ispravan put.

16. HTTP / REST klijent

Globalni fetch() povezuje aplikacije s vanjskim REST API-jima preko HTTP ili HTTPS. Podrška: app.capabilities().features.http. Sve funkcije, svojstva i opcije u ovom poglavlju dostupne su od Neutron AppEngine 1.0.0. Ovo je dokumentirani podskup fetch, a ne potpuno okruženje preglednika.

Uređaj djeluje kao HTTP klijent. Ovaj API ne dodaje prilagođene REST rute na Neutron interni HTTP poslužitelj. Zahtjevi ne pružaju automatske ponovne pokušaje, trajni red čekanja, automatski prijenos događaja ili pohranu odgovora. Aplikacija definira vrijeme poziva, formate podataka i rukovanje greškama.

fetch(url, options?)

Dostupno od: Neutron AppEngine 1.0.0
const response = await fetch(url, options);
Namjena. Pošaljite zahtjev vanjskom poslužitelju HTTP/HTTPS i primite ograničeni potpuni odgovor.
Opis. Promise se razrješava nakon primanja cijelog tijela, a ne samo početnih zaglavlja. HTTP 400, 401, 404 i 500 uobičajeni su odgovori i ne uzrokuju odbijanje. Pogreške veze, TLS-a, vremenskog ograničenja i veličine uzrokuju odbijanje. Mrežna obrada odvija se izvan JavaScript povratnog poziva bez njegova blokiranja tijekom čekanja.

Parametri

Tablica 78

Parametar

Tip / obveznost

Opis

url

string / obvezno

Apsolutni http:// ili https:// URL, najviše 512 ASCII bajtova. Kodiranje Unicode i razmaka u stazama/vrijednostima upita; koristite encodeURIComponent za pojedinačne vrijednosti. # fragment je uklonjen. URL vjerodajnice su zabranjene.

options

object / neobvezno

method, headers, body, timeoutMs, tls i redirect. Nepoznate opcije odbijaju se. Pojedinosti slijede u nastavku.

Rezultat

Promise<Response>, opisan u nastavku. body i kodirane opcije imaju zasebna ograničenja; binarni sadržaji nisu kodirani u JSON ili Base64.

Pogreške i posebnosti

INVALID_ARGUMENT, MESSAGE_TOO_LARGE, HEADERS_TOO_LARGE, RESPONSE_TOO_LARGE, NETWORK_ERROR, TLS_ERROR, TIMEOUT, CANCELLED, INVALID_RESPONSE, INCOMPLETE_RESPONSE, UNSUPPORTED_ENCODING, CERTIFICATE_NOT_FOUND, CERTIFICATE_TOO_LARGE, OUT_OF_MEMORY, BUSY. Nakon prekida/timeout poslužitelj je možda već obradio zahtjev; ponovni pokušaj POST može duplicirati njegov poslovni učinak.

Primjer

async function sendWeight() {
    const m = scale.read();
    const response = await fetch("https://api.example.com/measurements", {
        method: "POST",
        headers: { "Content-Type": "application/json", "Authorization": "Bearer replace-me" },
        body: JSON.stringify({ net: m.net, gross: m.gross, unit: m.unit }),
        timeoutMs: 10000
    });
    if (!response.ok) {
        console.warn("HTTP", response.status, await response.text());
        return;
    }
    if (response.status !== 204) console.info(await response.json());
}
sendWeight().catch(error => console.warn(error.code || error.name, error.message));
Tablica 79

Mogućnost od Neutron AppEngine 1.0.0

Tip / zadano

Značenje

method

string / GET

GET, POST, PUT, PATCH, DELETE ili HEAD. Pretvoreno u velika slova. Ostale metode nisu podržane u ovoj verziji.

headers

object / ništa

Vlastiti nazivi zaglavlja i vrijednosti nizova. Nazivi ne razlikuju velika i mala slova; dvostruki nazivi koji se razlikuju samo veličinom slova odbijaju se. Samo ASCII vrijednosti, bez CR/LF-a ili upravljačkih znakova osim tabulatora.

body

string | Uint8Array | null / nema

Najviše 4096 bajtova nakon UTF-8 kodiranja. null znači bez tijela. GET i HEAD ne smiju imati tijelo. Nizovi bez izričitog Content-Type dobivaju text/plain;charset=UTF-8; za JSON upotrijebite JSON.stringify i application/json. Uint8Array ne dobiva automatski Content-Type.

timeoutMs

integer / 10000

1..60000 ms; dokumentirano proširenje Neutron AppEngine, a ne standardna opcija preglednika fetch. Počinje u vrijeme poziva i uključuje čekanje u redu i prijenos tijela. Isporuka pogreške nije jamstvo u stvarnom vremenu; temeljno razrješenje imena ili pozivi veza mogu završiti kasnije.

tls

object / ništa

Samo HTTPS. caProfile i po izboru par clientCertificateProfile/clientKeyProfile. Vidi TLS.

redirect

string / manual

Podržan je samo manual. Vraća odgovore 3xx kako bi aplikacija mogla provjeriti Location. Nema automatskog praćenja.

Najviše 32 dostavljenih zaglavlja i 2048 bajtova zajedno (imena, vrijednosti i separatori); imena do 64 znakova, vrijednosti do 1024. Klijent upravlja automatskim zaglavljima protokola. Host, Content-Length, Connection, Transfer-Encoding, Accept-Encoding, Expect, Trailer, Upgrade, Proxy-Connection, TE i Keep-Alive ne mogu se postaviti. Kodirane opcije zahtjeva imaju dodatno kombinirano ograničenje bajtova 4096 UTF-8.

Odgovor: status i metapodaci

Dostupno od: Neutron AppEngine 1.0.0
const response = await fetch("https://api.example.com/articles/ART-001");
Namjena. Provjerite rezultat HTTP prije pretvaranja njegovog tijela.
Opis. Objekt sa svojstvima samo za čitanje i metodama za jednokratno konzumiranje tijela. Ne potvrđuje poslovno značenje statusa ili valjanosti primljenog JSON.

Parametri

Nema parametara.

Rezultat

{status, statusText, ok, url, redirected, headers, bodyUsed, text(), json(), arrayBuffer()}. status je HTTP kod; ok znači 200..299. url je traženi URL bez fragmenta; redirected je false; statusText je prazan niz u ovoj verziji.

Pogreške i posebnosti

Obradite odbijanje fetch odvojeno od response.ok. Očekujte prazno tijelo za 204 ili HEAD; response.json() na praznom tijelu uzrokuje SyntaxError. Nema protočnog response.body, clone(), Blob, FormData, Request ni globalnog konstruktora Response.

Primjer

const response = await fetch("https://api.example.com/articles/ART-001");
if (response.status === 404) console.info("Article not found");
else if (!response.ok) console.warn("HTTP status:", response.status);
else console.info(await response.json());

response.text()

Dostupno od: Neutron AppEngine 1.0.0
const text = await response.text();
Namjena. Jednom pretvorite primljeno tijelo u UTF-8 tekst.
Opis. Uklanja početni UTF-8 BOM. Ne izvršava daljnje mrežne zahtjeve; fetch već je primio tijelo. bodyUsed postaje true pri prvom pozivu metode potrošnje tijela.

Parametri

Nema parametara.

Rezultat

Promise<string>. Koristite arrayBuffer() za proizvoljne binarne podatke.

Pogreške i posebnosti

Ponovljeno čitanje baca TypeError s code=BODY_USED. Dekodira UTF-8; drugi skupovi znakova nisu automatski podržani.

Primjer

const response = await fetch("https://api.example.com/status");
const text = await response.text();
console.info(response.status, text);

response.json()

Dostupno od: Neutron AppEngine 1.0.0
const value = await response.json();
Namjena. Dekodirajte tijelo UTF-8 i jednom pokrenite JSON.parse.
Opis. Vraća objekt, polje ili drugu važeću vrijednost JSON. Content-Type ne mijenja pravila JSON.parse. Prvo provjerite status ako vaš API vraća različite formate tijela pogreške.

Parametri

Nema parametara.

Rezultat

Promise<JSON value>. bodyUsed postaje true čak i ako raščlanjivanje JSON ne uspije.

Pogreške i posebnosti

SyntaxError za nevažeće/prazno JSON; TypeError/BODY_USED za ponovno čitanje. Pohranite rezultat u varijablu da biste ga ponovno upotrijebili.

Primjer

const response = await fetch("https://api.example.com/settings");
const settings = await response.json();
console.info(settings);
// Do not also call response.text() on the same response.

response.arrayBuffer()

Dostupno od: Neutron AppEngine 1.0.0
const buffer = await response.arrayBuffer();
Namjena. Jednom vraća primljene binarne bajtove, bez konverzije teksta.
Opis. Koristite Uint8Array za pristup pojedinačnim bajtovima, uključujući NUL. Pohranite ih ili proslijedite drugom podržanom modulu.

Parametri

Nema parametara.

Rezultat

Promise<ArrayBuffer>, najviše 4096 bajtova.

Pogreške i posebnosti

TypeError/BODY_USED pri ponovnom čitanju. Nema automatskog gzipa ili dekompresije drugog sadržaja.

Primjer

const response = await fetch("https://api.example.com/data.bin");
if (!response.ok) throw new Error("HTTP " + response.status);
const data = new Uint8Array(await response.arrayBuffer());
await storage.write("download.bin", data);

response.headers

Dostupno od: Neutron AppEngine 1.0.0
const contentType = response.headers.get("Content-Type");
Namjena. Čitajte zaglavlja odgovora bez obzira na velika i mala slova.
Opis. Objekt samo za čitanje koji podržava get, has, entries, keys, values, forEach i iteraciju. Ponovljeni nazivi zaglavlja spajaju se zarezima; to nije automatski upravitelj kolačića.

Parametri

Tablica 80

Parametar

Tip / obveznost

Opis

name za get/has

string / obvezno

Važeći naziv zaglavlja HTTP.

callback za forEach

function / obvezno

Prima value, name i headers. Neobvezni drugi argument postavlja thisArg.

Rezultat

get vraća string ili null; has vraća boolean; entries/keys/values vraćaju iteratore. forEach ne vraća rezultat. Iteracija upotrebljava nazive zaglavlja malim slovima.

Pogreške i posebnosti

INVALID_ARGUMENT za nevaljane nazive zaglavlja ili povratne pozive. Nema globalnog konstruktora Headers ni metoda set/append/delete za odgovor. Ako poslužitelj premaši 32 zaglavlja, ukupno 2048 bajtova ili podržane duljine naziva/vrijednosti, fetch odbija umjesto tihog skraćivanja.

Primjer

const response = await fetch("https://api.example.com/status");
console.info(response.headers.get("Content-Type"));
for (const [name, value] of response.headers) console.info(name, value);

Autentifikacija

Navedite Bearer tokene, API ključeve ili unaprijed kodirane Basic vrijednosti u zaglavljima. Ne stavljajte vjerodajnice u URL-ove. Nema automatske prijave, osvježavanja tokena, HTTP Digest provjere autentičnosti ili zajedničke sesije sa sistemskim vezama. Kolačići se ne spremaju ni šalju automatski. Ovaj klijent uređaja ne podliježe CORS ograničenjima preglednika.

const response = await fetch("https://api.example.com/status", {
    headers: { "Authorization": "Bearer replace-me" }
});
// For example, Basic user:pass uses header "Authorization": "Basic dXNlcjpwYXNz".
// Basic/Base64 is not encryption: use HTTPS for credentials.

HTTPS i profili certifikata

HTTPS uvijek provjerava ime poslužitelja i povjerenje certifikata. Bez caProfile, koristi ugrađeno javno povjerenje-CA. Koristite prilagođeni profil za privatne CA-ove. Sat uređaja mora biti točan za provjere valjanosti certifikata. Nema nesigurne opcije ili premosnice za provjeru imena hosta.

Tablica 81

tls opcija

Pohranjeni profil

Svrha

caProfile: "company"

JHCA_company

Pouzdani CA PEM ili lanac CA certifikata.

clientCertificateProfile: "scale01"

JHCC_scale01

Certifikat klijenta za obostrani TLS.

clientKeyProfile: "scale01"

JHCK_scale01

Privatni ključ; potrebno zajedno s certifikatom klijenta.

Nazivi profila: 1..48 znakova A–Z/a–z, 0–9, _ ili -. Svaki PEM ima najviše 16384 bajta. Ovlašteni integratori postavljaju profile putem postojećeg SMD postupka za certifikate, primjerice JHCA_company=&lt;PEM&gt;. To nije proizvoljna putanja datoteke. Profili su odvojeni od sistemskih MQTT certifikata i certifikata internog HTTP poslužitelja te se učitavaju za svaki zahtjev. Privatni ključevi šifrirani lozinkom nisu podržani.

const response = await fetch("https://api.company.example/status", {
    tls: {
        caProfile: "company",
        clientCertificateProfile: "scale01",
        clientKeyProfile: "scale01"
    },
    timeoutMs: 15000
});
console.info(response.status);

Ograničenja i izvršenje

Tablica 82

Svojstvo od Neutron AppEngine 1.0.0

Rukovanje

Izvršenje

Jedan aktivan zahtjev i do četiri u redu čekanja. Vrijedi i zajedničko ograničenje izvršnog okruženja na osam asinkronih operacija na čekanju.

Veličina

4096-bajt tijela zahtjeva i odvojeno 4096-bajt ograničenja tijela odgovora. Preveliki odgovori podižu RESPONSE_TOO_LARGE; djelomična tijela nikada se ne vraćaju kao uspjeh.

Istek vremena

Zadano 10000 ms, maksimalno 60000 ms, uključujući čekanje u redu. Spori dolazni podaci ne poništavaju rok. Stvarno vrijeme isporuke pogreške nije zajamčeno u stvarnom vremenu.

Veze

Veze se oslobađaju nakon svakog zahtjeva. Nema stalne HTTP sesije ili automatskog ponovnog pokušaja. HTTPS stoga uspostavlja novu sigurnu vezu pri svakom pozivu.

Preusmjeravanja

Uvijek manual. 3xx ostaje odgovor; Location se može pročitati. Zaglavlja za provjeru autentičnosti ne prosljeđuju se automatski drugom poslužitelju.

Kodiranje tijela

Zahtijeva identity. gzip/br i druga kodiranja nisu podržana; neprazan kodirani odgovor uzrokuje UNSUPPORTED_ENCODING.

Stop aplikacije

Zahtjevi u redu čekanja iz prethodnog pokretanja se odbacuju; aktivni prijenos se prekida kada se detektira zaustavljanje ili završi osnovni poziv veze. Ovo ne poništava već izvedene efekte poslužitelja.

API podskup

Bez konstruktora AbortController/signal, streaming body, clone, Blob, FormData, URL/Request/Response/Headers ili automatsko okruženje CORS/cookie.

Zaštitite periodične pozive od preklapanja. Koristite ID-ove zahtjeva i dogovoreni protokol poslužitelja za pouzdane poslovne pokušaje. Isteklo vrijeme ili gubitak odgovora ne dokazuje da poslužitelj nije obradio POST/PUT/PATCH/DELETE.

Potpuni primjer: slanje mase

// Adjust the URL and, if required, Authorization for your REST server.
const endpoint = "https://api.example.com/measurements";
let sending = false;

async function sendWeight() {
    if (sending) return;
    const m = scale.read();
    if (!m.available) return;
    sending = true;
    try {
        const response = await fetch(endpoint, {
            method: "POST",
            headers: {
                "Content-Type": "application/json"
                // "Authorization": "Bearer replace-me"
            },
            body: JSON.stringify({ device: "scale-01", timeMs: m.timeMs, net: m.net, gross: m.gross, unit: m.unit }),
            timeoutMs: 10000
        });
        if (!response.ok) {
            console.warn("REST status:", response.status, await response.text());
            return;
        }
        console.info("REST status:", response.status);
        // If the API returns JSON: const result = await response.json();
        // 204 has no body. A body can be consumed only once.
    } catch (error) {
        console.warn(error.code || error.name, error.message);
    } finally {
        sending = false;
    }
}

if (!app.capabilities().features.http) {
    console.error("REST API is unavailable");
    app.stop();
} else {
    sendWeight();
    setInterval(sendWeight, 10000);
}

Integracijsko testiranje

Za lokalno testiranje izvorni paket uključuje tools/rest-test-server.py i tools/examples/rest-self-test.js za uređaj. Poslužitelj zadano sluša lokalno; izričito upotrijebite --host 0.0.0.0 za pristup Neutronu i postavite IP računala u testnoj aplikaciji. Neobvezni --cert/--key omogućuju HTTPS; --ca omogućuje provjeru certifikata klijenta. Postavljanje certifikata/profila ostaje zaseban postupak upravljanja.

Tablica 83

Test

Očekivani rezultat

GET/POST/PUT/PATCH/DELETE/HEAD

Ispravan zahtjev i status; HEAD nema tijelo.

404 ili 500

Promise ispunjava; response.ok je false.

302

Status i Location bez automatskog novog zahtjeva.

JSON / UTF-8 / usitnjeno

Kompletno ispravno dekodirano tijelo; komadi nisu odvojeni JavaScript događaji.

Binarno tijelo s NUL i 0xff

Točno 4096 bajtova u svakom smjeru.

Ponovno pročitajte tijelo

TypeError s code=BODY_USED.

Spor odgovor ili spori tok zaglavlja

TIMEOUT; vaganje i izvršno okruženje nastavljaju rad.

Prevelik odgovor/zaglavlja

Eksplicitno odbijanje bez tihog skraćivanja.

HTTPS s netočnim CA / imenom / certifikatom klijenta

TLS_ERROR; provjera ostaje uključena.

Stop tijekom prijenosa

Resursi se oslobađaju; zastarjeli odgovor ne dostavlja se novom izvršavanju aplikacije.

17. WebSocket klijent

Dostupno od: Neutron AppEngine 1.0.0 / API 1.
WebSocket pruža trajnu dvosmjernu vezu s vanjskim poslužiteljem. Aplikacije šalju tekstualne ili binarne poruke i primaju događaje. Svaka poruka zadržava svoju granicu; graničnici linija su nepotrebni. Koristite fetch() za REST i mqtt za brokera MQTT.
Svaka aplikacija ima jednu neovisnu vezu, odvojenu od postavki modula WebSocket, MQTT i Scale Monitor. Podržava imena ws://, wss://, DNS i IPv4. Provjerite app.capabilities().features.websocket; ograničenja su u app.capabilities().websocket.

new WebSocket(url, protocols?, options?)

Dostupno od: Neutron AppEngine 1.0.0
Stvara klijenta i pokreće asinkrono povezivanje. Vraća objekt WebSocket, a ne Promise. Uspjeh šalje open; neuspjeh šalje error i close. Nevaljani argumenti sinkrono uzrokuju iznimku.
  • url: apsolutna adresa, najviše 512 bajtova, kao što je wss://system.example.com/scales?device=01. Zadani priključci: 80 za ws, 443 za wss. Kodiranje staza i parametara; URL vjerodajnice, fragmenti i IPv6 nisu podržani.
  • protocols: izostavljen ili prazan niz []. Pregovaranje podprotokola nije dostupno u ovoj verziji; druge vrijednosti podižu UNSUPPORTED_PROTOCOL.
  • options: neobavezni objekt koji sadrži timeoutMs, headers i tls. Može se također dostaviti izravno kao drugi argument.
  • timeoutMs: ograničenje veze cijelog broja 1000–15000 ms, zadano 10000 ms. DNS/mrežni detalji mogu utjecati na stvarno vrijeme povratka. Ne ograničava cijeli životni vijek veze.
  • headers: HTTP zaglavlja s vrijednostima nizova, primjerice Authorization ili X-API-Key. Najviše 32 zaglavlja i ukupno 512 bajtova. Zaglavljima Connection i Sec-WebSocket-* upravlja klijent i ne mogu se postaviti. Cijeli zahtjev za nadogradnju, uključujući putanju, naziv hosta i automatska zaglavlja, mora biti kraći od 1024 bajta; prevelika kombinacija uzrokuje HEADERS_TOO_LARGE.
  • tls: samo wss. caProfile, clientCertificateProfile i clientKeyProfile koriste profile REST. Isporuka certifikata klijenta i ključa zajedno. Nazivi profila: 1–48 znakovi A–Z, a–z, 0–9, _ ili -. Bez caProfile, koristi zadano povjerenje. Naziv poslužitelja i provjera certifikata uvijek su omogućeni.
const ws = new WebSocket("wss://system.example.com/scales", [], {
  headers: { Authorization: "Bearer demo-token" },
  timeoutMs: 10000,
  tls: { caProfile: "company" }
});
ws.onopen = () => ws.send(JSON.stringify(scale.read()));
ws.onerror = event => console.warn(event.code, event.message);

Provjere certifikata zahtijevaju točno vrijeme uređaja. Pošalji vjerodajnice putem wss-a. Preusmjeravanja se ne prate automatski. Ako je utor za povezivanje zauzet, novi objekt prima BUSY i zatvara se; postojeća veza ostaje aktivna.

Osnovna autentifikacija s korisničkim imenom i lozinkom

Dostupno od: Neutron AppEngine 1.0.0
Unesite korisničko ime/lozinku kao nizove i upotrijebite pomoćnik u nastavku za izradu Authorization. Basic ne hashira vjerodajnice: on Base64 kodira username:password. Kodiranje je reverzibilno; koristite wss:// za vjerodajnice.
basicAuth(username, password) je definiran u ovom primjeru, nije ugrađen u Neutron AppEngine. Vraća punu vrijednost zaglavlja Basic <Base64>. Podržava UTF-8 ako poslužitelj to očekuje i ne trebaju ni btoa ni TextEncoder. Oba argumenta moraju biti nizovi ili se izbacuje TypeError. Korisnička imena ne mogu sadržavati dvotočku; lozinke mogu. Primjer adrese i vjerodajnica su izmišljeni.
function basicAuth(username, password) {
    if (typeof username !== "string" || typeof password !== "string")
        throw new TypeError("Username and password must be strings");
    if (username.includes(":"))
        throw new Error("Username must not contain ':'");

    // Encode username:password as UTF-8 bytes, then Base64.
    const text = encodeURIComponent(username + ":" + password)
        .replace(/%([0-9A-F]{2})/g,
            (_, hex) => String.fromCharCode(parseInt(hex, 16)));
    const alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
    let encoded = "";

    for (let i = 0; i < text.length; i += 3) {
        const n = (text.charCodeAt(i) << 16)
            | ((text.charCodeAt(i + 1) || 0) << 8)
            | (text.charCodeAt(i + 2) || 0);
        encoded += alphabet[(n >>> 18) & 63];
        encoded += alphabet[(n >>> 12) & 63];
        encoded += i + 1 < text.length ? alphabet[(n >>> 6) & 63] : "=";
        encoded += i + 2 < text.length ? alphabet[n & 63] : "=";
    }
    return "Basic " + encoded;
}

// Fictional address and credentials; replace with your server settings.
const username = "demo_operator";
const password = "DemoOnly-42!";
const socket = new WebSocket("wss://gateway.example.com:9443/scale/auth", {
    headers: { Authorization: basicAuth(username, password) }
});
socket.onopen = () => socket.send(JSON.stringify(scale.read()));
socket.onerror = event => console.warn(event.code, event.message);
socket.onclose = event => console.info("WebSocket closed", event.code, event.wasClean);
Zamijenite /scale/auth stvarnom krajnjom točkom poslužitelja. Pomoćnu funkciju ne treba mijenjati pri promjeni vjerodajnica. Nikada ne bilježite Authorization ili lozinke. HTTP 401/403 tijekom provjere autentičnosti šalje error s AUTH_FAILED, a zatim close. basicAuth radi i u fetch zaglavljima Authorization preko HTTPS-a.

socket.send(data)

Dostupno od: Neutron AppEngine 1.0.0

U stanju OPEN, jedna poruka u redu čekanja. Prihvaća niz, ArrayBuffer ili prikaz međuspremnika kao što je Uint8Array ili DataView. Nizovi se šalju kao tekst UTF-8; druge vrijednosti kao binarne poruke. Binarni podaci kopiraju se u vrijeme poziva, dopuštajući kasnije promjene izvora. Dopuštene su prazne poruke i binarni bajtovi 0 i 255.

Vraća undefined. Nemojte await kao potvrdu isporuke: slanje ne potvrđuje obradu poslužitelja. Dodajte ID-ove zahtjeva i odgovore svom protokolu. bufferedAmount broji lokalne bajtove u redu čekanja, a ne nepriznate poruke poslužitelja.

Najviše 4096 bajtova po poruci i 16384 bajta u lokalnom redu; vrijedi i zajedničko ograničenje operacija na čekanju. Prevelike poruke uzrokuju MESSAGE_TOO_LARGE; pun red uzrokuje BUSY. CONNECTING uzrokuje INVALID_STATE; CLOSING/CLOSED zanemaruju send. Naknadne pogreške prijenosa stižu putem error i mogu zatvoriti vezu.

ws.send("WEIGHT?");
ws.send(JSON.stringify({ net: scale.net, gross: scale.gross }));
ws.send(new Uint8Array([0, 127, 255]));

Događaji i slušatelji

Dostupno od: Neutron AppEngine 1.0.0
Upotrijebite onopen, onmessage, onerror, onclose ili addEventListener(type, callback, { once: true }). Uklonite pomoću removeEventListener(type, callback). Podržane su samo ove četiri vrste događaja i funkcijski povratni pozivi; najviše 32 registrirana slušatelja po objektu. Dvostruki parovi vrsta/funkcija ne dodaju se. Nema DOM događaja, capture ni AbortSignal.
  • open: nadogradnja veze i protokola uspjela; readyState je OPEN.
  • message: event.data je niz za tekst ili ArrayBuffer za binarne podatke. Fragmenti se sastavljaju u jednu poruku, uključujući znakove UTF-8 podijeljene po fragmentima. Ping/pong se ne isporučuje kao poruka.
  • error: event.code, event.message i Error u event.error. Pogreške povratnog poziva slijede pravila izvršnog okruženja; za nastavak ih uhvatite unutar povratnog poziva.
  • close: event.code, event.reason, event.wasClean. 1006 označava prekinuto zatvaranje; 1005 znači da primljeni okvir nije imao kod. Objekt ostaje CLOSED. Svi događaji sadrže i type, target i currentTarget.
ws.onmessage = event => {
  try {
    if (typeof event.data === "string") {
      if (event.data.trim() === "WEIGHT?") ws.send(JSON.stringify(scale.read()));
    } else {
      const bytes = new Uint8Array(event.data);
      console.info("Binarni bajti:", bytes.length);
    }
  } catch (error) { console.warn(error.code || error.name, error.message); }
};
ws.addEventListener("open", () => console.info("Povezava odprta"), { once: true });
ws.onclose = event => console.info(event.code, event.reason, event.wasClean);

socket.close(code?, reason?) i stanje veze

Dostupno od: Neutron AppEngine 1.0.0
close() pokreće asinkrono zatvaranje i vraća undefined. Zadano: code 1000, prazan reason. Korisnički kodovi: 1000 ili 3000–4999; reason najviše 123 UTF-8 bajta. Nevaljani argumenti uzrokuju INVALID_ARGUMENT. Ponovljeni close u CLOSING/CLOSED nema učinka. Zatvaranje tijekom povezivanja sprječava open; klijent dovršava trenutačni pokušaj i zatim zatvara vezu. Bez odgovora na zatvaranje u približno 3 sekunde slijedi prisilno neuredno zatvaranje.
readyState: WebSocket.CONNECTING = 0, OPEN = 1, CLOSING = 2, CLOSED = 3. Konstante postoje i na objektu. url sadrži adresu; protocol i extensions prazni su. binaryType uvijek je arraybuffer; blob nije podržan.
if (ws.readyState === WebSocket.OPEN) ws.send("PING");
ws.close(1000, "Application finished");

Ograničenja, oporavak i pogreške

Ova verzija podržava jednu vezu klijenta po aplikaciji, ws/wss, binarni/tekstualni prijenos i provjeru certifikata. Nema WebSocket poslužitelja, podprotokola, kompresije, Bloba ili automatskog ponovnog povezivanja. Stvorite novi objekt nakon zatvaranja; upotrijebite odgođeni setTimeout ako je potrebno. Ova utičnica je odvojena od MQTT preko ws/wss.

Prijem čeka dostupne podatke i ne zahtijeva periodično provjeravanje putem setInterval. Klijent šalje ping približno svakih 30 sekundi i čeka do 10 sekundi na pong. Mrežne operacije nakon povezivanja imaju ograničena čekanja od približno 3 sekunde. Prevelike dolazne poruke ili nevaljani UTF-8 uzrokuju error i zatvaranje. app.stop(), brisanje aplikacije ili pogreške izvršnog okruženja zatvaraju vezu i oslobađaju resurse; završetak aktivne mrežne operacije može potrajati nekoliko sekundi. JavaScript događaji više se ne izvršavaju nakon zaustavljanja.

Kodovi pogrešaka: INVALID_ARGUMENT, INVALID_STATE, UNSUPPORTED_PROTOCOL, BUSY, QUOTA_EXCEEDED, MESSAGE_TOO_LARGE, HEADERS_TOO_LARGE, OUT_OF_MEMORY, AUTH_FAILED (HTTP 401/403 tijekom povezivanja), HANDSHAKE_FAILED, NETWORK_ERROR, TLS_OR_NETWORK_ERROR, TIMEOUT, PROTOCOL_ERROR, INVALID_UTF8. Za TLS_OR_NETWORK_ERROR provjerite povezivost, vrijeme, naziv poslužitelja i certifikat. Pogreške reda događaja izvršnog okruženja slijede njegova opća pravila.

Integracijsko testiranje

Na računalu pokrenite python tools/websocket-test-server.py --host 0.0.0.0. Postavite adresu računala u tools/examples/websocket-self-test.js i prenesite datoteku na Neutron. Testovi pokrivaju UTF-8, fragmente s umetnutim pingom, prazne poruke, binarne prijenose do 4096 bajtova i uredno zatvaranje. Primjer slanja mase: tools/examples/websocket-scale.js. Poslužitelj podržava --cert/--key za wss i --token za testiranje Authorization. Za vlastite certifikate upotrijebite odgovarajući CA profil.

Također testirajte BIG (prevelik odgovor), netočan certifikat/token, gubitak mreže i Stop/Delete tijekom prijenosa. Testovi JavaScript API na strani računala ne zamjenjuju testiranje mreže i TLS na uređaju.

18. Pogreške, try/catch i nastavak

Vanjski try { setInterval(...) } catch (...) { ... } hvata pogreške registracije, a ne kasnije neuspjele povratne pozive. Slično, try { asyncOperation() } bez await ne hvata odbijanje Promise. Uhvatite unutar povratnog poziva ili na vraćenom Promise.
Razlikujte sinkrone JavaScript iznimke, asinkrono odbijanje Promise i pogreške cijelog izvršnog okruženja. Standardni TypeError, ReferenceError, SyntaxError i RangeError imaju name/message, ali ne nužno code. Pogreške operacija i provjere argumenata obično uključuju error.code i error.message.
Tablica 84

Kod

Opće značenje

INVALID_ARGUMENT

Nevažeći tip/vrijednost argumenta; detalji ovise o pozvanoj funkciji.

QUOTA_EXCEEDED

Ograničenje modula premašeno; uklonite neiskorištene registracije.

BUSY

Resurs je zauzet, previše operacija na čekanju ili pun red. Pričekajte i ograničite istodobnost/ponovne pokušaje.

OUT_OF_MEMORY

Nedovoljna radna memorija. JavaScript kvarovi memorije mogu umjesto toga koristiti standardnu ​​iznimku bez ovog koda.

TIMEOUT

Prekinuta ili istekla asinkrona operacija. Prije ponovnog pokušaja provjerite učinak prethodne operacije.

Uhvatite očekivane kvarove u funkciji tamo gdje se pojave da biste nastavili. Odaberite isključivanje pomoću app.stop() ili ostavite grešku neobrađenom. Ne postoji globalna konfigurabilna politika pogreške API. Samo bilježenje pogrešaka konzole ne zaustavlja aplikaciju.

async function readSettings() {
    return JSON.parse('{"enabled":true}');
}
async function start() {
    try {
        const settings = await readSettings();
        console.info("Enabled:", settings.enabled);
    } catch (error) {
        console.warn(error.code || error.name, error.message);
        // Handled error: application continues.
        // Use app.stop() to stop.
    }
}
start();

Neobrađene iznimke/odbijanja, iscrpljeno aktivno vrijeme, pretjerano ugnježđivanje poziva ili prekoračenje reda događaja zaustavljaju aplikaciju i postavljaju lastError. Unutarnje pogreške reda/vremenskog proračuna ne daju nužno objekt s code; status može sadržavati EVENT_OVERFLOW ili Active JS execution budget exceeded. Sistemske pogreške uređaja i gubitak napajanja nisu JavaScript iznimke i ne mogu se uhvatiti pomoću try/catch.

Pogreške i odgovori specifični za module dokumentirani su sa svojim funkcijama. Opća pravila try/catch primjenjuju se bez obzira na izvor operacije.

19. Ograničenja i planiranje resursa

Tablica 85

Resurs

Ograničenje / ponašanje

Naziv / verzija

Naziv: 1–64 UTF-8 bajtovi; verzija: 1–32 bajtovi; bez kontrolnih znakova. Verzija je tekst, a ne nužno semantička verzija.

Izvorni kod

Jedna datoteka UTF-8, 1–131 072 bajtovi.

Memorija aplikacije

1 048 576 bajtovi za Neutron AppEngine podatke i objekte; Veličina izvora provjerava se zasebno.

Gniježđenje funkcija

Izbjegavajte duboku rekurziju i duge lance poziva. Pretjerano ugniježđivanje može uzrokovati neuspjeh aplikacije.

Aktivno vrijeme

Otprilike 1 s po koraku obrade vremena izvođenja; 5 s proračun tijekom provjere koda. Nije zajamčeno vrijeme odziva vage.

Vremenske funkcije

16 aktivnih vremenskih poziva.

Istodobne operacije

Najviše 8 operacije na čekanju. Brzo obradite događaje; prekomjerni zaostatak može zaustaviti aplikaciju s EVENT_OVERFLOW.

Konzola

Ukupno 10 poziva/s, približno 512 bajtova sadržaja po pozivu.

Upload

768 sirovih bajtova/dio; postojeće BLE sučelje: 192 sirova bajta/dio; sesija istječe nakon 5 minuta neaktivnosti.

Bez događaja ili mjerača vremena, Neutron AppEngine čeka dok ostale funkcije uređaja nastavljaju normalno. Čekanje ne troši aktivni JavaScript proračun. Procijenite opterećenje CPU na stvarnoj konfiguraciji; ovdje nije zajamčen fiksni postotak CPU.

Ograničite rast Map/Array, podatke po naredbi i ponovne pokušaje. Vremenski pozivi za sporu komunikaciju obično trebaju oznaku slanja. Nemojte gomilati nove zahtjeve kada operacije ne mogu brzo završiti. Pohrana zadržava instalirane aplikacije nakon ponovnog pokretanja; JavaScript varijable nestaju pri Stop/resetiranju. Za trajne aplikacijske podatke upotrijebite dokumentirani API storage.

20. Instalacija, atributi i automatsko pokretanje

Tablica 86

Atribut

Opis

name

Naziv za prikaz aplikacije i dio prefiksa dnevnika JavaScript.

version

Verzija korisničke aplikacije; odvojeno od interpreterVersion, apiVersion i verzije firmvera uređaja.

autorun

Boolean: automatski se pokreće nakon pokretanja osim ako zaštita oporavka ne blokira pokretanje.

size / sha256

Duljina i SHA-256 stvarne izvorne datoteke UTF-8 bajtova. SHA-256 nije potpis autora niti zamjena za autorizaciju.

Na internom web poslužitelju ili BLE stranici odaberite datoteku, postavite atribute i Upload. Save attributes ažurira postojeću aplikaciju; Run započinje novo izvršavanje; Stop zahtijeva zaustavljanje; Refresh prikazuje stanje; Abort upload otkazuje prijenos; Delete uklanja instaliranu aplikaciju. busy=true tijekom izvršavanja: zaustavite i pričekajte prije promjene atributa ili instalacije. Delete tijekom izvršavanja pokreće zaustavljanje; početni odgovor je state=stopping, a brisanje završava poslije. Provjerite status za empty. Status uključuje i runtimeActive, runtimeTaskAllocated i resourcesReleased; nakon zaustavljanja oni su false, false i true. Oslobađanje aktivnih komunikacijskih zahtjeva asinkrono je; novi Run može u međuvremenu vratiti BUSY. Interpreter se ne izvršava bez pokrenute aplikacije.

Uspješan Upload potvrđuje provjereni pohranjeni kod, a ne uspješno izvršen program. Nakon toga odaberite Run i provjerite dnevnike/status. Auto run događa se nakon inicijalizacije firmwarea i najmanje 10 s od pokretanja, a ne pri svakom ponovnom MQTT povezivanju. Omogućivanje autorun u atributima ne pokreće odmah ručni Run.

Početni ispis konzole može biti nevidljiv ako je prijenos za otklanjanje pogrešaka odspojen; provjerite APP status/lastError. Program može ostati pokrenut nakon jednog console.log jer izvršno okruženje čeka buduće događaje.

21. APP protokol za klijente i Scale Monitor

Prijenos ne zahtijeva novi komunikacijski kanal. Koristite postojeći autentificirani put naredbe. Ovo je protokol za klijente vanjskog upravljanja, a ne funkcije koje aplikacija JavaScript može sama pozvati.

Tablica 87

Transport

Zahtjev

Odgovor

Interno HTTP/HTTPS

Autentificirani POST /api/cmd, Content-Type: text/plain; tijelo APP <JSON>. Koristite postojeću sesiju prijave uređaja.

objekt JSON; provjerite ok, ne samo status HTTP.

BLE

Postojeća karakteristika naredbe i naredba APP <JSON> uokvirena vjerodajnicama. Koristite isti red čekanja/fragmentaciju kao i druge naredbe.
Postojeći kanal obavijesti, APP <JSON> s mogućim isprepletenim izlazom otklanjanja pogrešaka.

MQTT

Postojeći uređaj CMP/RX tema. DATA sadrži Base64 kompletnog zahtjeva UTF-8 JSON. Objavi uz retain=false.

CMP/TX, APP <JSON>.
APP;MID=<device MID>;P=<existing credential>;DATA=<base64 UTF-8 JSON>;

Zadržite postojeće MID/provjere vjerodajnica i MQTT autentifikaciju. Zadržane APP naredbe se odbijaju. Prijenos MQTT odvojen je od korištenja MQTT unutar JavaScript. Dekodirani APP zahtjev JSON ima najviše 2048 bajtova.

21.1 Prijenos datoteke

Pošaljite stop i pomoću status provjerite busy=false prije početka. Izračunajte size i SHA-256 iz izvornih bajtova datoteke. Zatim izvedite begin → niz chunk → commit → status. Pričekajte svaki odgovor chunk; nemojte slati sve dijelove istodobno.

APP {"op":"begin","rid":"install-001","name":"TCP tehtnica","version":"1.0.0","autorun":false,"size":1234,"sha256":"<64 hex characters>"}
APP {"op":"chunk","rid":"chunk-001","uploadId":"<id from begin>","offset":0,"data":"<base64 source bytes>"}
APP {"op":"commit","rid":"commit-001","uploadId":"<id from begin>"}
APP {"op":"status","rid":"status-001"}

To je shema poruke, a ne prijenos spreman za slanje: zamijenite size, hash, uploadId i data stvarnim vrijednostima. begin vraća uploadId, offset=0 i chunkSize=768. Offset je položaj bajta; podijelite bajtove prije kodiranja Base64. Postojeće BLE sučelje upotrebljava 192 izvorna bajta po APP zahtjevu i dodatno dijeli poruke uokvirene vjerodajnicama u GATT pisanja.

Tablica 88

Operacija

Parametri osim op/rid

Rezultat / uvjeti

begin

name, version, autorun:boolean, size:integer, sha256:string

Stvara sesiju; vraća uploadId, offset i chunkSize. Zahtijeva najmanje size × 2 + 4096 slobodnih bajtova pohrane. Najprije prekinite svaku drugu aktivnu sesiju.

chunk

uploadId, offset:integer, data:base64

1–768 dekodirani bajtovi. Vraća potvrđeni ukupni pomak. Prethodni blok se može ponoviti samo s identičnim bajtovima koji su u cijelosti unutar potvrđenog raspona.

commit

uploadId

Dopušteno nakon primitka svih bajtova. Pokreće asinkronu provjeru SHA/sintakse i aktivaciju; ok=true ne potvrđuje dovršenu aktivaciju. Periodično provjeravajte status do busy=false.

abort

uploadId

Uklanja faznu datoteku i sesiju. Dopušteno kada nema posla. Sesije koje pripadaju drugim transportima ne mogu se preuzeti korištenjem samo uploadId.

configure

name, version, autorun:boolean

Mijenja sve postojeće atribute aplikacije i pokreće asinkronu provjeru/aktivaciju. Zahtijeva instaliranu aplikaciju, nema aktivnog prijenosa i busy=false.

run

—

Pokreće instaliranu aplikaciju i vraća stanje. Prijenos se mora dovršiti/prekinuti i busy=false.

stop

—

Otkazuje automatsko pokretanje na čekanju i zahtijeva zaustavljanje. Potvrda označava prihvaćanje naredbe; za dovršetak periodično provjeravajte status.

status

—

Trenutno stanje, instalirani atributi, pogreška i oporavak. Također dopušteno tijekom izvršenja.

delete

—

Briše aktivnu aplikaciju, njezinu sigurnosnu kopiju, posredne datoteke i zapis oporavka. Prvo zaustavite i prekinite svaki prijenos.

Provjerite logički ok u svakom odgovoru. Neuspjeh vraća ok=false i tekst pogreške, različit od JavaScript Promise error.code. Neobvezni rid je tekstualni korelacijski ID do 64 bajta. Ponovite ID samo s jednakim JSON-om; različiti sadržaji pod istim ID-jem odbijaju se. Predmemorija uspješnih promjena čuva samo posljednjih šest zahtjeva po procesu, a ne trajno jamstvo izvršavanja točno jednom. Za dijelove upotrijebite uploadId/offset i potvrđene bajtove.

Sesija pripada svojem početnom prijenosnom kanalu i uploadId te može isteći nakon 5 minuta neaktivnosti. Nakon izgubljenog odgovora provjerite status/received; nemojte pogađati pomake. Pogreška sažetka/sintakse nije uspješna instalacija. Nakon commit provjerite name/version/sha256 i lastError.

21.2 Status i dovršetak operacije

{
  "ok": true, "rid": "status-001",
  "state": "running", "busy": true,
  "name": "TCP tehtnica", "version": "1.0.0", "autorun": false,
  "size": 1234, "sha256": "<64 hex characters>", "lastError": "",
  "uploadId": "", "received": 0, "maxSize": 131072,
  "recovery": {
    "healthy": true, "crashes": 0, "limit": 3,
    "autoRunDisabled": false, "stableAfterMs": 60000,
    "lastState": "starting", "lastResetReason": 1, "error": ""
  }
}

Primjer je ilustrativan; pročitajte stvarne vrijednosti. Stanje može biti empty, ready, validating, running, stopped, error ili blocked. Busy je true i tijekom uobičajenog dugotrajnog izvršavanja. Za dovršetak provjere pričekajte busy=false i provjerite lastError i identitet instaliranog koda. Za Run provjerite running i pratite naknadne pogreške. lastState i lastResetReason oporavka dijagnostika su firmwarea, a ne status poslovnog protokola.

Tablica 89

Primjer pogreške APP

Značenje / odgovor klijenta

BUSY

Pošaljite stop i pričekajte dovršetak; tijekom provjere periodično provjeravajte status.

Invalid APP JSON

Nevažeći JSON ili zahtjev premašuje 2048 bajtova.

Invalid metadata / Invalid name, version, autorun, size or sha256

Provjerite UTF-8 duljine, logički autorun, sažetak i size.

Invalid upload session

Netočan uploadId, prijenosni kanal ili istekla sesija.

Invalid offset / Overlapping chunk / Duplicate chunk differs

Uskladite offset s potvrđenim received; nemojte mijenjati datoteku tijekom prijenosa.

Upload incomplete

commit prije primitka svih bajtova.

Insufficient filesystem space

Nema dovoljno prostora za siguran prijenos i zamjenu.

No application installed

Run/configure bez instalirane aplikacije.

Application storage not ready / Task allocation failed…

Skladištenje ili RAM nije spremno; pregledati status/zapise i dijagnostiku uređaja.

Popis tekstualnih pogrešaka nije iscrpan. Sačuvajte cijeli error/lastError u dijagnostici klijenta. Istek vremena vanjskog klijenta ne dokazuje odbijanje uređaja.

22. Automatsko pokretanje i zaštita od rušenja

Prije pokretanja, Neutron AppEngine pohranjuje identitet aplikacije i prati uspješnost pokretanja. Neočekivano ponovno pokretanje uređaja tijekom ovog razdoblja bilježi nestabilan pokušaj pri sljedećem pokretanju. Nakon tri uzastopna nestabilna pokušaja, automatsko pokretanje se blokira prije četvrtog automatskog pokušaja. Kod ostaje pohranjen za pregled ili zamjenu.

Neočekivana resetiranja zbog grešaka u sustavu ili problema s napajanjem mogu povećati brojač nestabilnih pokušaja. Normalno uključivanje i planirana ponovna pokretanja tretiraju se drugačije od rušenja aplikacije. Sam nestabilan pokušaj ne dokazuje grešku korisničkog koda; provjerite i dijagnostiku uređaja.

Približno 60 s potvrđenog rada briše niz neuspjeha, uključujući uobičajeno čekanje događaja, a ne samo CPU vrijeme. Uobičajeni Stop zatvara oznaku. Postojeća blokada automatskog pokretanja ostaje do uspješne izričite instalacije ili Save attributes/configure. Ručni Run ostaje moguć i nadzire se. Neuspjelo spremanje zapisa oporavka može radi zaštite spriječiti Run.

Obična neobrađena pogreška JavaScript zaustavlja aplikaciju i postavlja lastError; razlikuje se od resetiranja modula. Tvorničke postavke brišu instalirani kod, njegovu sigurnosnu kopiju, postupne datoteke, stanje oporavka i pohranu aplikacija uključujući lokalne baze podataka. JavaScript try/catch ne može spriječiti resetiranje hardvera.

23. Pravila za ScaleGuru AI i integratore

Koristite ovaj odjeljak kao ugovor za generiranje aplikacija. ScaleGuru AI treba vratiti jednu kompletnu UTF-8 .js datoteku i zasebno navesti potrebnu konfiguraciju sustava i korake testiranja. Dokumentacija ne ovlašćuje automatski AI za učitavanje ili izvršavanje koda na korisničkom uređaju.

Target: CS-NEUTRON application, Neutron AppEngine 1.0.0, API 1.
1. Identify required modules and verify support with app.capabilities().
2. Use only documented functions of supported modules. Never invent APIs.
3. Produce one UTF-8 file without top-level await, import/export or npm.
4. Define and call an async initialization function; handle its rejection.
5. Use standard timers; setInterval does not await async callbacks.
6. Handle rejected operations with await/try/catch or .catch().
7. Choose error handling: continue, bounded retry or app.stop().
8. Respect memory, active-time and module limits.
9. No busy waiting, deep recursion or unbounded queues and buffers.
10. Find configuration, events, errors and examples in the relevant module chapter.
11. The installation channel does not determine the application's communication module.
12. Test manual Run first; enable auto run only after functional testing.
13. If a required module is unsupported, explain the limit instead of generating fake calls.

23.1 Testiranje prije izdavanja aplikacije

Tablica 90

Test

Očekivani rezultat

Uređaj bez važećeg mjerenja

Nema nekontrolirane iznimke; aplikacija jasno javlja nedostupno mjerenje.

Više naredbi u jednom prijemu

Rukovati svakom naredbom; razmislite o redoslijedu odgovora za asinkrone naredbe.

Zauzeta vaga / odbijena operacija

Očekivano odbijanje rješava se bez beskonačnih ponovnih pokušaja.

Stop bez aktivnih vremenskih poziva

Neaktivno izvršno okruženje budi se i uobičajeno završava.

Ponovno pokretanje s automatskim pokretanjem

Pokreće se potvrđena instalirana verzija; lastError i oporavak su pregledani.

24. Revizije i povezana dokumentacija

Tablica 91

Priručnik

Datum

Promjene

1.0

15. 11. 2026

Prvo izdanje API-ja: izvršno okruženje, vaga, ulazi/izlazi, postavke modula, datoteke, lokalna baza podataka, TCP, serijska sučelja, MQTT, REST/HTTP, APP protokol i zaštita pri pokretanju.

Povezana dokumentacija: CSCP — Neutron komunikacijski protokol. CSCP opisuje naredbe i konfiguraciju sustava; one ne postaju automatski JavaScript funkcije. Ova referenca prati svrhu, sintaksu, parametre, rezultat, pogreške i primjer.

Primjeri su uključeni kao statički kod i ostaju čitljivi bez JavaScript. Pretraživanje stranice, kopiranje koda i ispis alati su za dokumentaciju; ne izvršavaju aplikacije niti komuniciraju s uređajem. Dokumentacija nije ugrađena u firmware.

Često postavljana pitanja

Mogu li upotrebljavati Node.js, npm ili API-je preglednika?

Ne. Prenesite jednu JavaScript skriptu u kodiranju UTF-8 i upotrebljavajte dokumentirane API-je neutron-js-1. Node.js, npm, DOM, import/export i await na najvišoj razini nisu dostupni.

Kako provjeriti dostupne značajke?

Pozovite app.capabilities() na uređaju. Prije upotrebe funkcije provjerite apiVersion, interpreterVersion, features i ograničenja pojedinačnog modula.

Ostaju li aplikacijski podaci nakon Stop i ponovnog pokretanja?

JavaScript varijable ne ostaju. Datoteke i lokalne baze zapisa u storage ostaju nakon Stop, ponovnog pokretanja i uobičajene zamjene aplikacije. Vraćanje tvorničkih postavki briše te podatke.

Kada trebam omogućiti Auto run?

Najprije prenesite aplikaciju, ručno je pokrenite i testirajte traženo ponašanje, ograničenja i slučajeve pogrešaka. Omogućite Auto run tek nakon funkcionalnog testiranja. Zaštita pokretanja može blokirati ponovljena nestabilna automatska pokretanja.

Trebate pomoć?

Trebate pomoć sa softverom, povezivošću ili uporabom rješenja? Opišite problem kako bismo vam pomogli odrediti sljedeći korak.

Pripremite zahtjev →