Merge branch 'thin-edge:main' into main

Author: Marco Stoffel

c8y-operations/Command/README.md

@@ -0,0 +1,77 @@
+#  thin-edge.io Command plugin
+
+To use command on a device that runs thin-edge.io, a plugin of the operation plugin concept is used. The tedge_agent is checking for command operation and is triggering the particular plugin. You can use the Shell tab in device management to use a command. Please be aware of the power of such an feature. Somebody with access could start various shell commands. Its more designed as an idea on how the plugin mechanism works.
+
+## Requirements
+
+- Working thin-edge.io installation
+
+- Python3 and pip3 installation (will not work on python2)
+
+
+## Installation 
+
+1. Clone this repo on the thin-edge.io device
+2. run pip3 install -r requirements.txt from this Command directory
+3. Copy c8y_Command to the following directory "/etc/tedge/operations/c8y/"
+4. Copy c8y_Command.py to the following directory "/bin/"
+5. Make sure, that both files do have permissions for beeing executed by tedge_mapper ("chmod 644 c8y_Command and chmod 555 c8y_Command.py")
+
+
+## Usage
+
+Make sure thin-edge.io is connected to Cumulocity.
+If installation is done properly according to the steps above, you hae to disconnect and reconnect thin-edge.io. In that way the suppoerted Operations will be updated.
+
+```shell
+sudo tedge disconnect c8y
+```
+
+and
+
+```shell
+sudo tedge connect c8y
+```
+
+However it would also to be sufficient to restart the tedge_mapper service via e.g.:
+
+```shell
+sudo systemctl tedge_mapper restart
+```
+
+You device within Cumulocity should look similar to this afterwards:
+
+
+<br/><br/>
+<p style="text-indent:30px;">
+  <a>
+  <center>
+    <img width="70%" src="pics/dm.png">
+  </center>
+  </a>
+</p>
+<br/>
+
+You can create a command you want to be executed on the device side, such as e.g. ls.
+
+<br/><br/>
+<p style="text-indent:30px;">
+  <a>
+  <center>
+    <img width="70%" src="pics/command.png">
+  </center>
+  </a>
+</p>
+<br/>
+
+If you click on "Execute" thin-edge.io triggers the c8y_Command.py script. You can check the output of the command in the section on the right.
+
+<br/><br/>
+<p style="text-indent:30px;">
+  <a>
+  <center>
+    <img width="70%" src="pics/result.png">
+  </center>
+  </a>
+</p>
+<br/>

c8y-operations/Command/c8y_Command

@@ -0,0 +1,4 @@
+[exec]
+  topic = "c8y/s/ds"
+  on_message = "511"
+  command = "/etc/c8y_Command.py"

c8y-operations/Command/c8y_Command.py

@@ -0,0 +1,20 @@
+#!/usr/bin/python3
+# coding=utf-8
+import sys
+from paho.mqtt import client as mqtt_client
+import os
+
+broker = 'localhost'
+port = 1883
+client_id = 'command-operation-client'
+
+
+command = sys.argv[1].split(',')[2]
+client = mqtt_client.Client(client_id)
+client.connect(broker, port)
+
+
+client.publish('c8y/s/us','501,c8y_Command')
+stream = os.popen(f'{command}')
+output = stream.read()
+client.publish('c8y/s/us',f'503,c8y_Command,"{output}"')

c8y-operations/Command/pics/command.png

@@ -0,0 +1 @@
+paho-mqtt

c8y-operations/Command/pics/dm.png

@@ -0,0 +1,67 @@
+#  thin-edge.io Textbased Configuration plugin
+
+To configure a device that runs thin-edge.io, a plugin of the operation plugin concept is used. The tedge_agent is checking for configuration operation and is triggering the particular plugin. You can use the configuration tab in device management to change a text based configuration. The plugin itself currently only receives and acknowledges the config change, but does not do anything with it. The part where this can be included is shown in the code section.
+
+## Requirements
+
+- Working thin-edge.io installation
+
+- Python3 and pip3 installation (will not work on python2)
+
+
+## Installation 
+
+1. Clone this repo on the thin-edge.io device
+2. run pip3 install -r requirements.txt from this Configuration directory
+3. Copy c8y_Configuration to the following directory "/etc/tedge/operations/c8y/"
+4. Copy c8y_Configuration.py to the following directory "/bin/"
+5. Make sure, that both files do have permissions for beeing executed by tedge_mapper ("chmod 644 c8y_Configuration and chmod 555 c8y_Configuration.py")
+
+
+## Usage
+
+Make sure thin-edge.io is connected to Cumulocity.
+If installation is done properly according to the steps above, you hae to disconnect and reconnect thin-edge.io. In that way the suppoerted Operations will be updated.
+
+```shell
+sudo tedge disconnect c8y
+```
+
+and
+
+```shell
+sudo tedge connect c8y
+```
+
+However it would also to be sufficient to restart the tedge_mapper service via e.g.:
+
+```shell
+sudo systemctl tedge_mapper restart
+```
+
+You device within Cumulocity should look similar to this afterwards:
+
+
+<br/><br/>
+<p style="text-indent:30px;">
+  <a>
+  <center>
+    <img width="70%" src="pics/dm.png">
+  </center>
+  </a>
+</p>
+<br/>
+
+You can configure now within the configuration tab to what text, variables etc the config should hold.
+
+<br/><br/>
+<p style="text-indent:30px;">
+  <a>
+  <center>
+    <img width="70%" src="pics/config.png">
+  </center>
+  </a>
+</p>
+<br/>
+
+If you click on "Send configuration to device" thin-edge.io triggers the c8y_Configuration.py script.

c8y-operations/Command/pics/result.png

@@ -0,0 +1,4 @@
+[exec]
+  topic = "c8y/s/ds"
+  on_message = "513"
+  command = "/bin/c8y_Configuration.py"

c8y-operations/Command/requirements.txt

@@ -0,0 +1,17 @@
+#!/usr/bin/python3
+# coding=utf-8
+import sys
+from paho.mqtt import client as mqtt_client
+
+broker = 'localhost'
+port = 1883
+client_id = 'configuration-operation-client'
+
+
+config = sys.argv[1].split(',')[2]
+client = mqtt_client.Client(client_id)
+client.connect(broker, port)
+client.publish('c8y/s/us','501,c8y_Configuration')
+client.publish('c8y/s/us',f'113,{config}')
+###Enter code here for doing somethin with the configuration
+client.publish('c8y/s/us','503,c8y_Configuration')