From 2e6a18516215c3ccec200454ba9c3f388c5059e5 Mon Sep 17 00:00:00 2001
From: Christopher Pusch <chris@Christophers-MacBook-Pro.local>
Date: Thu, 10 Oct 2019 19:24:27 +0200
Subject: [PATCH] added Readme

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b7fb69e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Example of a stream connector in Python
+
+At Device Insight the software CS Edge is used to send data to the Center Sight platform. It is possible to extend the functionality by adding a so called stream connector. Basically CS Edge needs to be configured to the start the script (see Centersight Edge manual) and gets started automatically.
+
+This example shows how a python script can be used as a stream connector.
+
+## Functionality
+
+The stream connector needs to print the data as a string to stdout in the following format:
+
+<code>{"datapointValue": {"key": "\<name of the datapoint>", "value": "\<value of the datapoint>", "dataType": "\<type of the datapoint", "tsIso8601": "\<timestamp>"}}</code>
+
+Format of the timestamp needs to be according to Iso 8601:
+
+2013-12-02T12:30:02.003+01:00
+yyyy-MM-DDThh:mm:ss.fffT
\ No newline at end of file