Services Web

Communication facile

Avec les services Web et les commandes HTTP simples, vous pouvez récupérer des informations et créer ou modifier des paramètres à l’aide du Miniserver de Loxone.

Contenu

Général

Structure des services web

Statut & Contrôle

Query: Status of a control
Push-button
Query: All output changes

Configuration & statistiques

PLC Commands
Configuration Commands
Statistics Commands

 

Général

La structure des Webservices

(Utilisant la technologie RESTful Web Services)

http://User:[email protected]/command/control/value

  • control: peut être n’importe quelle entrée ou sortie, réelle ou virtuelle. Les sorties ne peuvent être utilisées que pour les demandes d’état.
  • value: lorsque ‘value’ n’est pas disponible, la valeur de contrôle actuelle est renvoyée. Les valeurs suivantes sont autorisées: ‘A’, ‘On’, ‘off’, ‘Off’, ‘Impulse’, ‘Pulse’ ou une valeur décimale (<1).
  • Entrées numériques virtuelles avec 2 sorties (up-down, left-right, à partir de la version 1.5.4.16), les valeurs suivantes sont autorisées.
ImpulsPlus
ImpulsMinus
PulseUp
PulseDown
ImpulsAuf
ImpulsAb
PulseOpen
PulseClose
PlusEin
PlusAus
UpOn
UpOff
AufEin
AufAus
OpenOn
OpenOff
MinusEin
MinusAus
DownOn
DownOff
AbEin
AbAus
CloseOff
CloseOff

 

  • ‘On’ = 1 et ‘Off’ = 0 pour les entrées et sorties numériques.
  • Les entrées analogiques (0-10V) fonctionnent dans une plage comprise entre 0 et 10,00. Il n’y a pas de limite formelle (par exemple les températures EIB de 21,5 ou -5,2).
  • Un point est utilisé pour la sortie décimale.

Statut & contrôle

Requête: statut d’un contrôle

Commandehttp://miniserver/dev/sps/io/LivingroomLight/state
FonctionRetourne le statut à l’entrée
Réponse<LL control= »dev/sps/io/LivingroomLight » value= »0″ Code= »200″/>

 

Commandehttp://miniserver/dev/sps/io/LivingroomLight/astate
FonctionRetourne une valeur à la sortie requise (soit une valeur unique pour tous les – ou un ? pour différentes valeurs).
Réponse<LL control= »dev/sps/io/LivingroomLight » value= »1″ Code= »200″/>

 

Commandehttp://miniserver/dev/sps/io/LivingroomLight/all
FonctionRenvoie le nombre de sorties demandées et une liste des valeurs à ces sorties
Réponse<LL control= »dev/sps/io/LivingroomLight/all » value= »8″ Code= »200″
n1= »Aktor (Relais) Q1″ u1= »68347a0e-3bfc-11df-85f6ea34eeb9b08a » v1= »0″
n2= »Aktor (Relais) Q2″ u2= »68347a0e-3bfc-11df-85f6ea34eeb9b08a » v2= »0″
n3= »Aktor (Relais) Q3″ u3= »68347a0e-3bfc-11df-85f6ea34eeb9b08a » v3= »0″
n4= »Aktor (Relais) Q4″ u4= »68347a0e-3bfc-11df-85f6ea34eeb9b08a » v4= »0″
n5= »Aktor (Relais) Q5″ u5= »68347a0e-3bfc-11df-85f6ea34eeb9b08a » v5= »0″
n6= »Aktor (Relais) Q6″ u6= »68347a0e-3bfc-11df-85f6ea34eeb9b08a » v6= »1″
n7= »Aktor (Relais) Q7″ u7= »68347a0e-3bfc-11df-85f6ea34eeb9b08a » v7= »0″
n8= »Aktor (Relais) Q8″ u8= »68347a0e-3bfc-11df-85f6ea34eeb9b08a » v8= »0″/>

 

Commandehttp://miniserver/status
FonctionRépertorie tous les périphériques connectés au Miniserver, ainsi que le statut
Réponse<Status Modified= » « >
<Miniserver Name= »LoxMiniserver » Internalname= »  » IP= »  » Mask= »  » Gateway= »  » DHCP= »  » DNS1= »  » DNS2= »  » MAC= »  » Device= »  » Version= » « ><Extension Name= »  » Internalname= »  » Serial= »  » Version= »  » Online= » « /></Miniserver></Status>

Status requests via web service are only possible with inputs and outputs and are not possible with function blocks.

Bouton poussoir

Commandehttp://miniserver/dev/sps/io/PushbuttonLivingRoomLight/On
FonctionContrôler l’entrée analogique ou numérique
Réponse<LL control= »dev/sps/io/PushbuttonLivingRoomLight » value= »1″ Code= »200″/>

