Create a campaign (console) - AWS IoT FleetWise

Create a campaign (console)

You can use the AWS IoT FleetWise console to create a campaign to select, collect, and transfer vehicle data to the cloud.

To create a campaign
  1. Navigate to the AWS IoT FleetWise console.

  2. On the navigation pane, choose Campaigns.

  3. On the campaign summary page, choose Create campaign, and then do the following:

Important

Step 1: Configure campaign

In General information, do the following:

  1. Enter a name for the campaign.

  2. (Optional) Enter a description.

  3. Choose Next.

Step 2: Search vehicle attributes

To choose which vehicles to deploy your campaign to, search for the attributes and their values that you added when creating the vehicles.

Note

You can add up to five attributes to your search.

  • In Search vehicle attributes, do the following:

To search vehicle attributes
  1. Enter the attribute's fully qualified name, such as fuelType, that is specified for the vehicle you want to deploy the campaign to.

    Note

    Each attribute can be used only once.

    1. Choose the attribute name from the dropdown list.

    2. For Operators, choose Equals.

    3. Enter the value of the attribute, such as gasoline, that is specified for the vehicle you want to deploy the campaign to.

    4. To search for another vehicle attribute, repeat the preceding steps. You can search for up to five vehicle attributes.

  2. Vehicles that match your search are listed under Vehicle ID. The campaign will deploy to all the vehicles returned from your search.

    Note

    Up to 100 vehicles are displayed in search results.

  3. Choose Next.

Step 3: Configure data collection scheme

A campaign's data collection scheme gives the Edge Agent software instructions on what data to collect or when to collect it. In the AWS IoT FleetWise console, you can configure a data collection scheme in the following ways:

  • Manually define the data collection scheme

  • Upload a file to automatically define the data collection scheme

In Configuration option, do one of the following:

  • Select Define data collection scheme to manually specify the type of data collection scheme and define options to customize the scheme.

    You can manually specify the type of data collection scheme and define options to customize the scheme.

    To manually define the data collection scheme
    1. In the Data collection scheme details section, select the type of data collection scheme you want this campaign to use. To use a logical expression to recognize what vehicle data to collect, choose Condition-based. To use a specific time period to decide how often to collect vehicle data, choose Time-based.

    2. Define the duration of time the campaign collects data.

      Note

      By default, an approved campaign is activated immediately and doesn't have a set end time. To avoid extra charges, you must specify a range.

    3. If you specified a condition-based data collection scheme, you must define a logical expression to recognize what data to collect. AWS IoT FleetWise uses a logical expression to recognize what data to collect for a condition-based scheme. The expression must specify a signal's fully qualified name as a variable, a comparison operator, and a comparison value.

      For example, if the $variable.myVehicle.InVehicleTemperature > 50.0 expression is specified, AWS IoT FleetWise collects temperature values that are greater than 50.0. For instructions about how to write expressions, see Expressions in the AWS IoT Events Developer Guide.

      Enter the logical expression used to recognize what data to collect.

    4. (Optional) You can specify the language version of the conditional expression. The default value is 1.

    5. (Optional) You can specify the minimum trigger interval, which is the smallest duration of time between two data collection events. For example, if a signal changes often, you might want to collect data at a slower rate.

    6. Specify the Trigger mode condition for the Edge Agent software to collect data. By default, the Edge Agent for AWS IoT FleetWise software Always collects data whenever the condition is met. Or, it can collect data only when the condition is met for the first time, On first trigger.

    7. If you specified a time-based data collection scheme, you must specify a time Period, in milliseconds, from 10000 ‐ 60000 milliseconds. The Edge Agent software uses the time period to decide how often to collect data.

    8. (Optional) You can edit the scheme’s Advanced scheme options.

      1. To save wireless bandwidth and reduce network traffic by compressing data, choose Snappy.

      2. (Optional) To define how long, in milliseconds, to continue collecting data after a data collection event, you can specify the Post trigger collection duration.

      3. (Optional) To indicate the priority level of the campaign, you can specify the campaign Priority. Campaigns with a smaller number for priority are deployed first and are considered to have a higher priority.

      4. The Edge Agent software can temporarily store data locally when a vehicle isn't connected to the cloud. After the connection is reestablished, the data stored locally is automatically transferred to the cloud. Specify if you want the Edge Agent to Store data locally during a lost connection.

      5. (Optional) To provide additional information for a signal, add up to five attributes as Extra data dimensions.

  • Select Upload a .json file from your local device to upload a file to define the data collection scheme. AWS IoT FleetWise automatically defines which options that you can define in the file. You can review and update the selected options.

    You can upload a .json file with details about the data collection scheme.

    To import a file to define the data collection scheme
    1. To import information about the data collection scheme, choose Choose files. For more information about the required file format, see the CreateCampaign API documentation.

      Note

      AWS IoT FleetWise currently supports the .json file format extension.

    2. AWS IoT FleetWise automatically defines the data collection scheme based on the information in your file. Review the options that AWS IoT FleetWise selected for you. You can update the options, if needed. For more information about each option, see Manually define the data collection scheme.

Specify signals

You can specify the signals to collect data from when the data collection scheme is invoked.

Important

Signals used in the expression for the condition-based collection scheme must be specified in this field.

To specify the signals to collect data from
  1. Search for the fully qualified Name of the signal.

    Note

    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.

  2. (Optional) For Max sample count, enter the maximum number of data samples that the Edge Agent software collects and transfers to the cloud when the data collection scheme is invoked.

  3. (Optional) For Min sampling interval, enter the minimum duration of time between two data sample collection events, in milliseconds. If a signal changes often, you can use this parameter to collect data at a slower rate.

  4. To add another signal, choose Add more signals. You can add up to 999 signals.

  5. Choose Next.

Step 4: Review and create

Verify the configurations for the campaign, and then choose Create.

Note

After a campaign is created, you or your team must approve the campaign before AWS IoT FleetWise can deploy it to vehicles.

Step 5: Approve a campaign

After you create a campaign, you or your team must approve the campaign before AWS IoT FleetWise can deploy it to vehicles.

To approve a campaign
  1. On the Campaign summary page, choose Approve.

  2. Review and confirm that you want to approve the campaign and start the deployment to begin collecting data from vehicles connected to the campaign.

  3. Choose Approve.

If you want to pause collecting data from vehicles connected to the campaign, on the Campaign summary page, choose Suspend. To resume collecting data from vehicles connected to the campaign, choose Resume.