TEHTALNA TEHNIKA · LASTEN RAZVOJ · PODPORA
+386 2 320 33 46info@preciz.si
PRECIZTehnika tehtanja.
Povezana z vašim procesom.
SL / ENSpletna trgovinaPovpraševanje
PRECIZ / MENI
+386 2 320 33 46

SCALEWEBLINK · v1.5 · REST / JSON

ScaleWebLink – navodila za uporabo in REST API

HTML-navodila ScaleWebLink v1.5: nastavitve protokola, POST JSON, MID in PIN, podatki mase, kode ERR01–ERR10, API test in simulator.

English user manual ↗

1. Namen in način delovanja

ScaleWebLink omogoča komunikacijo s tehtnico prek SSL-šifriranih REST-spletnih storitev. Tehtnica je z oblakom povezana prek CloudScaleLink. Zunanji sistem pošlje dejanje in prejme odgovor JSON.

Vsak modul CloudScaleLink ima svoj MID (Module ID) in PIN (Module PIN). Skupaj predstavljata avtorizacijska podatka za dostop do tehtnice. Pri virtualnem CloudScaleLink prejmete MID in PIN po e-pošti.

Potrebujete račun Scale Monitor, povezano tehtnico z ustreznim protokolom ali simulator ter dostop do storitve. Podprti ukazi in razpoložljiva polja so odvisni od tehtnice in protokola.

2. Hiter začetek

  1. Registrirajte se prek povezave partnerja ali na register.scale-monitor.com in se prijavite v Scale Monitor.
  2. Dodajte tehtnico in preverite povezavo CloudScaleLink.
  3. Odprite Menu → Protocol → ScaleWebLink.
  4. Izberite Protocol in Protocol version.
  5. Dejanju Get_Weight dodelite ustrezen ukaz za branje mase.
  6. Odprite API test, izberite dejanje in pošljite zahtevo.
  7. Preverite odgovor in nato vključite POST-zahtevek v svojo aplikacijo.

3. Protokol, dejanja in ukazi

V Menu → Protocol → ScaleWebLink izberite protokol in njegovo različico za priključeno tehtnico. Primer v izvirnih navodilih uporablja Mettler Toledo MT SICS.

Tabela nastavitev ima stolpca Action in Command. Action je ime dejanja, ki ga kliče aplikacija; Command je ukaz, poslan tehtnici.

Vnaprej določeno ime Get_Weight se ne spreminja, lahko pa zanj izberete ustrezen ukaz. Za novo dejanje kliknite Add, vnesite svoje ime in izberite ukaz.

Polje / oznakaPomen in uporaba
Get_Weight → SIX1Primer branja mase pri protokolu MT SICS, različica MT SICS_1.
Tare → TPrimer tariranja pri MT SICS: dejanje Tare sproži ukaz T.

Primerov MT SICS ne uporabljajte kot univerzalnih ukazov za druge tehtnice. Razpoložljive funkcije preverite v protokolu priključene naprave.

4. POST-zahtevek in avtorizacija

API-ju pošljite objekt JSON s tremi polji. Imena polj so zapisana z malimi črkami.

Polje / oznakaPomen in uporaba
midID modula CloudScaleLink.
pinPIN modula CloudScaleLink.
actionGet_Weight ali ime lastnega shranjenega dejanja.

MID in PIN fizičnega modula najdete na njegovi nalepki. Pri virtualni izvedbi uporabite podatke iz prejete e-pošte.

Naslov API: uporabite URL storitve, ki je določen za vašo povezavo. PDF v1.5 ne navaja konkretnega URL-ja končne točke; če ga še nimate, ga pridobite pri podpori. Spodnji primer zato uporablja označen nadomestni naslov, ne delujoče končne točke.

{
  "mid": "yourMID",
  "pin": "yourCSLPIN",
  "action": "Get_Weight"
}

cURL

# Zamenjajte nadomestni URL in podatke modula.
curl --request POST 'https://YOUR-SCALEWEBLINK-ENDPOINT' --header 'Content-Type: application/json' --data '{"mid":"yourMID","pin":"yourCSLPIN","action":"Get_Weight"}'

5. Odgovor JSON

ScaleWebLink vrne objekt JSON. Naslednji primer ohranja odgovor iz priročnika v1.5; razpoložljivost in vsebina podatkov sledita protokolu tehtnice.

Polje / oznakaPomen in uporaba
error0 = brez napake; 1 = prišlo je do napake.
errorCodeKoda napake; razlage so v poglavju 7.
errorMsgKratek opis napake.
scaleResponseIzvorni niz, prejet od tehtnice kot odgovor na ukaz.
dateTimeUTC datum in čas izvedbe dejanja.
weightDataObjekt z razpoložljivimi podatki mase.

Priročnik v1.5 prikazuje dateTime kot besedilni UTC-datum. Izvirna spletna predstavitev prikazuje tudi številski časovni žig, mase pa kot nize. Pri integraciji preverite dejanski odgovor storitve in izbranega protokola ter ustrezno pretvorite tipe; ne predpostavljajte enega formata.

{
  "error": 0,
  "errorCode": null,
  "errorMsg": "",
  "scaleResponse": "SIX1 S 0 N R R 0 0 0 1 P 0.068     0.000   0.068 kg",
  "dateTime": "Wed, 04 Sep 2024 11:07:51 GMT",
  "weightData": {
    "net": 0,
    "gross": 0.068,
    "tare": 0.068,
    "unit": "kg",
    "stability": 1,
    "expectedResponseStatus": null,
    "expectedResponseMsg": null
  }
}

6. Polja weightData

