Erweiterung der XML-API - Version 1.2 ?

Nutzung von XML RPC, Remote Script, JSON RPC, XMLAPI

Moderator: Co-Administratoren

ultrah
Beiträge: 427
Registriert: 08.03.2010, 13:38
Hat sich bedankt: 6 Mal
Danksagung erhalten: 34 Mal

Erweiterung der XML-API - Version 1.2 ?

Beitrag von ultrah » 24.09.2012, 14:58

Hallo,

Maik von Home24 und ich haben zwei Erweiterungen zur XML-API hinzugefügt, state.cgi und favoritelist.cgi. Wir würden diese neue Version gern für unsere Apps nutzen, dazu muss bei allen Nutzern die gleiche Version installiert sein. Deshalb möchten wir die Erweiterungen hier zur Diskussion stellen, um mögliche Vorschläge zu ergänzen und den Patch als XML-API Version 1.2 festzulegen.

state.cgi gibt den status eines einzelnen Geräts aus. Syntax:

state.cgi?device_id=12796
state.cgi?channel_id=12796
state.cgi?datapoint_id=12839 (gibt nur Value() zurück)

für Geräte und Kanäle sieht das dann ungefähr so aus, selbe Syntax wie statelist.cgi:

Code: Alles auswählen

<?xml version="1.0" encoding="ISO-8859-1"?>
<state>-<device ise_id="1389" name="HM-CCU-1 System">
<channel ise_id="1390" name="Zentralennetzteil">
     <datapoint ise_id="1401" name="System.System:1.U_SOURCE_FAIL" timestamp="1348301775" valuetype="2" value="false" type="U_SOURCE_FAIL"/>
     <datapoint ise_id="1393" name="System.System:1.LOWBAT" timestamp="1348301789" valuetype="2" value="true" type="LOWBAT"/>
     <datapoint ise_id="1405" name="System.System:1.U_USBD_OK" timestamp="1348302275" valuetype="2" value="false" type="U_USBD_OK"/>
     <datapoint ise_id="1391" name="System.System:1.BAT_LEVEL" timestamp="1348302275" valuetype="4" value="0.000000" type="BAT_LEVEL"/>
     <datapoint ise_id="1488" name="Alarm1" timestamp="0" valuetype="2" value="" type=""/>
</channel>-<channel ise_id="1406" name="Sabotagekontakt"><datapoint ise_id="1407" name="System.System:2.SHAKING" timestamp="0" valuetype="2" value="" type="SHAKING"/>
</channel>
</device>
</state>
favoritelist.cgi gibt alle Favoriten in Gruppen aus. Output:

Code: Alles auswählen

<?xml version="1.0" encoding="ISO-8859-1"?>
<favoriteList>
    <favorite ise_id="1408" name="_USER1004">
        <channel ise_id="1540" name="Neue Favoritenliste 1" not_can_use="false" type="UNKNOWN"/>
        <channel ise_id="1484" name="Neue Favoritenliste" not_can_use="false" type="UNKNOWN"/>
    </favorite>
    <favorite ise_id="1484" name="Neue Favoritenliste">
        <channel ise_id="1390" name="Zentralennetzteil" not_can_use="false" type="CHANNEL"/>
        <channel ise_id="1487" name="Zahl1" not_can_use="true" type="SYSVAR"/>
        <channel ise_id="1409" name="Alarm an" not_can_use="false" type="PROGRAM"/>
    </favorite><favorite ise_id="1540" name="Neue Favoritenliste 1"/>
</favoriteList>
Dateianhänge
xmlapi_ccu_firmware_patch_1.2.img.txt
(25.93 KiB) 343-mal heruntergeladen
state.cgi.txt
(3.05 KiB) 319-mal heruntergeladen
favoritelist.cgi.txt
(1.52 KiB) 244-mal heruntergeladen

Benutzeravatar
anli
Beiträge: 4326
Registriert: 10.06.2009, 14:01
Wohnort: 20 Min. nördlich von Hannover und bei Bremen
Hat sich bedankt: 1 Mal
Danksagung erhalten: 23 Mal
Kontaktdaten:

