Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
renzop committed Sep 13, 2024
2 parents c899989 + 66c3d44 commit 9889042
Show file tree
Hide file tree
Showing 11 changed files with 270 additions and 212 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Make a minmal code example that reproduces the bug
2. Write about the environment (OS, OPC Server)
3. Can you reproduce the Bug with the Matrikon Simulation server in nomal opc Mode without the Gateway
4. Paste your environment variables of the Openopc2


**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.
Copy shell output text here (prefered to screenshots)

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Version [e.g. 22]
- OPC Server
- Python Version
- Environment Variables
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
13 changes: 10 additions & 3 deletions .github/workflows/build_exe.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,26 @@ jobs:
runs-on: windows-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
- name: Set up Python (32-bit)
uses: actions/setup-python@v5
with:
python-version: 3.8
architecture: x86
- name: Install poetry
uses: abatilo/actions-poetry@v3
- name: Register gbda_aut.dll
run: |
Copy-Item .\lib\gbda_aut.dll C:\Windows\System32\
regsvr32 /s C:\Windows\System32\gbda_aut.dll
shell: pwsh
- name: Install dependencies
run: poetry install
- name: Build executables
run: scripts/build_executables.ps1
- uses: ncipollo/release-action@v1
- name: Create GitHub Release
uses: ncipollo/release-action@v1
with:
artifacts: |
dist/OpenOpcCli.exe
dist/OpenOpcServer.exe
dist/OpenOpcService.exe
dist/OpenOpcService.exe
124 changes: 62 additions & 62 deletions CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,22 @@ $ openopc2 CLI [OPTIONS] COMMAND [ARGS]...

**Options**:

* `--install-completion`: Install completion for the current shell.
* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
* `--help`: Show this message and exit.
- `--install-completion`: Install completion for the current shell.
- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
- `--help`: Show this message and exit.

**Commands**:

* `list-clients`: [EXPERIMENTAL] List clients of OpenOPC...
* `list-tags`: List tags (items) of OPC server
* `properties`: Show properties of given tags
* `read`: Read tags
* `server-info`: Display OPC server information
* `write`: Write values
- `list-clients`: \[EXPERIMENTAL\] List clients of OpenOPC...
- `list-tags`: List tags (items) of OPC server
- `properties`: Show properties of given tags
- `read`: Read tags
- `server-info`: Display OPC server information
- `write`: Write values

## `openopc2 CLI list-clients`

[EXPERIMENTAL] List clients of OpenOPC Gateway Server
\[EXPERIMENTAL\] List clients of OpenOPC Gateway Server

**Usage**:

Expand All @@ -33,8 +33,8 @@ $ openopc2 CLI list-clients [OPTIONS]

**Options**:

* `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level [default: WARNING]
* `--help`: Show this message and exit.
- `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level \[default: WARNING\]
- `--help`: Show this message and exit.

## `openopc2 CLI list-tags`

Expand All @@ -48,15 +48,15 @@ $ openopc2 CLI list-tags [OPTIONS]

**Options**:

* `--protocol-mode [com|gateway]`: Protocol mode [default: gateway]
* `--opc-server TEXT`: OPC Server to connect to [default: Matrikon.OPC.Simulation]
* `--opc-host TEXT`: OPC Host to connect to [default: localhost]
* `--gateway-host TEXT`: OPC Gateway Host to connect to [default: 192.168.0.115]
* `--gateway-port INTEGER`: OPC Gateway Port to connect to [default: 7766]
* `--recursive / --no-recursive`: Recursively read sub-tags [default: False]
* `--output-csv / --no-output-csv`: Output in CSV format [default: False]
* `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level [default: WARNING]
* `--help`: Show this message and exit.
- `--protocol-mode [com|gateway]`: Protocol mode \[default: gateway\]
- `--opc-server TEXT`: OPC Server to connect to \[default: Matrikon.OPC.Simulation\]
- `--opc-host TEXT`: OPC Host to connect to \[default: localhost\]
- `--gateway-host TEXT`: OPC Gateway Host to connect to \[default: 192.168.0.115\]
- `--gateway-port INTEGER`: OPC Gateway Port to connect to \[default: 7766\]
- `--recursive / --no-recursive`: Recursively read sub-tags \[default: False\]
- `--output-csv / --no-output-csv`: Output in CSV format \[default: False\]
- `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level \[default: WARNING\]
- `--help`: Show this message and exit.

