[plc4x] branch feature/scraper updated: Update Camel Documentation

[er...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

erobinet pushed a commit to branch feature/scraper
in repository https://gitbox.apache.org/repos/asf/plc4x.git


The following commit(s) were added to refs/heads/feature/scraper by this push:
     new 6c49278  Update Camel Documentation
6c49278 is described below

commit 6c49278bdd2475693cf0d9d118af559f18ce1b92
Author: etiennerobinet <61...@users.noreply.github.com>
AuthorDate: Fri May 15 14:09:43 2020 +0200

    Update Camel Documentation
---
 .../apache-camel/src/main/docs/PLC4X.adoc          | 50 ++++++++++++++++++++--
 1 file changed, 46 insertions(+), 4 deletions(-)

diff --git a/plc4j/integrations/apache-camel/src/main/docs/PLC4X.adoc b/plc4j/integrations/apache-camel/src/main/docs/PLC4X.adoc
index 3aa5fe8..4724e0f 100644
--- a/plc4j/integrations/apache-camel/src/main/docs/PLC4X.adoc
+++ b/plc4j/integrations/apache-camel/src/main/docs/PLC4X.adoc
@@ -15,8 +15,50 @@
 //  limitations under the License.
 //
 
-// component options: START
-// component options: END
+:icons: font
 
-// endpoint options: START
-// endpoint options: END
\ No newline at end of file
+== Camel-PLC4X Component
+The Camel Component for PLC4X allows you to create routes using the PLC4X API to read from a PLC device or write to it.
+
+=== Maven dependency
+To use the Camel component, just add following dependency to your project
+----
+<dependency>
+  <groupId>org.apache.plc4x</groupId>
+  <artifactId>plc4j-apache-camel</artifactId>
+  <version>{current-last-released-version}</version>
+</dependency>
+----
+
+== Endpoint
+[cols="2"]
+|===
+|Name |Value
+
+|*Tags*   | The tags to read as `Map<String,String>` containing the tagname associated to its query
+|*Trigger*|(*Consumer*) Query to a trigger. On a rising edge of the trigger, the tags will be read once
+|*Period* |(*Consumer*) Interval on which the Trigger should be checked
+|*Driver parameters* | Every Parameter unknown to the Component will be passed to the driver
+|===
+=== URI Format
+----
+plc4x:[driver-code]://[IP|host][?parameters]
+----
+Note that sometimes you want to add the `Transport` code after the `Driver` code:
+
+----
+plc4x:[driver-code]:[transport-code]://[IP|host][?parameters]
+----
+== Consumer
+The consumer supports one-time reading or Triggered Reading. (_Schedulded Reading using Period only soon_).To read from
+the PLC, use a  `Map<String,String>` containing the Alias and Queries for the Data you want.
+
+The Body create by the Consumer will be a `Map<String,Object>` containing the Aliases and there associated value
+read from the PLC.
+
+== Producer
+To write data to the PLC, we also use a `Map`. The difference with the Producer is that the `Value` of the Map has also to
+be a Map. Also, this `Map` has to be set into the `Body` of the `Message`
+
+The used `Map` would be a `Map<String,Map<String,Object>` where the `Map<String,Object>` represent the Query and the
+data we want to write to it.