Skip to main content
Framed content
A config type represents a logical grouping of parameters used by your robot’s software. It consists of
  1. The config instances in its domain (the actual parameters deployed to devices)
  2. A versioned config schema, which defines the structure and constraints for those instances
For example, a Mobility config type houses configs related to the robot’s motion while a Perception config type houses configs related to the robot’s perception. Each config type has its own versioned schema, which its config instances must adhere to depending on the release they are deployed under.

​
Properties

​
name
string
A human-readable display name that can contain most characters, such as spaces, special characters, and punctuation. Must contain between 1 and 48 characters.Examples: Mobility, Safety Features, Perception
​
slug
string
A unique, code-friendly identifier for a config type.Slugs are immutable and must satisfy the following constraints:
  • Contain only lowercase letters, digits, and hyphens (-)
  • Start and end with a lowercase letter or digit
  • Contain between 1 and 48 characters
Slugs are primarily used in code to reference config types in a human-readable format. For instance, config schemas are annotated with a config type slug to associate them with their proper config type.Examples: mobility, safety-features, perception

​
Create a config type

Navigate to the Config Types page and click New Config Type in the top right corner.
Fill in the fields, then click Create.
Config type slugs are immutable and cannot be modified after creation.

​
Edit a config type

Click the ellipses (…) on the config type you want to edit and hit Edit.
Update the desired fields, then click Save.

​
Delete a config type

Deleting a config type is irreversible. Once a config type is deleted, it cannot be recovered. Deleting a config type is only possible if there are no config instances for that config type. As such, most config types cannot be deleted. If no config instances exist for the config type, deleting a config type removes all associated schemas. To delete a config type, click the ellipses of the config type you want to delete and select Delete.
A confirmation dialog will appear. Hit Delete to confirm the deletion.