SCALEWEBLINK · v1.5 · REST / JSON
ScaleWebLink – Benutzerhandbuch und REST API
ScaleWebLink v1.5 HTML-Handbuch: Protokollaufbau, POST JSON, MID und PIN, Gewichtsdaten, ERR01–ERR10, API-Test und Simulator.
Slovenska navodila ↗1. Zweck und Funktionsweise
ScaleWebLink kommuniziert über SSL-verschlüsselte REST-Webdienste mit einer Waage. Die Waage wird über CloudScaleLink mit der Cloud verbunden. Ein externes System sendet eine Aktion und erhält eine JSON-Antwort.
Jedes CloudScaleLink Modul besitzt eine eindeutige MID (Module ID) und eine PIN (Module PIN). Gemeinsam autorisieren sie den Zugriff auf die Waage. Für virtuelles CloudScaleLink erhalten Sie MID und PIN per E-Mail.
Sie benötigen ein Scale Monitor Konto, eine angeschlossene Waage mit geeignetem Protokoll oder einen Simulator sowie den Dienstzugang. Unterstützte Befehle und verfügbare Felder hängen von der Waage und dem Protokoll ab.
2. Schnellstart
- Registrieren Sie sich über Ihren Partnerlink oder register.scale-monitor.com und melden Sie sich an Scale Monitor.
- Fügen Sie Ihre Waage hinzu und überprüfen Sie die CloudScaleLink-Verbindung.
- Offen Menü → Protokoll → ScaleWebLink.
- Wählen Protokoll und Protokollversion.
- Weisen Sie einen geeigneten Gewichtsmessbefehl zu,
Get_Weight. - Offen API-TestWählen Sie die Aktion aus und senden Sie sie.
- Überprüfen Sie die Antwort und integrieren Sie dann die POST-Anfrage in Ihre Anwendung.
3. Protokoll, Aktionen und Befehle
Wählen Sie unter Menu → Protocol → ScaleWebLink das Protokoll und die Version für die angeschlossene Waage. Das Originalhandbuch verwendet Mettler Toledo MT SICS als Beispiel.
Die Einstellungstabelle hat zwei Spalten: Action ist der Aktionsname, den Ihre Anwendung aufruft; Command ist der Befehl, der an die Waage gesendet wird.
Der voreingestellte Aktionsname Get_Weight kann nicht geändert werden. Sie können jedoch den zugewiesenen Befehl auswählen. Klicken Sie auf Add, um eine Zeile anzulegen. Geben Sie den Namen Ihrer eigenen Aktion ein und wählen Sie den Befehl aus.
| Feld / Code | Bedeutung und Verwendung |
|---|---|
Get_Weight → SIX1 | Beispiel einer Gewichtsabfrage mit MT SICS, Version MT SICS_1. |
Tare → T | Beispiel für das Tarieren mit MT SICS: Die Aktion Tare sendet den Befehl T. |
Die MT SICS Beispiele sind keine universellen Befehle für andere Waagen. Prüfen Sie die verfügbaren Funktionen im Protokoll des angeschlossenen Geräts.
4. POST request and authorization
Posten Sie ein JSON-Objekt mit drei Feldern. Feldnamen sind Kleinbuchstaben.
| Feld/Code | Bedeutung und Verwendung |
|---|---|
mid | CloudScaleLink Modul ID. |
pin | CloudScaleLink Modul PIN. |
action | Get_Weight oder den Namen einer gespeicherten benutzerdefinierten Aktion. |
Für ein physisches Modul sind MID und PIN auf dem Etikett. Verwenden Sie für ein virtuelles Modul die per E-Mail bereitgestellten Anmeldeinformationen.
API-Adresse: Verwenden Sie die Service-URL, die Ihrer Verbindung zugewiesen ist. PDF v1.5 gibt keine konkrete Endpunkt-URL an; kontaktieren Sie den Support, wenn Sie diese nicht haben. Im folgenden Beispiel wird ein explizit markierter Platzhalter verwendet, kein Arbeitsendpunkt.
{
"mid": "yourMID",
"pin": "yourCSLPIN",
"action": "Get_Weight"
}cURL
# Ersetzen Sie die Platzhalter-URL und die Modul-Anmeldeinformationen.
curl --request POST 'https://YOUR-SCALEWEBLINK-ENDPOINT' --header 'Content-Type: application/json' --data '{"mid":"yourMID","pin":"yourCSLPIN","action":"Get_Weight"}'5. Antwort von JSON
ScaleWebLink gibt ein JSON-Objekt zurück. Das Beispiel übernimmt die Antwort aus dem Handbuch v1.5. Verfügbare Daten und Inhalte richten sich nach dem Waagenprotokoll.
| Feld / Code | Bedeutung und Verwendung |
|---|---|
error | 0 = kein Fehler; 1 = ein Fehler ist aufgetreten. |
errorCode | Fehlercode; siehe Kapitel 7. |
errorMsg | Kurze Fehlerbeschreibung. |
scaleResponse | Unverarbeitete Zeichenfolge, die als Antwort auf den Befehl von der Waage empfangen wurde. |
dateTime | UTC-Datum und -Uhrzeit der Ausführung der Aktion. |
weightData | Objekt mit den verfügbaren Gewichtsdaten. |
Das Handbuch v1.5 zeigt dateTime als UTC-Datum in Textform. Die ursprüngliche Website zeigt außerdem einen numerischen Zeitstempel und Gewichte als Zeichenfolgen. Prüfen Sie die tatsächliche Antwort Ihres Dienstes und des gewählten Protokolls und wandeln Sie die Datentypen entsprechend um. Gehen Sie nicht von einem einheitlichen Format aus.
{
"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. weightDatenfelder
| Feld / Code | Bedeutung und Verwendung |
|---|---|
net | Nettogewicht; null, wenn nicht empfangen. |
gross | Bruttogewicht; null, wenn nicht empfangen. |
tare | Tarawert; null, wenn nicht empfangen. |
unit | Gewichtseinheit; null, wenn nicht empfangen. |
stability | null = keine Daten; 0 = instabile Waage; 1 = stabile Waage. |
expectedResponseStatus | null = nicht konfiguriert; 0 = Antwort nicht OK; 1 = Antwort OK. |
expectedResponseMsg | Nachricht, die in den Protokolleinstellungen für den jeweiligen Befehl konfiguriert wurde. |
null bedeutet kein empfangenes Gewicht, nicht das Gewicht null. Prüfen Sie vor der Verwendung eines Messwerts Fehler, erforderliche Felder, Einheit und Stabilität. Beispielwerte sind keine Referenzmessungen. Prüfen Sie die Auswertung mit der tatsächlichen Waage.
7. Fehlercodes und Fehlerbehebung
Wenn eine Aktion fehlschlägt, enthält die Antwort einen Fehlercode. Prüfen Sie zunächst JSON und Aktionskonfiguration, anschließend die Verbindung und die Antwort der Waage.
| Feld / Code | Bedeutung und Verwendung |
|---|---|
ERR01 | Erforderliche POST-Daten fehlen oder JSON ist ungültig. Prüfen Sie den Anfrageinhalt und die JSON-Syntax. |
ERR02 | Die Modulkennung (MID) fehlt. Geben Sie mid an. |
ERR03 | Die Modul-PIN fehlt. Geben Sie pin an. |
ERR04 | Die Aktion fehlt. Geben Sie action an. |
ERR05 | Die Aktion wurde unter den gespeicherten Aktionen nicht gefunden. Prüfen Sie ihren Namen und ihre Konfiguration. |
ERR06 | Für das empfangene Topic wurde kein verbundener Scale Monitor gefunden. Prüfen Sie Topic und Verbindung. |
ERR07 | Die Befehlsdaten wurden nicht gefunden. Wählen Sie einen gültigen Befehl für die Aktion. |
ERR08 | Die Befehlszeichenfolge fehlt. Prüfen Sie die Eigenschaft command im gewählten Protokoll. |
ERR09 | Der Dienst ist beschäftigt: Ein anderer Client kommuniziert mit derselben MID und PIN mit der Waage. Führen Sie Anfragen nacheinander aus und versuchen Sie es später erneut. |
ERR10 | Zeitüberschreitung: Innerhalb der vorgesehenen Zeit wurde keine Antwort empfangen. Prüfen Sie Waagenverbindung und Protokoll. |
8. API-Test
- Offen Protokoll → ScaleWebLink.
- Klicken API-Test Am Ende der Seite.
- Wählen Sie eine gespeicherte Aktion im neuen Fenster aus.
- Sende die Aktion und inspiziere die Antwortanzeige.
Manuelles Beispiel: Protokoll: MT SICS, Version: MT SICS_1, Aktion: Get_Weight, zugewiesener Befehl SIX1. Wenn das Testen fehlschlägt, verwenden Sie die Fehlertabelle und überprüfen Sie den ausgewählten Befehl.
9. Simulator ohne echte Waage
- Öffnen Sie Scale simulation im Menü oben links.
- Klicken Sie im Reiter Presets auf das Plus-Symbol.
- Geben Sie die gewünschten Simulatordaten ein.
- Stellen Sie Connection type auf Scale link und klicken Sie auf Save.
- Nach dem Speichern werden die generierten MID und PIN oben angezeigt.
- Klicken Sie in Presets auf den gespeicherten Simulator, um ihn mit der Cloud zu verbinden.
- Verwenden Sie die MID und PIN des Simulators in ScaleWebLink-Anfragen.
Der Simulator unterstützt die API-Entwicklung und deren Tests. Prüfen Sie vor dem Einsatz der Integration in Ihrem Prozess die tatsächliche Waage, das Protokoll und die erforderlichen Aktionen.
10. Integrationsempfehlungen und Unterstützung
- Bewahren Sie MID und PIN auf der Serverseite auf. Legen Sie diese nicht in öffentlichem Webcode oder Protokollen offen.
- Führen Sie Anfragen an dieselbe Waage nacheinander aus. ERR09 zeigt an, dass die Kommunikation belegt ist.
- Prüfen Sie bei ERR10 die Verbindung und die Antwort der Waage. Wiederholen Sie zustandsändernde Aktionen nicht ungeprüft: Ohne Antwort wissen Sie nicht, ob die Aktion ausgeführt wurde.
- Behandeln Sie nicht verfügbare Felder als fehlende Daten und nicht als 0.
- Prüfen Sie Erfolg, Einheit und erforderliche Stabilität, bevor Sie ein Ergebnis speichern oder einen Prozess fortsetzen.
Weitere Informationen und technische Unterstützung: support@scale-monitor.com.
Diese Dokumentation basiert auf ScaleWebLink v1.5. Die Beispiele erläutern die Schnittstelle und müssen an Ihre Konfiguration angepasst werden.
Häufig gestellte Fragen zu ScaleWebLink
Was ist ScaleWebLink?
ScaleWebLink ist ein Webdienst, der über CloudScaleLink mithilfe von REST-Anfragen und JSON-Antworten mit einer Waage kommuniziert.
Kann ich eine vorhandene Waage verwenden?
Ja, wenn es sich über CloudScaleLink verbinden kann und sein Kommunikationsprotokoll konfiguriert werden kann. Wir überprüfen den Hersteller, das Modell, den Steckverbinder und die erforderlichen Befehle vor der Integration.
Kann ich eine Waage aus meiner Anwendung tarieren?
Ja, wenn die Waage und das Protokoll das Tarieren unterstützen. Definieren Sie eine Aktion und ihren Befehl in Scale Monitor und rufen Sie die Aktion anschließend über ScaleWebLink auf.
Ist eine Internetverbindung erforderlich?
Ja. Die dokumentierte Verbindung verwendet einen Cloud-Dienst und eine angeschlossene Waage oder einen Simulator.
Kann ich ohne echte Waage testen?
Ja. Der Scale Monitor-Simulator generiert eine MID und PIN zum Testen. Der API-Test überprüft Aktionen und zeigt Antworten an.
Sind immer alle Gewichtsfelder verfügbar?
Nein. net, gross, tare, unit und stability hängen von der Waagenantwort und dem Protokoll ab. null bedeutet, dass die Daten nicht empfangen wurden.
ScaleWebLink · v1.5 · PRECIZ / Scale Monitor
Brauchen Sie Hilfe?
Benötigen Sie Hilfe bei Software, Konnektivität oder der Verwendung einer Lösung? Beschreiben Sie das Problem, damit wir beim nächsten Schritt helfen können.