Ashbeitz/add command support

.accepted_words.txt

@@ -1,4 +1,6 @@
 br
+build
+cargo
 cd
 com
 digitaltwins
@@ -7,6 +9,8 @@ dt
 dtdl
 DTDL
 en
+gcc
+gcc's
 github
 hardcheese
 haudebourg
@@ -15,6 +19,7 @@ ibeji
 Ibeji
 Ibeji's
 intellectualproperty
+iot
 js
 json
 JSON
@@ -23,6 +28,7 @@ LD
 microsoft
 minimalistic
 opendigitaltwins
+plugandplay
 protobuf
 Protobuf
 repo
@@ -34,5 +40,3 @@ sudo
 timothee
 toolchain
 www
-cargo
-build

.github/workflows/alex-recommends-ci.yml

@@ -12,9 +12,9 @@ jobs:
   alex:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Use Node.js
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: 12.x
     - name: Comment on new PR

.github/workflows/check-spelling.yml

@@ -5,11 +5,11 @@ on:
       - main
 
 jobs:
-  notice_generation:
+  check_spelling:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository and submodules
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: recursive
       - name: Install spell
@@ -18,5 +18,5 @@ jobs:
         run: |
           ./tools/check_spelling.sh ./README.md
           ./tools/check_spelling.sh ./dtdl-parser/README.md
-          ./tools/check_spelling.sh ./docs/design/design_spec.md
+          ./tools/check_spelling.sh ./docs/design/README.md
         shell: bash

.github/workflows/editorconfig-audit-ci.yml

@@ -9,7 +9,7 @@ jobs:
   editorconfig-audit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: '16'

.github/workflows/generate-plantuml.yml

@@ -8,7 +8,7 @@ jobs:
     name: plantuml
     steps:
     - name: checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: plantuml
       id: plantuml
       uses: grassedge/generate-plantuml-action@v1.5

.github/workflows/markdown-ci.yml

@@ -13,8 +13,8 @@ jobs:
   lint-markdown:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
       - run: |
           npm install markdownlint-cli
       - run: |

.github/workflows/rust-ci.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout repository and submodules
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: recursive
       - name: Install protobuf-compiler
@@ -29,7 +29,7 @@ jobs:
           override: true
           components: clippy, rustfmt
       - name: Cache Dependencies
-        uses: Swatinem/rust-cache@v1
+        uses: Swatinem/rust-cache@v2
       - run: cargo check --workspace
         # Note: cargo check should use the --locked option
         #       Excluding it because of this known issue: https://github.com/mozilla/uniffi-rs/issues/1032
@@ -53,7 +53,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout repository and submodules
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: recursive
       - name: Install protobuf-compiler
@@ -65,7 +65,7 @@ jobs:
           default: true
           override: true
       - name: Cache Dependencies
-        uses: Swatinem/rust-cache@v1
+        uses: Swatinem/rust-cache@v2
       - name: Build
         run: cargo build
       - name: Test

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "opendigitaltwins-dtdl"]
 	path = opendigitaltwins-dtdl
 	url = https://github.com/Azure/opendigitaltwins-dtdl
+[submodule "iot-plugandplay-models"]
+	path = iot-plugandplay-models
+	url = https://github.com/Azure/iot-plugandplay-models

Cargo.toml

@@ -9,7 +9,8 @@ members = [
   "proto",
   "dtdl-parser",
   "in-vehicle-digital-twin",
-  "provider",
-  "samples/simple/consumer",
-  "samples/simple/provider"
+  "samples/command/consumer",
+  "samples/command/provider",
+  "samples/property/consumer",
+  "samples/property/provider"
 ]

README.md

