Skip to content

Commit

Permalink
Convert Mock Digital Twin to be compatible with standard adapters (#144)
Browse files Browse the repository at this point in the history
- Converts the Mock Digital Twin to be compatible with the standard adapters (fixes #143)
- Creates the standard Freyja application since it was convenient for testing (fixes #142)
- Removes any HTTP-based adapters that were used with the old implementation as well as deprecated examples
  • Loading branch information
wilyle authored Feb 27, 2024
1 parent cd5842d commit af3ce5c
Show file tree
Hide file tree
Showing 35 changed files with 398 additions and 928 deletions.
42 changes: 9 additions & 33 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 0 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@ resolver = "2"
members = [
"adapters/cloud/grpc_cloud_adapter",
"adapters/cloud/in_memory_mock_cloud_adapter",
"adapters/data/http_mock_data_adapter",
"adapters/data/in_memory_mock_data_adapter",
"adapters/data/managed_subscribe_data_adapter",
"adapters/data/mqtt_data_adapter",
"adapters/data/sample_grpc_data_adapter",
"adapters/digital_twin/grpc_digital_twin_adapter",
"adapters/digital_twin/in_memory_mock_digital_twin_adapter",
"adapters/digital_twin/mock_digital_twin_adapter",
"adapters/mapping/grpc_mapping_adapter",
"adapters/mapping/in_memory_mock_mapping_adapter",
"adapters/mapping/mock_mapping_service_adapter",
Expand All @@ -41,15 +39,13 @@ grpc-cloud-adapter = { path = "adapters/cloud/grpc_cloud_adapter" }
grpc-digital-twin-adapter = { path = "adapters/digital_twin/grpc_digital_twin_adapter" }
grpc-mapping-adapter = { path = "adapters/mapping/grpc_mapping_adapter" }
grpc-service-discovery-adapter = { path = "adapters/service_discovery/grpc_service_discovery_adapter" }
http-mock-data-adapter = { path = "adapters/data/http_mock_data_adapter" }
in-memory-mock-cloud-adapter = { path = "adapters/cloud/in_memory_mock_cloud_adapter" }
in-memory-mock-data-adapter = { path = "adapters/data/in_memory_mock_data_adapter" }
in-memory-mock-digital-twin-adapter = { path ="adapters/digital_twin/in_memory_mock_digital_twin_adapter" }
in-memory-mock-mapping-adapter = { path = "adapters/mapping/in_memory_mock_mapping_adapter" }
managed-subscribe-data-adapter = { path = "adapters/data/managed_subscribe_data_adapter" }
mapping-service-proto = { path = "proto/mapping_service" }
mock-digital-twin = { path = "mocks/mock_digital_twin" }
mock-digital-twin-adapter = { path = "adapters/digital_twin/mock_digital_twin_adapter" }
mock-mapping-service-adapter = { path = "adapters/mapping/mock_mapping_service_adapter" }
mqtt-data-adapter = { path = "adapters/data/mqtt_data_adapter" }
proc-macros = { path = "proc_macros" }
Expand Down
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,24 @@ This guide uses `apt` as the package manager in the examples. You may need to su

### Using Freyja

To use Freyja, you will need to implement some adapters and write the main executable that will run the Freyja application.
Freyja supports a default runtime that is integrated with a set of standard adapters. To build and run the Standard Freyja Runtime, run the following command:

For a guide on how to get started quickly by running some minimal examples, see the [Quickstart Guide](docs/tutorials/quickstart.md).
```shell
cargo run -p freyja
```

For more advanced topics on how to implement and use your own adapters, see the [Custom Adapters Guide](docs/tutorials/custom-adapters.md).
This runtime will support the following set of standard adapters:

- [gRPC Digital Twin Adapter](adapters/digital_twin/grpc_digital_twin_adapter/README.md) (which supports [Eclipse Ibeji](https://github.com/eclipse-ibeji/ibeji))
- [gRPC Mapping Adapter](adapters/mapping/grpc_mapping_adapter/README.md)
- [gRPC Cloud Adapter](adapters/cloud/grpc_cloud_adapter/README.md)
- [Sample gRPC Data Adapter](adapters/data/sample_grpc_data_adapter/README.md)
- [MQTT Data Adapter](adapters/data/mqtt_data_adapter/README.md)
- [Managed Subscribe Data Adapter](adapters/data/managed_subscribe_data_adapter/README.md) (which supports [Eclipse Agemo](https://github.com/eclipse-chariott/agemo))
- [File Service Discovery Adapter](adapters/service_discovery/file_service_discovery_adapter/README.md)
- [gRPC Service Discovery Adapter](adapters/service_discovery/grpc_service_discovery_adapter/README.md) (which supports [Eclipse Chariott](https://github.com/eclipse-chariott/chariott))

Freyja also supports custom adapter implementations for more specific scenarios. To learn about custom adapters and how to implement and use them, see the [Custom Adapters Guide](docs/tutorials/custom-adapters.md).

<!--alex disable he-she her-him brothers-sisters-->
## Why "Freyja"?
Expand Down
22 changes: 0 additions & 22 deletions adapters/data/http_mock_data_adapter/Cargo.toml

This file was deleted.

12 changes: 0 additions & 12 deletions adapters/data/http_mock_data_adapter/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions adapters/data/http_mock_data_adapter/build.rs

This file was deleted.

This file was deleted.

15 changes: 0 additions & 15 deletions adapters/data/http_mock_data_adapter/src/config.rs

This file was deleted.

Loading

0 comments on commit af3ce5c

Please sign in to comment.