tosca-controller 0.1.1

A library for building a controller that manages all Tosca devices across a network.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

<div align="center">

# `tosca-controller`

[![Crates.io Version][crates.io badge]][crates.io]
[![LICENSE][license badge]][license]

</div>

The `tosca-controller` library crate offers a set of APIs to manage,
orchestrate, and interact with all `tosca`-compliant devices within a network.

A device is compliant with the `tosca` architecture if its firmware is built
using the `tosca` APIs designed for the relative microcontroller.

The core functionalities of this crate include:

- Discovering all devices within the network that are compliant with the
  `tosca` architecture
- Constructing and sending _REST_ requests to `tosca` devices to trigger
  one or more of their operations
- Defining security and privacy policies to allow or block requests
- Intercepting device events by subscribing to the brokers where
  they are published

To optimize system resource usage, `tosca-controller` leverages `tokio` as an
asynchronous executor. This improves performance by allowing concurrent
execution of independent tasks. If the underlying machine is multi-threaded,
the performance boost is further amplified, as tasks are distributed across
multiple threads too.

# Build Process

To compile this crate with the debug profile, run:

```console
cargo build
```

To compile this crate with the release profile, which applies all optimizations
for faster performance and reduced memory usage, run:

```
cargo build --release
```

# Build Examples

The [examples](https://github.com/ToscaLabs/tosca/tree/master/crates/tosca-controller/examples)
directory includes some examples to interact with the `tosca` devices within
a network. Each example is independent from another and can be moved to
a separate repository.

To build an example:

```console
cd examples/[example directory name]
cargo build [--release]
```

<!-- Links -->
[crates.io]: https://crates.io/crates/tosca-controller
[license]: https://github.com/ToscaLabs/tosca?tab=readme-ov-file#license

<!-- Badges -->
[crates.io badge]: https://img.shields.io/crates/v/tosca-controller.svg
[license badge]: https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg