Commands¶

add-target¶

Add a target.

Usage

vws add-target [OPTIONS]

Options

--width <width>¶

Required The width of the target in the Vuforia database.

--application-metadata <application_metadata>¶

The base64 encoded application metadata associated with the target.

--server-access-key <server_access_key>¶

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>¶

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--name <name>¶

Required The name of the target in the Vuforia database.

--image <image_file_path>¶

Required The path to an image to upload and set as the target image.

--active-flag <active_flag_choice>¶

Whether or not the target is active for query.

Default:

'true'

Options:

ActiveFlagChoice.TRUE | ActiveFlagChoice.FALSE

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

create-model-target-dataset¶

Create a Model Target dataset.

Vuforia generates the dataset in the background, so the dataset is not available to download immediately. The UUID of the new dataset is shown.

Usage

vws create-model-target-dataset [OPTIONS]

Options

--name <name>¶

Required The name of the Model Target dataset.

--target-sdk <target_sdk>¶

Required The Vuforia Engine version to generate the dataset for, for example “10.29”.

--dataset-type <dataset_type>¶

The kind of Model Target dataset. Standard and advanced datasets are separate resources, so a dataset created as one type is not visible to requests for the other type.

Default:

'standard'

Options:

standard | advanced

--model-name <model_name>¶

The name of the model to generate the dataset from. This is required unless –models-file is given.

--cad-data-url <cad_data_url>¶

A URL which Vuforia downloads the model’s CAD data from.

--cad-data-file <cad_data_file_path>¶

The path to a file with the model’s CAD data. The file is sent to Vuforia as base64 encoded data.

--automatic-coloring <automatic_coloring>¶

Whether Vuforia colors the model automatically.

Options:

always | auto | never

--cad-data-format <cad_data_format>¶

The format of the model’s CAD data.

Options:

DAE | FBX | GLB | IGES | OBJ | PVZ | STL | VRML | ZIP

--motion-hint <motion_hint>¶

How the object which the model represents moves.

Options:

adaptive | dynamic | static

--optimize-tracking-for <optimize_tracking_for>¶

What Vuforia optimizes tracking of the model for.

Options:

ar_controller | default | low_feature_objects

--realistic-appearance <realistic_appearance>¶

Whether the model looks like the object it represents. This is documented for advanced datasets only.

Options:

auto | false | true

--simplify <simplify>¶

Whether Vuforia simplifies the model.

Options:

always | auto | never

--tracking-mode <tracking_mode>¶

The tracking mode to generate the dataset for.

Options:

car | default | scan

--state-based-configuration-file <state_based_configuration_file_path>¶

The path to a JSON file with the model’s State-Based Model Target configuration.

--models-file <models_file_path>¶

The path to a JSON file which describes the models to generate the dataset from, in the form which the Model Target Web API takes. The file holds either an array of models or an object with a “models” array. This is the only way to give multiple models, or to give guide views, and it cannot be used with the other model options.

--client-id <client_id>¶

Required A Vuforia OAuth2 client ID to use to access the Model Target Web API.

--client-secret <client_secret>¶

Required A Vuforia OAuth2 client secret to use to access the Model Target Web API.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_MODEL_TARGET_CLIENT_ID

Provide a default for --client-id

VUFORIA_MODEL_TARGET_CLIENT_SECRET

Provide a default for --client-secret

delete-model-target-dataset¶

Delete a Model Target dataset.

Usage

vws delete-model-target-dataset [OPTIONS]

Options

--dataset-uuid <dataset_uuid>¶

Required The UUID of a Model Target dataset, as given when the dataset was created.

--dataset-type <dataset_type>¶

The kind of Model Target dataset. Standard and advanced datasets are separate resources, so a dataset created as one type is not visible to requests for the other type.

Default:

'standard'

Options:

standard | advanced

--client-id <client_id>¶

Required A Vuforia OAuth2 client ID to use to access the Model Target Web API.

--client-secret <client_secret>¶

Required A Vuforia OAuth2 client secret to use to access the Model Target Web API.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_MODEL_TARGET_CLIENT_ID

Provide a default for --client-id

VUFORIA_MODEL_TARGET_CLIENT_SECRET

Provide a default for --client-secret

delete-target¶

Delete a target.

Usage

vws delete-target [OPTIONS]

Options

--server-access-key <server_access_key>¶

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>¶

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--target-id <target_id>¶

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

download-model-target-dataset¶

Download a generated Model Target dataset.

Usage

vws download-model-target-dataset [OPTIONS]

Options

--output <output_file_path>¶

Required The path to write the generated dataset zip file to.

--dataset-uuid <dataset_uuid>¶

Required The UUID of a Model Target dataset, as given when the dataset was created.

--dataset-type <dataset_type>¶

The kind of Model Target dataset. Standard and advanced datasets are separate resources, so a dataset created as one type is not visible to requests for the other type.

Default:

'standard'

Options:

standard | advanced

--client-id <client_id>¶

Required A Vuforia OAuth2 client ID to use to access the Model Target Web API.

--client-secret <client_secret>¶

Required A Vuforia OAuth2 client secret to use to access the Model Target Web API.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_MODEL_TARGET_CLIENT_ID

Provide a default for --client-id

VUFORIA_MODEL_TARGET_CLIENT_SECRET

Provide a default for --client-secret

get-database-reco-counts-report¶

Get a per-target recognition counts report for a database.

The report is a CSV with a target_id,reco_count header. Vuforia generates the report in the background, so by default we wait for the report to be generated before downloading it.

Usage

vws get-database-reco-counts-report [OPTIONS]

Options

--month <month>¶

The month to get recognition counts for, in the YYYY-mm form. Vuforia accepts only the current month and the previous month.

