Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/locka99/opcua

A client and server implementation of the OPC UA specification written in Rust
https://github.com/locka99/opcua

embedded iec-62541 iot monitoring opc opc-ua rust

Last synced: 7 days ago
JSON representation

A client and server implementation of the OPC UA specification written in Rust

Awesome Lists containing this project

README 

        
# Introduction



This is an [OPC UA](https://opcfoundation.org/about/opc-technologies/opc-ua/) server / client API implementation for Rust.



[![Build Status](https://github.com/locka99/opcua/workflows/OPC%20UA%20for%20Rust/badge.svg)](https://github.com/locka99/opcua/actions/workflows/main.yml)



OPC UA is an industry standard for monitoring of data. It's used extensively for embedded devices, industrial control, IoT,

etc. - just about anything that has data that something else wants to monitor, control or visualize. 



Rust is a systems programming language and is therefore a natural choice for implementing OPC UA. This implementation 

supports the embedded, micro and nano profiles but may grow to support features in time.



Read the [compatibility](./docs/compatibility.md) page for how the implementation conforms with the OPC UA spec.



Read the [change log](./CHANGELOG.md) for changes per version as well as aspirational / upcoming work.



# License



The code is licenced under [MPL-2.0](https://opensource.org/licenses/MPL-2.0). Like all open source code, you use this code at your own risk. 



# Setup



Read the [setup](./docs/setup.md) for instructions on building OPCUA for Rust.



Read [cross compilation](./docs/cross-compile.md) for hints for cross compiling OPC UA for Rust to other 

platforms.



# Migration notes



If you're using an earlier version of OPC UA for Rust, read the [migration](./docs/migration.md) notes.



# Design



Read the [design](./docs/design.md) for more in-depth description of implementation.



# Tutorial



Tutorials / user guides are still work in progress. 



* [Client Tutorial](docs/client.md)

* [Server Tutorial](docs/server.md)



# Further Documentation



The API documentation is generated from the latest published crates. This may be some way behind current development. 






# Samples



If you want to get stuck in, there are a number of samples in the samples/ folder. The `simple-client` and the `simple-server` projects are

minimal client and server programs respectively.



```bash

# In one bash

cd opcua/samples/simple-server

cargo run

# In another bash

cd opcua/samples/simple-client

cargo run

```



The full list of samples:



1. [`simple-server`](samples/simple-server) - an OPC UA server that adds 4 variables v1, v2, v3 and v4 and updates them from a timer via push and pull mechanisms.

2. [`simple-client`](samples/simple-client) - an OPC UA client that connects to a server and subscribes to the values of v1, v2, v3 and v4.

3. [`discovery-client`](samples/discovery-client) - an OPC UA client that connects to a discovery server and lists the servers registered on it.

4. [`chess-server`](samples/chess-server) - an OPC UA server that connects to a chess engine as its back end and updates variables representing the state of the game.

5. [`demo-server`](samples/demo-server) - an OPC UA server that is more complex than the simple server and can be used for compliance testing.

6. [`mqtt-client`](samples/mqtt-client) - an OPC UA client that subscribes to some values and publishes them to an MQTT broker.

7. [`event-client`](samples/event-client) - an OPC UA client that will connect to a server and subscribe to alarms / events.