WebCmd: Unterschied zwischen den Versionen

Aus FHEMWiki
(Erste Version der Seite)
 
(Hinweis auf autocreate-Deaktivierungsoption eingefügt)
 
(2 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
<!-- Bitte die unter Weiterführende Hinweise beschriebenen Auszüge aus der commandref testen. Ist die Darstellung in der jetzigen Reihenfolge sinnvoll? -->
{{SEITENTITEL:webCmd}}  <!-- da richtige Schreibweise kleinen Anfangsbuchstaben hat -->
{{SEITENTITEL:webCmd}}  <!-- da richtige Schreibweise kleinen Anfangsbuchstaben hat -->
<!-- Infobox Attribut sinnvoll? -->
<!-- Infobox Attribut sinnvoll? -->


Das Attribut [[webCmd]] dient dazu, ...
Das Attribut [[webCmd]] dient dazu, in [[FHEMWEB]]<ref>Nur für Instanzen, für die nicht das Attribut <code>stylesheetPrefix smallscreen</code> festgelegt wurde</ref> ein oder mehrere Befehle festzulegen, die für ein Gerät verfügbar sein sollen. Die gewünschten Befehle werden dabei nacheinander aufgelistet, getrennt jeweils durch einen Doppelpunkt. Das Attribut bezieht sich dabei immer nur auf das eine Gerät, für das es angegeben ist.


{{Todo|Bitte analog zu [[eventMap]] mit Inhalt füllen.}}
{{Hinweis|Ein Überblick über die verschiedenen Attribute zur Beeinflussung des Aussehens und der Funktionalität eines Geräts ist im Beitrag [[DeviceOverview anpassen]] enthalten.}}


== Syntax ==
== Syntax ==
Das ''webCmd'' Attribut wird in der folgenden Weise spezifiziert:
Das ''webCmd'' Attribut wird in der folgenden Weise spezifiziert:


    attr lamp webCmd on:off:on-for-timer 10
== Einschränkungen ==  
== Einschränkungen ==  
...
webCmd hat nur Auswirkung auf FHEMWEB-Instanzen, für die nicht das Attribut <code>stylesheetPrefix smallscreen</code> festgelegt wurde. Stattdessen kann [[devStateIcon]] verwendet werden.


== Beispiele ==
== Beispiele ==
Mit der Definition ...
 
*Für einen HomeMatic-Switch oä:
<code>attr lamp webCmd on:off:on-for-timer 10</code>
*Für einen Dummy zur Anzeige, ob das Gästezimmer belegt ist:
<code>attr Gaeste_im_Gaestezimmer webCmd Gaeste_da:Keine_Gaeste</code>
*Für einen virtuellen HM-Taster, um z.B. Dimm-Befehle an einen gepeerten Aktor zu senden:
<code>attr Vact_dev webCmd press short:press long</code>
*Für einen virtuellen Fensterkontakt (gepeert mit einem Homematic-Heizkörper-Thermostat):
<code>attr VCCU_Btn2 webCmd postEvent open:postEvent closed</code>
 
{{Hinweis|Manche Module weisen automatisch ein webCmd-Attribut zu, wenn keines definiert ist. Um in solchen Fällen diesen Bereich optisch frei zu halten, kann man mit <code>attr <Device> webCmd :</code> verhindern, dass erneut sichtbare Kommandos erstellt werden.}}
 
==Ergänzende Hinweise==
Der erste angegebene Befehl wird in der setList des Gerätes nachgeschlagen. Wird dabei ein sog. Modifier verwendet, führt dies - ähnlich wie bei Verwendung des Attributs widgetOverride - dazu, dass das Aussehen durch Anwendung eines anderen Widgets komplett verändert wird. Dies kann vor allem für Dummy-Geräte hilfreich sein.
Wenn als erster Befehl <code>state</code> angegeben ist, wird der Wert als Kommando interpretiert.
Beispiele:
 
    define d1 dummy
    attr d1 webCmd state
    attr d1 setList state:on,off
 
    define d2 dummy
    attr d2 webCmd state
    attr d2 setList state:slider,0,1,10
 
    define d3 dummy
    attr d3 webCmd state
    attr d3 setList state:time


== Links ==
== Links ==
* Ausführliche Beschreibung (mit Beispielen) zu [[eventMap]], [[devStateIcon]], [[setList]] und webCmd in {{Link2Forum|Topic=12080|LinkText=diesem Forenthread}}
* Ausführliche Beschreibung (mit Beispielen) zu [[eventMap]], [[devStateIcon]], [[setList]] und webCmd in {{Link2Forum|Topic=12080|LinkText=diesem Forenthread}}
 
* siehe auch [[FHEMWEB#widgetOverride|widgetOverride]]
[[Kategorie:Attribut (allgemeingültig)]]
[[Kategorie:Attribut (allgemeingültig)]]

Aktuelle Version vom 29. Januar 2019, 11:01 Uhr


Das Attribut webCmd dient dazu, in FHEMWEB[1] ein oder mehrere Befehle festzulegen, die für ein Gerät verfügbar sein sollen. Die gewünschten Befehle werden dabei nacheinander aufgelistet, getrennt jeweils durch einen Doppelpunkt. Das Attribut bezieht sich dabei immer nur auf das eine Gerät, für das es angegeben ist.


Info blue.png
Ein Überblick über die verschiedenen Attribute zur Beeinflussung des Aussehens und der Funktionalität eines Geräts ist im Beitrag DeviceOverview anpassen enthalten.


Syntax

Das webCmd Attribut wird in der folgenden Weise spezifiziert:

   attr lamp webCmd on:off:on-for-timer 10

Einschränkungen

webCmd hat nur Auswirkung auf FHEMWEB-Instanzen, für die nicht das Attribut stylesheetPrefix smallscreen festgelegt wurde. Stattdessen kann devStateIcon verwendet werden.

Beispiele

  • Für einen HomeMatic-Switch oä:

attr lamp webCmd on:off:on-for-timer 10

  • Für einen Dummy zur Anzeige, ob das Gästezimmer belegt ist:

attr Gaeste_im_Gaestezimmer webCmd Gaeste_da:Keine_Gaeste

  • Für einen virtuellen HM-Taster, um z.B. Dimm-Befehle an einen gepeerten Aktor zu senden:

attr Vact_dev webCmd press short:press long

  • Für einen virtuellen Fensterkontakt (gepeert mit einem Homematic-Heizkörper-Thermostat):

attr VCCU_Btn2 webCmd postEvent open:postEvent closed


Info blue.png
Manche Module weisen automatisch ein webCmd-Attribut zu, wenn keines definiert ist. Um in solchen Fällen diesen Bereich optisch frei zu halten, kann man mit attr <Device> webCmd : verhindern, dass erneut sichtbare Kommandos erstellt werden.


Ergänzende Hinweise

Der erste angegebene Befehl wird in der setList des Gerätes nachgeschlagen. Wird dabei ein sog. Modifier verwendet, führt dies - ähnlich wie bei Verwendung des Attributs widgetOverride - dazu, dass das Aussehen durch Anwendung eines anderen Widgets komplett verändert wird. Dies kann vor allem für Dummy-Geräte hilfreich sein. Wenn als erster Befehl state angegeben ist, wird der Wert als Kommando interpretiert. Beispiele:

   define d1 dummy
   attr d1 webCmd state
   attr d1 setList state:on,off
   define d2 dummy
   attr d2 webCmd state
   attr d2 setList state:slider,0,1,10
   define d3 dummy
   attr d3 webCmd state
   attr d3 setList state:time

Links

  1. Nur für Instanzen, für die nicht das Attribut stylesheetPrefix smallscreen festgelegt wurde