git.basschouten.com Git - openhab-addons.git/blob

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <config-description:config-descriptions
   3         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   4         xmlns:config-description="https://openhab.org/schemas/config-description/v1.0.0"
   5         xsi:schemaLocation="https://openhab.org/schemas/config-description/v1.0.0 https://openhab.org/schemas/config-description-1.0.0.xsd">
   6
   7         <config-description uri="thing-type:mqtt:rollershutter_channel">
   8                 <parameter-group name="transformations">
   9                         <label>Transform Values</label>
  10                         <description>These configuration parameters allow you to alter a value before it is published to MQTT or before a
  11                                 received value is assigned to an item.</description>
  12                         <advanced>true</advanced>
  13                 </parameter-group>
  14
  15                 <parameter name="stateTopic" type="text">
  16                         <label>MQTT State Topic</label>
  17                         <description>An MQTT topic that this thing will subscribe to, to receive the state. This can be left empty, the
  18                                 channel will be state-less command-only channel.</description>
  19                 </parameter>
  20                 <parameter name="commandTopic" type="text">
  21                         <label>MQTT Command Topic</label>
  22                         <description>An MQTT topic that this thing will send a command to. If not set, this will be a read-only switch.</description>
  23                 </parameter>
  24                 <parameter name="transformationPattern" type="text" groupName="transformations">
  25                         <label>Incoming Value Transformations</label>
  26                         <description><![CDATA[
  27                         Applies transformations to an incoming MQTT topic value.
  28                         A transformation example for a received JSON would be "JSONPATH:$.device.status.temperature" for
  29                         a json {device: {status: { temperature: 23.2 }}}.
  30
  31                         You can chain transformations by separating them with the intersection character ∩.
  32                         ]]></description>
  33                         <advanced>true</advanced>
  34                 </parameter>
  35                 <parameter name="transformationPatternOut" type="text" groupName="transformations">
  36                         <label>Outgoing Value Transformation</label>
  37                         <description><![CDATA[
  38                         Applies a transformation before publishing a MQTT topic value.
  39
  40                         Transformations are specialised in extracting a value, but some transformations like
  41                         the MAP one could be useful.
  42                         ]]></description>
  43                         <advanced>true</advanced>
  44                 </parameter>
  45                 <parameter name="formatBeforePublish" type="text" groupName="transformations">
  46                         <label>Outgoing Value Format</label>
  47                         <description><![CDATA[
  48                         Format a value before it is published to the MQTT broker.
  49                         The default is to just pass the channel/item state.
  50
  51                         If you want to apply a prefix, say "MYCOLOR,", you would use "MYCOLOR,%s".
  52                         If you want to adjust the precision of a number to for example 4 digits, you would use "%.4f".
  53                         ]]></description>
  54                         <advanced>true</advanced>
  55                         <default>%s</default>
  56                 </parameter>
  57                 <parameter name="qos" type="integer" min="0" max="2" required="false">
  58                         <label>QoS</label>
  59                         <description>MQTT QoS of this channel (0, 1, 2). Default is QoS of the broker connection.</description>
  60                         <options>
  61                                 <option value="0">At most once (best effort delivery "fire and forget")</option>
  62                                 <option value="1">At least once (guaranteed that a message will be delivered at least once)</option>
  63                                 <option value="2">Exactly once (guarantees that each message is received only once by the counterpart)</option>
  64                         </options>
  65                         <advanced>true</advanced>
  66                 </parameter>
  67                 <parameter name="retained" type="boolean">
  68                         <label>Retained</label>
  69                         <description>The value will be published to the command topic as retained message. A retained value stays on the
  70                                 broker and can even be seen by MQTT clients that are subscribing at a later point in time.</description>
  71                         <default>false</default>
  72                         <advanced>true</advanced>
  73                 </parameter>
  74                 <parameter name="postCommand" type="boolean">
  75                         <label>Is Command</label>
  76                         <description>If the received MQTT value should not only update the state of linked items, but command them, enable
  77                                 this option.</description>
  78                         <default>false</default>
  79                         <advanced>true</advanced>
  80                 </parameter>
  81                 <parameter name="on" type="text">
  82                         <label>Up Value</label>
  83                         <description>A string (like "OPEN") that is recognised as UP state. You can use this parameter for a second keyword,
  84                                 next to UP.</description>
  85                         <advanced>true</advanced>
  86                 </parameter>
  87                 <parameter name="off" type="text">
  88                         <label>Down Value</label>
  89                         <description>A string (like "CLOSE") that is recognised as DOWN state. You can use this parameter for a second
  90                                 keyword, next to DOWN.</description>
  91                         <advanced>true</advanced>
  92                 </parameter>
  93                 <parameter name="stop" type="text">
  94                         <label>Stop Value</label>
  95                         <description>A string (like "STOP") that is recognised as stop state. Will set the rollershutter state to undefined,
  96                                 because the current position is unknown at that point.</description>
  97                         <default>STOP</default>
  98                         <advanced>true</advanced>
  99                 </parameter>
 100         </config-description>
 101 </config-description:config-descriptions>