Skip to main content

Documentation Index

Fetch the complete documentation index at: https://inorbitinc.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Robot camera configuration controls how still images from robot cameras are captured and displayed in InOrbit. Each camera is identified by a numeric ID and can have custom settings for resolution, frame rate, and display options.

When to Use

  • Multiple cameras: Configure front, rear, or specialized cameras with different settings
  • Bandwidth optimization: Adjust resolution and frame rate based on network conditions
  • Display customization: Set labels, rotation, and mirroring for proper orientation

Spec Fields

FieldTypeRequiredDescription
idstringYesCamera identifier. Must be a numeric string ("0", "1", etc.).
labelstringNoDisplay label for this camera.
shortLabelstringNoShort label (max 10 chars) for compact displays. Defaults to first letter of label.
rosTopicstringNoROS topic to subscribe to for camera images.
widthnumberNoCaptured image width in pixels (1-2048).
heightnumberNoCaptured image height in pixels (1-2048).
ratenumberNoFrames per second (0-10).
outputEncodingstringNoImage encoding. Default: "rgb8".
qualitynumberNoJPEG quality (1-100).
rotationnumberNoImage rotation in degrees (multiples of 90).
mirrorbooleanNoMirror image horizontally. Default: false.
enabledbooleanNoWhether camera is active. Default: true.

Example

kind: RobotCamera
apiVersion: v0.1
metadata:
  scope: robot/<accountId>/<robotId>
  id: "0"
spec:
  label: "Front Camera"
  shortLabel: "F"
  rosTopic: "/usb_cam/image_raw"
  width: 320
  height: 240
  rate: 2
  outputEncoding: "rgb8"
  quality: 50
  rotation: 0
  mirror: false
  enabled: true

Multiple Cameras Example

# Front camera - high resolution for navigation
kind: RobotCamera
apiVersion: v0.1
metadata:
  scope: tag/<accountId>/delivery-robots
  id: "0"
spec:
  label: "Front"
  shortLabel: "F"
  rosTopic: "/front_camera/image_raw"
  width: 640
  height: 480
  rate: 5
  quality: 70
---
# Rear camera - lower resolution for monitoring
kind: RobotCamera
apiVersion: v0.1
metadata:
  scope: tag/<accountId>/delivery-robots
  id: "1"
spec:
  label: "Rear"
  shortLabel: "R"
  rosTopic: "/rear_camera/image_raw"
  width: 320
  height: 240
  rate: 1
  quality: 40
  rotation: 180