Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- software:clients:vzclient [2011/11/27 09:31] – angelegt sven_anders
+++ software:clients:vzclient [2020/05/03 09:07] (aktuell) – Python 3 jau
@@ Zeile 1: / Zeile 1: @@
-Das Programm vzclient ermöglicht, alle Aktionen die man über die API ausführen kann auch auf der Kommandozeile (ohne curl, wget oder ähnliches) zu machen.
+====== 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.
-Hier ein Beispiel:
-====== Installation: ======
+===== 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: ======
+===== Konfiguration =====
-Die Url zum middelware.php am besten in der Konfigurationsdatei: /etc/vzclient.conf oder ~/.vzclient.conf ablegen:
+Die Url zu middleware.php am besten in der Konfigurationsdatei /etc/vzclient.conf oder ~/.vzclient.conf ablegen:
-''[default]
+<code>
-url:http://example.org/dir/volkszaehler.org/middleware.php''
+[default]
+url:http://example.org/dir/volkszaehler.org/middleware.php
+</code>
-====== Benutzung: (Beispiele) ======
+===== Benutzung (Beispiele) =====
 Jetzt kann man mit:
-''vzclient get channel''
+<code>
+vzclient get channel
+</code>
 alle öffentlichen Channels ansehen. Die Ausgabe erfolgt in JSON.
-''vzclient -u ccd52140-9999-11e1-8e36-e556c9177879 get data ''
+<code>
+vzclient -u ccd52140-9999-11e1-8e36-e556c9177879 get data
+</code>
-Gibt alle Daten des Zaehlers mit der ID: ccd52140-9999-11e1-8e36-e556c9177879 zurück.
+Gibt alle Daten des Zaehlers mit der UUID: ccd52140-9999-11e1-8e36-e556c9177879 zurück.
-''vzclient add channel type=heat public=1 \
+<code>
-  title="Beispiel Wärmemengenzähler" resolution=1000''
+vzclient add channel type=heat public=1 title="Beispiel Wärmemengenzähler" resolution=1000
+</code>
 Erstellt einen Channel.
@@ Zeile 35: / Zeile 63: @@
 Um 27 Impulse zum aktuellen Zeitpunkt zu senden:
-''vzclient -u 18bdae40-18cf-11e1-97b1-c9ebec812cd6 add data value=27''
+<code>
+vzclient -u 18bdae40-18cf-11e1-97b1-c9ebec812cd6 add data value=27
+</code>
 Mit dem Befehl:
-''vzclient -u 18bdae40-18cf-11e1-97b1-c9ebec812cd6 delete channel''
+<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:
-''vzclient --help ''
+<code>
+vzclient --help
+</code>
 Die Parameter die man übergeben kann erfährt man auf der [[development/api/reference]] Seite