summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <matthias.beyer@ifm.com>2022-05-15 10:58:01 +0200
committerMatthias Beyer <matthias.beyer@ifm.com>2022-05-17 11:11:36 +0200
commit16573c7e4b15ff903df05de5d341b34cd66774c2 (patch)
tree98b11b23ac7c150fbd17c6fac044ebfb53525c57
parent06321bce8a53586bde1cdce2ccfc09db9d3a5196 (diff)
plugin_thin_edge_json_to_measurement_mapper: Add README
Signed-off-by: Matthias Beyer <matthias.beyer@ifm.com>
-rw-r--r--plugins/plugin_thin_edge_json_to_measurement_mapper/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/plugins/plugin_thin_edge_json_to_measurement_mapper/README.md b/plugins/plugin_thin_edge_json_to_measurement_mapper/README.md
new file mode 100644
index 00000000..af8bbf8e
--- /dev/null
+++ b/plugins/plugin_thin_edge_json_to_measurement_mapper/README.md
@@ -0,0 +1,26 @@
+# plugin_thin_edge_json_to_measurement_mapper
+
+This plugin implements a mapper from the the "thin-edge-json" format to
+`Measurement`s.
+
+This plugin parses `ThinEdgeJson` messages it receives to `Measurement`
+objects, which it then sends out to another plugin able to receive this kind of
+objects.
+
+## TODO
+
+If the `ThinEdgeJson` object contains multiple measurements, these are currently
+send out as individual `Measurement` objects.
+
+This has to be cleaned up, depending on whether this is feasible.
+
+## Configuration
+
+The only configuration this plugin needs is the name of the plugin to send the
+`ThinEdgeJson` objects to:
+
+```toml
+target = "my_other_plugin"
+```
+
+