SCALEWEBLINK · v1.5 · REST / JSON
ScaleWebLink – instrukcja użytkownika i REST API
Instrukcja HTML ScaleWebLink v1.5: konfiguracja protokołu, POST JSON, MID i PIN, dane masy, ERR01–ERR10, API test i symulator.
Instrukcja w języku słoweńskim ↗← Wszystkie instrukcje produktów
1. Cel i działanie
ScaleWebLink komunikuje się z wagą przez usługi internetowe REST szyfrowane SSL. Waga łączy się z chmurą przez CloudScaleLink. System zewnętrzny wysyła akcję i otrzymuje odpowiedź JSON.
Każdy moduł CloudScaleLink ma unikalne MID (Module ID) i PIN (Module PIN). Razem autoryzują dostęp do wagi. Dla wirtualnego CloudScaleLink MID i PIN są dostarczane e-mailem.
Potrzebujesz konta Scale Monitor, podłączonej wagi z odpowiednim protokołem lub symulatora oraz dostępu do usługi. Obsługiwane polecenia i dostępne pola zależą od wagi i protokołu.
2. Szybki start
- Zarejestruj się przez link partnera lub register.scale-monitor.com i zaloguj do Scale Monitor.
- Dodaj wagę i sprawdź jej połączenie CloudScaleLink.
- Otwórz Menu → Protocol → ScaleWebLink.
- Wybierz Protocol i Protocol version.
- Przypisz odpowiednie polecenie odczytu masy do
Get_Weight. - Otwórz API test, wybierz akcję i wyślij ją.
- Sprawdź odpowiedź, a następnie zintegruj żądanie POST ze swoją aplikacją.
3. Protokół, akcje i polecenia
W Menu → Protocol → ScaleWebLink wybierz protokół i wersję dla podłączonej wagi. Oryginalna instrukcja używa jako przykładu Mettler Toledo MT SICS.
Tabela ustawień ma dwie kolumny: Action to nazwa akcji wywoływanej przez aplikację; Command to polecenie wysyłane do wagi.
Nie można zmienić fabrycznie zdefiniowanej nazwy akcji Get_Weight, ale można wybrać przypisane jej polecenie. Kliknij Add, aby utworzyć wiersz, wprowadź własną nazwę akcji i wybierz polecenie.
| Pole / kod | Znaczenie i zastosowanie |
|---|---|
Get_Weight → SIX1 | Przykładowe żądanie masy z użyciem MT SICS, wersja MT SICS_1. |
Tare → T | Przykład tarowania MT SICS: akcja Tare wysyła polecenie T. |
Przykłady MT SICS nie są uniwersalnymi poleceniami dla innych wag. Sprawdź dostępne funkcje w protokole podłączonego urządzenia.
4. Żądanie POST i autoryzacja
Wyślij obiekt JSON z trzema polami. Nazwy pól są pisane małymi literami.
| Pole / kod | Znaczenie i zastosowanie |
|---|---|
mid | Identyfikator modułu CloudScaleLink. |
pin | PIN modułu CloudScaleLink. |
action | Get_Weight lub nazwa zapisanej akcji własnej. |
Dla modułu fizycznego MID i PIN znajdują się na etykiecie. Dla modułu wirtualnego użyj danych uwierzytelniających dostarczonych e-mailem.
Adres API: użyj adresu URL usługi przypisanego do połączenia. PDF v1.5 nie podaje konkretnego adresu URL punktu końcowego; skontaktuj się ze wsparciem, jeżeli go nie masz. Poniższy przykład używa wyraźnie oznaczonego adresu zastępczego, a nie działającego punktu końcowego.
{
"mid": "yourMID",
"pin": "yourCSLPIN",
"action": "Get_Weight"
}cURL
# Zastąp przykładowy adres URL i dane uwierzytelniające modułu.
curl --request POST 'https://YOUR-SCALEWEBLINK-ENDPOINT' --header 'Content-Type: application/json' --data '{"mid":"yourMID","pin":"yourCSLPIN","action":"Get_Weight"}'5. Odpowiedź JSON
ScaleWebLink zwraca obiekt JSON. Przykład zachowuje odpowiedź z instrukcji v1.5; dostępność i zawartość danych wynikają z protokołu wagi.
| Pole / kod | Znaczenie i zastosowanie |
|---|---|
error | 0 = brak błędu; 1 = wystąpił błąd. |
errorCode | Kod błędu; zobacz rozdział 7. |
errorMsg | Krótki opis błędu. |
scaleResponse | Surowy ciąg odebrany z wagi w odpowiedzi na polecenie. |
dateTime | Data i czas UTC wykonania akcji. |
weightData | Obiekt zawierający dostępne dane masy. |
Instrukcja v1.5 pokazuje dateTime jako tekstową datę UTC. Oryginalna strona pokazuje też liczbowy znacznik czasu i masy jako ciągi znaków. Sprawdź rzeczywistą odpowiedź swojej usługi i wybranego protokołu oraz odpowiednio konwertuj typy; nie zakładaj jednego formatu.
{
"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. Pola weightData
| Pole / kod | Znaczenie i zastosowanie |
|---|---|
net | Masa netto; null, jeżeli nie odebrano. |
gross | Masa brutto; null, jeżeli nie odebrano. |
tare | Wartość tary; null, jeżeli nie odebrano. |
unit | Jednostka masy; null, jeżeli nie odebrano. |
stability | null = brak danych; 0 = waga niestabilna; 1 = waga stabilna. |
expectedResponseStatus | null = nie skonfigurowano; 0 = odpowiedź nie OK; 1 = odpowiedź OK. |
expectedResponseMsg | Komunikat skonfigurowany dla odpowiedniego polecenia w ustawieniach protokołu. |
null nie oznacza zerowej masy. Przed użyciem pomiaru sprawdź błędy, wymagane pola, jednostkę i stabilność. Wartości przykładowe nie są pomiarami referencyjnymi; sprawdź parsowanie z rzeczywistą wagą.
7. Kody błędów i rozwiązywanie problemów
Jeżeli akcja nie powiedzie się, odpowiedź zawiera kod błędu. Najpierw sprawdź JSON i konfigurację akcji, a następnie łączność i odpowiedź wagi.
| Pole / kod | Znaczenie i zastosowanie |
|---|---|
ERR01 | Brakuje wymaganych danych POST lub JSON jest nieprawidłowy. Sprawdź treść żądania i składnię JSON. |
ERR02 | Brakuje identyfikatora modułu (MID). Dodaj mid. |
ERR03 | Brakuje PIN modułu. Dodaj pin. |
ERR04 | Brakuje akcji. Dodaj action. |
ERR05 | Nie znaleziono akcji wśród zapisanych akcji. Sprawdź jej nazwę i konfigurację. |
ERR06 | Nie znaleziono Scale Monitor połączonego z otrzymanym tematem. Sprawdź temat i połączenie. |
ERR07 | Nie znaleziono danych polecenia. Wybierz prawidłowe polecenie dla akcji. |
ERR08 | Brakuje ciągu polecenia. Sprawdź właściwość command w wybranym protokole. |
ERR09 | Usługa zajęta: inny klient komunikuje się z wagą przy użyciu tego samego MID i PIN. Wysyłaj żądania kolejno i spróbuj później. |
ERR10 | Przekroczono limit czasu: nie odebrano odpowiedzi w przydzielonym czasie. Sprawdź łączność wagi i protokół. |
8. API test
- Otwórz Protocol → ScaleWebLink.
- Kliknij API test na dole strony.
- Wybierz zapisaną akcję w nowym oknie.
- Wyślij akcję i sprawdź wyświetloną odpowiedź.
Przykład z instrukcji: Protocol: MT SICS, Version: MT SICS_1, Action: Get_Weight, przypisane polecenie SIX1. Jeżeli test się nie powiedzie, użyj tabeli błędów i sprawdź wybrane polecenie.
9. Symulator bez fizycznej wagi
- Otwórz Scale simulation z menu w lewym górnym rogu.
- Kliknij ikonę plusa na karcie Presets.
- Wprowadź żądane dane symulatora.
- Ustaw Connection type na Scale link i kliknij Save.
- Wygenerowane MID i PIN pojawią się u góry po zapisaniu.
- Kliknij zapisany symulator w Presets, aby połączyć go z chmurą.
- Użyj MID i PIN symulatora w żądaniach ScaleWebLink.
Symulator wspiera tworzenie i testowanie API. Przed użyciem integracji w swoim procesie sprawdź rzeczywistą wagę, protokół i wymagane akcje.
10. Zalecenia integracji i wsparcie
- Przechowuj MID i PIN po stronie serwera; nie ujawniaj ich w publicznym kodzie strony ani dziennikach.
- Wysyłaj żądania do tej samej wagi kolejno. ERR09 oznacza, że komunikacja jest zajęta.
- Dla ERR10 sprawdź łączność i odpowiedź wagi. Nie ponawiaj bez sprawdzenia akcji zmieniających stan: bez odpowiedzi nie wiadomo, czy akcja została wykonana.
- Traktuj niedostępne pola jako brakujące dane, a nie 0.
- Przed zapisaniem wyniku lub kontynuowaniem procesu sprawdź powodzenie, jednostkę i wymaganą stabilność.
Dodatkowe informacje i wsparcie techniczne: support@scale-monitor.com.
Ta dokumentacja opiera się na ScaleWebLink v1.5. Przykłady wyjaśniają interfejs i wymagają dostosowania do Twojej konfiguracji.
Najczęściej zadawane pytania o ScaleWebLink
Czym jest ScaleWebLink?
ScaleWebLink to usługa internetowa komunikująca się z wagą przez CloudScaleLink za pomocą żądań REST i odpowiedzi JSON.
Czy mogę wykorzystać istniejącą wagę?
Tak, jeżeli można ją połączyć przez CloudScaleLink i skonfigurować jej protokół komunikacyjny. Przed integracją sprawdzamy producenta, model, złącze i wymagane polecenia.
Czy mogę tarować wagę ze swojej aplikacji?
Tak, jeżeli waga i protokół obsługują tarowanie. Zdefiniuj akcję i jej polecenie w Scale Monitor, a następnie wywołaj akcję przez ScaleWebLink.
Czy wymagane jest połączenie z internetem?
Tak. Udokumentowane połączenie wykorzystuje usługę chmurową i połączoną wagę lub symulator.
Czy mogę testować bez fizycznej wagi?
Tak. Symulator Scale Monitor generuje MID i PIN do testowania. API test sprawdza akcje i wyświetla odpowiedzi.
Czy wszystkie pola masy są zawsze dostępne?
Nie. net, gross, tare, unit i stability zależą od odpowiedzi wagi i protokołu. null oznacza, że danych nie odebrano.
ScaleWebLink · v1.5 · PRECIZ / Scale Monitor
Potrzebujesz pomocy?
Potrzebujesz pomocy z oprogramowaniem, łącznością lub obsługą rozwiązania? Opisz problem, abyśmy mogli pomóc w następnym kroku.