1 Star 1 Fork 1

openwms / org.openwms.common.comm

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Purpose

This standalone and runnable Spring Boot application is an implementation of the OSIP specification that communicates with the subsystems, like a PLC or a Raspberry Pi, using the OSIP TCP/IP message format. This kind of subsystems lack of resources and do not provide a higher level protocol on top of TCP/IP. The implementation is aware of multiple tenants (e.g. projects) and may run in the cloud with different port settings. Note: Instantiating multiple instances of the driver component with same port settings is not possible. Each instance must have its own configuration, in particular its own TCP/IP port settings. A project (tenant) may have multiple drivers deployed, all running on different ports.

Resources

Documentation at OpenProject Wiki

Build status Quality License Maven central Docker pulls Join the chat at https://gitter.im/openwms/org.openwms

Operation Modes

A driver instance can be started in different operation modes: Simplex or Duplex communication with either Client or Server connection mode. All four can be arbitrary combined.

Simplex Communication

Simplex communication means a client application connecting to the driver uses one socket for inbound communication and another socket for the outbound. So sending and receiving messages is handled through separated and dedicated socket connections.

With the simplex communication mode the inbound communication is configured differently as the outbound communication. This way the driver creates two separate ConnectionFactories, one for inbound and one for outbound. Each socket can be configured either in Client or Server mode. A Client configured Socket tries to connect to a listening server whereas configured as Server the driver opens a socket itself and listens for incoming connections.

A typical simplex configuration looks like:

owms:
  driver:
    connections:
      hostname: 0.0.0.0
      subsystems:
        - name: SPS01
          inbound:
            mode: server
            port: 30001
            so-receive-buffer-size: 200
          outbound:
            mode: client
            port: 30002
            so-send-buffer-size: 200
            identified-by-field: "RECV"
            identified-by-value: "SPS01"

Each communication direction is configured with a different port setting and with mode set to server and client. To correlate outbound messages with previously received ones, the identified-by-* fields are used.

Duplex Communication

In contrast to simplex connections the driver instance can also be configured for bidirectional duplex mode where only one socket is used for inbound and outbound communication. Instead of configuring inbound or outbound only one duplex configuration must be present.

owms:
  driver:
    connections:
      subsystems:
        - name: SPS03
          duplex:
            mode: server
            hostname: localhost
            port: 30003
            so-send-buffer-size: 200
            so-receive-buffer-size: 200
            identified-by-field: "RECV"
            identified-by-value: "SPS03"

Architecture

The module uses a couple of the well known Enterprise Integration Patterns (EIP), like a Router, Transformer or an Enricher. For that reason Spring Integration is used as integration framework. In addition this is a very convenient and flexible way to adopt new transport channels beside TCP/IP.

The overall integration architecture is shown below. The entry point is the inboundAdapter that is connected to a TcpNetServerConnectionFactory (not shown) and forwards incoming telegrams to the inboundChannel. A first transformer (telegramTransformer) terminates the ASCII string and converts into a Spring Message. This is done with support of the appropriate MessageMapper that must exist for each telegram type. For instance the TimesyncTelegramMapper knows best how to transform a String into a TimesyncRequest. After the telegram is transformed into a valid message type the generic messageRouter picks up the right queue and activates the proper ServiceActivator. Notice that the service activators queue name is built on the fly and follows a naming convention. This is one aspect to support requirements NR003.

Architecture

Deployment

The TCP/IP driver can run completely independent of cloud infrastructure services. This could be the appropriate deployment model during development or for small projects where no central infrastructure services are required. In a larger project setup with lots of subsystems and where the driver component is instantiated multiple times it makes sense to keep configuration on a central config server, this is where OpenWMS.org Configuration comes into play.

Standalone Deployment

As said all required configuration must be passed at startup time because no infrastructure services are required to access. Without any configuration the driver is started with the provided default configuration that is suitable for one driver instance:

owms:
  driver:
    server:
      port: 30001
Property Description
owms.driver.server.port The unique port number the driver receives connections on. Multiple driver instances must have different port numbers.

In case you want to override the port number on startup just set the environment variable accordingly. In the following example 2 drivers are started, with different ports.

$ java -Dowms.driver.server.port=30001 -jar tcpip-driver.jar
$ java -Dowms.driver.server.port=30002 -jar tcpip-driver.jar

