Skip to main content

Robot Settings Tab

The Settings tab allows users to configure and manage various operational, connection, storage, and security parameters for their robot. The settings are categorized into several sections accessible via the left-hand navigation menu.

1. General​

The General section covers the basic identification, software version, and local network connection details of the robot.

  • Robot name: View and edit the display name of the robot (e.g., QA_robot_new).
  • Robot image: Upload or change the visual avatar representing the robot in the platform.
  • Agent: Displays the currently installed version of the robot agent. It indicates if a new version is available and provides an Update Agent button.
  • Local connection: Provides the IP address and port required to connect directly to the robot via a local network (e.g., https://10.170.2.52:19993). It also includes options to copy the URL, open it in a new tab, and a button to download the Linux desktop app.

2. Recordings​

Set up and manage data capture from the robot. Recordings are automatically uploaded based on the configured storage provider.

  • Add Video Recording: Configure video captures to record footage directly from connected camera devices or video streams.
  • Add CSV Recording: Configure text-based data persistence to log stream data over time.

For more information on managing and using recordings, see the Recordings documentation.

3. Notifications​

Configure alerts triggered when specific system conditions or thresholds are met.

  • Notifications quota: Displays a progress bar showing the monthly usage out of the allocated limit for SMS (e.g., 0 of 100), WhatsApp (0 of 100), and Email (0 of 1000) notifications.
  • Built-in notifications: Toggle and set percentage thresholds for automatic system alerts:
    • CPU threshold: Alerts when CPU usage exceeds the specified percentage.
    • RAM threshold: Alerts when RAM usage exceeds the specified percentage.
    • Disk usage threshold: Alerts when disk usage exceeds the specified percentage.
  • Custom Notifications: An + Add Custom Notification button allows users to define specific operator rules and thresholds for re-notification.

4. Custom KPI​

Create and track custom Key Performance Indicators (KPIs) to monitor specialized metrics. These values are displayed in the monitoring pages and robot tables.

  • Add KPI: Clicking the + Add button opens a modal to define the new metric.
    • Name: The display name of the KPI.
    • Measurement units: The unit of the metric being tracked.
    • Stream source: A dropdown to select the specific data stream that feeds the KPI.

5. Storage​

Select the primary storage provider for uploading resources such as video logs and CSV recordings.

  • Storage Providers available:
    • Cogniteam Cloud
    • AWS S3
    • Locally on the Robot

AWS S3 Configuration (when selected)​

To configure AWS S3 storage, you need to set up your AWS account and obtain the necessary credentials. Follow these steps:

Step 1: Create an S3 Bucket​

  1. Log in to the AWS Management Console.
  2. Navigate to S3 and click Create bucket.
  3. Choose a bucket name (e.g., automation-test-upload).
  4. Select the appropriate region (e.g., eu-north-1).
  5. Create the bucket with default settings or customize as needed.

Step 2: Set Up IAM Policy​

To allow secure access to your bucket, create an IAM policy with the necessary permissions:

  1. Navigate to IAM → Policies → Create Policy.
  2. Use the following policy document (replace YOUR_BUCKET_NAME with your actual bucket name):
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": ["s3:PutObject", "s3:GetObject", "s3:DeleteObject"],
      "Resource": "arn:aws:s3:::YOUR_BUCKET_NAME/*"
    },
    {
      "Effect": "Allow",
      "Action": ["s3:ListBucket"],
      "Resource": "arn:aws:s3:::YOUR_BUCKET_NAME"
    }
  ]
}

Step 3: Create Access Keys​

  1. In the AWS Management Console, navigate to IAM → Users.
  2. Select your test user (or create one if needed).
  3. Go to the Security credentials tab.
  4. Click Create access key.
  5. AWS will provide two values:
    • Access Key ID
    • Secret Access Key

Store these credentials securely.

Step 4: Configure in Robot Settings​

In the Robot Settings tab, enter the following information:

  • Access key: Your Access Key ID from AWS
  • Secret key: Your Secret Access Key from AWS
  • Bucket name: Your S3 bucket name (e.g., automation-test-upload)
  • Region: The region where your bucket is located (e.g., eu-north-1)

Once configured, all files uploaded using the upload-file command in the Record Manager will be automatically sent to your AWS S3 bucket.

Important: To avoid sync conflicts and performance issues, we recommend storing files to be uploaded in locations outside of Nimbus synced folders on the robot. Preferably, use a dedicated directory that is not monitored by Nimbus synchronization.

Step 5: Verify the Setup with AWS CLI​

You can verify that your AWS credentials and bucket access are configured correctly using the AWS CLI.

First, configure your credentials:

aws configure

Enter the following values:

AWS Access Key ID: <your access key>
AWS Secret Access Key: <your secret key>
Default region name: eu-north-1
Default output format: json

Then upload a test file:

aws s3 cp test.txt s3://automation-test-upload/ --region eu-north-1

If the command succeeds, your AWS S3 storage configuration is working.

6. Docker Registry​

Manage authentication credentials for private container registries, which are necessary when pulling custom component images.

  • Add private docker registry: Clicking this opens a modal requiring the following details:
    • URL: The registry endpoint.
    • Username: Authentication username.
    • Password: Authentication password.

7. ROS​

Configure the networking parameters specifically for the Robot Operating System (ROS) environment.

  • ROS IP: Set the IP address for the ROS node (e.g., 127.0.0.1).
  • ROS Master URI: Define the URI for the ROS Master (e.g., http://127.0.0.1:11311).
  • ROS 2 Domain ID: Set the domain ID for ROS 2 communications to isolate traffic on the same network.

8. Security​

Enhance the robot's physical and network security by restricting access to external interfaces and communication channels.

  • Block HTTP ports: A toggle that blocks unsecured HTTP-like ports using an iptables rule.
  • Block USB storage: A toggle that disables USB mass-storage devices (usb-storage / UAS) and applies a udev rule to prevent unauthorized physical data extraction or malware injection.
  • Disable Wi-Fi: A toggle that turns off all Wi-Fi radios and interfaces via NetworkManager and wpa_supplicant.
  • Disable Bluetooth: A toggle that turns off the Bluetooth radio and stops the corresponding Bluetooth service.