Rosbag

rio rosbag

Record ROS Topics for ROS components

rio rosbag [OPTIONS] COMMAND [ARGS]...

blob

ROSBag file actions

rio rosbag blob [OPTIONS] COMMAND [ARGS]...

delete

Delete a ROSbag blob

rio rosbag blob delete [OPTIONS] GUID

Arguments

GUID

Required argument

download

Download a ROSbag blob

rio rosbag blob download [OPTIONS] GUID

Options

--filename <filename>

Name of the file

--download-dir <download_dir>

Directory to download the file into

Arguments

GUID

Required argument

list

List the Rosbag blobs in the selected project

rio rosbag blob list [OPTIONS]

Options

--guids <guids>

Filter by blob guids

--deployment-ids <deployment_ids>

Filter by deployment ids

--component-instance-ids <component_instance_ids>

Filter by component instance ids

--job-ids <job_ids>

Filter by job ids

--device-ids <device_ids>

Filter by device ids

--statuses <statuses>

Filter by rosbag blob statuses

Options:

Starting | Uploading | Uploaded | Error

job

Record the topics for any ROS component

rio rosbag job [OPTIONS] COMMAND [ARGS]...

create

Create a ROSbag job

rio rosbag job create [OPTIONS]

Options

--name <name>

Name of the rosbag job

--deployment-id <deployment_id>

Deployment id

--component-instance-id <component_instance_id>

Component instance id

--all-topics, --not-all-topics

Record all topics?

--topics <topics>

List of topics whose content is to be recorded

--topic-include-regex <topic_include_regex>

Include topics matching the given regular expression

--topic-exclude-regex <topic_exclude_regex>

Exclude topics matching the given regular expression

--max-message-count <max_message_count>

Only record NUM messages on each topic

--node <node>

Record all topics subscribed to by a specific node

--compression <compression>

Compression ?

Options:

LZ4 | BZ2

--max-splits <max_splits>

Split bag at most MAX_SPLITS times

--max-split-size <max_split_size>

Record a bag of maximum size

--chunk-size <chunk_size>

Record to chunks of size KB before writing to disk

inspect

Inspect a ROSbag job

rio rosbag job inspect [OPTIONS] JOB_GUID

Options

-f, --format <format_type>
Options:

json | yaml

Arguments

JOB_GUID

Required argument

list

List the Rosbag jobs for the given Deployment

rio rosbag job list [OPTIONS] DEPLOYMENT_NAME

Options

--component-instance-ids <component_instance_ids>

Filter by component instance ids

--guids <guids>

Filter by job guids

--statuses <statuses>

Filter by rosbag job statuses

Options:

Starting | Running | Error | Stopping | Stopped

Arguments

DEPLOYMENT_NAME

Required argument

stop

Stop ROSbag jobs

rio rosbag job stop [OPTIONS] DEPLOYMENT_NAME

Options

--component-instance-ids <component_instance_ids>

Filter by component instance ids

--guids <guids>

Filter by job guids

Arguments

DEPLOYMENT_NAME

Required argument

trigger

Trigger Rosbag Upload

Here are some examples of RFC3339 date/time format that can be given to ‘–upload-from’ & ‘–upload-to’ options

  1. 2022-10-21T23:20:50.52Z

    This represents 20 minutes and 50.52 seconds after the 23rd hour of October 21st, 2022 in UTC.

  2. 2022-10-21T23:20:50.52+05:30

    This represents 20 minutes and 50.52 seconds after the 23rd hour of October 21st, 2022 with an offset of +05:30 from UTC (Indian Standard Time).

    Note that this is equivalent to 2022-10-21T17:50:50.52Z in UTC.

  3. 2022-10-21T23:20:50.52+09:00

    This represents 20 minutes and 50.52 seconds after the 23rd hour of October 21st, 2022 with an offset of +09:00 from UTC (Japan Standard Time).

    Note that this is equivalent to 2022-10-21T14:20:50.52Z in UTC.

  4. 2022-10-21T23:20:50.52-07:00

    This represents 20 minutes and 50.52 seconds after the 23rd hour of October 21st, 2022 with an offset of -07:00 from UTC (Pacific Daylight Time).

    Note that this is equivalent to 2022-10-22T06:20:50.52Z in UTC.

Ref: https://www.rfc-editor.org/rfc/rfc3339#section-5.8

rio rosbag job trigger [OPTIONS] DEPLOYMENT_NAME JOB_GUID

Options

--upload-from <upload_from>

Required Rosbags recorded after or at this time are uploaded. Specify time in RFC 3339 format (1985-04-12T23:20:50.52Z)

--upload-to <upload_to>

Required Rosbags recorded before or at this time are uploaded. Specify time in RFC 3339 format (1985-04-12T23:20:50.52Z)

Arguments

DEPLOYMENT_NAME

Required argument

JOB_GUID

Required argument

update

Update the Rosbag Job

rio rosbag job update [OPTIONS] DEPLOYMENT_NAME JOB_GUID

Options

--upload-mode <upload_mode>

Required Change upload mode

Options:

OnStop | Continuous | OnDemand

Arguments

DEPLOYMENT_NAME

Required argument

JOB_GUID

Required argument