Requête: changement de toutes les entrées

Commandehttp://miniserver/dev/sps/changes
FonctionEnvoie toutes les sorties qui ont changé depuis la dernière requête
Réponse<LL control= »dev/sps/changes » value= »5″ Code= »200″
n1= »Aktor (Relais) Q1″ u1= »68347a0e-3bfc-11df-8604ea34eeb9b08a » v1= »0″
n2= »Aktor (Relais) Q2″ u2= »68347a0e-3bfc-11df-8605ea34eeb9b08a » v2= »0″
n3= »Aktor (Relais) Q3″ u3= »68347a0e-3bfc-11df-8606ea34eeb9b08a » v3= »0″
n4= »Aktor (Relais) Q4″ u4= »68347a0e-3bfc-11df-8607ea34eeb9b08a » v4= »0″
n5= »Aktor (Relais) Q5″ u5= »68347a0e-3bfc-11df-8608ea34eeb9b08a » v5= »1″/>

 

Commandehttp://miniserver/dev/sps/event
FonctionGénère un serveur d’événements dans le serveur Web. Un Eventhandler doit être programmé dans le Webclient (ex., new EventSource (http://miniserver/dev/sps/event)).
RéponseEnvoie toutes les sorties qui ont changé sans nouvelle demande d’envoi.
http://www.w3.org/TR/eventsource/
Event: changed
data: Name
data: uuid
data: Wert

 

Commandehttp://miniserver/dev/sps/enablestatusupdate
FonctionPermet l’envoi automatique des changements d’état dans le WebSocket.
RéponseEnvoie l’état actuel via WebSocket

Configuration et statistiques

Commande PLC

CommandeFonction
http://miniserver/dev/sps/stateRequête d’état de l’automate
0 – No status
1 – PLC booting
2 – PLC program is loaded
3 – PLC has started
4 – Loxone Link has started
5 – PLC running
6 – PLC change
7 – PLC error
8 – Update is occuring
http://miniserver/dev/sps/statusFréquence PLC actuelle
http://miniserver/dev/sps/restartPLC restart
http://miniserver/dev/sps/stopPLC stop
http://miniserver/dev/sps/runPLC continue
http://miniserver/dev/sps/logPLC permit global logging
http://miniserver/dev/sps/nologPLC disable global logging
http://miniserver/dev/sps/enumdevList all PLC devices (Miniserver, extensions)
http://miniserver/dev/sps/enuminList all PLC inputs
http://miniserver/dev/sps/enumoutList all PLC outputs
http://miniserver/dev/sps/identifyIdentifier Miniserver (version 1.5.6.7 et supérieure)
Pour les extensions, le numéro de série doit être un paramètre

Commandes de configuration

CommandeFonction
http://miniserver/dev/cfg/macRécupérer l’adresse MAC
http://miniserver/dev/cfg/versionObtenir la version du firmware
http://miniserver/dev/cfg/versiondateObtenir la date de production du firmware
http://miniserver/dev/cfg/dhcpRécupérer ou définir la configuration DHCP
http://miniserver/dev/cfg/ipRécupérer ou définir l’adresse IP
http://miniserver/dev/cfg/maskRécupérer ou définir un masque IP
http://miniserver/dev/cfg/gatewayRécupérer ou définir l’adresse de la passerelle
http://miniserver/dev/cfg/deviceRécupérer ou définir le nom de périphérique Miniserver
http://miniserver/dev/cfg/dns1Récupérer ou définir l’adresse DNS 1
http://miniserver/dev/cfg/dns2Récupérer ou définir l’adresse DNS 2
http://miniserver/dev/cfg/ntpRécupérer ou définir l’adresse NTP
http://miniserver/dev/cfg/timezoneoffsetRécupérer ou définir le décalage de fuseau horaire
http://miniserver/dev/cfg/httpRécupérer ou définir le port HTTP
http://miniserver/dev/cfg/ftpRécupérer ou définir le port FTP
http://miniserver/dev/cfg/LoxPLANRécupérer ou définir le port du logiciel de configuration
http://miniserver/dev/cfg/ftllocalonlyRécupérer ou définir « FTP, Telnet, accès aux logiciels locaux uniquement »

Commandes système

CommandeFonction
http://miniserver/dev/lan/txpRécupérer le nombre de paquets LAN envoyés
http://miniserver/dev/lan/txeRécupérer le nombre de paquets LAN envoyés avec des erreurs
http://miniserver/dev/lan/txcRécupérer le nombre de paquets LAN envoyés avec des collisions
http://miniserver/dev/lan/exhRécupérer le nombre d’erreurs de tampon LAN
http://miniserver/dev/lan/txuRécupérer le nombre d’erreurs sous-jacentes du LAN
http://miniserver/dev/lan/rxpRécupérer le nombre de paquets LAN reçus
http://miniserver/dev/lan/eofRécupérer le nombre d’erreurs LAN EOF
http://miniserver/dev/lan/rxoRécupérer le nombre d’erreurs de dépassement de réception LAN
http://miniserver/dev/lan/nobRécupérer le nombre d’erreurs LAN ‘No receive buffer’
http://miniserver/dev/bus/packetssentRécupérer le nombre de paquets envoyés au bus CAN
http://miniserver/dev/bus/packetsreceivedRécupérer le nombre de paquets reçus sur le bus CAN
http://miniserver/dev/bus/receiveerrorsRécupérer le nombre d’erreurs de réception sur le bus CAN
http://miniserver/dev/bus/frameerrorsRécupérer le nombre d’erreurs de trame sur le bus CAN
http://miniserver/dev/bus/overrunsRécupérer le nombre d’erreurs de débordement sur le bus CAN
http://miniserver/dev/bus/parityerrorsRécupérer le nombre d’erreurs de parité sur le bus CAN
http://miniserver/dev/sys/numtasksRécupérer le nombre de tâches
http://miniserver/dev/sys/cpuRécupérer la charge du processeur
http://miniserver/dev/sys/contextswitchesRécupérer le nombre de commutations entre les tâches
http://miniserver/dev/sys/contextswitchesiRécupérer le nombre de commutations entre les tâches qui ont été déclenchées
http://miniserver/dev/sys/heapRécupérer la taille de la mémoire
http://miniserver/dev/sys/intsRécupérer le nombre d’interruptions du système
http://miniserver/dev/sys/comintsRécupérer le nombre d’interruptions de communication
http://miniserver/dev/sys/lanintsRécupérer le nombre d’interruptions LAN
http://miniserver/dev/sys/watchdogRécupérer des bits de surveillance
http://miniserver/dev/sys/dateRenvoie la date locale
http://miniserver/dev/sys/timeRenvoie l’heure locale
http://miniserver/dev/sys/setdatetimeDéfinissez la date et l’heure du système. Format: 2013-06-18 16:58:00 ou 18/06/2013 16:58:00
http://miniserver/dev/sys/spscycleRécupérer le nombre de cycles de l’automate
http://miniserver/dev/sys/ntpForcer les requêtes NTP
http://miniserver/dev/task0/nameRécupérer le nom de la tâche 0 (0-http://nubuserver/dev/sys/numtasks – 1)
http://miniserver/dev/task0/priorityRécupérer la priorité de la tâche 0
http://miniserver/dev/task0/stackRécupérer la pile de la tâche 0
http://miniserver/dev/task0/contextswitchesRécupérer le nombre de commutations de tâches 0
http://miniserver/dev/task0/waittimeoutRécupérer la tâche 0 temps d’attente en ms
http://miniserver/dev/task0/stateRécupérer le statut de la tâche 0
http://miniserver/dev/sys/rebootMiniserver de démarrage
http://miniserver/dev/sys/checkAffiche les connexions actives dans Loxone Config
http://miniserver/dev/sys/logoffTermine toutes les connexions existantes dans Loxone Config
http://miniserver/dev/sys/sdtestTeste la carte SD
http://miniserver/dev/sys/lastcpuAffiche la dernière valeur de l’utilisation du processeur et le nombre de cycles de l’automate
http://miniserver/dev/sys/searchEffectue une recherche pour les extensions connectées
http://miniserver/dev/sys/searchdataRépertorie les résultats de la recherche
http://miniserver/dev/fslist/Répertorie le répertoire racine de la carte SD
http://miniserver/dev/fslist/path/Répertorie le chemin du répertoire sur la carte SD
http://miniserver/dev/fsget/filepath/Récupère un fichier (remplace le chemin du fichier par le nom du fichier)
http://miniserver/dev/fsdel/filepath/Supprime un fichier (remplace le fichier par le nom du fichier)
http://miniserver/data/statusAffiche le statut du Miniserver et de toutes les extensions connectées
http://miniserver/statsAffiche les statistiques
http://miniserver/data/LoxAPP2.xmlFichier de structure pour la visualisation
http://miniserver/dev/fsget/log/def.logRécupérer le journal
http://miniserver/dev/sys/ExtStatistics/05000001Récupérer les statistiques d’une extension à 1 fil (remplacez le 05000001 par le numéro de série actuel)
http://miniserver/dev/sys/AirStatistics/0C000001/DeviceIndexRécupérer les statistiques d’une extension de la base aérienne (remplacer 0C000001 par le numéro de série actuel)
http://miniserver/dev/sys/updateextLancer une mise à jour des extensions