feat: update docs for edgex 3.0 update #152

vli11 · 2023-09-26T21:06:12Z

Closes: #137

PR Checklist

Added label to the Pull Request for easier discoverability and search
Commit Message meets guidelines as indicated in the URL https://github.com/intel-retail/automated-vending/blob/main/.github/CONTRIBUTING.md
Every commit is a single defect fix and does not mix feature addition or changes
Unit Tests have been added for new changes
Updated Documentation as relevant to the changes
All commented out code has been removed
If you've added a dependency, you've ensured license is compatible with repository license and clearly outlined the added dependency.
PR change contains code related to security
PR introduces changes that breaks compatibility with other modules (If YES, please provide details below)

What are you changing?

update automated checking to automated vending; updated toml file to yaml file and their new links.

Issue this PR will close

close: #137

Anything the reviewer should know when reviewing this PR?

Test Instructions if applicable

read through the docs_src folder, all automated checkout should be replaced, and no more toml file

If the there are associated PRs in other repositories, please link them here (i.e. intel-retail/automated-vending )

Closes: intel-retail#137 Signed-off-by: Valina Li <[email protected]>

Signed-off-by: Valina Li <[email protected]>

jim-wang-intel

there are some url still pointing to the old url (intel-iot-devkit) and /v2 to /v3
please do a global search under docs/src folder to fix them all.

jim-wang-intel · 2023-09-26T21:24:07Z

docs_src/automated-vending-services/device_services.md

@@ -265,12 +265,12 @@ The following picture illustrates the flow to calculate the inventory deltas bet
    <img src="../images/delta.png">
 </p>

-The Automated Checkout architecture uses three MQTT topics:
+The Automated Vending architecture uses three MQTT topics:

 | Topic                       | Description                                                                                             |
 | ----------------------------- | ------------------------------------------------------------------------------------------------ |
 | Inference/CommandTopic                  | All events pushed from EdgeX's command API are fed into this topic. The [`as-vending`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-vending) and [`as-controller-board-status`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-controller-board-status) are two services that make requests to this API, typically for making door close/open and heartbeat events. |


we probably also want to fix the url for that too:

Suggested change

| Inference/CommandTopic | All events pushed from EdgeX's command API are fed into this topic. The [`as-vending`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-vending) and [`as-controller-board-status`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-controller-board-status) are two services that make requests to this API, typically for making door close/open and heartbeat events. |

| Inference/CommandTopic | All events pushed from EdgeX's command API are fed into this topic. The [`as-vending`](https://github.com/intel-retail/automated-vending/tree/main/as-vending) and [`as-controller-board-status`](https://github.com/intel-retail/automated-vending/tree/main/as-controller-board-status) are two services that make requests to this API, typically for making door close/open and heartbeat events. |

jim-wang-intel · 2023-09-26T21:25:08Z

docs_src/automated-vending-services/device_services.md


 | Topic                       | Description                                                                                             |
 | ----------------------------- | ------------------------------------------------------------------------------------------------ |
 | Inference/CommandTopic                  | All events pushed from EdgeX's command API are fed into this topic. The [`as-vending`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-vending) and [`as-controller-board-status`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-controller-board-status) are two services that make requests to this API, typically for making door close/open and heartbeat events. |
-| Inference/ResponseTopic  | The Automated Checkout cv inference service will respond to published messages on the `Inference/CommandTopic` topic on the `Inference/ResponseTopic` topic. |
+| Inference/ResponseTopic  | The Automated Vending cv inference service will respond to published messages on the `Inference/CommandTopic` topic on the `Inference/ResponseTopic` topic. |
 | Inference/DataTopic                | The cv inference service publishes delta SKUs on this topic, then the MQTT device service converts them into EdgeX event readings, and finally the [`as-vending`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-vending) service processes the event readings and pushes them to downstream services. |


Suggested change

| Inference/DataTopic | The cv inference service publishes delta SKUs on this topic, then the MQTT device service converts them into EdgeX event readings, and finally the [`as-vending`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-vending) service processes the event readings and pushes them to downstream services. |

