Configure Cloud Sync

Before you can configure cloud sync, you must add the Data Management Service.

To enable cloud sync, navigate to the Services tab on your robot configuration page and enable Syncing for your Data Management Service.

By default, the Data Management Service syncs data to Viam’s cloud every 5 minutes. To change the sync interval, specify an interval in minutes in the interval field.

The JSON configuration for the Data Management Service is:

{
  "components": [ ],
  "services": [
    {
      "name": "data_manager",
      "type": "data_manager",
      "attributes": {
        "sync_interval_mins": 5,
        "capture_dir": "/.viam/capture"
      }
    }
  ]
}

Sync files from another directory

You may have additional files you want to sync to the cloud from your robot. For example, there may be components on your robot which are not controlled by Viam that are collecting data locally on your robot. Or there may be a set of logs indicating the status of the robot at different points in time. To include these types of files in cloud sync, click ADD PATHWAY in the Data Management Service panel and specify the directory where your files are located on your robot. Once you save the configuration, the Data Management Service begins syncing the files in the specified folder at the interval configured for the service. To avoid syncing files that are still being written to, the Data Management Service only syncs files that haven’t been modified in the previous 10 seconds.

In the example pictured here, the Data Management Service syncs the configured component data from /tmp/capture as well as all files in /logs every 5 minutes.

service config example

The JSON configuration for this example is:

{
  "components": [ ],
  "services": [
    {
      "name": "data_manager",
      "type": "data_manager",
      "attributes": {
        "sync_interval_mins": 5,
        "capture_dir": "/.viam/capture",
        "sync_disabled": false,
        "additional_sync_paths": [
          "/logs"
        ]
      }
    }
  ]
}