Create a signal catalog (AWS CLI) - AWS IoT FleetWise

Create a signal catalog (AWS CLI)

AWS IoT FleetWise is in preview release and is subject to change. We recommend that you use the service only with test data, and not in production environments.

While AWS IoT FleetWise is in preview, you must download the preview AWS SDK and AWS CLI to use the API operations for this service. These API operations aren't available in the public AWS SDK or AWS CLI. For more information, see Preview AWS CLI and AWS SDKs.

You can use the CreateSignalCatalog API operation to create a signal catalog. The following example uses AWS CLI.

To create a signal catalog, run the following command.

Replace signal-catalog-configuration with the name of the JSON file that contains the configuration.

aws iotfleetwise create-signal-catalog --cli-input-json file://signal-catalog-configuration.json
  • Replace signal-catalog-name with the name of the signal catalog that you're creating.

  • (Optional) Replace description with a description to help you identify the signal catalog.

For more information about how to configure branches, attributes, sensors, and actuators, see Configure signals.

{ "name": "signal-catalog-name", "description": "description", "nodes": [ ... { "branch": { "description": "Root node for the vehicle.", "fullyQualifiedName": "Vehicle", "name": "Vehicle" }, "type": "Branch" }, { "branch": { "description": "Powertrain data for battery management.", "fullyQualifiedName": "Vehicle.Powertrain", "name": "Powertrain" }, "type": "Branch" }, { "branch": { "description": "Transmission-specific data, stopping at the drive shafts.", "fullyQualifiedName": "Vehicle.Powertrain.Transmission", "name": "Transmission" }, "type": "Branch" }, { "sensor": { "dataType": "FLOAT", "description": "Vehicle_Odometer", "fullyQualifiedName": "Vehicle.Powertrain.Transmission.VehicleOdometer", "max": 67108863.984375, "min": 0, "name": "VehicleOdometer", "unit": "km" }, "type": "Sensor" }, { "branch": { "description": "All data concerning steering, suspension, wheels, and brakes.", "fullyQualifiedName": "Vehicle.Chassis", "name": "Chassis" }, "type": "Branch" }, { "branch": { "description": "Steering wheel signals.", "fullyQualifiedName": "Vehicle.Chassis.SteeringWheel", "name": "SteeringWheel" }, "type": "Branch" }, { "attribute": { "dataType": "FLOAT", "description": "The diameter of the steering wheel.", "fullyQualifiedName": "Vehicle.Chassis.SteeringWheel.Diameter", "max": 50, "min": 1, "name": "Diameter", "unit": "cm" }, "type": "Attribute" }, { "actuator": { "dataType": "BOOLEAN", "description": "Hands Off Steering State.", "fullyQualifiedName": "Vehicle.Chassis.SteeringWheel.HandsOffSteeringState", "name": "HandsOffSteeringState" }, "type": "Actuator" }, { "branch": { "description": "Front of vehicle-specific data.", "fullyQualifiedName": "Vehicle.Front", "name": "Front" }, "type": "Branch" }, { "branch": { "description": "Front right of vehicle specific data.", "fullyQualifiedName": "Vehicle.Front.Right", "name": "Right" }, "type": "Branch" }, { "branch": { "description": "Door-specific data for the front right of vehicle.", "fullyQualifiedName": "Vehicle.Front.Right.Door", "name": "Door" }, "type": "Branch" }, { "actuator": { "fullyQualifiedName": "Vehicle.Front.Right.Door.Lock", "name": "Lock", "description": "Whether the front right door is locked.", "dataType": "BOOLEAN" }, "type": "Actuator" } ] }