feat: Add device-opcua documentation

Signed-off-by: Jieke Choo <jiekechoo@yiqisoft.cn>
edgexfoundry · Dec 15, 2023 · 89bde9e · 89bde9e
1 parent d2fa22c
commit 89bde9e
Show file tree

Hide file tree

Showing 10 changed files with 453 additions and 0 deletions.
diff --git a/docs_src/microservices/device/services/device-opcua/ApiReference.md b/docs_src/microservices/device/services/device-opcua/ApiReference.md
@@ -0,0 +1,7 @@
+---
+title: Device OPC-UA - API Reference
+---
+
+# Device OPC-UA - API Reference
+
+This service inherits the [Common Device Service APIs](../../ApiReference.md) from the SDK.
diff --git a/docs_src/microservices/device/services/device-opcua/Configuration.md b/docs_src/microservices/device/services/device-opcua/Configuration.md
@@ -0,0 +1,31 @@
+---
+title: Device OPC-UA - Configuration
+---
+
+# Device OPC-UA - Configuration
+
+OPC-UA Device Service has the following configurations to implement the `OPCUAServer` protocol.
+
+Example of OPCUAServer as shown below:
+
+```yaml
+# configuration.yml
+
+OPCUAServer:
+  DeviceName: SimulationServer
+  Policy: None
+  Mode: None
+  CertFile: ''
+  KeyFile: ''
+  Writable:
+    Resources: 'Counter,Random'
+```
+
+| Configuration      | Default Value     | Description                                                                                                                                      |
+| ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| DeviceName         | SimmulationServer | Device name of OPC-UA                                                                                                                            |
+| Policy             | None              | Security Policy of OPC-UA<pre>- None<br>- Basic128Rsa15<br>- Basic256<br>- Basic256Sha256<br>- Aes128Sha256RsaOaep<br>- Aes256Sha256RsaPss</pre> |
+| Mode               | None              | Security Mode of OPC-UA<pre>-None<br>- Sign<br>- SignAndEncrypt</pre>                                                                            |
+| CertFile           | none              | Cert file of OPC-UA, path to cert.pem                                                                                                            |
+| KeyFile            | none              | Key file of OPC-UA, path to private key.pem                                                                                                      |
+| Writable.Resources | none              | Subscritions of OPC-UA                                                                                                                           |
diff --git a/...services/device/services/device-opcua/EdgeX_ExampleOPCUA_simulation_objects.png b/...services/device/services/device-opcua/EdgeX_ExampleOPCUA_simulation_objects.png
diff --git a/...services/device/services/device-opcua/EdgeX_ExampleOPCUA_simulation_startup.png b/...services/device/services/device-opcua/EdgeX_ExampleOPCUA_simulation_startup.png
diff --git a/...oservices/device/services/device-opcua/EdgeX_ExampleOPCUA_simulation_status.png b/...oservices/device/services/device-opcua/EdgeX_ExampleOPCUA_simulation_status.png