/dvs/git/dirty/gitlab-master_av/dw/sdk/tools/mapperception/cloud/upload_client/README-tool_mapperception_upload_client.md

Go to the documentation of this file.

# Copyright (c) 2019-2020, NVIDIA CORPORATION.  All rights reserved.

@page dwx_tool_mapperception_upload_client MapStream Upload Tool
@tableofcontents

@section dwx_tool_mapperception_upload_client_description Description

The NVIDIA<sup>&reg;</sup> DriveWorks MapStream Upload tool uploads MapStream data to NVIDIA's DRIVE Mapping Cloud.<br>
This tool returns a UUID of the uploaded MapStream data so it can be downloaded with the @ref dwx_tool_mapperception_download_client.

@note SW Release Applicability: This tool is available in <b>NVIDIA DRIVE Software</b> releases.

@section dwx_tool_mapperception_upload_client_prereqs Prerequisites

This tool is available on the x86 Host System, NVIDIA DRIVE<sup>&trade;</sup> OS Linux, and NVIDIA DRIVE<sup>&trade;</sup> OS QNX.

This tool requires MapStream data created with the RoadRunner application. The
input folder must have the same structure as the data serialized from RoadRunner:

To get access to the NVIDIA MappingServices IP address and JWT token, please contact your NVIDIA account representative.

@section dwx_tool_mapperception_upload_client_usage Running the Tool

Run this tool by executing:

    ./tool_mapperception_upload_client --path=[input_folder]
                                       --ipaddress=[ip_address]
                                       --port=[port]
                                       --token=[token]
                                       --secret=[secret]
                                       --tags=[tags]
                                       [--config=[config file]]

If you have a JSON file containing the non-bracketed parameters, you can also run the tool by executing:

    ./tool_mapperception_upload_client --config=[path to config file]

@subsection dwx_tool_mapperception_upload_client_params Parameters

    --path=[path to input file]
            Description: Folder path to upload the offline MapStream data to.

    --ipaddress=[IP address of service to upload to]
            Description: IP address of the NVIDIA's DRIVE Mapping Cloud upload service.
            Example: --ipaddress=[localhost]

    --port=[service port number]
            Description: Port of NVIDIA's DRIVE Mapping Cloud upload service.
            Example: --port=[50051]

    --token=[]
            Description: Your authorization token.

    --secret=[]
            Description: Your authorization secret.

    --tags=[<key,value>,<key,value>,...]
            Description: A comma separated list of (key,value) pairs to apply to the MapStream asset.
                         The asset will automatically be tagged with the DriveWorks version.

    --config=[path to config file]
            Description: If this parameter is present, the program reads the configuration from a
                         JSON file containing the required parameters.
                         Command line arguments can be used to override what is specified in the file, except for tags.
                         Tags on the command line will supplement and override the existing tags specified within the JSON file.

@section dwx_tool_mapperception_upload_client_example Examples

@subsection dwx_tool_mapperception_upload_client_withoutconfig Running without the Config File

    ./tool_mapperception_upload_client --path=[input_folder]
                                       --ipaddress=[ip_address]
                                       --port=[port]
                                       --token=[token]
                                       --secret=[secret]
                                       --tags=[tags]

@subsection dwx_tool_mapperception_upload_client_withconfig Running with the Config File

    ./tool_mapperception_upload_client --config=../tool_mapperception_upload_client_config.json