README.txt

# Extended OPC UA Gateway

## Overview

This software has been developed within the framework of the I4byDesign Competence Center workflow (https://i4bydesign.gr/), specifically within the Frog IoT project in close cooperation with a team of researchers from Centre of Research and Technology, Hellas's Information Technology Insitute (ITI-CERTH). The goal was to enable the operation of a multi-endpoint Python-based industrial device, serving as a connector between OPC UA servers located on the industrial site and the Frog platform. Notably, the software is designed with a platform-independent orientation. Furthermore, third-party utilization is encouraged, fostering the broader adoption of OPC UA and contributing to the unification of industrial IoT practices.

## Project Details

The project consists of a main program, known as the "general manager," which operates as an MQTT client. It awaits commands from users through various topics, managing the registration details of OPC UA servers. Users have the capability to add, delete, and edit registered OPC UA servers. Additionally, the general manager includes the starting function for each OPC UA client instance, utilizing the `opcUaClientClass`. This class is based on the `asyncua` library and offers extra features.

The script `opcUaClientClass.py` implements an OPC UA client with an MQTT broker as a child object. It handles user messages received through the MQTT protocol. Each instance of `opcUaClientClass` has its own topics for receiving orders, such as method calls, variable subscriptions, un-subscriptions from variables, reads, writes, and node browsing. These topics are defined at the time of their creation. Furthermore, each instance has attributed topics for sending data to the user platform or database, including values from subscribed variables, the server's node architecture, console messages, and more.

The system aims to provide an innovative and adaptable solution for industrial environments where a single, complex IoT system is required for a variety of devices. The system is designed with fundamental local memory, storing all requested subscriptions in a static JSON file and all registered OPC UA servers in an `.ini` file, respectively.

## Third-Party Libraries

1. **Paho MQTT**
   - Description: Eclipse Paho MQTT Python client library.
   - License: Eclipse Public License 2.0
   - [Link to Paho MQTT Repository](https://github.com/eclipse/paho.mqtt.python/blob/master/LICENSE.txt)

2. **Asyncua**
   - Description: An asyncio library for OPC UA (Open Platform Communications Unified Architecture) protocol.
   - License: MIT License
   - [Link to Asyncua Repository](https://github.com/FreeOpcUa/opcua-asyncio/blob/master/COPYING)

3. **Python Standard Library**
   - Description: This project makes use of various modules from the Python Standard Library, including but not limited to:
     - `json`: JSON encoding and decoding.
     - `configparser`: Configuration file parsing.
     - `sys`: System-specific parameters and functions.
     - `threading`: Threading support for concurrent execution.
     - `time`: Time-related functions.

   - License: See Python Software Foundation License
   - [Link to Python Software Foundation License] (https://docs.python.org/3/license.html)


## Requirements

   - Install Python3

   - Install pip
      $ sudo apt-install pip

   - Install Asyncua package:
      $ pip install asyncua

   - Install numpy:
      $ pip install numpy

   - Install paho mqtt:
      $ pip install paho-mqtt

   - Install dict2xml:
      $ python3 -m install dict2xml

   - Install Configparser:
      $ pip install configparser

## Installation

   $ cd /path/to/your/desired/directory
   $ git clone https://github.com/YiannisTsitouridis/Extended-OPC-UA-Client.git

## Usage

To run the client's application you need to start the main.py
   $ cd Extended-OPC-UA-Client
   $ ./main.py

Then what's needed is a banch of commands through MQTT messages:

## Description of MQTT messages

...

## Acknowledgments

We extend our heartfelt gratitude to the individuals and organizations whose contributions have been instrumental in the development and success of this project. Their unwavering support, valuable insights, and dedicated efforts have significantly shaped the project into its current form. Special thanks to:

- **Petros Iakovou (I4byDesign):** For skillfully project managing I4byDesign's Frog Project ([Watch the video](https://www.youtube.com/watch?v=7eMxYEYd3J8)) **[github link](https://github.com/berxt).
- **Apostolos Papagiannis (I4byDesign):** For playing a key role in establishing the project's foundations during its early stages **[github link](https://github.com/apost9lis).
- **Chris Sougles (CERTH):** For overseeing the hardware design of I4byDesign's OPC UA gateway, the planned platform for running this software **[github link]().
- **Dimos Ioannidis (CERTH):** For serving as an overall supervisor for the Frog project **[github link]().

We also express gratitude to the broader open-source community for creating the tools and libraries that empower our project, with special recognition to the authors of `asyncua`, a project that has proven pivotal in addressing many of our challenges.

Thank you to everyone who has contributed, provided feedback, and supported us along the way. Your efforts are genuinely appreciated. And we continue to move forward...


## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.