Re: Erweiterung der XML-API - Version 1.2 ?

Beitrag von anli » 24.09.2012, 19:00

Gibt es in der XML-Api eigentlich schon eine Versionsnummer - sonst könnte man die mit version.cgi abfragen (gibt einen festen Wert zurück - ihr könntet jedoch entsprechend darauf reagieren ("bitte installieren Sie eine neue XML-API-Version"))
Herzliche Grüße, anli

Alle Angaben ohne Gewähr und Haftung meinerseits. Verwendung der von mir zur Verfügung gestellten Downloads auf eigene Gefahr. Ich bitte um Verständnis, dass ich aus zeitlichen Gründen keine unaufgeforderte Hilfestellung per PN/Mail geben kann. Bitte allgemeine Fragen ins Forum stellen, hier können viele fähige User viel schneller helfen.

Homematic-Manager v2: einfaches Tool zum Erstellen von Direktverknüpfungen und Bearbeiten von Gerätenamen, -parametern etc. für Homematic und HomematicIP (Alternative diesbzgl. zur WebUI)

Einsteiger-Hilfeerweiterter Skript-Parser

Benutzeravatar
Homie
Beiträge: 111
Registriert: 24.09.2012, 19:43

Re: Erweiterung der XML-API - Version 1.2 ?

Beitrag von Homie » 24.09.2012, 20:21

Hallo.

Mir ist aufgefallen das Home24 und HomeDroid das Ändern von Variablen vom Typ Werte-Liste nicht unterstützen. Ich hätte erwartet das dann ein Dialog mit den jeweiligen Werten zur Auswahl erscheint.

Ist das eine Limitierung der XML-API? Wenn ja, dann könnte man diese Gelegenheit doch nutzen um diese Funktion jetzt zu ermöglichen...

Tschüss
Homie
CCU2 steuert 90 Kanäle in 62 Geräten

ultrah
Beiträge: 427
Registriert: 08.03.2010, 13:38
Hat sich bedankt: 6 Mal
Danksagung erhalten: 34 Mal

Re: Erweiterung der XML-API - Version 1.2 ?

Beitrag von ultrah » 25.09.2012, 12:34

Versionsnummer ist eine gute Idee, danke für den Vorschlag!

@Homie: Ist mir auch aufgefallen aber ob sich das fixen lässt weis ich nicht wirklich, da ist Mike der Experte :)

Benutzeravatar
Monty1979
Beiträge: 854
Registriert: 28.10.2010, 20:47
Wohnort: Bremen
Kontaktdaten:

Re: Erweiterung der XML-API - Version 1.2 ?

Beitrag von Monty1979 » 25.09.2012, 13:42

Homie hat geschrieben:Ist das eine Limitierung der XML-API? Wenn ja, dann könnte man diese Gelegenheit doch nutzen um diese Funktion jetzt zu ermöglichen...
ja ist es, kann ich so noch nicht sagen denn ich habe keine Plan wie ich an die Werte komme. Aber irgendwo in der CCU FW wird die Lösung stehen :wink:

Benutzeravatar
anli
Beiträge: 4326
Registriert: 10.06.2009, 14:01
Wohnort: 20 Min. nördlich von Hannover und bei Bremen
Hat sich bedankt: 1 Mal
Danksagung erhalten: 23 Mal
Kontaktdaten:

Re: Erweiterung der XML-API - Version 1.2 ?

Beitrag von anli » 25.09.2012, 14:05

Monty1979 hat geschrieben:
Homie hat geschrieben:Ist das eine Limitierung der XML-API? Wenn ja, dann könnte man diese Gelegenheit doch nutzen um diese Funktion jetzt zu ermöglichen...
ja ist es, kann ich so noch nicht sagen denn ich habe keine Plan wie ich an die Werte komme. Aber irgendwo in der CCU FW wird die Lösung stehen :wink:
api\methods\sysvar -> get.tcl, siehe Anhang
Dateianhänge
get.zip
(1.25 KiB) 277-mal heruntergeladen
Herzliche Grüße, anli

