[camel] branch main updated: (chores) camel-plc4x: removed incorrect documentation file (#8666)

[da...@apache.org]

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

davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/main by this push:
     new 771746f8fb1 (chores) camel-plc4x: removed incorrect documentation file (#8666)
771746f8fb1 is described below

commit 771746f8fb1c7df8ad21ade947b1f6059a02e2d4
Author: Otavio Rodolfo Piske <or...@users.noreply.github.com>
AuthorDate: Sat Nov 5 10:57:57 2022 +0100

    (chores) camel-plc4x: removed incorrect documentation file (#8666)
---
 components/camel-plc4x/src/main/docs/PLC4X.adoc    | 64 ----------------------
 .../camel-plc4x/src/main/docs/plc4x-component.adoc | 15 +++++
 2 files changed, 15 insertions(+), 64 deletions(-)

diff --git a/components/camel-plc4x/src/main/docs/PLC4X.adoc b/components/camel-plc4x/src/main/docs/PLC4X.adoc
deleted file mode 100644
index 5e6901d1e48..00000000000
--- a/components/camel-plc4x/src/main/docs/PLC4X.adoc
+++ /dev/null
@@ -1,64 +0,0 @@
-//
-//  Licensed to the Apache Software Foundation (ASF) under one or more
-//  contributor license agreements.  See the NOTICE file distributed with
-//  this work for additional information regarding copyright ownership.
-//  The ASF licenses this file to You under the Apache License, Version 2.0
-//  (the "License"); you may not use this file except in compliance with
-//  the License.  You may obtain a copy of the License at
-//
-//      https://www.apache.org/licenses/LICENSE-2.0
-//
-//  Unless required by applicable law or agreed to in writing, software
-//  distributed under the License is distributed on an "AS IS" BASIS,
-//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-//  See the License for the specific language governing permissions and
-//  limitations under the License.
-//
-
-:icons: font
-
-== 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.
diff --git a/components/camel-plc4x/src/main/docs/plc4x-component.adoc b/components/camel-plc4x/src/main/docs/plc4x-component.adoc
index a55f91f0349..b0f4395e84a 100644
--- a/components/camel-plc4x/src/main/docs/plc4x-component.adoc
+++ b/components/camel-plc4x/src/main/docs/plc4x-component.adoc
@@ -58,3 +58,18 @@ Maven users will need to add the following dependency to their pom.xml.
 ---------------------------------------
 
 where `$\{camel-version}` must be replaced by the actual version of Camel.
+
+
+== 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.