Skip to main content

L2 CDK construct to provision AWS IoT Fleetwise

Project description

NPM version PyPI version release

cdk-aws-iotfleetwise

L2 CDK construct to provision AWS IoT Fleetwise

Install

Typescript

npm install cdk-aws-iotfleetwise

API Reference

Python

pip install cdk-aws-iotfleetwise

API Reference

Sample

import { SignalCatalog,
         VehicleModel,
         Vehicle,
         Campaign,
         CanVehicleInterface,
         CanVehicleSignal,
         SignalCatalogBranch,
         TimeBasedCollectionScheme
         } from 'cdk-aws-iotfleetwise';

const signalCatalog = new SignalCatalog(stack, 'SignalCatalog', {
  database,
  table,
  role,
  nodes: [
    new SignalCatalogBranch('Vehicle'),
    new SignalCatalogSensor('Vehicle.EngineTorque', 'DOUBLE'),
  ],
});

const model_a = new VehicleModel(stack, 'ModelA', {
  signalCatalog,
  name: 'modelA',
  description: 'Model A vehicle',
  networkInterfaces: [new CanVehicleInterface('1', 'vcan0')],
  signals: [
    new CanVehicleSignal('Vehicle.EngineTorque', '1',
      401, // messageId
      1.0, // factor
      true, // isBigEndian
      false, // isSigned
      8, // lenght
      0.0, // offset
      9), // startBit
  ],
});

const vin100 = new Vehicle(stack, 'vin100', {
  vehicleName: 'vin100',
  vehicleModel: model_a,
  createIotThing: true
});

new Campaign(stack, 'Campaign', {
  name: 'TimeBasedCampaign',
  target: vin100,
  collectionScheme: new TimeBasedCollectionScheme(cdk.Duration.seconds(10)),
  signals: [
    new CampaignSignal('Vehicle.EngineTorque'),
  ],
});

Getting started

To deploy a simple end-to-end example you can use the following commands

yarn install
projen && projen compile
npx cdk -a lib/integ.full.js deploy -c key_name=mykey

Where mykey is an existing keypair name present in your account. The deploy takes about 15 mins mostly due to compilation of the IoT FleetWise agent in the EC2 instance that simulate the vehicle. Once deploy is finshed, data will start to show up in your Timestream table.

TODO

Warning: this construct should be considered at alpha stage and is not feature complete.

  • Implement updates for all the custom resources
  • Conditional campaigns

Security

See CONTRIBUTING for more information.

License

This code is licensed under the MIT-0 License. See the LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk-aws-iotfleetwise-0.2.13.tar.gz (10.6 MB view details)

Uploaded Source

Built Distribution

cdk_aws_iotfleetwise-0.2.13-py3-none-any.whl (10.6 MB view details)

Uploaded Python 3

File details

Details for the file cdk-aws-iotfleetwise-0.2.13.tar.gz.

File metadata

  • Download URL: cdk-aws-iotfleetwise-0.2.13.tar.gz
  • Upload date:
  • Size: 10.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for cdk-aws-iotfleetwise-0.2.13.tar.gz
Algorithm Hash digest
SHA256 265493aef1e2c447e3a3642214fb7774360302a801eee28d6474d4aabe609b99
MD5 44728de6ca16c38b0a1f90d72103d3b0
BLAKE2b-256 57847389b267a4a76a3c793745e79796ad4f23ceaad6415f192d0baf69c36095

See more details on using hashes here.

File details

Details for the file cdk_aws_iotfleetwise-0.2.13-py3-none-any.whl.

File metadata

File hashes

Hashes for cdk_aws_iotfleetwise-0.2.13-py3-none-any.whl
Algorithm Hash digest
SHA256 2cc24f60c21c784337acc11cb11fdfa7945ef66639c33e495697d9f784b93764
MD5 ab9fbd4c46ab6a00828abffab9f889f3
BLAKE2b-256 2f40e336c204a7ed522a5d292c3cce4548a28160410f272ae408576ae97829bc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page