controlsystemadapter-opc-ua-adapter

The OPC-UA implementation for the ControlSystemAdapter

https://github.com/chimeratk/controlsystemadapter-opc-ua-adapter

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

The OPC-UA implementation for the ControlSystemAdapter

Basic Info
  • Host: GitHub
  • Owner: ChimeraTK
  • License: lgpl-3.0
  • Language: Python
  • Default Branch: master
  • Size: 5.52 MB
Statistics
  • Stars: 2
  • Watchers: 11
  • Forks: 5
  • Open Issues: 5
  • Releases: 1
Created almost 10 years ago · Last pushed 8 months ago
Metadata Files
Readme License Citation Authors

README.md

ControlSystem-OPCUA_Adapter

License DOI Supported Platforms

Welcome to the ControlSystem-OPCUA_Adapter project. This project add an control system adapter to ChimeraTK, that is based on the OPC UA stack open62541.

Mapping

In order to use the control system adapter a dedicated map file is required. The name of the map file is expected to be ApplicationName_mapping.xml, where ApplicationName is the name of the ChiemraTK application.

The map file allows to change general OPC UA settings and to control/configure the process of mapping ChimarTK process variables to OPC UA nodes. In principle all process variables are mapped in the OPC UA server. Node IDs and browse names are derived from the process variables register paths. The mapping allows to extend the variable tree based on the tree created from mapping the ChimeraTK process variables. Details can be found in the documentation of the xml scheme file. An example map file, illustrated how to set general properties of the OPC UA server.

Map file generator

It is recommended to use the mapfile generator included in this project to generate map files or to modify existing map files. The generator can be started without any input files. It allows to create map file that includes the general server configuration parameters: * Port * Application root directory, name, description * Enable encrytion * Requires server certificate and private key * Optinal supply CA certificate, revocation list, trusted certiciates * Add login * username * password * Set logging level (can be changes also at runtime)

Each ChimeraTK application should include an XML generator that allows to create an XML file that includes the address space of the application. If using the map file generator with such an application specific XML fie the generaotr allows to: * Rename process variables or folders (double click on the name to edit) * Restructure the address space * Move individual process variables to a different location (drag and drop) * Move complete folder to a different location (drag and drop) * Exclude process variables or folders from the mapping process * Excluded process variables will not be part of the OPC UA address space * The application is optimized considering unmapped process variables * Change process variable unit and description * Assign a history to process variables or folders (add history setting first and use folder/process variable drop down after) * Multiple history settings can be created * A history can be assigned to all application input variables with one single switch

Below is a screenshot of the map file generator illustrating the features discussed above.

Mapfile Generator Example

OPC UA stack

In principle it is possible to install open62541 via official packages, but it is recommended to install the open62541 interface included in ChiemraTK. It might include patches in the future and freezes the open62541 version. Thus, it is guaranteed that the control system adapter works - independent of upstream changes of the open62541 stack.

Author Contributions

A list of autors is contained in this directory.

Owner

  • Name: ChimeraTK
  • Login: ChimeraTK
  • Kind: organization

Control system and Hardware Interface with Mapped and Extensible Register-based device Abstraction Tool Kit

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: >-
  OPC UA based control system adapter for the ChimeraTK
  framework
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Klaus
    family-names: Zenker
    orcid: 'https://orcid.org/0000-0002-8120-6806'
    affiliation: Helmholtz-Zentrum Dresden-Rossendorf
  - given-names: Chris
    family-names: Iatrou
    affiliation: Technische Universität Dresden
  - family-names: Rahm
    given-names: Julian
    affiliation: Technische Universität Dresden
  - family-names: Pfrommer
    given-names: Julius
    affiliation: >-
      Fraunhofer-Institut für Optronik, Systemtechnik und
      Bildauswertung IOSB 
  - affiliation: >-
      Fraunhofer-Institut für Optronik, Systemtechnik und
      Bildauswertung IOSB 
    family-names: Bischoff
    given-names: Tino
  - family-names: Ebner
    given-names: Andreas
    affiliation: >-
      Fraunhofer-Institut für Optronik, Systemtechnik und
      Bildauswertung IOSB 
  - family-names: Düwel
    given-names: Florian
    affiliation: >-
      Fraunhofer-Institut für Optronik, Systemtechnik und
      Bildauswertung IOSB 
identifiers:
  - type: doi
    value: 10.14278/rodare.3257
repository-code: >-
  https://github.com/ChimeraTK/ControlSystemAdapter-OPC-UA-Adapter
url: >-
  https://chimeratk.github.io/ChimeraTK-ControlSystemAdapter-OPCUAAdapter/head/html/index.html
keywords:
  - OPC UA
  - ChimeraTK
  - Control System
license: LGPL-3.0
commit: >-
  https://github.com/ChimeraTK/ControlSystemAdapter-OPC-UA-Adapter/commit/87b06e423945897cffb9f0c17869c0ac7cfdd928
version: 04.00.00
date-released: '2024-11-11'

GitHub Events

Total
  • Release event: 1
  • Delete event: 20
  • Push event: 41
  • Pull request review event: 1
  • Pull request event: 26
  • Fork event: 1
  • Create event: 22
Last Year
  • Release event: 1
  • Delete event: 20
  • Push event: 41
  • Pull request review event: 1
  • Pull request event: 26
  • Fork event: 1
  • Create event: 22

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 12
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 minute
  • Total issue authors: 0
  • Total pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 12
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 minute
  • Issue authors: 0
  • Pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • zenker (2)
  • d-rothe (1)
Pull Request Authors
  • zenker (10)
  • mhier (6)
  • killenb (5)
  • phako (2)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

pyproject.toml pypi