Object Occupancy Rate: Sample Application on AITRIOS

Contents

• Contents
  • Overview
  • Restrictions
  • Getting Started
    • Start application
      • Start application on Github Codespaces
      • Start application on local Docker environment(DevContainer)
  • Documentation
    • Functional Specifications
  • Get support
  • See also
  • Trademark
  • Versioning
  • Branch
  • Security

Overview

This repository provides sample code for application that calculates the occupancy rate of objects using "aitrios-sdk-cloud-app-sample-ts".

Restrictions

• Following required software you need to install in your system

  • Node.js version 16.x.x (Confirmed it functions with version 16.20.2)

  For installation please refer the following link:

  https://nodejs.org/en/download/

• In the AITRIOS connect mode of this application, only the image data of the last 1 hour is acquired. Therefore, when using this mode, please make sure that the device is either in the process of uploading image and inference result or has the data has been uploaded in the past 1 hour.

Getting Started

For basic Edge Device and Console operation, please refer to the Device Setup Guide and Console User Manual.

Start application

Start application on Github Codespaces

1. Clone or fork this application in your GitHub environment.

2. Click the + button to create a codespace on the GitHub environment. See how to create a codespace.

3. Create console access setting configuration file with real values in src/common/console_access_settings.yaml.

   src/common/console_access_settings.yaml

   console_access_settings:
       console_endpoint: "__console_endpoint__"
       portal_authorization_endpoint: "__portal_authorization_endpoint__"
       client_secret: "__client_secret__"
       client_id: "__client_id__"

   Note

   • Specify the base URL
   • Specify the token URL
   • Specify registered application secret for client_secret
   • Specify registered application client ID for client_id

   To obtain the endpoint URL, see REST API Authentication, or see the Portal user manual for more details.

4. Run the sample application using the following command.

    $ npm run dev
   

5. Access the host address from the pop-up in the lower right corner, and verify that the application is running.

   Note

   When checking the operation in AITRIOS connect mode, make sure that the inference upload is running on the device where the AI model and EdgeApp is deployed.

Start application on local Docker environment(DevContainer)

1. Open the cloned repository from VSCode's "Open Folder" in "File" tab

2. Open Command Palette in VSCode(Ctrl + Shift + P)

3. Type and choose "Dev Containers: Open Folder in Container..."

4. Select root directory of the project and wait for building DevContainer.

   /your/local/workspace/aitrios-application_object-occupancy-rate

5. Create console access setting configuration file with real values in src/common/console_access_settings.yaml.

6. Run the sample application using the following command.

    $ npm run dev
   

7. Access the host address from the pop-up in the lower right corner, and verify that the application is running.

   Note

   When checking the operation in AITRIOS connect mode, make sure that the inference upload is running on the device where the AI model and EdgeApp is deployed.

Documentation

Functional Specifications

• "Cloud SDK Sample Application TypeScript IDE Functional Specifications"
• "Cloud SDK Sample Application TypeScript Functional Specifications"

Get support

• About the AI model, Edge App and command parameter file for this application :
  • Contact SSS member (Logistics Team) via the following query: "Inquiry Form - Input"
• The others
  • "Contact Us"

See also

• aitrios-sdk-cloud-app-sample-ts
• aitrios-sdk-console-access-lib-ts
• "Developer Site"

Trademark

• "Read This First"

Versioning

This repository aims to adhere to Semantic Versioning 2.0.0.

Branch

See the "Release Note" from [Releases] for this repository.

Each release is generated in the main branch. Pre-releases are generated in the develop branch. Releases will not be provided by other branches.

Security

Before using Codespaces, please read the Site Policy of GitHub and understand the usage conditions.