Skip to content

Commit

Permalink
Rename samples folder to examples
Browse files Browse the repository at this point in the history
  • Loading branch information
flosse committed Nov 22, 2023
1 parent 496f1e5 commit 7d13055
Show file tree
Hide file tree
Showing 59 changed files with 119 additions and 118 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ target/
pki/
log/
/curl-ca-bundle.crt
/samples/server.test.conf
/examples/server.test.conf
/integration/pki-client
/integration/pki-server
3rd-party/open62541/build/
3rd-party/open62541/build/
6 changes: 3 additions & 3 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"program": "${workspaceRoot}/target/debug/opcua-simple-client.exe",
"args": [],
"stopAtEntry": false,
"cwd": "${workspaceRoot}/samples/simple-client",
"cwd": "${workspaceRoot}/exsamples/simple-client",
"environment": [],
"externalConsole": true,
"MIMode": "gdb",
Expand All @@ -29,7 +29,7 @@
"program": "${workspaceRoot}/target/debug/opcua-simple-server.exe",
"args": [],
"stopAtEntry": false,
"cwd": "${workspaceRoot}/samples/simple-server",
"cwd": "${workspaceRoot}/exsamples/simple-server",
"environment": [],
"externalConsole": true,
"MIMode": "gdb",
Expand Down Expand Up @@ -85,4 +85,4 @@
],
"windows": {
}
}
}
16 changes: 8 additions & 8 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
members = [
"lib",
"integration",
"samples/demo-server",
"samples/simple-client",
"samples/mqtt-client",
"samples/simple-server",
"samples/chess-server",
"samples/discovery-client",
"samples/web-client",
"samples/event-client",
"examples/demo-server",
"examples/simple-client",
"examples/mqtt-client",
"examples/simple-server",
"examples/chess-server",
"examples/discovery-client",
"examples/web-client",
"examples/event-client",
"tools/certificate-creator"
]

Expand Down
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ This is an [OPC UA](https://opcfoundation.org/about/opc-technologies/opc-ua/) se
[![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.
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
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.
Expand All @@ -16,13 +16,13 @@ Read the [change log](./CHANGELOG.md) for changes per version as well as aspirat

# 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.
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
Read [cross compilation](./docs/cross-compile.md) for hints for cross compiling OPC UA for Rust to other
platforms.

# Migration notes
Expand All @@ -35,38 +35,38 @@ Read the [design](./docs/design.md) for more in-depth description of implementat

# Tutorial

Tutorials / user guides are still work in progress.
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.
The API documentation is generated from the latest published crates. This may be some way behind current development.

<a href="https://docs.rs/opcua"><img src="https://docs.rs/opcua/badge.svg"></img></a>

# Samples
# Examples

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
If you want to get stuck in, there are a number of examples in the `examples/` 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
cd opcua/examples/simple-server
cargo run
# In another bash
cd opcua/samples/simple-client
cd opcua/examples/simple-client
cargo run
```

The full list of samples:
The full list of examples:

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. [`web-client`](samples/web-client) - an OPC UA client that subscribes to some values and streams them over a websocket.
8. [`modbus-server`](samples/modbus-server) - an OPC UA server that translates variables from MODBUS.
1. [`simple-server`](examples/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`](examples/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`](examples/discovery-client) - an OPC UA client that connects to a discovery server and lists the servers registered on it.
4. [`chess-server`](examples/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`](examples/demo-server) - an OPC UA server that is more complex than the simple server and can be used for compliance testing.
6. [`mqtt-client`](examples/mqtt-client) - an OPC UA client that subscribes to some values and publishes them to an MQTT broker.
7. [`web-client`](examples/web-client) - an OPC UA client that subscribes to some values and streams them over a websocket.
8. [`modbus-server`](examples/modbus-server) - an OPC UA server that translates variables from MODBUS.
Loading

0 comments on commit 7d13055

Please sign in to comment.