Skip to content

usage-example.rst

Latest commit

 

History

History
95 lines (81 loc) · 2.93 KB

usage-example.rst

File metadata and controls

95 lines (81 loc) · 2.93 KB
Raw

Usage example

$ vws add-target \
    --server-access-key "$SERVER_ACCESS_KEY" \
    --server-secret-key "$SERVER_SECRET_KEY" \
    --name my_image_name \
    --width 2 \
    --image ~/Documents/my_image.png \
    --application-metadata "$(echo 'my_metadata' | base64)" \
    --active-flag true
03b99df0-78cf-4b01-b929-f1860d4f8ed1
$ vws --help
...
$ vuforia-cloud-reco my_image.jpg \
    --max-num-results 5 \
    --include-target-data none
- target_id: b60f60121d37418eb1de123c381b2af9
- target_id: e3a6e1a216ad4df3aaae1f6dd309c800
$

Model Target datasets

Model Target dataset commands use OAuth2 credentials for the Model Target Web API, rather than server keys. Vuforia generates a dataset in the background, so create the dataset, wait for it, and then download it.

$ vws create-model-target-dataset \
    --client-id "$MODEL_TARGET_CLIENT_ID" \
    --client-secret "$MODEL_TARGET_CLIENT_SECRET" \
    --name my_dataset_name \
    --target-sdk 10.29 \
    --model-name my_model_name \
    --cad-data-file ~/Documents/my_model.obj \
    --cad-data-format obj
1f0f2b7c1f0f4b0a9a1c4b6b0a5b0f2b
$ vws wait-for-model-target-dataset-generated \
    --client-id "$MODEL_TARGET_CLIENT_ID" \
    --client-secret "$MODEL_TARGET_CLIENT_SECRET" \
    --dataset-uuid 1f0f2b7c1f0f4b0a9a1c4b6b0a5b0f2b
completed_at: '2026-08-14 12:00:00+00:00'
created_at: '2026-08-14 11:59:00+00:00'
dataset_uuid: 1f0f2b7c1f0f4b0a9a1c4b6b0a5b0f2b
error: null
eta: null
status: done
warning: null
$ vws download-model-target-dataset \
    --client-id "$MODEL_TARGET_CLIENT_ID" \
    --client-secret "$MODEL_TARGET_CLIENT_SECRET" \
    --dataset-uuid 1f0f2b7c1f0f4b0a9a1c4b6b0a5b0f2b \
    --output ~/Documents/my_dataset.zip
$ vws delete-model-target-dataset \
    --client-id "$MODEL_TARGET_CLIENT_ID" \
    --client-secret "$MODEL_TARGET_CLIENT_SECRET" \
    --dataset-uuid 1f0f2b7c1f0f4b0a9a1c4b6b0a5b0f2b
$

Use --dataset-type advanced with each of these commands for an advanced dataset. To give more than one model, or to give guide views, describe the models in a JSON file and give it with --models-file:

{
  "models": [
    {
      "name": "my_model_name",
      "cadDataUrl": "https://example.com/my_model.zip",
      "cadDataFormat": "OBJ",
      "views": [
        {
          "name": "front",
          "guideViewPosition": {
            "rotation": [0, 0, 0, 1],
            "translation": [0, 0, -1.5]
          }
        }
      ]
    }
  ]
}