@@ -3,6 +3,7 @@
 - [Introduction](#introduction)
 - [High-level Design](#high-level-design)
 - [Prerequisites](#prerequisites)
+  - [Install gcc](#install-gcc)
   - [Install Rust](#install-rust)
   - [Install Protobuf Compiler](#install-protobuf-compiler)
 - [Cloning the Repo](#cloning-the-repo)
@@ -21,14 +22,22 @@ through an extensible, open and dynamic architecture that provides access to the
 
 ## <a name="high-level-design">High-level Design</a>
 
-Ibeji's architecture has a In-Vehicle Digital Twin Service at its core. The In-Vehicle Digital Twin Service captures all of the vehicle's primary capabilities
-and make them available to Ibeji consumers. Another component in Ibeji's architecture is the Provider. A vehicle may have one or more providers.
+Ibeji's architecture has an In-Vehicle Digital Twin Service at its core. The In-Vehicle Digital Twin Service captures all of the vehicle's primary capabilities
+and makes them available to Ibeji consumers. Another component in Ibeji's architecture is the Provider. A vehicle may have one or more providers.
 A provider exposes a subset of the vehicle's primary capabilities by registering them with the In-Vehicle Digital Twin Service. Once registered with the
 In-Vehicle Digital Twin Service they can in turn be offered to Ibeji consumers. Each capability includes meta data that allow Ibeji consumers to comprehend
 the nature of the capability, how to work with it and how it can be remotely accessed.
 
 ## <a name="prerequisites">Prerequisites</a>
 
+### <a name="install-gcc">Install gcc</a>
+
+Rust needs gcc's linker, so you will need to install it. To install gcc, do the following:
+
+```shell
+sudo apt install gcc
+```
+
 ### <a name="install-rust">Install Rust</a>
 
 At this point in time, you will need to use the nightly release of Rust. While it is not ideal to rely on a nightly release, we should be able to rely on the
@@ -57,8 +66,8 @@ You will need to install the Protobuf Compiler. This can be done by executing:
 
 ## <a name="cloning-the-repo">Cloning the Repo</a>
 
-The repo has one submodule [opendigitaltwins-dtdl](https://github.com/Azure/opendigitaltwins-dtdl) that provide the DTDL context files and DTDL samples file.
-To ensure that it is included, please use the following command when cloning Ibeji's github repo:
+The repo has two submodule [opendigitaltwins-dtdl](https://github.com/Azure/opendigitaltwins-dtdl) and [iot-plugandplay-models](https://github.com/Azure/iot-plugandplay-models) that provide DTDL context files
+and DTDL samples file. To ensure that these are included, please use the following command when cloning Ibeji's github repo:
 
 `git clone --recurse-submodules https://github.com/eclipse-ibeji/ibeji`
 
@@ -73,7 +82,7 @@ and checkout its "resolve-issue-40" branch. It should be cloned to a directory t
 
 ### <a name="dtdl-parser">DTDL Parser</a>
 
-There is no existing DTDL Parser for Rust, so we have provided a minimalistic one that is based on the [JavaScript DTDL Parser](https://github.com/Azure/azure-sdk-for-js/tree/%40azure/dtdl-parser_1.0.0-beta.2/sdk/digitaltwins/dtdl-parser).
+There is no existing DTDL Parser for Rust, so we have provided a minimalistic one for DTDL v2 that is based on the [JavaScript DTDL Parser](https://github.com/Azure/azure-sdk-for-js/tree/%40azure/dtdl-parser_1.0.0-beta.2/sdk/digitaltwins/dtdl-parser).
 
 ## <a name="building">Building</a>
 
@@ -93,23 +102,25 @@ Currently, we have no integration tests or end-to-end tests.
 
 ## <a name="running-the-demo">Running the Demo</a>
 
+There are currently two demos: one that demonstrates the use of a property and one that demonstrates the use of a command. The following instructions are for the demo for the use of a property. These instructions can easily be adjusted for the demonstration for the use of a command.
+
 Steps:
 
 1. The best way to run the demo is by using three windows: one running the In-Vehicle Digital Twin, one running the Provider and one running a Consumer.
 Orientate the three windows so that they are lined up in a column. The top window can be used for the In-Vehicle Digital Twin.
 The middle window can be used for the Provider. The bottom window can be used for a Consumer.<br>
 1. In each window run the following command too set the DTDL_PATH environment variable.
 Make sure that you replace "{repo-root-dir}" with the repository root directory on the machine where you are running the demo.<br><br>
-`export DTDL_PATH="{repo-root-dir}/ibeji/opendigitaltwins-dtdl/DTDL;{repo-root-dir}/ibeji/dtdl;{repo-root-dir}/ibeji/samples/simple/dtdl"`<br>
+`export DTDL_PATH="{repo-root-dir}/ibeji/opendigitaltwins-dtdl/DTDL;{repo-root-dir}/ibeji/dtdl;{repo-root-dir}/ibeji/samples/property/dtdl"`<br>
 1. In each window change directory to the directory containing the build artifacts.
 Make sure that you replace "{repo-root-dir}" with the repository root directory on the machine where you are running the demo.<br><br>
 `cd {repo-root-dir}/ibeji/target/debug`<br>
 1. In the top window, run:<br><br>
 `./in-vehicle-digital-twin`<br>
 1. In the middle window, run:<br><br>
-`./simple-provider`<br>
+`./property-provider`<br>
 1. In the bottom window, run:<br><br>
-`./simple-consumer`<br>
+`./property-consumer`<br>
 1. Use control-c in each of the windows when you wish to stop the demo.
 
 ## <a name="trademarks">Trademarks</a>

common-test/src/lib.rs

@@ -32,7 +32,9 @@ fn get_repo_dir() -> Option<String> {
 pub fn set_dtdl_path() {
     let repo_dir_result = get_repo_dir();
     if let Some(repo_dir) = repo_dir_result {
-        let value = format!("{}/opendigitaltwins-dtdl/DTDL;{}/dtdl", repo_dir, repo_dir);
+        let value = format!(
+            "{repo_dir}/opendigitaltwins-dtdl/DTDL;{repo_dir}/iot-plugandplay-models;{repo_dir}/dtdl"
+        );
         env::set_var(DTDL_PATH, &value);
         trace!("{}={}", DTDL_PATH, &value);
     } else {

common/src/lib.rs

@@ -25,9 +25,8 @@ pub fn find_full_path(relative_path: &str) -> Result<String, String> {
             }
         }
         Err(_) => {
-            return Err(format!(
-                "Unable to get the environment variable {}. Please set it.",
-                DTDL_PATH
+            return Err(String::from(
+                "Unable to get the environment variable DTDL_PATH. Please set it."
             ))
         }
     }
@@ -43,7 +42,7 @@ pub fn retrieve_dtdl(file_path: &str) -> Result<String, String> {
     let read_result = fs::read_to_string(path);
     match read_result {
         Ok(contents) => Ok(contents),
-        Err(error) => Err(format!("Unable to retrieve the DTDL due to: {:?}", error)),
+        Err(error) => Err(format!("Unable to retrieve the DTDL due to: {error}")),
     }
 }