summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Ranostay <matt.ranostay@konsulko.com>2019-03-28 19:50:10 -0700
committerMatt Ranostay <matt.ranostay@konsulko.com>2019-03-28 21:58:32 -0700
commit3fd25b6160b4ec3418c7a79e9ca455238f7f63d4 (patch)
treeead67266363badf824502e31835564e8c3361aa6
parentb38b9a888bacfc89d00e3b0a5e14328ef2695141 (diff)
binding: network: docs: add set_property/get_property verbs documentation
Change-Id: I926f3a59ed67292e8fb08616864fde7f4000a5d6 Signed-off-by: Matt Ranostay <matt.ranostay@konsulko.com>
-rw-r--r--README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
index 02b8426..2efa682 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,8 @@ Network service uses the respective ConnMan package to administer networking int
| state | get current global network connection state | {"response":"online"} |
| offline | set global offline mode | *Request:* {"value": true} |
| technologies | returns the respective available technology types | see technologies verb section |
+| get_property | get properties for a respective service/technology | see get_property section |
+| set_property | set property value for a respective service/technology | see set_property section |
| services | returns services provided from technologies | see services verb section |
| enable_technology | enable respective technology | *Request:* {"technology": "wifi"} |
| disable_technology | disable respective technology | *Request:* {"technology": "wifi"} |
@@ -83,6 +85,44 @@ Network service uses the respective ConnMan package to administer networking int
}
</pre>
+# get_property Verb
+
+Request for a techology's properties:
+
+<pre>
+{
+ "technology": "bluetooth",
+}
+</pre>
+
+Response:
+
+<pre>
+{
+ "response": {
+ "name": "Bluetooth",
+ "type": "bluetooth",
+ "powered": true,
+ "connected": false,
+ "tethering": true
+ },
+ ...
+}
+</pre>
+
+# set_property Verb
+
+Request for setting properties for a technology:
+
+<pre>
+{
+ "technology": "bluetooth",
+ "properties": {
+ "tethering": true
+ }
+}
+</pre>
+
### services Verb
<pre>