API V4 Pilotage par URL

De GCE Electronics
Aller à : navigation, rechercher

API V4.00.35

Introduction

API URL IPX800 V4

Presentation.png
Nom API URL IPX800 V4
Famille IPX800 V4

L'ensemble de l'API est protégé par les mots de passe de vos comptes administrateur et utilisateur. Si ces derniers ne sont pas protégés, votre API ne l'est pas non plus.

Cette API permet de commander :

  • les lampes MiLight,
  • l'envoi de Push URL,
  • l'envoi de Push UDP,
  • les canaux DMX reliés à l'extension X-DMX,
  • les canaux PWM de l'extension X-12PWM,
  • les volets roulants reliés à l'extension X-4VR,
  • les chauffages reliés à l'extension X-4FP,
  • les thermostats.

Les requêtes commenceront donc de la manière suivante : « http://IPX800_V4/admin/api.cgi?... » ou « http://IPX800_V4/user/api.cgi?... » selon que vous souhaitez utiliser l'API administrateur ou utilisateur.

Si les comptes sont protégés par un mot de passe, il faudra renseigner ce dernier de la manière suivante : « http://login:motDePasse@IPX800_V4/user/api.cgi?... » où le login et le « motDePasse » correspondent aux authentifications utilisateur (si on utilise l'API administrateur, il faudra les authentifications correspondantes).


Les commandes disponibles sont détaillées ci-dessous. Il est important de noter que certaines commandes ne peuvent pas être effectuées seules. En effet, par exemple, le protocole de communication de base des lampes MiLight demande à ce que le canal ou le groupe visé par la commande précède systématiquement une modification de ce dernier.


Dans cette optique, la commande ON n'est comprise par l'IPX que lorsqu'elle est précédée d'un canal ou d'un groupe. Pour les commandes de couleur et d'intensité lumineuse, si le canal n'est pas précisé, soit la requête s'appliquera au dernier canal piloté, soit elle ne s'appliquera pas (selon la période de temps écoulé depuis la dernière requête). Enfin, les commandes de vitesse et de mode ne nécessitent pas forcément que le canal soit indiqué. La encore, ce sera le dernier canal piloté qui effectuera la requête le cas échéant (pas de contrainte temporelle avec ces commandes).

Liste des commandes

Mi Light

