Ligne 8 : |
Ligne 8 : |
| == Rest API == | | == Rest API == |
| === HTTP Get === | | === HTTP Get === |
− | To get a state of a device HTTP GET request can be send to the evok
| + | Il est possible d'obtenir l'état d'un périphérique en faisant un requête GET sur Evok. |
| | | |
| GET /rest/DEVICE/CIRCUIT | | GET /rest/DEVICE/CIRCUIT |
| | | |
− | or
| + | ou |
| | | |
| GET /rest/DEVICE/CIRCUIT/PROPERTY | | GET /rest/DEVICE/CIRCUIT/PROPERTY |
| | | |
− | Where DEVICE can be substituted by any of these: 'relay', 'di' or 'input', 'ai' or 'analoginput, 'ao' or 'analogoutput', 'sensor', CIRCUIT is the number of circuit (in case of 1Wire sensor, it is its address) corresponding to the number in your configuration file and PROPERTY is mostly 'value'.
| + | Où DEVICE peut être substitué par l'une des valeurs suivantes : |
| + | * relay |
| + | * di ''ou'' input |
| + | * ai ''ou'' analoginput |
| + | * ao ''ou'' analogoutput |
| + | * sensor |
| | | |
− | Simple example using wget to get status of devices:
| + | Où CIRCUIT est le numéro du circuit |
| + | * dans le cas du senseur 1Wire : il s'agit de son adresse 1-Wire. |
| + | * correspondant au numéro de dans le fichier de configuration evok.conf. |
| | | |
− | * wget -qO- http://your.pi.ip.address/rest/all <br />returns status of all devices configured in evok.conf | + | Où PROPERTY est principalement une 'valeur'. |
− | * wget -qO- http://your.pi.ip.address/rest/relay/1 <br />returns status of relay with circuit nr. 1 | + | |
− | * wget -qO- http://your.pi.ip.address/rest/relay/1/value <br />returns whether the relay 1 is on or of (1/0) | + | Voici quelques exemples simples utilisant {{fname|wget}} pour obtenir le statut de périphériques (vous pouvez également utiliser la commande {{fname|curl}}): |
− | * wget -qO- http://your.pi.ip.address/rest/ao/1/value <br />returns the value of analog output | + | |
− | * wget -qO- http://your.pi.ip.address/rest/ai/1/value <br />returns the value of analog input | + | * wget -qO- http://your.pi.ip.address/rest/all <br />Retourne le statut de tous les périphériques configurés dans evok.conf |
| + | * wget -qO- http://your.pi.ip.address/rest/relay/1 <br />Retourne le statut du relais avec le n° 1 |
| + | * wget -qO- http://your.pi.ip.address/rest/relay/1/value <br />Retourne la valeur du relais 1, s'il est actif ou inactif (1/0) |
| + | * wget -qO- http://your.pi.ip.address/rest/ao/1/value <br />Retourne la valeur de la '''sortie''' analogique |
| + | * wget -qO- http://your.pi.ip.address/rest/ai/1/value <br />Retourne la valeur de '''l'entrée''' analogique |
| | | |
| === HTTP Post === | | === HTTP Post === |