Default:

'the current month'

--output <output_file_path>¶

The path to write the CSV report to. By default, the report is written to stdout.

--no-wait¶

Do not wait for the report to be generated. Instead, show the URL to download the report from once it has been generated.

--seconds-between-requests <seconds_between_requests>¶

The number of seconds to wait between requests made while polling for the report. We wait 0.2 seconds by default, rather than less, than that to decrease the number of calls made to the API, to decrease the likelihood of hitting the request quota.

Default:

0.2

--timeout-seconds <timeout_seconds>¶

The maximum number of seconds to wait for the report to be generated.

Default:

300

--server-access-key <server_access_key>¶

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>¶

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--database-id <database_id>¶

Required The ID of the Vuforia database which the given server keys belong to. This is shown in the Vuforia target manager.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

VUFORIA_DATABASE_ID

Provide a default for --database-id

get-database-summary-report¶

Get a database summary report.

Usage

vws get-database-summary-report [OPTIONS]

Options

--server-access-key <server_access_key>¶

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>¶

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

get-duplicate-targets¶

Get a list of potential duplicate targets.

Usage

vws get-duplicate-targets [OPTIONS]

Options

--server-access-key <server_access_key>¶

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>¶

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--target-id <target_id>¶

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

get-model-target-dataset-status¶

Get the status of a Model Target dataset.

Usage

vws get-model-target-dataset-status [OPTIONS]

Options

--dataset-uuid <dataset_uuid>¶

Required The UUID of a Model Target dataset, as given when the dataset was created.

--dataset-type <dataset_type>¶

The kind of Model Target dataset. Standard and advanced datasets are separate resources, so a dataset created as one type is not visible to requests for the other type.

Default:

'standard'

Options:

standard | advanced

--client-id <client_id>¶

Required A Vuforia OAuth2 client ID to use to access the Model Target Web API.

--client-secret <client_secret>¶

Required A Vuforia OAuth2 client secret to use to access the Model Target Web API.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_MODEL_TARGET_CLIENT_ID

Provide a default for --client-id

VUFORIA_MODEL_TARGET_CLIENT_SECRET

Provide a default for --client-secret

get-target-record¶

Get a target record.

Usage

vws get-target-record [OPTIONS]

Options

--server-access-key <server_access_key>¶

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>¶

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--target-id <target_id>¶

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

get-target-summary-report¶

Get a target summary report.

Usage

vws get-target-summary-report [OPTIONS]

Options

--server-access-key <server_access_key>¶

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>¶

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--target-id <target_id>¶

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

list-targets¶

List targets.

Usage

vws list-targets [OPTIONS]

Options

--server-access-key <server_access_key>¶

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>¶

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

update-target¶

Update a target.

Usage

vws update-target [OPTIONS]

Options

--width <width>¶

The width of the target in the Vuforia database.

--application-metadata <application_metadata>¶

The base64 encoded application metadata associated with the target.

--server-access-key <server_access_key>¶

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>¶

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--name <name>¶

The name of the target in the Vuforia database.

--image <image_file_path>¶

The path to an image to upload and set as the target image.

--active-flag <active_flag_choice>¶

Whether or not the target is active for query.

Options:

ActiveFlagChoice.TRUE | ActiveFlagChoice.FALSE

--target-id <target_id>¶

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

wait-for-model-target-dataset-generated¶

Wait for Vuforia to finish generating a Model Target dataset.

This is done by polling the Model Target Web API. The status of the dataset is shown once Vuforia has finished with it. A dataset which failed to generate is also finished, and gives a non-zero exit code.

Usage

vws wait-for-model-target-dataset-generated [OPTIONS]

Options

--seconds-between-requests <seconds_between_requests>¶

The number of seconds to wait between requests made while polling the dataset status. We wait 0.2 seconds by default, rather than less, than that to decrease the number of calls made to the API, to decrease the likelihood of hitting the request quota.

Default:

0.2

--timeout-seconds <timeout_seconds>¶

The maximum number of seconds to wait for the dataset to be generated.

Default:

300

--dataset-uuid <dataset_uuid>¶

Required The UUID of a Model Target dataset, as given when the dataset was created.

--dataset-type <dataset_type>¶

The kind of Model Target dataset. Standard and advanced datasets are separate resources, so a dataset created as one type is not visible to requests for the other type.

Default:

'standard'

Options:

standard | advanced

--client-id <client_id>¶

Required A Vuforia OAuth2 client ID to use to access the Model Target Web API.

--client-secret <client_secret>¶

Required A Vuforia OAuth2 client secret to use to access the Model Target Web API.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_MODEL_TARGET_CLIENT_ID

Provide a default for --client-id

VUFORIA_MODEL_TARGET_CLIENT_SECRET

Provide a default for --client-secret

wait-for-target-processed¶

Wait for a target to be “processed”. This is done by polling the VWS API.

Usage

vws wait-for-target-processed [OPTIONS]

Options

--seconds-between-requests <seconds_between_requests>¶

The number of seconds to wait between requests made while polling the target status. We wait 0.2 seconds by default, rather than less, than that to decrease the number of calls made to the API, to decrease the likelihood of hitting the request quota.

Default:

0.2

--timeout-seconds <timeout_seconds>¶

The maximum number of seconds to wait for the target to be processed.

Default:

300

--server-access-key <server_access_key>¶

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>¶

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--target-id <target_id>¶

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>¶

The base URL for the VWS API.

Default:

'https://vws.vuforia.com'

--connection-timeout-seconds <connection_timeout_seconds>¶

The connection timeout for HTTP requests, in seconds.

Default:

30

--read-timeout-seconds <read_timeout_seconds>¶

The read timeout for HTTP requests, in seconds.

Default:

30

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key