SCALEWEBLINK · v1.5 · REST / JSON
ScaleWebLink – notice utilisateur et REST API
Notice HTML ScaleWebLink v1.5 : protocole, POST JSON, MID et PIN, données de poids, ERR01–ERR10, API test et simulateur.
Notice en slovène ↗← Toutes les notices des produits
1. Objectif et fonctionnement
ScaleWebLink communique avec une balance par des services web REST chiffrés SSL. La balance se connecte au cloud via CloudScaleLink. Un système externe envoie une action et reçoit une réponse JSON.
Chaque module CloudScaleLink possède un MID (Module ID) et un PIN (Module PIN) uniques. Ensemble, ils autorisent l’accès à la balance. Pour CloudScaleLink virtuel, MID et PIN sont fournis par e-mail.
Vous avez besoin d’un compte Scale Monitor, d’une balance connectée avec un protocole adapté ou d’un simulateur, et de l’accès au service. Les commandes et les champs disponibles dépendent de la balance et du protocole.
2. Démarrage rapide
- Inscrivez-vous par votre lien partenaire ou register.scale-monitor.com, puis connectez-vous à Scale Monitor.
- Ajoutez la balance et vérifiez sa connexion CloudScaleLink.
- Ouvrez Menu → Protocol → ScaleWebLink.
- Sélectionnez Protocol et Protocol version.
- Affectez une commande de lecture du poids adaptée à
Get_Weight. - Ouvrez API test, sélectionnez l’action et envoyez-la.
- Vérifiez la réponse, puis intégrez la requête POST dans votre application.
3. Protocole, actions et commandes
Dans Menu → Protocol → ScaleWebLink, sélectionnez le protocole et sa version pour la balance connectée. La notice originale utilise Mettler Toledo MT SICS comme exemple.
Le tableau des réglages comprend deux colonnes : Action est le nom de l’action appelée par votre application ; Command est la commande envoyée à la balance.
Le nom prédéfini Get_Weight ne peut pas être modifié, mais sa commande peut être sélectionnée. Cliquez sur Add pour créer une ligne, saisissez votre nom d’action et sélectionnez la commande.
| Champ / code | Signification et utilisation |
|---|---|
Get_Weight → SIX1 | Exemple de requête de poids avec MT SICS, version MT SICS_1. |
Tare → T | Exemple de tarage MT SICS : l’action Tare envoie la commande T. |
Les exemples MT SICS ne sont pas des commandes universelles pour les autres balances. Vérifiez les fonctions disponibles dans le protocole de l’appareil connecté.
4. Requête POST et autorisation
Envoyez un objet JSON avec trois champs. Leurs noms sont en minuscules.
| Champ / code | Signification et utilisation |
|---|---|
mid | Identifiant du module CloudScaleLink. |
pin | PIN du module CloudScaleLink. |
action | Get_Weight ou nom d’une action personnalisée enregistrée. |
Pour un module physique, MID et PIN figurent sur son étiquette. Pour un module virtuel, utilisez les identifiants fournis par e-mail.
Adresse API : utilisez l’URL du service affectée à votre connexion. Le PDF v1.5 ne précise pas d’URL de point de terminaison ; contactez l’assistance si vous ne l’avez pas. L’exemple ci-dessous utilise une adresse fictive explicitement indiquée, pas un point de terminaison opérationnel.
{
"mid": "yourMID",
"pin": "yourCSLPIN",
"action": "Get_Weight"
}cURL
# Remplacez l’URL fictive et les identifiants du module.
curl --request POST 'https://YOUR-SCALEWEBLINK-ENDPOINT' --header 'Content-Type: application/json' --data '{"mid":"yourMID","pin":"yourCSLPIN","action":"Get_Weight"}'5. Réponse JSON
ScaleWebLink renvoie un objet JSON. L’exemple conserve la réponse de la notice v1.5 ; la disponibilité et le contenu suivent le protocole de la balance.
| Champ / code | Signification et utilisation |
|---|---|
error | 0 = aucune erreur ; 1 = une erreur s’est produite. |
errorCode | Code d’erreur ; voir le chapitre 7. |
errorMsg | Brève description de l’erreur. |
scaleResponse | Chaîne brute reçue de la balance en réponse à la commande. |
dateTime | Date et heure UTC d’exécution de l’action. |
weightData | Objet contenant les données de poids disponibles. |
La notice v1.5 présente dateTime comme date UTC textuelle. Le site original montre aussi un horodatage numérique et des poids sous forme de chaînes. Vérifiez la réponse réelle du service et du protocole et convertissez les types en conséquence ; ne supposez pas un format unique.
{
"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. Champs weightData
| Champ / code | Signification et utilisation |
|---|---|
net | Poids net ; null si non reçu. |
gross | Poids brut ; null si non reçu. |
tare | Valeur de tare ; null si non reçue. |
unit | Unité de poids ; null si non reçue. |
stability | null = aucune donnée ; 0 = balance instable ; 1 = balance stable. |
expectedResponseStatus | null = non configuré ; 0 = réponse non OK ; 1 = réponse OK. |
expectedResponseMsg | Message configuré pour la commande correspondante dans les réglages du protocole. |
null ne signifie pas un poids nul. Avant d’utiliser une mesure, vérifiez les erreurs, les champs requis, l’unité et la stabilité. Les exemples ne sont pas des mesures de référence ; validez l’analyse des données avec la balance réelle.
7. Codes d’erreur et dépannage
Si une action échoue, la réponse contient un code d’erreur. Vérifiez d’abord le JSON et la configuration de l’action, puis la connexion et la réponse de la balance.
| Champ / code | Signification et utilisation |
|---|---|
ERR01 | Données POST requises absentes ou JSON non valide. Vérifiez le corps de la requête et la syntaxe JSON. |
ERR02 | Identifiant de module (MID) absent. Incluez mid. |
ERR03 | PIN du module absent. Incluez pin. |
ERR04 | Action absente. Incluez action. |
ERR05 | Action introuvable parmi les actions enregistrées. Vérifiez son nom et sa configuration. |
ERR06 | Aucun Scale Monitor connecté au topic reçu. Vérifiez le topic et la connexion. |
ERR07 | Données de commande introuvables. Sélectionnez une commande valide pour l’action. |
ERR08 | Chaîne de commande absente. Vérifiez la propriété command dans le protocole sélectionné. |
ERR09 | Service occupé : un autre client communique avec la balance avec le même MID et PIN. Sérialisez les requêtes et réessayez plus tard. |
ERR10 | Délai dépassé : aucune réponse reçue dans le temps imparti. Vérifiez la connexion et le protocole. |
8. API test
- Ouvrez Protocol → ScaleWebLink.
- Cliquez sur API test au bas de la page.
- Sélectionnez une action enregistrée dans la nouvelle fenêtre.
- Envoyez l’action et examinez la réponse affichée.
Exemple de la notice : Protocol: MT SICS, Version: MT SICS_1, Action: Get_Weight, commande affectée SIX1. Si le test échoue, utilisez le tableau des erreurs et vérifiez la commande.
9. Simulateur sans balance physique
- Ouvrez Scale simulation dans le menu en haut à gauche.
- Cliquez sur l’icône plus de l’onglet Presets.
- Saisissez les données souhaitées du simulateur.
- Définissez Connection type sur Scale link, puis cliquez sur Save.
- Le MID et le PIN générés apparaissent en haut après l’enregistrement.
- Cliquez sur le simulateur enregistré dans Presets pour le connecter au cloud.
- Utilisez son MID et son PIN dans les requêtes ScaleWebLink.
Le simulateur aide au développement et aux tests API. Avant d’utiliser l’intégration dans votre processus, vérifiez la balance réelle, le protocole et les actions requises.
10. Recommandations d’intégration et assistance
- Conservez MID et PIN côté serveur ; ne les exposez pas dans le code public du site ou les journaux.
- Sérialisez les requêtes vers une même balance. ERR09 indique que la communication est occupée.
- Pour ERR10, vérifiez la connexion et la réponse. Ne répétez pas aveuglément une action modifiant l’état : sans réponse, vous ne savez pas si elle a été exécutée.
- Traitez les champs indisponibles comme des données absentes, pas comme 0.
- Avant d’enregistrer un résultat ou de poursuivre un processus, vérifiez la réussite, l’unité et la stabilité requise.
Pour des informations et une assistance technique : support@scale-monitor.com.
Cette documentation repose sur ScaleWebLink v1.5. Les exemples expliquent l’interface et doivent être adaptés à votre configuration.
Questions fréquentes sur ScaleWebLink
Qu’est-ce que ScaleWebLink ?
ScaleWebLink est un service web qui communique avec une balance via CloudScaleLink en utilisant des requêtes REST et des réponses JSON.
Puis-je utiliser une balance existante ?
Oui, si elle peut se connecter via CloudScaleLink et si son protocole est configurable. Nous vérifions le fabricant, le modèle, le connecteur et les commandes requises avant l’intégration.
Puis-je tarer la balance depuis mon application ?
Oui, si la balance et le protocole le permettent. Définissez une action et sa commande dans Scale Monitor, puis appelez-la via ScaleWebLink.
Une connexion internet est-elle requise ?
Oui. La connexion documentée utilise un service cloud et une balance connectée ou un simulateur.
Puis-je tester sans balance physique ?
Oui. Le simulateur Scale Monitor génère un MID et un PIN pour les tests. API test vérifie les actions et affiche les réponses.
Tous les champs de poids sont-ils toujours disponibles ?
Non. net, gross, tare, unit et stability dépendent de la réponse et du protocole. null signifie que les données n’ont pas été reçues.
ScaleWebLink · v1.5 · PRECIZ / Scale Monitor
Besoin d’aide ?
Besoin d’aide pour logiciel, connectivité ou utilisation ? Décrivez le problème pour que nous aidions à la prochaine étape.