You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by jf...@apache.org on 2018/11/24 12:21:47 UTC
[incubator-plc4x] branch develop updated (6fa99c2 -> abcda3b)
This is an automated email from the ASF dual-hosted git repository.
jfeinauer pushed a change to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git.
from 6fa99c2 [plc4j-opm] enable write support (PLC4X-70)
new 78c7562 [OPM] Added OPM Documentation.
new abcda3b [plc4j-pool] Fixed visibility of Interface.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../connectionpool/PooledPlcDriverManager.java | 2 +-
src/site/asciidoc/users/opm.adoc | 73 ++++++++++++++++++++++
src/site/site.xml | 1 +
3 files changed, 75 insertions(+), 1 deletion(-)
create mode 100644 src/site/asciidoc/users/opm.adoc
[incubator-plc4x] 01/02: [OPM] Added OPM Documentation.
Posted by jf...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
jfeinauer pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git
commit 78c756254f85b7946e94b9e3d7cf2261867c8fcd
Author: Julian Feinauer <j....@pragmaticminds.de>
AuthorDate: Fri Nov 23 14:22:01 2018 +0100
[OPM] Added OPM Documentation.
---
src/site/asciidoc/users/opm.adoc | 73 ++++++++++++++++++++++++++++++++++++++++
src/site/site.xml | 1 +
2 files changed, 74 insertions(+)
diff --git a/src/site/asciidoc/users/opm.adoc b/src/site/asciidoc/users/opm.adoc
new file mode 100644
index 0000000..e41c3c3
--- /dev/null
+++ b/src/site/asciidoc/users/opm.adoc
@@ -0,0 +1,73 @@
+//
+// 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
+//
+// http://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.
+//
+
+== Object PLC Mapping
+
+
+=== What is Object PLC Mapping
+
+Object PLC Mapping (OPM) is heavily inspired by the Java Persistence API (JPA) [1].
+One of the main goal of the PLC4X Project is to make it easy to communicate with PLC devices to enable the development
+of applications that interact with PLCs.
+As many (or even most) of the application programmers are no experts in PLC Communication and protocols it should be as
+easy as possible to interact with PLCs without too much domain knowledge.
+This is exactly the reason why JPA was initialized many years ago to allow the interaction with a Database by simply
+calling methods on POJOs (Plain old Java Object).
+This is exactly what the OPM Module is for, to enable PLC communication by simply interacting with a POJO.
+
+=== Simple Example
+
+The following short code snippet shows how to read one value from a PLC via OPM.
+First, a _PlcEntityManager_ is instantiated, then a *connected* entity is fetched for a given PLC connection address.
+Connected means that all method calls of the entity are intersected and replaced by PLC calls.
+This is then used to print one value to the console.
+In the second snippet one can see how the Entity class looks. The address where to read the variable _pressure_ from is given
+in the _@PlcField_ annotation.
+[source,java]
+----
+public static void main(String[] args) {
+ PlcEntityManager em = new PlcEntityManager();
+ MyEntity entity = em.connect(MyEntity.class, "s7://...");
+ System.out.println(entity.getPressure());
+}
+----
+The class _MyEntity_ is given by
+[source,java]
+----
+@PlcEntity
+public class MyEntity {
+
+ @PlcField("DB01:DW01:LONG")
+ private double pressure;
+
+ public void MyEntity() {
+ // For OPM
+ }
+
+ public double getPressure() {
+ return pressure;
+ }
+}
+----
+
+=== Annotations
+
+=== More details
+
+=== References
+
+[1] https://www.oracle.com/technetwork/java/javaee/tech/persistence-jsp-140049.html
\ No newline at end of file
diff --git a/src/site/site.xml b/src/site/site.xml
index 557d00f..f30c01e 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -102,6 +102,7 @@
<menu name="Users">
<item name="Download" href="users/download.html"/>
<item name="Getting Started" href="users/gettingstarted.html"/>
+ <item name="Object PLC Mapping (OPM)" href="users/opm.html"/>
<item name="Industry 4.0 with Apache" href="users/industry40.html"/>
<item name="Security" href="users/security.html"/>
</menu>
[incubator-plc4x] 02/02: [plc4j-pool] Fixed visibility of Interface.
Posted by jf...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
jfeinauer pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git
commit abcda3bc7837eb73cc2a27365bf4c8c4c5439873
Author: Julian Feinauer <j....@pragmaticminds.de>
AuthorDate: Fri Nov 23 18:29:40 2018 +0100
[plc4j-pool] Fixed visibility of Interface.
---
.../apache/plc4x/java/utils/connectionpool/PooledPlcDriverManager.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/plc4j/utils/connection-pool/src/main/java/org/apache/plc4x/java/utils/connectionpool/PooledPlcDriverManager.java b/plc4j/utils/connection-pool/src/main/java/org/apache/plc4x/java/utils/connectionpool/PooledPlcDriverManager.java
index 9a7e5d7..a88794f 100644
--- a/plc4j/utils/connection-pool/src/main/java/org/apache/plc4x/java/utils/connectionpool/PooledPlcDriverManager.java
+++ b/plc4j/utils/connection-pool/src/main/java/org/apache/plc4x/java/utils/connectionpool/PooledPlcDriverManager.java
@@ -142,7 +142,7 @@ public class PooledPlcDriverManager extends PlcDriverManager {
}
@FunctionalInterface
- interface PoolCreator {
+ public interface PoolCreator {
KeyedObjectPool<PoolKey, PlcConnection> createPool(PooledPlcConnectionFactory pooledPlcConnectionFactory);
}