Configure signals - AWS IoT FleetWise

Configure signals

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.

This section shows you how to configure branches, attributes, sensors, and actuators.

Configure branches

To configure a branch, specify the following information.

  • name – The branch's name.

    The branch name must be unique. Valid characters: a-z, A-Z, 0-9, : (colon), and _ (underscore).

  • fullyQualifiedName – The fully qualified name of the branch is the path to the branch plus the branch's name. Use a dot(.) to refer to a child branch. For example, Vehicle.Chassis.SteeringWheel is the fully qualified name for the SteeringWheel branch. Vehicle.Chassis. is the path to this branch.

    The fully qualified name can have up to 150 characters. Valid characters: a-z, A-Z, 0-9, : (colon), and _ (underscore)

  • (Optional) Description – The description for the branch.

    The description can have up to 2048 characters. Valid characters: a-z, A-Z, 0-9, : (colon), _ (underscore), and - (hyphen)

Configure attributes

To configure an attribute, specify the following information.

  • name – The attribute's name.

    The attribute name must be unique. Valid characters: a-z, A-Z, 0-9, : (colon), and _ (underscore).

  • dataType– The attribute's data type must be one of the following: INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, BOOLEAN, FLOAT, DOUBLE, STRING, UNIX_TIMESTAMP, INT8_ARRAY, UINT8_ARRAY, INT16_ARRAY, UINT16_ARRAY, INT32_ARRAY, UINT32_ARRAY, INT64_ARRAY, UINT64_ARRAY, BOOLEAN_ARRAY, FLOAT_ARRAY, DOUBLE_ARRAY, STRING_ARRAY, UNIX_TIMESTAMP_ARRAY, or UNKNOWN.

  • fullyQualifiedName – The fully qualified name of the attribute is the path to the attribute plus the attribute's name. Use a dot(.) to refer to a child signal. For example, Vehicle.Chassis.SteeringWheel.Diameter is the fully qualified name for the Diameter attribute. Vehicle.Chassis.SteeringWheel. is the path to this attribute.

    The fully qualified name can have up to 150 characters. Valid characters: a-z, A-Z, 0-9, : (colon), and _ (underscore)

  • (Optional) Description – The description for the attribute.

    The description can have up to 2048 characters. Valid characters: a-z, A-Z, 0-9, : (colon), _ (underscore), and - (hyphen)

  • (Optional) unit – The scientific unit for the attribute, such as km or Celsius.

  • (Optional) min – The minimum value of the attribute.

  • (Optional) max – The maximum value of the attribute.

  • (Optional) defaultValue – The default value of the attribute.

  • (Optional) assignedValue – The value assigned to the attribute.

  • (Optional) allowedValues – A list of values that the attribute accepts.

Configure sensors or actuators

To configure a sensor or actuator, specify the following information.

  • name – The signal's name.

    The signal name must be unique. Valid characters: a-z, A-Z, 0-9, : (colon), and _ (underscore).

  • dataType– The signal's data type must be one of the following: INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, BOOLEAN, FLOAT, DOUBLE, STRING, UNIX_TIMESTAMP, INT8_ARRAY, UINT8_ARRAY, INT16_ARRAY, UINT16_ARRAY, INT32_ARRAY, UINT32_ARRAY, INT64_ARRAY, UINT64_ARRAY, BOOLEAN_ARRAY, FLOAT_ARRAY, DOUBLE_ARRAY, STRING_ARRAY, UNIX_TIMESTAMP_ARRAY, or UNKNOWN.

  • fullyQualifiedName – The fully qualified name of the signal is the path to the signal plus the signal's name. Use a dot(.) to refer to a child signal. For example, Vehicle.Chassis.SteeringWheel.HandsOff.HandsOffSteeringState is the fully qualified name for the HandsOffSteeringState actuator. Vehicle.Chassis.SteeringWheel.HandsOff. is the path to this actuator.

    The fully qualified name can have up to 150 characters. Valid characters: a-z, A-Z, 0-9, : (colon), and _ (underscore)

  • (Optional) Description – The description for the signal.

    The description can have up to 2048 characters. Valid characters: a-z, A-Z, 0-9, : (colon), _ (underscore), and - (hyphen)

  • (Optional) unit – The scientific unit for the signal, such as km or celsius.

  • (Optional) min – The minimum value of the signal.

  • (Optional) max – The maximum value of the signal.

  • (Optional) assignedValue – The value assigned to the signal.

  • (Optional) allowedValues – A list of values that the signal accepts.