| Inference/DataTopic | The cv inference service publishes delta SKUs on this topic, then the MQTT device service converts them into EdgeX event readings, and finally the [`as-vending`](https://github.com/intel-retail/automated-vending/tree/main/as-vending) service processes the event readings and pushes them to downstream services. |

jim-wang-intel · 2023-09-26T21:26:05Z

docs_src/automated-vending-services/device_services.md

@@ -279,7 +279,7 @@ The Automated Checkout architecture uses three MQTT topics:

 #### `GET`: `http://localhost:59982/api/v2/device/name/Inference-device/inferenceHeartbeat`


Suggested change

#### `GET`: `http://localhost:59982/api/v2/device/name/Inference-device/inferenceHeartbeat`

#### `GET`: `http://localhost:59982/api/v3/device/name/Inference-device/inferenceHeartbeat`

jim-wang-intel · 2023-09-26T21:26:34Z

docs_src/automated-vending-services/device_services.md

@@ -279,7 +279,7 @@ The Automated Checkout architecture uses three MQTT topics:

 #### `GET`: `http://localhost:59982/api/v2/device/name/Inference-device/inferenceHeartbeat`

-The `GET` call to the EdgeX MQTT device service's `inferenceHearbeat` command will act as a health-check for the Automated Checkout cv inference service. It must return `200 OK` upon swiping an RFID card in order for the vending workflow to begin. If it does not, the [`as-vending`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-vending) service will enter maintenance mode.
+The `GET` call to the EdgeX MQTT device service's `inferenceHearbeat` command will act as a health-check for the Automated Vending cv inference service. It must return `200 OK` upon swiping an RFID card in order for the vending workflow to begin. If it does not, the [`as-vending`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-vending) service will enter maintenance mode.


fix url to intel-retail

jim-wang-intel · 2023-09-26T21:27:06Z

docs_src/configuration.md

@@ -1,29 +1,13 @@
 # Configuration

-This page lists all of the relevant configuration parameters for each service in the Automated Checkout reference implementation.
+This page lists all of the relevant configuration parameters for each service in the Automated Vending reference implementation.

 !!!info
    Note that this document likely does not cover EdgeX-specific configuration parameters. Application and device service SDK documentation can be found in the [EdgeX Foundry GitHub repositories](https://github.com/edgexfoundry) or in the [official EdgeX documentation here](https://docs.edgexfoundry.org/2.2/).


Suggested change

Note that this document likely does not cover EdgeX-specific configuration parameters. Application and device service SDK documentation can be found in the [EdgeX Foundry GitHub repositories](https://github.com/edgexfoundry) or in the [official EdgeX documentation here](https://docs.edgexfoundry.org/2.2/).

Note that this document likely does not cover EdgeX-specific configuration parameters. Application and device service SDK documentation can be found in the [EdgeX Foundry GitHub repositories](https://github.com/edgexfoundry) or in the [official EdgeX documentation here](https://docs.edgexfoundry.org/3.0/).

docs_src/configuration.md

lenny-goodell · 2023-09-26T22:08:44Z

docs_src/configuration.md

@@ -58,19 +42,15 @@ The following items can be configured via the `DriverConfig` section of the serv

 ## EdgeX MQTT device service

-This reference implementation uses the [MQTT Device Service](https://github.com/edgexfoundry/device-mqtt-go) from EdgeX with custom device profiles. These device profiles YAML files are located [here](https://github.com/intel-iot-devkit/automated-checkout/blob/master/res/device-mqtt/profiles/inference-mqtt-device-profile.yml) and are volume mounted into the device service's running Docker container.
+This reference implementation uses the [MQTT Device Service](https://github.com/edgexfoundry/device-mqtt-go) from EdgeX with custom device profiles. These device profiles YAML files are located [here](https://github.com/intel-retail/automated-vending/blob/Edgex-3.0/res/device-mqtt/profiles/inference-mqtt-device-profile.yml) and are volume mounted into the device service's running Docker container.


This one exists on main, so link to main branch

lenny-goodell · 2023-09-26T22:09:23Z

docs_src/configuration.md


-The following items can be configured via `MQTTBrokerInfo` section of the service's [configuration.toml](https://github.com/intel-iot-devkit/automated-checkout/blob/master/res/device-mqtt/configuration.toml) file. All values are strings.
+The following items can be configured via `device-mqtt.environment` section of the service's [docker-compose.edgex.yml](https://github.com/intel-retail/automated-vending/blob/Edgex-3.0/docker-compose.edgex.yml) file.


compose file exist on main, so like to main branch

lenny-goodell · 2023-09-26T22:11:17Z

docs_src/modifying_source_code.md

@@ -22,11 +22,11 @@ Next, build the specific service's image:
 make ds-card-reader
 ```

-After Docker builds the image (by executing the steps in [`ds-card-reader/Dockerfile`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/ds-card-reader/Dockerfile)), proceed to the next section.
+After Docker builds the image (by executing the steps in [`ds-card-reader/Dockerfile`](https://github.com/intel-retail/automated-vending/blob/Edgex-3.0/ds-card-reader/Dockerfile)), proceed to the next section.


file exists on main, link to main branch

lenny-goodell · 2023-09-26T22:11:41Z

docs_src/phases/phase1.md

@@ -117,7 +117,7 @@ curl -X PUT -H "Content-Type: application/json" -d '{"card-number":"0003293374"}
    There should not be any response message when running this EdgeX command successfully.

 !!! info
-    By default, the card number `0003293374` corresponds to a card in the [`ms-authentication/cards.json`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/ms-authentication/cards.json) file that has the "stocker" role associated to it.
+    By default, the card number `0003293374` corresponds to a card in the [`ms-authentication/cards.json`](https://github.com/intel-retail/automated-vending/blob/Edgex-3.0/ms-authentication/cards.json) file that has the "stocker" role associated to it.


file exists on main, link to main branch

lenny-goodell · 2023-09-26T22:17:55Z

docs_src/index.md

    | edgexfoundry/core-command:2.2.0                      | Up About a minute |
    | edgexfoundry/core-data:2.2.0                         | Up About a minute |
    | edgexfoundry/core-metadata:2.2.0                     | Up About a minute |
    | edgexfoundry/support-notifications:2.2.0             | Up About a minute |


lenny-goodell · 2023-09-26T22:18:47Z

docs_src/index.md

@@ -126,21 +126,21 @@ docker ps --format 'table{{.Image}}\t{{.Status}}'

    | IMAGE                                                | STATUS            |
    |------------------------------------------------------|-------------------|
-    | automated-checkout/ms-ledger:dev                     | Up 53 seconds     |
+    | automated-vending/ms-ledger:dev                     | Up 53 seconds     |
    | eclipse-mosquitto:2.0.14                             | Up 52 seconds     |


lenny-goodell · 2023-09-26T22:19:27Z

docs_src/index.md

-    | automated-checkout/ds-card-reader:dev                | Up 53 seconds     |
-    | automated-checkout/as-controller-board-status:dev    | Up 52 seconds     |
+    | automated-vending/ds-card-reader:dev                | Up 53 seconds     |
+    | automated-vending/as-controller-board-status:dev    | Up 52 seconds     |
    | edgexfoundry/core-command:2.2.0                      | Up About a minute |
    | edgexfoundry/core-data:2.2.0                         | Up About a minute |
    | edgexfoundry/core-metadata:2.2.0                     | Up About a minute |
    | edgexfoundry/support-notifications:2.2.0             | Up About a minute |
    | edgexfoundry/consul:1.10.10                          | Up About a minute |


lenny-goodell · 2023-09-26T22:19:58Z

docs_src/index.md

    | edgexfoundry/core-command:2.2.0                      | Up About a minute |
    | edgexfoundry/core-data:2.2.0                         | Up About a minute |
    | edgexfoundry/core-metadata:2.2.0                     | Up About a minute |
    | edgexfoundry/support-notifications:2.2.0             | Up About a minute |
    | edgexfoundry/consul:1.10.10                          | Up About a minute |
-    | automated-checkout/ds-cv-inference:dev               | Up 51 seconds     |
+    | automated-vending/ds-cv-inference:dev               | Up 51 seconds     |
    | redis:6.2-alpine                                     | Up About a minute |


lenny-goodell · 2023-09-26T22:20:26Z

docs_src/index.md


 ### How to use the Compose Files

-The docker-compose files are segmented to allow for fine control of physical and simulated devices, as well as allowing you the choice of running Portainer. Use the [`makefile`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/Makefile) to manage the various compose files:
+The docker-compose files are segmented to allow for fine control of physical and simulated devices, as well as allowing you the choice of running Portainer. Use the [`makefile`](https://github.com/intel-retail/automated-vending/blob/Edgex-3.0/Makefile) to manage the various compose files:


file exists on main. Link to main

ejlee3 · 2023-09-26T22:58:50Z

docs_src/automated-vending-services/device_services.md

@@ -12,7 +12,7 @@ The **Automated Checkout** reference implementation utilizes three device servic

 ### Card reader description

-The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to grant access to the Automated Checkout. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and then forwarding the input into the EdgeX framework.
+The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to grant access to the Automated Vending. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and then forwarding the input into the EdgeX framework.


Suggested change

The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to grant access to the Automated Vending. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and then forwarding the input into the EdgeX framework.

The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to connect with the Automated Vending business logic. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and forwarding the input into the EdgeX framework.

not sure if this is the right phrasing, but grant access to the Automated Vending seems incomplete

we do need device to be authenticated to give information to automated vending. @brian-intel what do you think?

The only atuh is auth of the user. The way AV Auth works is the card is read by this service and then the Auth service validates the card number and grants/denies access to the cooler.

So maybe this is better?

Suggested change

The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to grant access to the Automated Vending. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and then forwarding the input into the EdgeX framework.

The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to read user's card for accessing to the Automated Vending. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and then forwarding the input thru the EdgeX framework to the ms-authentication service which authorizes/denies access to the Automated Vending.

ejlee3 · 2023-09-26T23:01:43Z

docs_src/phases/phase1.md


-The steps in this guide show how to simulate the automated checkout workflow using [`curl`](https://github.com/curl/curl) REST API calls. It is a step-by-step walkthrough with specific commands to run on the command line.
+The steps in this guide show how to simulate the automated Vending workflow using [`curl`](https://github.com/curl/curl) REST API calls. It is a step-by-step walkthrough with specific commands to run on the command line.


Suggested change

The steps in this guide show how to simulate the automated Vending workflow using [`curl`](https://github.com/curl/curl) REST API calls. It is a step-by-step walkthrough with specific commands to run on the command line.

The steps in this guide show how to simulate the Automated Vending workflow using [`curl`](https://github.com/curl/curl) REST API calls. It is a step-by-step walkthrough with specific commands to run on the command line.

Signed-off-by: Valina Li <[email protected]>

docs_src/configuration.md

lenny-goodell · 2023-09-27T15:48:20Z

docs_src/configuration.md


-The following items can be configured via `MQTTBrokerInfo` section of the service's [configuration.toml](https://github.com/intel-iot-devkit/automated-checkout/blob/master/res/device-mqtt/configuration.toml) file. All values are strings.
+The following items can be configured via `device-mqtt.environment` section of the service's [docker-compose.edgex.yml](https://github.com/intel-retail/automated-vending/tree/main/docker-compose.edgex.yml) file.


Suggested change

The following items can be configured via `device-mqtt.environment` section of the service's [docker-compose.edgex.yml](https://github.com/intel-retail/automated-vending/tree/main/docker-compose.edgex.yml) file.

The following `MQTTBrokerInfo` configuration items can be configured via `device-mqtt.environment` section of the service's [docker-compose.edgex.yml](https://github.com/intel-retail/automated-vending/tree/main/docker-compose.edgex.yml) file.

lenny-goodell · 2023-09-27T15:49:04Z

docs_src/configuration.md


-`MQTTBrokerInfo`
+`device-mqtt.environment`


Suggested change

`device-mqtt.environment`

`MQTTBrokerInfo via device-mqtt.environment`

Signed-off-by: Valina Li <[email protected]>

brian-intel · 2023-09-27T17:49:49Z

docs_src/automated-vending-services/device_services.md

@@ -12,7 +12,7 @@ The **Automated Checkout** reference implementation utilizes three device servic

 ### Card reader description

-The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to grant access to the Automated Checkout. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and then forwarding the input into the EdgeX framework.
+The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to read user's card for accessing to the Automated Vending. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and then forwarding the input through the EdgeX framework to the ms-authentication service which authorizes/denies access to the Automated Vending.


Suggested change

The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to read user's card for accessing to the Automated Vending. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and then forwarding the input through the EdgeX framework to the ms-authentication service which authorizes/denies access to the Automated Vending.

The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to read the user's card and grant access to the Automated Vending system. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and then forwarding the input through the EdgeX framework to the ms-authentication service which authorizes/denies access to the Automated Vending.

Signed-off-by: Valina Li <[email protected]>

docs_src/configuration.md

Signed-off-by: Valina Li <[email protected]>

lenny-goodell

LGTM

jim-wang-intel

LGTM

* refactor: Migrate Edgex compose to 3.0 closes #121 Signed-off-by: Leonard Goodell <[email protected]> * feat(ms-authentication): Update ms-authentication service to EdgeX v3.0 (#126) * feat(ms-authentication): Update ms-authentication service to EdgeX v3.0 --------- Signed-off-by: Sean O'Hair <[email protected]> * feat: Migrate device-mqtt service files and add ENV overrides for mqtt topics (#128) Signed-off-by: Sean O'Hair <[email protected]> * feat: Migrate as-vending microservice to EdgeX 3.0 (#139) * feat: Migrate as-vending microservice to EdgeX 3.0 Signed-off-by: Brian McGinn <[email protected]> --------- Signed-off-by: Brian McGinn <[email protected]> Co-authored-by: Lenny Goodell <[email protected]> Co-authored-by: Jim Wang @ Intel <[email protected]> * feat: update as controller board to use EdgeX-3.0 (#140) * feat: update as controller board to use EdgeX-3.0 * fix: remove build tags related to no_zmq for tests * fix: change automated checkout wording to automated vending for as-controller board * fix: add the missing support-notification client config in configuration yaml file Signed-off-by: Jim Wang <[email protected]> --------- Signed-off-by: Jim Wang <[email protected]> * feat: Migrate ms-ledger microservice to EdgeX 3.0 (#141) * feat: Migrate ms-ledger microservice to EdgeX 3.0 Signed-off-by: Neethu Elizabeth Simon <[email protected]> * feat: Migration changes in docker-compose Signed-off-by: Neethu Elizabeth Simon <[email protected]> * feat: removed zmq references Signed-off-by: Neethu Elizabeth Simon <[email protected]> * feat: change image name in trivyimagescan Signed-off-by: Neethu Elizabeth Simon <[email protected]> --------- Signed-off-by: Neethu Elizabeth Simon <[email protected]> * feat: update ds-card-reader to use EdgeX-3.0 (#144) * feat: update ds-card-reader to use EdgeX-3.0 Closes: #133 Signed-off-by: Valina Li <[email protected]> * feat: Migrate ds-controller microservice to EdgeX 3.0 (#145) * feat: Migrate ds-controller to EdgeX 3.0 Signed-off-by: Neethu Elizabeth Simon <[email protected]> * feat: handle hadolint + remove zeromq Signed-off-by: Neethu Elizabeth Simon <[email protected]> * feat: add hadolint flag Signed-off-by: Neethu Elizabeth Simon <[email protected]> * feat: changed devicelist toml to yaml Signed-off-by: Neethu Elizabeth Simon <[email protected]> * fix: typo Signed-off-by: Neethu Elizabeth Simon <[email protected]> * fix: change device-list in dockerfile Signed-off-by: Neethu Elizabeth Simon <[email protected]> * fix: yaml indentation Signed-off-by: Neethu Elizabeth Simon <[email protected]> --------- Signed-off-by: Neethu Elizabeth Simon <[email protected]> * build: Upgrade portianer to CE version closes #136 Signed-off-by: Leonard Goodell <[email protected]> * feat(ms-inventory): Migrate ms-inventory to EdgeX v3.0 (#130) * feat(ms-inventory): Migrate ms-inventory to EdgeX v3.0 --------- Signed-off-by: Sean O'Hair <[email protected]> * feat: Migrate ds-cv-inferencing to be EdgeX 3.0 compatible Closes #135 Signed-off-by: Elizabeth J Lee <[email protected]> * fix: address pr comments Signed-off-by: Elizabeth J Lee <[email protected]> * fix: remove top level go.mod and go.sum Signed-off-by: Elizabeth J Lee <[email protected]> * fix: Address Lenny's PR comments Signed-off-by: Elizabeth J Lee <[email protected]> * refactor: added code for command client Signed-off-by: preethi-satishcandra <[email protected]> * fix: address pr feedback Signed-off-by: Elizabeth J Lee <[email protected]> * fix: address jim's comments Signed-off-by: Elizabeth J Lee <[email protected]> * refactor: added mock command client for the unit tests Signed-off-by: preethi-satishcandra <[email protected]> * feat: update license year to include 2023 (#149) Closes: #138 Signed-off-by: Jim Wang <[email protected]> * refactor: updated unit test to pass by adding mock command client that returns error Signed-off-by: preethi-satishcandra <[email protected]> * refactor: cleaned up the code Signed-off-by: preethi-satishcandra <[email protected]> * refactor: addressed Lenny's code review comments Signed-off-by: preethi-satishcandra <[email protected]> * feat: Update test script for v3 endpoints Closes #150 Signed-off-by: Elizabeth J Lee <[email protected]> * refactor: addressed more of Lenny's code review comments Signed-off-by: preethi-satishcandra <[email protected]> * refactor: Fix naming of checkout-> vending and fix service names Signed-off-by: Elizabeth J Lee <[email protected]> * refactor: addressed more code review comments Signed-off-by: preethi-satishcandra <[email protected]> * refactor: changed some of the error logs to debug from info mode Signed-off-by: preethi-satishcandra <[email protected]> * feat: update docs for edgex 3.0 update (#152) * feat: update docs for edgex 3.0 update Closes: #137 Signed-off-by: Valina Li <[email protected]> * feat: update and cleanup compose-av env file (#157) ------- Signed-off-by: Sean O'Hair <[email protected]> * feat: update references of automated-checkout to automated-vending (#159) Signed-off-by: Sean O'Hair <[email protected]> * refactor: remove use of iot-devkit utilities package, fix ioutil calls Closes #158 Signed-off-by: Elizabeth J Lee <[email protected]> * fix: broken unit tests Signed-off-by: Elizabeth J Lee <[email protected]> * fix: address pr comments Signed-off-by: Elizabeth J Lee <[email protected]> * fix: adjust return statement Signed-off-by: Elizabeth J Lee <[email protected]> * fix: Revert cv-inference back to OpenVINO 2021. Update controller-board device-list format Removed double escape in smoke-test string Closes #161 Signed-off-by: Brian McGinn <[email protected]> * fix: remove ioutil to update to os package Signed-off-by: Elizabeth J Lee <[email protected]> * fix: address pr comments Signed-off-by: Elizabeth J Lee <[email protected]> * fix: Integration issues with upgrade to EdgeX 3.0 Signed-off-by: Elizabeth J Lee <[email protected]> * fix: adjust unit tests Signed-off-by: Elizabeth J Lee <[email protected]> * fix: Dependabot reference updates (#174) Signed-off-by: Brian McGinn <[email protected]> --------- Signed-off-by: Leonard Goodell <[email protected]> Signed-off-by: Sean O'Hair <[email protected]> Signed-off-by: Brian McGinn <[email protected]> Signed-off-by: Jim Wang <[email protected]> Signed-off-by: Neethu Elizabeth Simon <[email protected]> Signed-off-by: Valina Li <[email protected]> Signed-off-by: Elizabeth J Lee <[email protected]> Signed-off-by: preethi-satishcandra <[email protected]> Co-authored-by: Leonard Goodell <[email protected]> Co-authored-by: seanohair22 <[email protected]> Co-authored-by: Jim Wang @ Intel <[email protected]> Co-authored-by: NeethuES <[email protected]> Co-authored-by: Valina Li <[email protected]> Co-authored-by: Elizabeth J Lee <[email protected]> Co-authored-by: preethi-satishcandra <[email protected]>

feat: update docs for edgex 3.0 update

64d2d2a

Closes: intel-retail#137 Signed-off-by: Valina Li <[email protected]>

vli11 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 26, 2023

vli11 self-assigned this Sep 26, 2023

fix: replace toml to yaml

c00452d

Signed-off-by: Valina Li <[email protected]>

vli11 requested review from NeethuES-intel, jim-wang-intel, lenny-goodell, brian-intel, ejlee3 and seanohair22 September 26, 2023 21:19

jim-wang-intel requested changes Sep 26, 2023

View reviewed changes

lenny-goodell suggested changes Sep 26, 2023

View reviewed changes

ejlee3 requested changes Sep 26, 2023

View reviewed changes

vli11 added 2 commits September 26, 2023 18:28

fix: comments

de9d2af

Signed-off-by: Valina Li <[email protected]>

fix: index page

83a7615

Signed-off-by: Valina Li <[email protected]>

lenny-goodell suggested changes Sep 27, 2023

View reviewed changes

vli11 added 2 commits September 27, 2023 10:18

fix: driver config example and ds-card-reader discription

b5445b1

Signed-off-by: Valina Li <[email protected]>

fix: configuration doc

9d12cee

Signed-off-by: Valina Li <[email protected]>

vli11 requested review from jim-wang-intel, ejlee3 and lenny-goodell September 27, 2023 17:30

fix: driverconfig is using DRIVERCONFIG_ prefix in environment

7bb434a

Signed-off-by: Valina Li <[email protected]>

brian-intel reviewed Sep 27, 2023

View reviewed changes

fix: card reader description

aa83ed9

Signed-off-by: Valina Li <[email protected]>

vli11 requested a review from brian-intel September 27, 2023 17:58

brian-intel approved these changes Sep 27, 2023

View reviewed changes

lenny-goodell suggested changes Sep 27, 2023

View reviewed changes

docs_src/configuration.md Outdated Show resolved Hide resolved

docs_src/configuration.md Outdated Show resolved Hide resolved

fix: double underscores

8ddd9e1

Signed-off-by: Valina Li <[email protected]>

vli11 requested a review from lenny-goodell September 27, 2023 18:50

lenny-goodell approved these changes Sep 27, 2023

View reviewed changes

jim-wang-intel approved these changes Sep 27, 2023

View reviewed changes

vli11 merged commit e9694b6 into intel-retail:Edgex-3.0 Sep 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: update docs for edgex 3.0 update #152

feat: update docs for edgex 3.0 update #152

vli11 commented Sep 26, 2023

jim-wang-intel left a comment

jim-wang-intel Sep 26, 2023

jim-wang-intel Sep 26, 2023

jim-wang-intel Sep 26, 2023

jim-wang-intel Sep 26, 2023

jim-wang-intel Sep 26, 2023

lenny-goodell Sep 26, 2023

lenny-goodell Sep 26, 2023

lenny-goodell Sep 26, 2023

lenny-goodell Sep 26, 2023

lenny-goodell Sep 26, 2023

lenny-goodell Sep 26, 2023

lenny-goodell Sep 26, 2023

lenny-goodell Sep 26, 2023

lenny-goodell Sep 26, 2023

ejlee3 Sep 26, 2023

ejlee3 Sep 26, 2023

vli11 Sep 27, 2023

lenny-goodell Sep 27, 2023

ejlee3 Sep 26, 2023

lenny-goodell Sep 27, 2023

lenny-goodell Sep 27, 2023

brian-intel Sep 27, 2023

lenny-goodell left a comment

jim-wang-intel left a comment

	\| Inference/DataTopic \| The cv inference service publishes delta SKUs on this topic, then the MQTT device service converts them into EdgeX event readings, and finally the [`as-vending`](https://github.com/intel-iot-devkit/automated-checkout/blob/master/as-vending) service processes the event readings and pushes them to downstream services. \|
	\| Inference/DataTopic \| The cv inference service publishes delta SKUs on this topic, then the MQTT device service converts them into EdgeX event readings, and finally the [`as-vending`](https://github.com/intel-retail/automated-vending/tree/main/as-vending) service processes the event readings and pushes them to downstream services. \|

		@@ -279,7 +279,7 @@ The Automated Checkout architecture uses three MQTT topics:

		#### `GET`: `http://localhost:59982/api/v2/device/name/Inference-device/inferenceHeartbeat`

	Note that this document likely does not cover EdgeX-specific configuration parameters. Application and device service SDK documentation can be found in the [EdgeX Foundry GitHub repositories](https://github.com/edgexfoundry) or in the [official EdgeX documentation here](https://docs.edgexfoundry.org/2.2/).
	Note that this document likely does not cover EdgeX-specific configuration parameters. Application and device service SDK documentation can be found in the [EdgeX Foundry GitHub repositories](https://github.com/edgexfoundry) or in the [official EdgeX documentation here](https://docs.edgexfoundry.org/3.0/).


		The following items can be configured via `MQTTBrokerInfo` section of the service's [configuration.toml](https://github.com/intel-iot-devkit/automated-checkout/blob/master/res/device-mqtt/configuration.toml) file. All values are strings.
		The following items can be configured via `device-mqtt.environment` section of the service's [docker-compose.edgex.yml](https://github.com/intel-retail/automated-vending/blob/Edgex-3.0/docker-compose.edgex.yml) file.

	\| eclipse-mosquitto:2.0.14 \| Up 52 seconds \|
	\| eclipse-mosquitto:2.0.15 \| Up 52 seconds \|

	\| edgexfoundry/consul:1.10.10 \| Up About a minute \|
	\| edgexfoundry/consul:1.15.2 \| Up About a minute \|

	\| redis:6.2-alpine \| Up About a minute \|
	\| redis:7.0.11-alpine \| Up About a minute \|

	The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to grant access to the Automated Vending. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and then forwarding the input into the EdgeX framework.
	The `ds-card-reader` device service is an EdgeX device service that allows a USB-based RFID card reader to connect with the Automated Vending business logic. At a high level, this device service is responsible for discovering a specific card reader device, watching for input from that device, parsing that input, and forwarding the input into the EdgeX framework.


		The steps in this guide show how to simulate the automated checkout workflow using [`curl`](https://github.com/curl/curl) REST API calls. It is a step-by-step walkthrough with specific commands to run on the command line.
		The steps in this guide show how to simulate the automated Vending workflow using [`curl`](https://github.com/curl/curl) REST API calls. It is a step-by-step walkthrough with specific commands to run on the command line.

	The following items can be configured via `device-mqtt.environment` section of the service's [docker-compose.edgex.yml](https://github.com/intel-retail/automated-vending/tree/main/docker-compose.edgex.yml) file.
	The following `MQTTBrokerInfo` configuration items can be configured via `device-mqtt.environment` section of the service's [docker-compose.edgex.yml](https://github.com/intel-retail/automated-vending/tree/main/docker-compose.edgex.yml) file.

	`device-mqtt.environment`
	`MQTTBrokerInfo via device-mqtt.environment`

feat: update docs for edgex 3.0 update #152

feat: update docs for edgex 3.0 update #152

Conversation

vli11 commented Sep 26, 2023

PR Checklist

What are you changing?

Issue this PR will close

Anything the reviewer should know when reviewing this PR?

Test Instructions if applicable

If the there are associated PRs in other repositories, please link them here (i.e. intel-retail/automated-vending )

jim-wang-intel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lenny-goodell left a comment

Choose a reason for hiding this comment

jim-wang-intel left a comment

Choose a reason for hiding this comment