Commande Argument Paramètre(s) Exemple(s)
SetMiLight
(commande permettant de déterminer l'adresse IP du contrôleur Wi- Fi de vos lampes MiLight)
XXX.XXX.XXX.XXX
l'adresse IP du contrôleur Wi-Fi de vos lampes MiLight
Commande obligatoire pour chaque requête MiLight http://IPX800_V4/user/api.cgi?Set MiLight=192.168.1.163
Type
(Commande permettant de déterminer le type de lampe et de contrôleur utilisé)
0 : Contrôleur de première génération et ampoule RGBW
1 : Ibox2 et ampoule RGBW
2 : Ibox2 et ampoule RGBWW,RGB+CCT, deux couleurs de blanc
Sans cette commande, ce paramètre est considéré à 0 par défaut. http://IPX800_V4/user/api.cgi?Set MiLight=192.168.1.163&Type=2
Channel
(commande permettant de déterminer le canal ou le groupe que vous souhaitez piloter)
X
le numéro du canal que vous souhaitez piloter de 0 à 4. Le canal 0 correspondant à un pilotage de tous les canaux.
Commande nécessaire au bon fonctionnement des autres requêtes http://IPX800_V4/user/api.cgi?Set MiLight=192.168.1.163&Type=1&Channel=0
(Pilotage de l'ensemble des canaux)

http://admin:admin@IPX800_V4/admin/api.cgi?SetMiLight=192.16 8.1.163&Type=2&Channel=4
(Pilotage du canal 4)

On
(commande permettant d'allumer ou de valider le fait que les lampes piloter sont bien allumées)
X
1 pour allumer, 0 pour éteindre vos lampes MiLight
Commande nécessairement précédée d'une commande « Channel » http://IPX800_V4/admin/api.cgi? SetMiLight=192.168.1.163&Type=2&Channel=0&On=1
(allumer tous les canaux)

http://user:user@IPX800_V4/user/api.cgi?SetMiLight=192.168.1.16 3&Type=1&Channel=4&On=0
(éteindre le canal 4)

Color
(commande permettant de modifier la couleur des lampes MiLight)
X
valeur de couleur souhaitée entre 0 et 255)
Commande de préférence précédée d'une commande « Channel » voire d'une commande « On » pour son bon fonctionnement

Priorité inférieure vis-à-vis d'une commande « White »

http://login:motdepasse@IPX800_V4/admin/api.cgi?SetMiLight=192.168.1.163&Type=1&Channel=0&On=1&Color=0

(allumer tous en violet)

White

(commande permettant de repasser les lampes MiLight en blanc)

X
de 1 à 100 pour passer en blanc (1 = blanc chaud, 100 = blanc froid), 0 pour ne rien faire
Commande de préférence précédée d'une commande « Channel » voire d'une commande « On » pour son bon fonctionnement

Commande prioritaire vis-à- vis d'une commande «Color»

http://IPX800_V4/user/api.cgi?Set MiLight=192.168.1.163&Type=2&Channel=4&On=1&Color=255&White=1

(passer le canal 4 en blanc tous en violet)

Dimmer

(commande permettant de modifier l'intensité lumineuse de vos lampes)

X
la valeur souhaitée en pourcentage : 0% faible luminosité, 100% forte luminosité
Commande de préférence précédée d'une commande « Channel » voire d'une commande « On » pour son bon fonctionnement http://IPX800_V4/admin/api.cgi? SetMiLight=192.168.1.163&Type=0&Channel=1&On=1&Dimmer=50

(mettre une intensité lumineuse moyenne sur le canal 1)

Mode

(commande permettant de passer au mode suivant : 8 modes disponibles à découvrir)

X
1 pour passer au mode suivant, 0 pour ne rien faire
Cette commande ne permet pas de revenir à un mode « classique » ou les lampes s'allument de manière continues http://login:motdepasse@IPX800_V4/user/api.cgi?SetMiLight=192.168.1.163&Type=1&Mode=1

(passer au mode suivant sur le dernier canal piloter)

SpeedUp

(commande permettant d'augmenter la vitesse des modes)

X : 1 pour augmenter la vitesse, 0 pour ne rien faire Cette commande n'a d'effet que lorsqu'un mode est actif http://login:motdepasse@IPX800_V4/admin/api.cgi?SetMiLigh=19 2.168.1.163&Mode=1&SpeedUp=1

(passer au mode suivant sur le canal 1 et en augmenter la vitesse)

SpeedDown

(commande permettant d'augmenter la vitesse des modes)

X
1 pour diminuer la vitesse, 0 pour ne rien faire
Cette commande n'a d'effet que lorsqu'un mode est actif http://IPX800_V4/admin/api.cgi? SetMiLight=192.168.1.163&Type=2&SpeedDown=1

(diminuer la vitesse du dernier canal piloter)

UnSync

(commande permettant de désynchroniser une lampe MiLight de son groupe ou de son contrôleur Wi-Fi)

X
1 pour désynchroniser, 0 pour ne rien faire
/ http://IPX800_V4/admin/api.cgi? SetMiLight=192.168.1.163&Type=1&UnSync=1

PUSH URL

Commande Argument Paramètre(s) Exemple(s)
SetPushURL

(commande permettant de déterminer le serveur vers lequel on veut communiquer)

XXX.XXX.XXX.XXX

l'adresse IP avec laquelle on veut communiquer

Commande obligatoire pour chaque requête de push URL http://IPX800_V4/user/api.cgi?Set PushURL=192.168.1.163
Message

(commande permettant de déterminer le message que l'on souhaite envoyer)

Le message tel qu'il doit être envoyé et se terminant par « EndMsg ».

Les caractères spéciaux ne sont pas gérés (hors '& ', '=' et ' ' ').

Commande obligatoire pour chaque requête de push URL.
Cette commande doit absolument être placée en dernier.
http://admin:admin@IPX800_V4/admin/api.cgi?SetPushURL=192.168.1.163&Message=Le message que vous souhaitezEndMsg
Port
(commande permettant de déterminer le port de communication)
X
le numéro du port que vous souhaitez de 0 à 65 535.
S'il n'est pas précisé, le port par défaut est le port 80 http://login:motdepasse@IPX800_V4/admin/api.cgi?SetPushURL=192.168.1.163&Port=9989&Message=Le message que vous souhaitezEndMsg
SSL

(commande permettant d'ajouter un encryptage SSL à votre communication)

X
1 pour activer le SSL, 0 pour ne rien faire
S'il n'est pas précisé, le SSL ne sera pas actif. S'il l'est, il sera actif uniquement pour la commande en cours http://IPX800_V4/admin/api.cgi? SetPushURL=192.168.1.163&SSL=1&Message=Le message que vous souhaitezEndMsg
Login

(commande permettant de renseigner une éventuelle authentification)

L'authentification sous la forme :

« login:motDePasse »

/ http://login:motdepasse@IPX800_V4/admin/api.cgi?SetPushURL=192.168.1.163&Port=9989&Login=login:motdepasse&Message=Le message que vous souhaitezEndMsg
Method

(commande permettant de choisir la méthode d’envoi des notifications : GET ou POST)

X
1 pour activer un envoi en POST, 0 pour un envoi en GET
Si la méthode n'est pas précisée, l'envoi sera de type GET http://login:motdepasse@IPX800_V4/admin/api.cgi?SetPushURL=192.168.1.163&Port=9989&Login=login:motdepasse&Method=1&Message=Le message que vous souhaitezEndMsg

Push UDP

Commande Argument Paramètre(s) Exemple(s)
SetPushUDP

(commande permettant de déterminer le serveur vers lequel on veut communiquer)

XXX.XXX.XXX.XXX

l'adresse IP avec laquelle on veut communiquer

Commande obligatoire pour chaque requête de push UDP http://IPX800_V4/user/api.cgi?SetPushUDP=192.168.1.163
Port

(commande permettant de déterminer le port de communication)

X
le numéro du port que vous souhaitez de 0 à 65 535.
Commande obligatoire pour chaque requête de push UDP http://admin:admin@IPX800_V4/ad min/api.cgi?SetPushUDP=192.168.1.163&Port=9
Message

(commande permettant de déterminer le message que l'on souhaite envoyer en UDP)

Le message tel qu'il doit être envoyé Commande obligatoire pour chaque requête de push UDP http://login:motdepasse@IPX800_V4/admin/api.cgi?SetPushUDP=192.168.1.163&Port=9989&Message=Le message que vous souhaitez
ListenPort

(commande permettant de déterminer le port d'écoute de votre communication)

X
le numéro du port que vous souhaitez de 0 à 65 535.

Si non renseigné, par défaut 0.

Le port d'écoute peut être nécessaire à l'envoi de certains push UDP. En effet, il peut conditionner l'ouverture de la socket UDP. http://admin:admin@IPX800_V4/user/api.cgi?SetPushUDP=192.168.1.163&Port=9&Message=Le message que vous souhaitez&ListenPort=9988

X-DMX

Commande Argument Paramètre(s) Exemple(s)
SetDMX

(commande permettant de déterminer le canal que l'on veut piloter)

X
le canal DMX que vous souhaitez piloter (de 0 à 512)
Commande obligatoire pour chaque requête DMX sur un seul canal http://IPX800_V4/user/api.cgi?SetD MX=192&DMXValue=0
DMXValue

(commande permettant de déterminer la valeur à attribuer à un canal déterminé)

X
la valeur que vous souhaitez de 0 à 255
Commande suivant obligatoirement une commande SetDMX http://admin:admin@IPX800_V4/ad min/api.cgi?SetDMX=1&DMXValue=255
DMXAll

(commande permettant de piloter l'ensemble des canaux simultanément)

X
1 pour mettre tous les canaux à 255, 0 pour les repasser à 0
Commande unique http://IPX800_V4/user/api.cgi?DMX All=1

X-4VR

Commande Argument Paramètre(s) Exemple(s)
Set4VR

(commande permettant de déterminer le numéro de l'extension que l'on veut piloter)

X
le numéro de l'extension que l'on veut piloter (de 1 à 8)
Commande obligatoire pour chaque requête X4VR http://IPX800_V4/user/api.cgi?Set4VR=1
VrNum

(commande permettant de déterminer le volet à piloter)

X
le numéro du volet à piloter de 1 à 4
Sans cette commande, tous les volets sont pilotés http://admin:admin@IPX800_V4/admin/api.cgi?Set4VR=8&VrNum=4
VrCmd

(commande permettant de choisir la commande à appliquer)

X
0 pour stopper le moteur, 1 pour monter, 2 pour descendre
Commande incompatible avec un PulseCmd et VrPercent http://admin:admin@IPX800_V4/admin/api.cgi?Set4VR=8&VrNum=4&VrCmd=2
VrPercent X
le pourcentage souhaité
Commande incompatible avec un PulseCmd et VrCmd http://IPX800_V4/user/api.cgi?Set4VR=8&VrNum=4&VrPercent=95
PulseUp X
le nombre d'impulsion (de 0 à 127)
Commande incompatible avec un VrCmd et PulseDown http://admin:admin@IPX800_V4/admin/api.cgi?Set4VR=8&VrNum=4&PulseUp=20
PulseDown X
le nombre d'impulsion (de 0 à 127)
Commande incompatible avec un VrCmd et PulseUp http://admin:admin@IPX800_V4/admin/api.cgi?Set4VR=8&VrNum=4&PulseDown=20
Cal X
1
Commande incompatible avec un VrCmd, VrNum, PulseDown et PulseUp http://admin:admin@IPX800_V4/admin/api.cgi?Set4VR=8&Cal=1

X-4FP

Commande Argument Paramètre(s) Exemple(s)
Set4FP

(commande permettant de déterminer le numéro de l'extension que l'on veut piloter)

X
le numéro de l'extension que l'on veut piloter (de 1 à 4)
Commande obligatoire pour chaque requête X4FP http://IPX800_V4/user/api.cgi?Set4FP= 1
FpZone

(commande permettant de déterminer la zone à piloter)

X
le numéro de la zone à piloter de 1 à 4
Sans cette commande, toutes les zones sont pilotés http://admin:admin@IPX800_V4/admin/api.cgi?Set4FP=4&FpZone=4
FpCmd

(commande permettant de choisir la commande à appliquer)

X
0 pour confort,
1 pour Eco,
2 pour Hors Gel,
3 pour Arrêt,
4 pour Confort -1
5 pour Confort -2
Commande obligatoire pour chaque requête X4FP http://admin:admin@IPX800_V4/admin/api.cgi?Set4FP=8&FpZone=4&FpCmd=2

X-PWM

Commande Argument Paramètre(s) Exemple(s)
SetPWM

(commande permettant de déterminer le canal que l'on veut piloter)

X : le canal PWM dque vous souhaitez piloter, de 1 à 24
1 à 12 pour la première extension,
13 à 24 pour la seconde)
Commande obligatoire pour chaque requête PWM sur un seul canal http://IPX800_V4/user/api.cgi?SetP WM=12&PWMValue=0
PWMValue

(commande permettant de déterminer la valeur à attribuer à un canal déterminé)

X
la valeur que vous souhaitez de 0 à 100 (pourcentage)
Commande suivant obligatoirement une commande SetPWM http://admin:admin@IPX800_V4/ad min/api.cgi?SetPWM=1&PWMValue=50
PWMDelay
X
vitesse de transition (de 0 à 60000) en millisecondes
Commande facultative (0 par défaut) http://admin:admin@IPX800_V4/ad min/api.cgi?SetPWM=1&PWMValue=50&PWMDelay=30000
PWMAllOn

(commande permettant de mettre l'ensemble des canaux à 100)

X
le numéro de l'extension (1 ou 2)
Commande ne pouvant être complétée que par une commande de délais http://IPX800_V4/user/api.cgi?PWM AllOn=1
PWMAllOff

(commande permettant de mettre l'ensemble des canaux à 0)

X
le numéro de l'extension (1 ou 2)
Commande ne pouvant être complétée que par une commande de délais http://IPX800_V4/user/api.cgi?PWM AllOff=2&PWMDelay=30000

X-ENO

Commande Argument Paramètre(s) Exemple(s)
PCEnoSet

(commande permettant d'allumer une prise de courant Enocean)

X
le numéro de la prise de 1 à 8
Commande unique http://IPX800_V4/user/api.cgi?PCEnoSet=7
PCEnoClear

(commande permettant d'éteindre une prise de courant Enocean)

X
le numéro de la prise de 1 à 8
Commande unique http://admin:admin@IPX800_V4/ad min/api.cgi?PCEnoClear=2
PCEnoToggle

(commande permettant changer l'état d'une prise de courant Enocean)

X
le numéro de la prise de 1 à 8
Commande unique http://admin:admin@IPX800_V4/ad min/api.cgi?PCEnoToggle=2
PCEnoPairing

(commande permettant de forcer l'appairage d'une prise de courant Enocean)

X
le numéro de la prise de 1 à 8
Commande unique http://IPX800_V4/user/api.cgi?PCEn oPairing=1
PCEnoConso

(commande permettant d'activer les retours de consommation des prises Enocean compatible)

X
le numéro de la prise de 1 à 8
Commande unique http://IPX800_V4/user/api.cgi?PCEnoConso=1

X-Dimmer

Commande Argument Paramètre(s) Exemple(s)
SetDim

(commande permettant de déterminer l'extension que l'on veut piloter)

X
le n uméro de l'extension X-Dimmer que vous souhaitez piloter (de 1 à 6)
Commande obligatoire pour chaque requête X- Dimmer sur un seul canal http://IPX800_V4/user/api.cgi?S etDim=1&DimCha=1&DimValue=0
DimCha

(commande permettant de déterminer le canal que l'on veut piloter)

X
le canal de X-Dimmer que vous souhaitez piloter (de 1 à 4)
Commande obligatoire pour chaque requête X-Dimmer sur un seul canal http://IPX800_V4/user/api.cgi?S etDim=6&DimCha=4&DimValue=0
DimValue

(commande permettant de déterminer la valeur à attribuer à un canal déterminé)

X
la valeur que vous souhaitez de 0 (OFF) à 100(pourcentage)

OU 101 : simple ON à la dernière valeur connue

Commande suivant obligatoirement une commande SetDim http://admin:admin@IPX800_V 4/admin/api.cgi?SetDim=1&DimCha=4&DimValue=50
DimDelay

(commande permettant de déterminer la vitesse de transition d'une commande de pilotage)

X
vitesse de transition (de 0 à 60000) en milliseconde
Commande facultative (0 par défaut) http://admin:admin@IPX800_V4/admin/api.cgi?SetDim=2&DimCha=2&DimValue=0&DimDelay=30000
DimAll

(commande permettant de piloter l'ensemble des canaux d'une extension)

X
le numéro de l'extension (de 1 à 6)
Commande ne pouvant être complétée par une commande DimValue
et/ou DimDelay (si non renseigné,
DimDelay à 0
et DimValue à 101 afin d'attribuer la dernière valeur connue)
http://IPX800_V4/user/api.cgi?DimAllOn=1&DimValue=0

Thermostat

Commande Argument Paramètre(s) Exemple(s)
SetThermo

(commande permettant de déterminer le numéro du thermostat que l'on veut commander)

XX
le numéro Thermostat que vous souhaitez commander (de 00 à 15)
Commande obligatoire pour chaque requête Thermostat http://IPX800_V4/admin/api.cgi?SetThermo=00&Cons=22&Hys=2
Cons

(commande permettant de déterminer la température de consigne)

X
la valeur que vous souhaitez (0, 0.5, 1, 2…)
Commande à associer obligatoirement avec « Hys » http://IPX800_V4/admin/api.cgi?SetThermo=00&Cons=22.5&Hys=2
Hys

(commande permettant de déterminer l’hystérésis)

X : la valeur que vous souhaitez (0, 0.5, 1, 2…) Commande à associer obligatoirement avec « Cons » http://IPX800_V4/admin/api.cgi?SetThermo=00&Cons=20&Hys=2.5
ConsPlus

(commande permettant d’augmenter la consigne de température)

X
valeur à ajouter à la consigne (0, 0.5, 1…)
Commande unique http://IPX800_V4/admin/api.cgi?SetT hermo=00&ConsPlus=0.5
ConsMoins

(commande permettant de diminuer la consigne de température)

X
valeur à soustraire à la consigne (0, 0.5, 1…)
Commande unique http://IPX800_V4/admin/api.cgi?SetT hermo=00&ConsMoins=0.5

Remarques

Concernant l’utilisation des entrées analogiques et des entrées analogiques virtuelles, vous pouvez utiliser des formules personnalisées sous conditions de respecter les règles suivantes :

  • La formule doit commencer par la variable « X » ;
  • Le traducteur ne tient pas compte de la priorité opératoire ;
  • Le convertisseur effectue les calculs de gauche à droite ;
  • Le convertisseur effectue au maximum 4 opérations ;
  • Le convertisseur prend en compte les chiffres à virgule (mettre un point) ;
  • Le convertisseur ne prend pas en compte les parenthèses.