## `openopc2 CLI properties`

Expand All @@ -70,17 +70,17 @@ $ openopc2 CLI properties [OPTIONS] TAGS...

**Arguments**:

* `TAGS...`: Tags to read [required]
- `TAGS...`: Tags to read \[required\]

**Options**:

* `--protocol-mode [com|gateway]`: Protocol mode [default: gateway]
* `--opc-server TEXT`: OPC Server to connect to [default: Matrikon.OPC.Simulation]
* `--opc-host TEXT`: OPC Host to connect to [default: localhost]
* `--gateway-host TEXT`: OPC Gateway Host to connect to [default: 192.168.0.115]
* `--gateway-port INTEGER`: OPC Gateway Port to connect to [default: 7766]
* `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level [default: WARNING]
* `--help`: Show this message and exit.
- `--protocol-mode [com|gateway]`: Protocol mode \[default: gateway\]
- `--opc-server TEXT`: OPC Server to connect to \[default: Matrikon.OPC.Simulation\]
- `--opc-host TEXT`: OPC Host to connect to \[default: localhost\]
- `--gateway-host TEXT`: OPC Gateway Host to connect to \[default: 192.168.0.115\]
- `--gateway-port INTEGER`: OPC Gateway Port to connect to \[default: 7766\]
- `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level \[default: WARNING\]
- `--help`: Show this message and exit.

## `openopc2 CLI read`

Expand All @@ -94,24 +94,24 @@ $ openopc2 CLI read [OPTIONS] TAGS...

**Arguments**:

* `TAGS...`: Tags to read [required]
- `TAGS...`: Tags to read \[required\]

**Options**:

* `--protocol-mode [com|gateway]`: Protocol mode [default: gateway]
* `--opc-server TEXT`: OPC Server to connect to [default: Matrikon.OPC.Simulation]
* `--opc-host TEXT`: OPC Host to connect to [default: localhost]
* `--gateway-host TEXT`: OPC Gateway Host to connect to [default: 192.168.0.115]
* `--gateway-port INTEGER`: OPC Gateway Port to connect to [default: 7766]
* `--group-size INTEGER`: Group tags into group_size tags per transaction
* `--pause INTEGER`: Sleep time between transactionsin milliseconds [default: 0]
* `--source [cache|device|hybrid]`: Data SOURCE for reads (cache, device, hybrid) [default: hybrid]
* `--update-rate INTEGER`: Update rate for group in milliseconds [default: 0]
* `--timeout INTEGER`: Read timeout in milliseconds [default: 10000]
* `--include-error-messages / --no-include-error-messages`: Include descriptive error message strings [default: False]
* `--output-csv / --no-output-csv`: Output in CSV format [default: False]
* `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level [default: WARNING]
* `--help`: Show this message and exit.
- `--protocol-mode [com|gateway]`: Protocol mode \[default: gateway\]
- `--opc-server TEXT`: OPC Server to connect to \[default: Matrikon.OPC.Simulation\]
- `--opc-host TEXT`: OPC Host to connect to \[default: localhost\]
- `--gateway-host TEXT`: OPC Gateway Host to connect to \[default: 192.168.0.115\]
- `--gateway-port INTEGER`: OPC Gateway Port to connect to \[default: 7766\]
- `--group-size INTEGER`: Group tags into group_size tags per transaction
- `--pause INTEGER`: Sleep time between transactionsin milliseconds \[default: 0\]
- `--source [cache|device|hybrid]`: Data SOURCE for reads (cache, device, hybrid) \[default: hybrid\]
- `--update-rate INTEGER`: Update rate for group in milliseconds \[default: 0\]
- `--timeout INTEGER`: Read timeout in milliseconds \[default: 10000\]
- `--include-error-messages / --no-include-error-messages`: Include descriptive error message strings \[default: False\]
- `--output-csv / --no-output-csv`: Output in CSV format \[default: False\]
- `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level \[default: WARNING\]
- `--help`: Show this message and exit.

