View a markdown version of this page

Create an AWS IoT FleetWise campaign - AWS IoT FleetWise
Create a campaign (console)Create a campaign (AWS CLI)

AWS IoT FleetWise is no longer open to new customers. Existing AWS IoT FleetWise customers can continue using the service. The Guidance for Connected Mobility on AWS provides guidance on how to develop and deploy modular services for connected mobility solutions that can be used to achieve equivalent capabilities as AWS IoT FleetWise.

Create an AWS IoT FleetWise campaign

Important

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in AWS IoT FleetWise.

You can use the AWS IoT FleetWise console or API to create campaigns to collect vehicle data.

Important

For your campaign to work, you must have the following:

  • The Edge Agent software is running in your vehicle. For more information about how to develop, install, and work with the Edge Agent software, do the following:

    1. Open the AWS IoT FleetWise console.

    2. On the service home page, in the Get started with AWS IoT FleetWise section, choose Explore Edge Agent.

  • You've set up AWS IoT Core to provision your vehicle. For more information, see Provision AWS IoT FleetWise vehicles.

Topics

Create a campaign (console)

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. Open the AWS IoT FleetWise console.

  2. On the navigation pane, choose Campaigns.

  3. On the Campaigns page, choose Create campaign, and then complete the steps in the following topics.

Important

Step 1: Configure campaign

In General information, do the following:

  1. Enter a name for the campaign.

  2. (Optional) Enter a description.

Configure the campaign's data collection scheme. A 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, choose one of the following:

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

Manually specify the type of data collection scheme and define options to customize the scheme.

  1. In the Data collection scheme details section, choose 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 time 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 you specify the $variable.`myVehicle.InVehicleTemperature` > 50.0 expression, AWS IoT FleetWise collects temperature values that are greater than 50.0. For instructions about how to write expressions, see Logical expressions for AWS IoT FleetWise campaigns.

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

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

  5. (Optional) 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 10,000 ‐ 60,000 milliseconds. The Edge Agent software uses the time period to decide how often to collect data.

  8. (Optional) 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, 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.

Upload a .json file with details about 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.

Step 2: Specify storage and upload conditions

To choose if the Edge Agent software will temporarily store data locally when a vehicle isn't connected to the cloud, specify the spooling mode.

  • In Data spooling mode, choose one of the following:

    • Not stored – The Edge Agent software collects but doesn't temporarily store data locally when a vehicle is offline. The Edge Agent software transfers data to the cloud when the vehicle reconnects.

    • Stored to disk – The Edge Agent software collects and temporarily stores data locally when a vehicle is offline. Collected data is temporarily stored at a location defined by the Edge Agent config file “persistency” section. The Edge Agent transfers data to the cloud when the vehicle reconnects.

    • Stored to disk with partitions – The vehicle always temporarily stores data on the Edge in your specified data partition. You can choose when you want to forward your stored data to the cloud.

      1. (Optional) Enter a partition ID to designate a particular set of data.

      2. Enter a folder name as the location where data will be stored. The absolute path of the storage location is {persistency_path} / {vehicle_name} / {campaign_name} / {storage_location}.

      3. Enter the maximum storage size of the data stored in the partition. Newer data overwrites older data when the partition reaches the maximum size.

      4. Enter the minimum amount of time that data in this partition will be kept on the disk.

      5. (Optional) Enter upload conditions for the partition.

Specify signals

You can specify the signals to collect data from during the campaign.

To specify the signals to collect data from

  1. Select the Signal name.

  2. (Optional) For Max sample count, enter the maximum number of data samples that the Edge Agent software collects and transfers to the cloud during the campaign.

  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.