Merge pull request #2 from SonySemiconductorSolutions/release/v1.0.2

Release v1.0.2

Author: TE-YOSHIYUKIHAYASHI

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement
+[our contact form](https://developer.sony.com/contact-us/).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# CONTRIBUTING
+
+**We are not accepting Pull Requests and Issues at this time.**

README.md

@@ -52,7 +52,7 @@ The repository is organized as follows:
 
 #### `.devcontainer`
 
-This directory contain the files necessary to run this project in a development container (dev container), be it in **GitHub Codespaces** or **Visual Studio Code**.
+This directory contains the files necessary to run this project in a development container (dev container), be it in **GitHub Codespaces** or **Visual Studio Code**.
 More details how to use it are provided in the [USAGE.md](./docs/USAGE.md) document.
 
 #### `.github/workflows/`
@@ -103,30 +103,28 @@ To get started with the Zone Detection Application, follow the steps below.
 
 ### Prepare a device on AITRIOS Console
 
-To run this reference solution you need to have a CSV26 camera to be enrolled to your project in the Aitrios Console. In addition, it should have deployed a zone detection Edge application and a compatible object detection AI model. These artifacts should first be obtained locally, then imported to the Console and finaly be deployed on device.
+To run this reference solution you need to have a CSV26 camera to be enrolled to your project in the Aitrios Console. In addition, it should have deployed a zone detection Edge application and a compatible object detection AI model. These artifacts should first be obtained locally, then imported to the Console and finally be deployed on device.
 
 > _Note_ </br>
-> For basic device and console operation, please refer to the [**Device Setup Guide**](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/device-setup-guide/) and [**Console User Manual**](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/console-user-manual/).
+> For basic device and console operation, please refer to the [**Console V2 Device Setup Guide**](https://developer.aitrios.sony-semicon.com/en/docs/developer-edition/console-v2/device-setup-guide) and [**Console V2 User Manual**](https://developer.aitrios.sony-semicon.com/en/docs/developer-edition/console-v2/console-user-manual), or [**Console V1 Device Setup Guide**](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/device-setup-guide/) and [**Console V1 User Manual**](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/console-user-manual/).
 
 #### Create and deploy artifacts
 
-The reference solution requires a model and an edge application to be deployed on the device. In some cases, the process for obtaining and deploying these artifacts varies between versions of Console for AITRIOS, V1 and V2. When applicable, such differentce is directly indicated in further description.
+The reference solution requires a model and an edge application to be deployed on the device. In some cases, the process for obtaining and deploying these artifacts varies between versions of Console for AITRIOS, V1 and V2. When applicable, such difference is directly indicated in further description.
 
 ##### AI Model
-- In order to obtain the model, follow the description in [ai_model/model.md](https://github.com/SonySemiconductorSolutions/aitrios-sample-application-reference/blob/main/ai_model/model.md) of this repository.
+- In order to obtain the model, follow the description in [ai_model/model.md](./ai_model/model.md) of this repository.
 The AI model is obtained as a `packerOut.zip` or `yoloXXX_imx.onnx` file and needs to be imported to the AITRIOS Console and then deployed to the device.
-- To import the AI model into **Console**, follow the [PyTorch Model Deployment Guide](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/pytorch-model-deployment-guide?version=2025-02-03) from AITRIOS | Developer Site.
+- To import the AI model into Console, follow the [**Console V2 Deployment Guide for PyTorch AI Model**](https://developer.aitrios.sony-semicon.com/en/docs/developer-edition/console-v2/deployment-guide-for-pytorch-ai-model) or [**Console V1 PyTorch Model Deployment Guide**](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/pytorch-model-deployment-guide).
 
 ##### Edge Application
 
-- In order to get the Edge Application, follow the description in [edge_app/edge_app_v1.md](./edge_app/edge_app_v1.md) of this repository for V1 or the description in [edge_app/edge_app_v2.md](./edge_app/edge_app_v2.md) for V2. You will obtain an Edge Application that will need to be imported to the AITRIOS Console and then deployed to the device.
+- In order to get the Edge Application, follow the description in [edge_app/edge_app_v1.md](./edge_app/edge_app_v1.md) of this repository for V1 or the description in [edge_app/edge_app_v2.md](./edge_app/edge_app_v2.md) for V2.
 
   > **NOTE**<br>
-  > Note that for V1 the Edge Application artifact would be a single file of type `.wasm`/`.aot`, while V2 would result in an Edge Appliction Package.
+  > Note that for V1 the Edge Application artifact would be a single file of type `.wasm`/`.aot`, while V2 would result in an Edge Application Package.
 
--  For instructions on how to import an Edge Application into **Console**, and how to deploy it to the device check [**Console User Manual**](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/console-user-manual/).
-    > **NOTE**<br>
-    > At the moment of writing this document the **Console User Manual** only included instructions for importing V1 Edge Applications. No documentation was available about importing V2 Edge Applications as Edge Application Packages.
+- For instructions on how to import an Edge Application into Console and deploy it to the device, check the [**Console V2 User Manual**](https://developer.aitrios.sony-semicon.com/en/docs/developer-edition/console-v2/console-user-manual) or [**Console V1 User Manual**](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/console-user-manual/).
 
 #### Configure the Edge Application
 
@@ -167,7 +165,7 @@ You can then apply the following configuration to the Edge Application deployed
 ```
 
 > **Note**<br/>
-> For general details on the Edge Application interface, check the [Edge Application Interface JSON Specification](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/console-v2/edge-application-interface-json-specification) page on the AITRIOS developer website. Pay attention to the [`port_settings` subsection](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/console-v2/edge-application-interface-json-specification?progLang=#_portsettingsSpec) <br/>
+> For general details on the Edge Application interface, check the [Edge Application Interface JSON Specification](https://developer.aitrios.sony-semicon.com/en/docs/developer-edition/console-v2/edge-application-interface-json-specification) page on the AITRIOS developer website. Pay attention to the [`port_settings` subsection](https://developer.aitrios.sony-semicon.com/en/docs/developer-edition/console-v2/edge-application-interface-json-specification?progLang=#_portsettingsSpec) <br/>
 > For details on the custom settings for the zone detection Edge Application, check its [README.md](https://github.com/SonySemiconductorSolutions/aitrios-sdk-edge-app/tree/main/sample_apps/detection#custom-parameters).
 
 ### Check prerequisites for executing the Reference Solution
@@ -230,7 +228,7 @@ docker compose up frontend
 ```
 
 >  **Note**</br>
-> This  approach doesn't suport debuging. To run app in the debugging mode you should start frontend and backend separately.
+> This  approach doesn't support debugging. To run app in the debugging mode you should start frontend and backend separately.
 
 #### Frontend
 
@@ -242,7 +240,7 @@ For more detailed usage instructions, see the [backend README](./backend/README.
 
 ## Trademark
 
-- [Read This First](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/read-this-first)
+- [Read This First](https://developer.aitrios.sony-semicon.com/en/docs/developer-edition/console-v2/read-this-first)
 
 ## Notice
 

VERSION

@@ -1 +1 @@
-1.0.0
+1.0.2

ai_model/model.md

@@ -5,7 +5,7 @@ There are two types of object detection models (networks) available for use with
 - SSD Mobilenet-v1 model (for v1 and v2) and
 - Ultralytics YOLO: Yolov8n and Yolo11n model (v2 only)
 > [!NOTE]
-That although all models can be deployed to the IMX500 independly of whether the device runs v1 or v2 firmware, they need to be matched with a compatible Edge App.
+That although all models can be deployed to the IMX500 independently of whether the device runs v1 or v2 firmware, they need to be matched with a compatible Edge App.
 The Edge App that we provide for **v1** is only compatible with the SSD Mobilenet-v1 model and will not work with the Yolov8n/Yolo11n model.*
 
 # How to obtain a ready-to-use Ultralytics YOLO model
@@ -70,10 +70,11 @@ You can modify or extend the script as needed based on [Ultralytics' guidelines]
 # How to obtain a ready-to-use SSD Mobilenet-v1 model
 
 You can download a ready-to-use SSD Mobilenet-v1 model from the
-[AITRIOS Developer Site](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/downloads/console-v2).
-Please choose the Sample AI Model
-[*ssd_mobilenet_v1_0.75_packerOut*](https://developer.aitrios.sony-semicon.com/en/file/download/ssd_mobilenet_v1_0-75_packerout)
-for the Object Detection task.
+[**Console V2 Downloads**](https://developer.aitrios.sony-semicon.com/en/downloads/developer-edition/console-v2).
+Please choose the Sample AI Model for the Object Detection task.
+
+  > **NOTE**<br>
+  > The AI model is downloaded from Console V2 Downloads, but can be used with both V1 and V2 Console versions.
 
 Make sure to follow the instructions on the Developer Site to ensure to have a compatible set of firmware,
 AI model and sample application.

backend/README.md

@@ -72,10 +72,12 @@ See the chapter "Issuing a Client Secret for SDK" in ["Portal User Manual"](http
 - Client ID
 - Client Secret
 
-Get the following required information from [this material](https://developer.aitrios.sony-semicon.com/en/file/download/edge-ai-sensing-portal-console-end-point-info/).
-
-- Console endpoint
-- Portal endpoint
+To execute the REST APIs, please obtain the endpoint information as follows:
+1. Log in to Portal.
+2. From Support → Download, download the document Portal_Console_Endpoint_information_00_en.pdf.
+3. Check the following information described in the document:
+  - Console endpoint
+  - Portal endpoint
 
 And fill [console_access_settings.yaml](app/config/console_access_settings.yaml) file.
 

backend/app/tests/test_timestamp.py

@@ -2,9 +2,9 @@
 This section assumes you are using [Microsoft Visual Studio Code](https://code.visualstudio.com/download).
 
 To set up and run the Zone Detection Sample Application, follow the instructions in the relevant sections:
-- [Preparing devices on AITRIOS](https://github.com/SonySemiconductorSolutions/aitrios-sample-application-reference/tree/main?tab=readme-ov-file#prepare-a-device-on-aitrios-console).
-- [Starting the backend](https://github.com/SonySemiconductorSolutions/aitrios-sample-application-reference/blob/main/backend/README.md#usage), for both _Production_ and _Development_ modes, including debugging instructions.
-- [Starting the frontend](https://github.com/SonySemiconductorSolutions/aitrios-sample-application-reference/blob/main/frontend/README.md#usage), for both _Production_ and _Development_ modes.
+- [Preparing devices on AITRIOS](../README.md#prepare-a-device-on-aitrios-console).
+- [Starting the backend](../backend/README.md#usage), for both _Production_ and _Development_ modes, including debugging instructions.
+- [Starting the frontend](../frontend/README.md#usage), for both _Production_ and _Development_ modes.
 
 
 ## Dev container
@@ -34,7 +34,7 @@ You can then execute the debugging process in Visual Studio Code as follows:
 1. Select the _Run and Debug_ item of the activity bar (`Ctrl+Shift+D` keyshortcut).
 2. Choose the _Launch BE Debugger_ option as seen below.
 
-    ![Launch BE Debugger option](../docs/media/launch_be_debugger.png "Launch BE Debugger")
+    ![Launch BE Debugger option](./media/launch_be_debugger.png "Launch BE Debugger")
 
 ### Frontend
 Make sure the frontend application has been started with a development environment as explained in [here](../frontend/README.md#development-environment).
@@ -44,6 +44,6 @@ You can then execute the debugging process in Visual Studio Code as follows:
 1. Select the _Run and Debug_ item of the activity bar (`Ctrl+Shift+D` keyshortcut).
 2. Choose the _Launch FE Debugger_ option as seen below.
 
-    ![Launch FE Debugger option](../docs/media/launch_fe_debugger.png "Launch FE Debugger")
+    ![Launch FE Debugger option](./media/launch_fe_debugger.png "Launch FE Debugger")
 
 3. This will open a new browser window with the Zone Detection application, so make sure you are using the right window when debugging.