fhem-mirror/fhem/contrib/JsonList/commandref.html.patch

--- commandref.html-orig	2008-12-11 19:37:59.000000000 +0100
+++ commandref.html	2008-12-11 19:15:02.000000000 +0100
@@ -27,6 +27,7 @@
       <a href="#help">?,help</a> &nbsp;
       <a href="#include">include</a> &nbsp;
       <a href="#inform">inform</a> &nbsp;
+      <a href="#jsonlist">jsonlist</a> &nbsp;
       <a href="#list">list</a> &nbsp;
       <a href="#modify">modify</a> &nbsp;
       <a href="#quit">quit</a> &nbsp;
@@ -434,6 +435,97 @@
   <br>
 </ul>
 
+<a name="jsonlist"></a>
+<h3>jsonlist</h3>
+<ul>
+  <code>jsonlist [&lt;devspec&gt;|&lt;typespec&gt;|ROOMS]</code>
+  <br><br>
+  Returns an JSON tree of all definitions, all notify settings and all at
+  entries if no parameter is given.
+  <br><br>
+  Example:
+  <pre><code>  FHZ> jsonlist
+  {
+    "ResultSet": {
+      "Results": [
+        { "_internal__LIST": [
+            { "_internal_": {
+              "name": "global",
+              "state": "<no definition>",
+              "sets": [ { "VAL": "null" } ],
+              "attrs": [ { "VAL": "room" },{ "VAL": "comment" },
+        [...]
+      ],
+      "totalResultsAvailable": 86,
+      "totalResultsReturned": 86
+    }
+  }
+  </code></pre>
+  If specifying <code>&lt;devspec&gt;</code>, then a detailed status for
+  <code>&lt;devspec&gt;</code>  will be displayed, e.g.:
+  <pre><code>  FHZ> jsonlist lamp1
+  {
+    "ResultSet": {
+      "Results": {
+        "ATTRIBUTES": {
+          "comment": "Light",
+          "room": "Livingroom"
+        },
+        "BTN": "f0",
+        [...]
+        "NAME": "lamp1",
+        "NR": "26",
+        "READINGS": {
+          "state": {
+            "TIME": "2008-12-11 18:11:21",
+            "VAL": "toggle"
+          }
+        },
+        "STATE": "on",
+        "TYPE": "FS20",
+        "XMIT": "0b0b"
+      }
+    }
+  }
+  </code></pre>
+  If specifying <code>&lt;typespec&gt;</code>, then a list with the status for
+  the defined <code>&lt;typespec&gt;</code> devices will be displayed, e.g.:
+  <pre><code>  FHZ> jsonlist HMS
+  {
+    "ResultSet": {
+      "Results": [
+        { "NAME": "smokeDetector01", "STATE": "smoke_detect: off" },
+        { "NAME": "smokeDetector02", "STATE": "smoke_detect: off" },
+        { "NAME": "smokeDetector03", "STATE": "smoke_detect: off" }
+      ],
+      "totalResultsAvailable": 3,
+      "totalResultsReturned": 3
+    }
+  }
+  </code></pre>
+  If specifying <code>ROOMS</code>, then a list with the defined rooms
+  will be displayed, e.g.:
+  <pre><code>  FHZ> jsonlist ROOMS
+  {
+    "ResultSet": {
+      "Results": [
+        { "NAME": "Bathroom" },
+        { "NAME": "Office" },
+        { "NAME": "Diningroom" },
+        { "NAME": "Garden" },
+        { "NAME": "House" },
+        { "NAME": "Bedroom" },
+        { "NAME": "Garage" },
+        { "NAME": "Livingroom" },
+        { "NAME": "hidden" }
+      ],
+      "totalResultsAvailable": 9,
+      "totalResultsReturned": 9
+    }
+  }
+  </code></pre>
+</ul>
+
 <a name="list"></a>
 <h3>list</h3>
 <ul>