From 8eda4ef9a7786c8ed51557cec4de7907985da84f Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Wed, 11 Sep 2024 09:09:12 +0200 Subject: [PATCH] Chore: rename library to "Arduino_OPC_UA". --- README.md | 12 ++++++------ docs/api.md | 4 ++-- examples/opcua_server/opcua_server.ino | 2 +- extras/precompile/Dockerfile | 2 +- extras/precompile/docker-run.sh | 2 +- keywords.txt | 2 +- library.properties | 6 +++--- package-lock.json | 2 +- src/{Arduino_open62541.h => Arduino_OPC_UA.h} | 0 src/Opta.h | 2 +- 10 files changed, 17 insertions(+), 17 deletions(-) rename src/{Arduino_open62541.h => Arduino_OPC_UA.h} (100%) diff --git a/README.md b/README.md index f5e33f1..8cb8f13 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -:floppy_disk: `Arduino_open62541` -================================= -[![Compile Examples](https://github.com/bcmi-labs/Arduino_open62541/workflows/Compile%20Examples/badge.svg)](https://github.com/bcmi-labs/Arduino_open62541/actions?workflow=Compile+Examples) -[![Arduino Lint](https://github.com/bcmi-labs/Arduino_open62541/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/bcmi-labs/Arduino_open62541/actions/workflows/arduino-lint.yml) -[![Sync Labels status](https://github.com/bcmi-labs/Arduino_open62541/actions/workflows/sync-labels.yml/badge.svg)](https://github.com/bcmi-labs/Arduino_open62541/actions/workflows/sync-labels.yml) +:floppy_disk: `Arduino_OPC_UA` +============================== +[![Compile Examples](https://github.com/bcmi-labs/Arduino_OPC_UA/workflows/Compile%20Examples/badge.svg)](https://github.com/bcmi-labs/Arduino_OPC_UA/actions?workflow=Compile+Examples) +[![Arduino Lint](https://github.com/bcmi-labs/Arduino_OPC_UA/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/bcmi-labs/Arduino_OPC_UA/actions/workflows/arduino-lint.yml) +[![Sync Labels status](https://github.com/bcmi-labs/Arduino_OPC_UA/actions/workflows/sync-labels.yml/badge.svg)](https://github.com/bcmi-labs/Arduino_OPC_UA/actions/workflows/sync-labels.yml) This library provides an implementation of [OPC/UA](https://en.wikipedia.org/wiki/OPC_Unified_Architecture) by porting the Fraunhofer [`open62541`](https://github.com/open62541/open62541) for the Arduino [Opta](https://www.arduino.cc/pro/hardware-arduino-opta/) `microPLC` family. @@ -31,7 +31,7 @@ $ cat /dev/ttyACM0 [2024-06-21 02:30:19.000 (UTC+0000)] info/server New DiscoveryUrl added: opc.tcp://192.168.8.137:4840 ``` * Connect to OPC/UA server using IP/port as printed by the Arduino Opta -![image](https://github.com/bcmi-labs/Arduino_open62541/assets/3931733/ac153e79-6648-4808-9c4f-17aaf4305d89) +![image](https://github.com/bcmi-labs/Arduino_OPC_UA/assets/3931733/ac153e79-6648-4808-9c4f-17aaf4305d89) ### How-to-`opcua-client-gui` ```bash diff --git a/docs/api.md b/docs/api.md index 3f6cb4d..5ce24de 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2,11 +2,11 @@ Members | Descriptions --------------------------------|--------------------------------------------- -`namespace ` [`opcua`](#namespaceopcua) | opcua is used as enclosing namespace for all parts of the Arduino_open62541 library in order to avoid naming conflicts with already existing frameworks pertaining the Arduino [Opta](#classopcua_1_1_opta). +`namespace ` [`opcua`](#namespaceopcua) | opcua is used as enclosing namespace for all parts of the Arduino_OPC_UA library in order to avoid naming conflicts with already existing frameworks pertaining the Arduino [Opta](#classopcua_1_1_opta). # namespace `opcua` -opcua is used as enclosing namespace for all parts of the Arduino_open62541 library in order to avoid naming conflicts with already existing frameworks pertaining the Arduino [Opta](#classopcua_1_1_opta). +opcua is used as enclosing namespace for all parts of the Arduino_OPC_UA library in order to avoid naming conflicts with already existing frameworks pertaining the Arduino [Opta](#classopcua_1_1_opta). ## Summary diff --git a/examples/opcua_server/opcua_server.ino b/examples/opcua_server/opcua_server.ino index ab92976..332937a 100644 --- a/examples/opcua_server/opcua_server.ino +++ b/examples/opcua_server/opcua_server.ino @@ -2,7 +2,7 @@ * INCLUDE **************************************************************************************/ -#include +#include #include #include /* Arduino_Opta_Blueprint */ #include diff --git a/extras/precompile/Dockerfile b/extras/precompile/Dockerfile index c9c0b3e..b148b5f 100644 --- a/extras/precompile/Dockerfile +++ b/extras/precompile/Dockerfile @@ -5,4 +5,4 @@ RUN apt-get update && \ apt-get clean && \ rm -rf /var/lib/apt/lists/* -CMD ["/bin/bash", "-c", "cd /Arduino_open62541; ./extras/precompile/precompile.sh; exit"] +CMD ["/bin/bash", "-c", "cd /Arduino_OPC_UA; ./extras/precompile/precompile.sh; exit"] diff --git a/extras/precompile/docker-run.sh b/extras/precompile/docker-run.sh index 5c26976..3bf3836 100755 --- a/extras/precompile/docker-run.sh +++ b/extras/precompile/docker-run.sh @@ -1,4 +1,4 @@ #!/bin/bash set -euo pipefail IFS=$'\n\t' -docker run -it -v ${PWD}/../../:/Arduino_open62541 open62541_precompile_lib +docker run -it -v ${PWD}/../../:/Arduino_OPC_UA open62541_precompile_lib diff --git a/keywords.txt b/keywords.txt index 09234fc..b6d3f51 100644 --- a/keywords.txt +++ b/keywords.txt @@ -1,5 +1,5 @@ ####################################### -# Syntax Coloring Map for Arduino_open62541 +# Syntax Coloring Map for Arduino_OPC_UA ####################################### ####################################### diff --git a/library.properties b/library.properties index dd4148e..f54b0e1 100644 --- a/library.properties +++ b/library.properties @@ -1,4 +1,4 @@ -name=Arduino_open62541 +name=Arduino_OPC_UA version=0.0.1 author=Arduino maintainer=Arduino @@ -6,8 +6,8 @@ sentence=Arduino port of the open62541 providing OPC/UA for Arduino Opta. paragraph=This library is an Arduino port of open62541, an open source implementation of OPC UA (OPC Unified Architecture / IEC 62541) written in the C language. category=Communication architectures=mbed_opta -url=https://github.com/bcmi-labs/Arduino_open62541 +url=https://github.com/bcmi-labs/Arduino_OPC_UA ldflags=-lopen62541 -includes=Arduino_open62541.h +includes=Arduino_OPC_UA.h precompiled=true depends=Arduino_Opta_Blueprint diff --git a/package-lock.json b/package-lock.json index 45943a7..0108b0e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "Arduino_open62541", + "name": "Arduino_OPC_UA", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/src/Arduino_open62541.h b/src/Arduino_OPC_UA.h similarity index 100% rename from src/Arduino_open62541.h rename to src/Arduino_OPC_UA.h diff --git a/src/Opta.h b/src/Opta.h index caa68ef..d842105 100644 --- a/src/Opta.h +++ b/src/Opta.h @@ -30,7 +30,7 @@ **************************************************************************************/ /** - * opcua is used as enclosing namespace for all parts of the Arduino_open62541 library + * opcua is used as enclosing namespace for all parts of the Arduino_OPC_UA library * in order to avoid naming conflicts with already existing frameworks pertaining the * Arduino Opta. */