Afterwards simply send a OSIP SYNQ telegram to driver with port 30001 to get a response telegram:

$ telnet localhost 30001
Trying ::1...
Connected to localhost.
Escape character is '^]'.
###00160SPS01MFC__00001SYNQ20171123225959***********************************************************************************************************************
###00160MFC__SPS0100002SYNC20180927152848***********************************************************************************************************************

The first telegram string (SYNQ) is sent to the driver, whereas the driver responds with a SYNC telegram to synchronize the current system time.

Distributed Deployment

In case of multiple driver components and lots of microservices it makes sense to keep service configuration at a central place and the OpenWMS.org Configuration server is the right choice. This infrastructure service takes the configuration of each process from a configured Git repository and passes it down to the processes at process startup. By using a configuration sever it is also possible to change configuration at runtime without the need to restart processes. Configuration is pushed down into the microservices and the service configuration is refreshed dynamically.

To run the driver component in a distributed fashion, the Spring profile "DISTRIBUTED" must be enabled. It's also a good practice to provide unique application names, at least when the driver is instantiated multiple times:

$ java -Dspring.profiles.active=DISTRIBUTED -Dspring.application.name=tcpip-palett1 -jar tcpip-driver.jar
$ java -Dspring.profiles.active=DISTRIBUTED -Dspring.application.name=tcpip-palett2 -jar tcpip-driver.jar

Each driver is now starting up and looking for a configuration server. The application name is used to load the appropriate driver configuration from. For example the Git repository KARL includes YAML configuration files for all processes used in KARL project, same is true for tcpip-palett1.yml and tcpip-palett2.yml.

tcpip-palett1.yml

owms:
  tenant: KARL
  driver:
    server:
      port: 30001
      so-timeout: 300000
      so-receive-buffer-size: 160
      so-send-buffer-size: 160
      routing-service-name: routing-service # is default

tcpip-palett2.yml

owms:
  tenant: KARL
  driver:
    server:
      port: 30002
      so-timeout: 300000
      so-receive-buffer-size: 160
      so-send-buffer-size: 160
      routing-service-name: routing-service # is default

Communication Protocols

The way how the driver communicates to other OpenWMS.org microservices can be defined by setting a Spring profile. In ASYNCHRONOUS mode the driver uses AMQP and sends the messages to RabbitMQ exchanges. In SYNCHRONOUS mode the driver calls defined REST endpoints of microservices.

Synchronous communication is used by default.

Synchronous Communication

Either set the SYNCHRONOUS profile explicitly or omit it.

$ java -Dspring.profiles.active=SYNCHRONOUS -Dspring.application.name=tcpip-palett1 -jar tcpip-driver.jar

Asynchronous Communication (RabbitMQ)

To enable asynchronous communication over RabbitMQ set the Spring profile ASYNCHRONOUS

$ java -Dspring.profiles.active=ASYNCHRONOUS -Dspring.application.name=tcpip-palett1 -jar tcpip-driver.jar

Configuration

Important configuration properties of the driver component are the following.

Property Description
owms.driver.timezone The ZoneId (java.time.ZoneId) used to create timestamps
owms.driver.serialization (De-)Serialization method used for asynchronous communication. Possible values are barrayand json
owms.driver.osip.enabled Whether OSIP telegram support is enabled or not
owms.driver.osip.sync-field Value of the SYNC field used to detect the start of a telegram
owms.driver.osip.date-pattern Date pattern used in OSIP telegrams
owms.driver.routing-service.name The logical service name of the TMS Routing Service
owms.driver.routing-service.protocol The protocol used to connect to the TMS Routing Service (eg. https)
owms.driver.routing-service.username The username for BASIC authentication
owms.driver.routing-service.password The password for BASIC authentication
owms.driver.connections.hostname The hostname setting inherited to all subsequent subsystem configurations
owms.driver.connections.port-rest The driver accepts incoming connections at this port in synchronous communication
owms.driver.connections.so-timeout The socket timeout inherited to all subsequent subsystem configurations
owms.driver.connections.so-receive-buffer-size The receiving buffer size inherited to all subsequent subsystem configurations
owms.driver.connections.so-send-buffer-size The sending buffer size inherited to all subsequent subsystem configurations
owms.driver.connections.identified-by-field The identified-by-field inherited to all subsequent subsystem configurations
owms.driver.connections.subsystems A list of subsystems. A driver can handle multiple subsystems in different modes
owms.driver.connections.subsystems[].name Unique name of the subsystem
owms.driver.connections.subsystems[].inbound.mode The operational mode. Either server or client
owms.driver.connections.subsystems[].inbound.hostname The hostname to connect to or the name of the interface to listen on (if mode is server)
owms.driver.connections.subsystems[].inbound.port The port to connect to or to listen on
owms.driver.connections.subsystems[].inbound.so-timeout The socket timeout
owms.driver.connections.subsystems[].inbound.so-receive-buffer-size The size of the receiving buffer
owms.driver.connections.subsystems[].outbound.mode The operational mode. Either server or client
owms.driver.connections.subsystems[].outbound.hostname The hostname to connect to or the name of the interface to listen on (if mode is server)
owms.driver.connections.subsystems[].outbound.port The port to connect to or to listen on
owms.driver.connections.subsystems[].outbound.so-timeout The socket timeout
owms.driver.connections.subsystems[].outbound.so-send-buffer-size The size of the send buffer
owms.driver.connections.subsystems[].outbound.identified-by-field The name of the telegram field that identifies the telegram receiver
owms.driver.connections.subsystems[].outbound.identified-by-value The actual telegram receiver name
owms.driver.connections.subsystems[].duplex.mode The operational mode. Either server or client
owms.driver.connections.subsystems[].duplex.hostname The hostname to connect to or the name of the interface to listen on (if mode is server)
owms.driver.connections.subsystems[].duplex.port The port to connect to or to listen on
owms.driver.connections.subsystems[].duplex.so-timeout The socket timeout
owms.driver.connections.subsystems[].duplex.so-send-buffer-size The size of the send buffer
owms.driver.connections.subsystems[].duplex.so-receive-buffer-size The size of the receiving buffer
owms.driver.connections.subsystems[].duplex.identified-by-field The name of the telegram field that identifies the telegram receiver
owms.driver.connections.subsystems[].duplex.identified-by-value The actual telegram receiver name

Logging

The driver component is configured for tenant aware logging. If, for instance, the tenant is configured to 'myProject' (owms.tenant=myProject) a tslog file (Technical Service Log) is written with name 'myProject-COMMON.tslog' that contains the time consumption processing each telegram took. An example tslog file looks like:

myProject COMMON 2018-09-27 15:26:27.280  INFO  [MEASURED                                ] : [TSL]>> ErrorMessageServiceActivator#wakeUp
myProject COMMON 2018-09-27 15:26:27.305  INFO  [MEASURED                                ] : [TSL]<< ErrorMessageServiceActivator#wakeUp took 26 [ms]
myProject COMMON 2018-09-27 15:27:01.586  INFO  [MEASURED                                ] : [TSL]>> TimesyncServiceActivator#wakeUp
myProject COMMON 2018-09-27 15:27:01.587  INFO  [MEASURED                                ] : [TSL]<< TimesyncServiceActivator#wakeUp took 1 [ms]
myProject COMMON 2018-09-27 15:28:48.638  INFO  [MEASURED                                ] : [TSL]>> TimesyncServiceActivator#wakeUp
myProject COMMON 2018-09-27 15:28:48.657  INFO  [MEASURED                                ] : [TSL]<< TimesyncServiceActivator#wakeUp took 22 [ms]
myProject COMMON 2018-09-27 15:28:50.704  INFO  [MEASURED                                ] : [TSL]>> TimesyncServiceActivator#wakeUp
Column Description
#1 Tenant name
#2 Module name (CORE, COMMON, TMS or WMS)
#3 Date of log entry written
#4 Time of log entry written
#5 Log level (INFO)
#6 Log category. All tslogs are using the category MEASURED
#7 TSL is another identifier used in log processing systems like logstash
#8 >>: incoming or <<: outgoing
#9 Type of telegram activator and indirectly the telegram handler used. By this information the processing telegram can be determined
#10 How long the message processing took in ms

Build and Release

$ mvn deploy -Prelease,gpg -Ddebug.info=true
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed 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.

简介

OpenWMS OSIP TCP / IP驱动程序组件 展开 收起
Java 等 4 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/comk1/org.openwms.common.comm.git
git@gitee.com:comk1/org.openwms.common.comm.git
comk1
org.openwms.common.comm
org.openwms.common.comm
master

搜索帮助