Alle Angaben ohne Gewähr und Haftung meinerseits. Verwendung der von mir zur Verfügung gestellten Downloads auf eigene Gefahr. Ich bitte um Verständnis, dass ich aus zeitlichen Gründen keine unaufgeforderte Hilfestellung per PN/Mail geben kann. Bitte allgemeine Fragen ins Forum stellen, hier können viele fähige User viel schneller helfen.

Homematic-Manager v2: einfaches Tool zum Erstellen von Direktverknüpfungen und Bearbeiten von Gerätenamen, -parametern etc. für Homematic und HomematicIP (Alternative diesbzgl. zur WebUI)

Einsteiger-Hilfeerweiterter Skript-Parser

Benutzeravatar
Monty1979
Beiträge: 854
Registriert: 28.10.2010, 20:47
Wohnort: Bremen
Kontaktdaten:

Re: Erweiterung der XML-API - Version 1.2 ?

Beitrag von Monty1979 » 25.09.2012, 16:09

anli hat geschrieben:api\methods\sysvar -> get.tcl, siehe Anhang
Danke, was für ein Service jetzt musste ich nicht mal selbst suchen :D

Benutzeravatar
anli
Beiträge: 4326
Registriert: 10.06.2009, 14:01
Wohnort: 20 Min. nördlich von Hannover und bei Bremen
Hat sich bedankt: 1 Mal
Danksagung erhalten: 23 Mal
Kontaktdaten:

Re: Erweiterung der XML-API - Version 1.2 ?

Beitrag von anli » 25.09.2012, 16:17

Monty1979 hat geschrieben:
anli hat geschrieben:api\methods\sysvar -> get.tcl, siehe Anhang
Danke, was für ein Service jetzt musste ich nicht mal selbst suchen :D
Gerne! Jetzt gibt es aber auch für die nächste Version keine Ausrede mehr, warum es nicht geht :mrgreen:
Herzliche Grüße, anli

Alle Angaben ohne Gewähr und Haftung meinerseits. Verwendung der von mir zur Verfügung gestellten Downloads auf eigene Gefahr. Ich bitte um Verständnis, dass ich aus zeitlichen Gründen keine unaufgeforderte Hilfestellung per PN/Mail geben kann. Bitte allgemeine Fragen ins Forum stellen, hier können viele fähige User viel schneller helfen.

Homematic-Manager v2: einfaches Tool zum Erstellen von Direktverknüpfungen und Bearbeiten von Gerätenamen, -parametern etc. für Homematic und HomematicIP (Alternative diesbzgl. zur WebUI)

Einsteiger-Hilfeerweiterter Skript-Parser

ultrah
Beiträge: 427
Registriert: 08.03.2010, 13:38
Hat sich bedankt: 6 Mal
Danksagung erhalten: 34 Mal

Re: Erweiterung der XML-API - Version 1.2 ?

Beitrag von ultrah » 26.09.2012, 12:51

Abend,

ich habe mal die Vorschläge hinzugefügt und noch eine info.html gebastelt (Text ist von Marc‘s Seite) da mich einige schon gefragt haben was man da so auslesen kann.

Grüße Maik
Funktioniert wunderbar, habs schon implementiert :P

Ich hab alle Skripte ausgepackt und als .zip angehängt , dazu das .img

Die Idee mit der info.html ist klasse, jetzt muss man nur http://ccu-ip/config/xmlapi/ aufrufen und bekommt eine schöne Seite präsentiert :)
Dateianhänge
xmlapi_ccu_firmware_patch_1.2.img.txt
(26.78 KiB) 304-mal heruntergeladen
skripte.zip
(34.57 KiB) 339-mal heruntergeladen

ultrah
Beiträge: 427
Registriert: 08.03.2010, 13:38
Hat sich bedankt: 6 Mal
Danksagung erhalten: 34 Mal

Re: Erweiterung der XML-API - Version 1.2 ?

Beitrag von ultrah » 28.09.2012, 11:50

gibt es noch weitere Vorschläge/Meinungen ?

Antworten

Zurück zu „Softwareentwicklung von externen Applikationen“