Polje / oznakaPomen in uporaba
netNeto masa; null, če podatek ni prejet.
grossBruto masa; null, če podatek ni prejet.
tareTara; null, če podatek ni prejet.
unitEnota mase; null, če podatek ni prejet.
stabilitynull = ni podatka; 0 = nestabilna tehtnica; 1 = stabilna tehtnica.
expectedResponseStatusnull = ni nastavljeno; 0 = odgovor ni ustrezen; 1 = odgovor je ustrezen.
expectedResponseMsgSporočilo, nastavljeno za pripadajoči ukaz v nastavitvah protokola.

null ni ničelna masa. Pred uporabo meritve preverite napako, pričakovano polje, enoto in stabilnost. Podatkov iz primerov ne uporabljajte kot referenčno meritev; razčlenitev preverite z dejansko tehtnico.

7. Kode napak in odpravljanje težav

Če izvedba dejanja ne uspe, odgovor vsebuje kodo napake. Najprej preverite JSON in nastavitve dejanja, nato povezavo in odziv tehtnice.

Polje / oznakaPomen in uporaba
ERR01Manjkajo podatki POST ali JSON ni veljaven. Preverite telo zahteve in zapis JSON.
ERR02Manjka MID. Vključite polje mid.
ERR03Manjka PIN. Vključite polje pin.
ERR04Manjka dejanje. Vključite polje action.
ERR05Dejanje ni med shranjenimi dejanji. Preverite ime in nastavitve.
ERR06Za prejeto temo (topic) ni povezanega Scale Monitorja. Preverite temo in povezavo.
ERR07Podatki ukaza niso najdeni. Za dejanje izberite veljaven ukaz.
ERR08Manjka niz ukaza. Preverite lastnost command v izbranem protokolu.
ERR09Storitev je zasedena: s tehtnico z istim MID in PIN trenutno komunicira drug odjemalec. Zahtevke razporedite zaporedno in ponovite pozneje.
ERR10Časovna prekoračitev: odgovor ni bil prejet v razpoložljivem času. Preverite povezavo tehtnice in protokol.

8. API test

  1. Odprite Protocol → ScaleWebLink.
  2. Na dnu strani kliknite API test.
  3. V novem oknu izberite shranjeno dejanje.
  4. Kliknite gumb za pošiljanje in preglejte izpis odgovora.

Primer iz priročnika: Protocol: MT SICS, Version: MT SICS_1, Action: Get_Weight, pripadajoči ukaz SIX1. Če preizkus ne uspe, uporabite tabelo napak in preverite izbiro ukaza.

9. Simulator brez fizične tehtnice

  1. V zgornjem levem meniju odprite Scale simulation.
  2. V zavihku Presets kliknite ikono plus.
  3. Vnesite želene podatke simulatorja.
  4. Za Connection type izberite Scale link in kliknite Save.
  5. Po shranjevanju se na vrhu prikažeta ustvarjena MID in PIN.
  6. Kliknite shranjeni simulator v oknu Presets, da ga povežete z oblakom.
  7. Za zahteve ScaleWebLink uporabite MID in PIN simulatorja.

Simulator je namenjen razvoju in preizkusu API-ja. Pred uporabo v procesu preverite še dejansko tehtnico, njen protokol in zahtevana dejanja.

10. Priporočila za integracijo in podpora

  • MID in PIN hranite na strežniški strani; ne vključujte ju v javno spletno kodo ali dnevnike.
  • Za isto tehtnico zahtevke izvajajte zaporedno. ERR09 pomeni, da je komunikacija trenutno zasedena.
  • Ob ERR10 preverite povezavo in odgovor tehtnice. Ne ponavljajte slepo dejanj, ki spreminjajo stanje, saj brez odgovora ne veste, ali je bilo dejanje izvedeno.
  • Manjkajoča polja obravnavajte kot manjkajoče podatke, ne kot 0.
  • Pred shranjevanjem ali nadaljevanjem procesa preverite uspeh, enoto in zahtevano stabilnost.

Za dodatne informacije in tehnično podporo: support@scale-monitor.com.

Navodila temeljijo na ScaleWebLink v1.5. Primeri so namenjeni razumevanju vmesnika in jih prilagodite svoji nastavitvi.

Pogosta vprašanja o ScaleWebLinku

Kaj je ScaleWebLink?

ScaleWebLink je spletna storitev, ki prek CloudScaleLink omogoča komunikacijo s tehtnico z REST-zahtevki in odgovori JSON.

Ali lahko uporabim obstoječo tehtnico?

Da, kadar jo je mogoče povezati prek CloudScaleLink in nastaviti njen komunikacijski protokol. Pred vključitvijo preverimo proizvajalca, model, priključek in zahtevane ukaze.

Ali lahko tehtnico tariram iz lastne aplikacije?

Da, če tehtnica in protokol podpirata tariranje. V Scale Monitorju določite dejanje in pripadajoči ukaz ter nato pokličete to dejanje prek ScaleWebLinka.

Ali potrebujem internetno povezavo?

Da. Opisana povezava uporablja oblačno storitev in povezano tehtnico oziroma simulator.

Ali lahko integracijo preizkusim brez fizične tehtnice?

Da. Simulator Scale Monitor ustvari MID in PIN za preizkus. API test preveri dejanja in prikaže odgovor.

Ali so vsi podatki mase vedno na voljo?

Ne. Polja net, gross, tare, unit in stability so odvisna od odgovora tehtnice in protokola. null pomeni, da podatek ni bil prejet.

ScaleWebLink · v1.5 · PRECIZ / Scale Monitor

Povpraševanje ↗