Skip to main content

create

inctl recordings create​

Creates a new recording directly on the workcell

Synopsis​

Creates a new recording directly on the workcell using the DataLogger API. You can specify exact times and content groupings.

Limits:

  • Mixed data (anything beyond text-logs or flowstate-data) will fail if it exceeds a maximum of 10 minutes.
  • Text/flowstate-only data will fail if it exceeds a maximum of 24 hours.
inctl recordings create [flags]

Examples​

  # Create a default recording (all data) for the last 5 minutes
  inctl recordings create --workcell my-workcell --org my-org

  # Create a recording containing everything, with a custom timeframe in UTC (answer yes on prompt)
  inctl recordings create --workcell my-workcell --org my-org \
    --start_timestamp 2024-08-20T12:00:00Z \
    --end_timestamp 2024-08-20T12:05:00Z

  # Create a recording with a custom timeframe in a specific timezone (e.g. PST, -07:00)
  inctl recordings create --workcell my-workcell --org my-org \
    --start_timestamp 2024-08-20T12:00:00-07:00 \
    --end_timestamp 2024-08-20T12:05:00-07:00

  # Record only text logs plus a specific custom event source
  inctl recordings create --workcell my-workcell --include_text_logs --additional_event_sources "^/my/custom/topic$"

  # Record multiple custom data sources using multiple flags or regex
  inctl recordings create --workcell my-workcell \
    --additional_event_sources "^/my/custom/topic1$" \
    --additional_event_sources "^/my/custom/topic2/.*"

Options​

      --additional_event_sources strings   Custom RE2 regex patterns of event sources to record.
      --description string                 A human-readable description for the recording.
      --end_timestamp string               End timestamp in RFC3339 format for fetching recordings. eg. 2024-08-20T12:00:00Z (UTC) or 2024-08-20T12:00:00-07:00 (UTC-7)
  -h, --help                               help for create
      --include_all_data                   Include all eligible event sources (.*). Use this flag to suppress the interactive prompt and intentionally record everything.
      --include_debug_data                 Include Debug data. Contains debug data, such as system metrics and the executive state.
      --include_flowstate_data             Include Flowstate data. Contains Flowstate data, such as Flowstate events.
      --include_perception_data            Include Perception data. Contains perception data, such as camera images and pose estimations.
      --include_robot_data                 Include Robot data. Contains robot-related data, such as robot status and motion planning information.
      --include_scene_data                 Include Scene data. Contains scene data, such as TFs, world geometries, and markers.
      --include_skill_data                 Include Skill data. Contains skill data, such as skill inputs and execution results.
      --include_text_logs                  Include Text logs. Contains all text logs (including ones from user installed assets).
      --org string                         The Intrinsic organization to use. You can set the environment variable
                                           	INTRINSIC_ORG=organization to set a default organization.
  -p, --project string                     The Google Cloud Project (GCP) project to use. You can set the environment variable
                                           	INTRINSIC_PROJECT=project_name to set a default project name.
  -q, --quiet                              Suppress interactive prompts. Prompts will resolve to their default values (e.g. deny missing-data prompt, accept generate prompt).
      --skip_generate                      If set, unconditionally skips prompting for and generating the recording after creation.
      --start_timestamp string             Start timestamp in RFC3339 format for fetching recordings. eg. 2024-08-20T12:00:00Z (UTC) or 2024-08-20T12:00:00-07:00 (UTC-7)
      --workcell string                    The Kubernetes cluster to use.

Options inherited from parent commands​

  -o, --output string   (optional) Output format. One of: (json, ndjson)
      --print-trace     Print the trace identifier when exiting.

SEE ALSO​