Skip to content
Snippets Groups Projects
Commit b0b802f0 authored by Susanna Weber's avatar Susanna Weber
Browse files

further changes to readme.md

parent 555bba54
Branches
No related tags found
No related merge requests found
...@@ -4,13 +4,16 @@ ...@@ -4,13 +4,16 @@
OPC UA-Generation from JSON-Files OPC UA-Generation from JSON-Files
## Description ## Description
This project can iterate JSON-Models generated from SOIL-Interfaces and convert them into an OPC UA Server.At the moment everything except enums can be generated. Our code generates the functions as empty bodies, but you get a descripton and a guide on how to integrate your algorithm. This project can iterate **JSON-Models** generated from SOIL-Interfaces and convert them into an **OPC UA Server**. At the moment everything except enums can be generated. Our code generates the functions as empty bodies, but you get a **descripton** and a **small guide** on how to integrate your algorithm.
## Installation ## Installation
1. Clone Project in a Directory of your choice 1. Clone Project in a Directory of your choice
2. Copy the jsonfile you want to generate in that folder 2. Copy the jsonfile you want to generate in that folder
3. If you want to run the code manually run: 3. If you want to run the code **manually** run:
```$pip install -r requirements.txt```
```$ pip install -r requirements.txt```
## Usage:
## Usage with Dockerfile ## Usage with Dockerfile
3. Change file name of the json file in line 16 to the name of the file which you wish to generate 3. Change file name of the json file in line 16 to the name of the file which you wish to generate
...@@ -18,17 +21,20 @@ This project can iterate JSON-Models generated from SOIL-Interfaces and convert ...@@ -18,17 +21,20 @@ This project can iterate JSON-Models generated from SOIL-Interfaces and convert
## Usage manually ## Usage manually
1. run: 1. run:
```$python newmodeljsonparse.py "name of your file"```
```$ python newmodeljsonparse.py <name of your file>```
## How to modify the server ## How to modify the server
1. Functions: 1. Functions:
To get the value of a node use: - To get the value of a node use:
await node.get_value()
To changethe value of a node use: ```await node.get_value()```
await node.set_value() - To change the value of a node use:
```await node.set_value()```
2. For everything else it is the easiest to just change your Json-Model accordingly and generate a new server. 2. For everything else it is the easiest to just change your Json-Model accordingly and generate a new server.
## Roadmap ## Roadmap
One could work on connecting the events and Streams to their respective Objecttypes, to make it easier for the user. One could work on connecting the events and Streams to their respective objecttypes, to make it easier for the user.
The dynamic streams also can't be generated at the moment. The dynamic streams also can't be generated at the moment.
Ranges are not enforced as of now. Ranges are not enforced as of now.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment