====== VZClient ======

vzclient ist ein einfaches programm (python-script) um Funktionen der middleware-api aufzurufen, ohne selbst die URLs zusammenzustellen und mit curl, wget o.ae. aufzurufen.



===== Voraussetzungen =====

Python mitsamt Modul "argparse"; in Debian und Ubuntu zu installieren per 
<code>
sudo apt-get install python3 python3-argh python3-pip
</code>

Allgemein (und für alle anderen Distros, sofern [[http://pypi.python.org/pypi/pip|pip]] installiert ist) lässt sich das Modul wie folgt installieren:

<code>
pip install argparse
</code>
===== Download =====
vzclient liegt zusammen mit der middleware im git-repository, unter bin.

man kann das script auch direkt ueber das web-interface von github einstehen/herunterladen:

https://github.com/volkszaehler/volkszaehler.org/blob/master/bin/vzclient

https://raw.github.com/volkszaehler/volkszaehler.org/master/bin/vzclient

===== Installation =====
Das Programm igrendwo in den Pfad kopieren, z.B unter /usr/local/bin/

===== Konfiguration =====


Die Url zu middleware.php am besten in der Konfigurationsdatei /etc/vzclient.conf oder ~/.vzclient.conf ablegen:

<code>
[default]
url:http://example.org/dir/volkszaehler.org/middleware.php
</code>


===== Benutzung (Beispiele) =====
Jetzt kann man mit:

<code>
vzclient get channel
</code>

alle öffentlichen Channels ansehen. Die Ausgabe erfolgt in JSON.

<code>
vzclient -u ccd52140-9999-11e1-8e36-e556c9177879 get data
</code>

Gibt alle Daten des Zaehlers mit der UUID: ccd52140-9999-11e1-8e36-e556c9177879 zurück.

<code>
vzclient add channel type=heat public=1 title="Beispiel Wärmemengenzähler" resolution=1000
</code>

Erstellt einen Channel.

Um 27 Impulse zum aktuellen Zeitpunkt zu senden:

<code>
vzclient -u 18bdae40-18cf-11e1-97b1-c9ebec812cd6 add data value=27
</code>

Mit dem Befehl:

<code>
vzclient -u 18bdae40-18cf-11e1-97b1-c9ebec812cd6 delete channel
</code>

löscht den Channel wieder.

Um einen Wert ("23") für die UUID einzutragen:

<code>
vzclient -u 18bdae40-18cf-11e1-97b1-c9ebec812cd6 add data ts=`date +%s000` value=23
</code>


Alle Optionen bekommt man mit:

<code>
vzclient --help 
</code>

Die Parameter die man übergeben kann erfährt man auf der [[development/api/reference]] Seite