## `openopc2 CLI server-info`

Expand All @@ -125,13 +125,13 @@ $ openopc2 CLI server-info [OPTIONS]

**Options**:

* `--protocol-mode [com|gateway]`: Protocol mode [default: gateway]
* `--opc-server TEXT`: OPC Server to connect to [default: Matrikon.OPC.Simulation]
* `--opc-host TEXT`: OPC Host to connect to [default: localhost]
* `--gateway-host TEXT`: OPC Gateway Host to connect to [default: 192.168.0.115]
* `--gateway-port INTEGER`: OPC Gateway Port to connect to [default: 7766]
* `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level [default: WARNING]
* `--help`: Show this message and exit.
- `--protocol-mode [com|gateway]`: Protocol mode \[default: gateway\]
- `--opc-server TEXT`: OPC Server to connect to \[default: Matrikon.OPC.Simulation\]
- `--opc-host TEXT`: OPC Host to connect to \[default: localhost\]
- `--gateway-host TEXT`: OPC Gateway Host to connect to \[default: 192.168.0.115\]
- `--gateway-port INTEGER`: OPC Gateway Port to connect to \[default: 7766\]
- `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level \[default: WARNING\]
- `--help`: Show this message and exit.

## `openopc2 CLI write`

Expand All @@ -145,17 +145,17 @@ $ openopc2 CLI write [OPTIONS] TAG_VALUE_PAIRS...

**Arguments**:

* `TAG_VALUE_PAIRS...`: Tag value pairs to write (use ITEM,VALUE) [required]
- `TAG_VALUE_PAIRS...`: Tag value pairs to write (use ITEM,VALUE) \[required\]

**Options**:

* `--protocol-mode [com|gateway]`: Protocol mode [default: gateway]
* `--opc-server TEXT`: OPC Server to connect to [default: Matrikon.OPC.Simulation]
* `--opc-host TEXT`: OPC Host to connect to [default: localhost]
* `--gateway-host TEXT`: OPC Gateway Host to connect to [default: 192.168.0.115]
* `--gateway-port INTEGER`: OPC Gateway Port to connect to [default: 7766]
* `--group-size INTEGER`: Group tags into group_size tags per transaction
* `--pause INTEGER`: Sleep time between transactionsin milliseconds [default: 0]
* `--include-error-messages / --no-include-error-messages`: Include descriptive error message strings [default: False]
* `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level [default: WARNING]
* `--help`: Show this message and exit.
- `--protocol-mode [com|gateway]`: Protocol mode \[default: gateway\]
- `--opc-server TEXT`: OPC Server to connect to \[default: Matrikon.OPC.Simulation\]
- `--opc-host TEXT`: OPC Host to connect to \[default: localhost\]
- `--gateway-host TEXT`: OPC Gateway Host to connect to \[default: 192.168.0.115\]
- `--gateway-port INTEGER`: OPC Gateway Port to connect to \[default: 7766\]
- `--group-size INTEGER`: Group tags into group_size tags per transaction
- `--pause INTEGER`: Sleep time between transactionsin milliseconds \[default: 0\]
- `--include-error-messages / --no-include-error-messages`: Include descriptive error message strings \[default: False\]
- `--log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]`: Log level \[default: WARNING\]
- `--help`: Show this message and exit.
24 changes: 12 additions & 12 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
- Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down Expand Up @@ -121,8 +121,8 @@ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

[homepage]: https://www.contributor-covenant.org
Loading

0 comments on commit 9889042

Please sign in to comment.