Skip to content

Commit

Permalink
README: Updates for 0.10
Browse files Browse the repository at this point in the history 
- remove "under development status"
- open62541 no longer "partially" integrated
- few minor wording changes
- lots of formatting changes to silence Codacy
  • Loading branch information
@ralphlange
ralphlange committed Sep 4, 2024
1 parent 7b650af commit 2d61ef3
Showing 1 changed file with 57 additions and 51 deletions.
108 changes: 57 additions & 51 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,75 +1,76 @@
<a target="_blank" href="http://semver.org">![Version][badge.version]</a>
<a target="_blank" href="https://app.codacy.com/gh/epics-modules/opcua/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade">![Codacy grade][badge.codacy]</a>

[![open62541](https://github.com/epics-modules/opcua/actions/workflows/ci-build-open62541-linux.yml/badge.svg)](https://github.com/epics-modules/opcua/actions/workflows/ci-build-open62541-linux.yml)
[![UA SDK](https://github.com/epics-modules/opcua/actions/workflows/ci-build-uasdk-linux.yml/badge.svg)](https://github.com/epics-modules/opcua/actions/workflows/ci-build-uasdk-linux.yml)
[![open62541][badge.open62541-linux]](https://github.com/epics-modules/opcua/actions/workflows/ci-build-open62541-linux.yml)
[![UA SDK][badge.uasdk-linux]](https://github.com/epics-modules/opcua/actions/workflows/ci-build-uasdk-linux.yml)

[![open62541](https://github.com/epics-modules/opcua/actions/workflows/ci-build-open62541-win.yml/badge.svg)](https://github.com/epics-modules/opcua/actions/workflows/ci-build-open62541-win.yml)
[![UA SDK](https://github.com/epics-modules/opcua/actions/workflows/ci-build-uasdk-win.yml/badge.svg)](https://github.com/epics-modules/opcua/actions/workflows/ci-build-uasdk-win.yml)
[![open62541][badge.open62541-win]](https://github.com/epics-modules/opcua/actions/workflows/ci-build-open62541-win.yml)
[![UA SDK][badge.uasdk-win]](https://github.com/epics-modules/opcua/actions/workflows/ci-build-uasdk-win.yml)

# opcua - EPICS Device Support for OPC UA

[EPICS](https://epics-controls.org) Device Support module for interfacing
to the OPC UA protocol. The architecture allows supporting different
implementations of the low level client library.
[EPICS](https://epics-controls.org)
Device Support module for interfacing to the OPC UA protocol.
The architecture allows using different implementations
of the low level client library.

Linux and Windows builds are supported.
Linux and Windows native builds are supported.

## Status

:warning:
This module is under development.
Please contact the author [Ralph Lange](mailto:ralph.lange@gmx.de) for details.
:warning:
The module is under development, but releases are stable and robust.

There are two choices for the low-level OPC UA client library:

1. The commercially available Unified Automation C++ Based OPC UA Client SDK. \
This is the original, full implementation.
1. The commercially available
[Unified Automation C++ Based OPC UA Client SDK][unified.sdk]. \
This is the original implementation.

2. The open source client implementation of the open62541 project. \
This integration is still experimental and does not support structured data yet.
2. The open source client of the [open62541 project SDK][open62541.sdk]. \
This integration is relatively new (2024)
and hasn't seen much in-production use yet.

## Prerequisites

* A C++ compiler that supports the C++11 standard. \
Microsoft Visual C++ needs to be from Visual Studio 2015 or newer.
g++ needs to be 4.6 or above.
* A C++ compiler that supports the C++11 standard. \
Microsoft Visual C++ needs to be from Visual Studio 2015 or newer.
g++ needs to be 4.6 or above.

* [EPICS Base](https://epics-controls.org/resources-and-support/base/)
3.15 (>= 3.15.7) or EPICS 7 (>= 7.0.4).
* [EPICS Base](https://epics-controls.org/resources-and-support/base/)
3.15 (>= 3.15.7) or EPICS 7 (>= 7.0.4).

* The [gtest module](https://github.com/epics-modules/gtest) if you want
to compile and run the Google Test based unit tests.
* The [gtest module](https://github.com/epics-modules/gtest) if you want
to compile and run the unit tests that are based on Google Test.

### Using the Unified Automation Client SDK

* Unified Automation C++ Based [OPC UA Client SDK][unified.sdk]
(1.5/1.6/1.7 are supported, as well as their evaluation bundles;
1.8 is having trouble).
* Unified Automation C++ Based [OPC UA Client SDK][unified.sdk]
(1.5/1.6/1.7 are supported, as well as their evaluation bundles;
1.8 is having trouble).

* For OPC UA security support (authentication/encryption), you need
openssl/libcrypto on your system - both when compiling the SDK and when
generating any binaries (IOCs).
* For OPC UA security support (authentication/encryption), you need
openssl/libcrypto on your system - both when compiling the SDK and when
generating any binaries (IOCs).

* In `CONFIG_SITE.local`, set `UASDK` to the path of the SDK installation.
* In `CONFIG_SITE.local`, set `UASDK` to the path of your SDK installation.

* For more details, refer to the `README.md` in the
[`devOpcuaSup/UaSdk`][uasdk.dir] directory.
* For more details, refer to the `README.md` in the
[`devOpcuaSup/UaSdk`][uasdk.dir] directory.

### Using the open62541 SDK

* The open62541 SDK is available at https://open62541.org/ \
Choose a recent release (1.2 and 1.3 are supported).
* The [open62541 SDK][open62541.sdk] \
Choose a recent release (1.2 and 1.3 are supported).
Download the sources using GitHub releases, not through the project website.

* For OPC UA security support (authentication/encryption), you need
openssl/libcrypto on your system - both when compiling the SDK and when
generating any binaries (IOCs).
* For OPC UA security support (authentication/encryption), you need
openssl/libcrypto on your system - both when compiling the SDK and when
generating any binaries (IOCs).

* In `CONFIG_SITE.local`, set `OPEN62541` to the path of the SDK installation.
* In `CONFIG_SITE.local`, set `OPEN62541` to the path of your SDK installation.

* For more details, refer to the `README.md` in the
[`devOpcuaSup/open62541`][open62541.dir] directory.
* For more details, refer to the `README.md` in the
[`devOpcuaSup/open62541`][open62541.dir] directory.

## Building the module

Expand All @@ -82,9 +83,11 @@ installation. The `GTEST` module is needed to compile and run the tests.
Not defining it produces a clean build, but without any tests.

Configure the compiler on Linux to use the C++11 standard by adding

```makefile
USR_CXXFLAGS_Linux += -std=c++11
```

to the `CONFIG_SITE` file (or one of the host/target specific site
configuration files). \
It is preferable to set this option globally in EPICS Base.
Expand All @@ -97,9 +100,9 @@ is documented in the `README.md` file inside the respective subdirectory of

IOC applications that use the module need to

* add an entry to the Device Support module in their `RELEASE.local` file
* include `opcua.dbd` when building the IOC's DBD file
* include `opcua` in the support libraries for the IOC binary.
* add an entry to the Device Support module in their `RELEASE.local` file
* include `opcua.dbd` when building the IOC's DBD file
* include `opcua` in the support libraries for the IOC binary.

## Documentation

Expand All @@ -118,8 +121,10 @@ script and the database links.
Please look at the "Assets" sections of specific releases
on the [release page](https://github.com/epics-modules/opcua/releases)
for the binary distribution tars.
These tars contain an EPICS module with a binary Linux shared library (`libopcua.so.<version>`)
These tars contain an EPICS module
with a binary Linux shared library (`libopcua.so.<version>`)
that contains (embeds) the Unified Automation low-level client.

In your build setup, the module from the binary distribution
can be used like a support module built from source.
The binary device support is fully functional
Expand All @@ -141,7 +146,8 @@ This module is based on extensive
by Bernhard Kuner (HZB/BESSY) and uses ideas and code snippets from
Michael Davidsaver (Osprey DCS).

Support for the open62541 client library was added by Dirk Zimoch (PSI)
Support for the open62541 client library
and many fixes and new features were added by Dirk Zimoch (PSI)
with additional help from Carsten Winkler (HZB/BESSY).

The end-to-end test suite is a reduced clone of the test application
Expand All @@ -150,19 +156,19 @@ that has been developed at the ESS by Ross Elliot and Karl Vestin.
## License

This module is distributed subject to a Software License Agreement found
in file LICENSE that is included with this distribution.
in the file `LICENSE` that is included with this distribution.

<!-- Links -->
[badge.version]: https://img.shields.io/github/v/release/epics-modules/opcua?sort=semver
[badge.codacy]: https://app.codacy.com/project/badge/Grade/ec0d53f8285249d394b3af067acf2ad4
[badge.gha]: https://github.com/epics-modules/opcua/actions/workflows/ci-build.yml/badge.svg

[badge.ua-win]: https://github.com/epics-modules/opcua/actions/workflows/ci-build-uasdk-win.yml/badge.svg
[badge.ua-linux]:


[badge.uasdk-win]: https://github.com/epics-modules/opcua/actions/workflows/ci-build-uasdk-win.yml/badge.svg
[badge.uasdk-linux]: https://github.com/epics-modules/opcua/actions/workflows/ci-build-uasdk-linux.yml/badge.svg
[badge.open62541-win]: https://github.com/epics-modules/opcua/actions/workflows/ci-build-open62541-win.yml/badge.svg
[badge.open62541-linux]: https://github.com/epics-modules/opcua/actions/workflows/ci-build-open62541-linux.yml/badge.svg

[unified.sdk]: https://www.unified-automation.com/products/client-sdk/c-ua-client-sdk.html
[open62541.sdk]: https://open62541.org/

[uasdk.dir]: https://github.com/epics-modules/opcua/tree/master/devOpcuaSup/UaSdk
[open62541.dir]: https://github.com/epics-modules/opcua/tree/master/devOpcuaSup/open62541
Expand Down

0 comments on commit 2d61ef3

Please sign in to comment.