"Console Access Library" - Quick Start Guide

Prerequisites

Following required software you need to install in your system

• Node >= v18

For installation please refer the following link:

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

To node installation

node --version

• TypeScript >= v4.7.4

To install TypeScript global, run the following command

npm install -g typescript

To verify the TypeScript installation

tsc --version

Install "Console Access Library"

• Build and generate dependency package for "Console Access Library"

Open terminal and go to the lib/js-client path and run the following command

    > npm install
    > tsc -b
    > npm pack

• Build and generate "Console Access Library" package

Open terminal and go to the src path and run the following command

    > npm install
    > tsc -b
    > npm pack

To Start "Demo-Console app"

• Set up configuration parameter to start "Demo-Console app".

• Create console access setting configuration parameters with real values

  samples/demo-console/console_access_settings.yaml.

  In the case of using "Console Developer Edition"

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

  In the case of using "Console Enterprise Edition"

          console_access_settings:
              console_endpoint: "__console_endpoint__"
              portal_authorization_endpoint: "https://login.microsoftonline.com/'__tenant_id__'"
              client_secret: "__client_secret__"
              client_id: "__client_id__"
              application_id: "__application_id__"
  

• Network proxy setting

  To use the "Console Access Library" in a proxy environment, set the https_proxy environment variable.

   export https_proxy= http://username:password@proxyhost:port
   
  

• Edit demo configuration parameters with real values.

  • Case 1：When setting only required parameters samples/demo-console/demo_config.yaml.

    demo_configuration:
        device_id: "__device_id__"
        model_id: "__model_id__"
        model: "__model__"
        config_id: "__config_id__"
        app_name: "__app_name__"
        file_content_name: "__file_content_name__"
        version_number: "__version_number__"
        sub_directory_name: "__sub_directory_name__"
    

  • Case 2：When setting optional parameters (samples\demo_config.yaml).

    demo_configuration:
        device_id: "__device_id__"
        get_model_device_id: "__get_model_device_id__"
        publish_model_wait_response_device_id: "__publish_model_wait_response_device_id__"
        model_id: "__model_id__"
        model: "__model__"
        converted: "__converted__"
        vendor_name: "__vendor_name__"
        comment: "__comment__"
        input_format_param: "__input_format_param__"
        network_config: "__network_config__"
        network_type: "__network_type__"
        metadata_format_id: "__metadata_format_id__"
        project_name: "__project_name__"
        model_platform: "__model_platform__"
        project_type: "__project_type__"
        latest_type: "__latest_type__"
        config_id: "__config_id__"
        sensor_loader_version_number: "__sensor_loader_version_number__"
        sensor_version_number: "__sensor_version_number__"
        model_version_number: "__model_version_number__"
        ap_fw_version_number: "__ap_fw_version_number__"
        device_ids: "__device_ids__"
        replace_model_id: "__replace_model_id__"
        timeout: "__timeout__"
        app_name: "__app_name__"
        file_content_name: "__file_content_name__"
        version_number: "__version_number__"
        file_name: "__file_name__"
        entry_point: "__entry_point__"
        schema_info: "__schema_info__"
        device_name: "__device_name__"
        connection_state: "__connection_state__"
        device_group_id: "__device_group_id__"
        scope: "__scope__"
        sub_directory_name: "__sub_directory_name__"
        number_of_images: "__number_of_images__"
        skip: "__skip__"
        order_by: "__order_by__"
        number_of_inference_results: "__number_of_inference_results__"
        filter: "__filter__"
        raw: "__raw__"
        time: "__time__"
        from_datetime: "__from_datetime__"
        to_datetime: "__to_datetime__"
    

• To run ImportDeviceApp

  To execute the API "ImportDeviceApp", place the contents of the wasm or aot file under samples. And set the file name to "file_content_name" of samples/demo_config.yaml.

• Run the Sample App

  To run the CLI demo, open cmd terminal from the root folder, go to the samples/demo-console and run the following command.

  > npm install
  > npx ts-node index.ts 
  
  

Restrictions

• None

Get support

• Contact us

See also

• "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.