aws_iot 0.1.0

Flutter AWS IoT #

Pub

AWS IoT plugin for flutter, intended to fit nicely with flutter_cognito_plugin and mqtt_client.

  • Basic pub/sub functionality.
  • Supports AttachPolicy, which is needed to make cognito identity auth work with aws iot.
  • Automatically handles cognito identity auth in the background.

Install #

  • Use flutter plugin installation instructions on Dart Pub.
  • Ensure platform :ios, '9.0' at ios/Podfile.
  • Add awsconfiguration.json by following instructions at flutter_cognito_plugin for Android/iOS.

Example app #

  • Clone
git clone https://github.com/IoTReady/flutter-aws-iot.git
cd example
cp assets/.env.example assets/.env
  • Edit example/assets/.env file, and fill in the proper credentials.

  • Add awsconfiguration.json to the example app, by following instructions at flutter_cognito_plugin for both Android/iOS.

  • Run

flutter run

Prior art #

0.0.1 #

  • TODO: Describe initial release.

example/README.md

aws_iot_example #

Demonstrates how to use the aws_iot plugin.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  aws_iot: ^0.1.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:aws_iot/aws_iot.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
30
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
60
Overall:
Weighted score of the above. [more]
57
Learn more about scoring.

We analyzed this package on Feb 13, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.5
  • Flutter: 1.12.13+hotfix.7

Health issues and suggestions

Document public APIs. (-1 points)

33 out of 33 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Format lib/aws_iot.dart.

Run flutter format to format lib/aws_iot.dart.

Maintenance issues and suggestions

Support latest dependencies. (-20 points)

The version constraint in pubspec.yaml does not support the latest published versions for 2 dependencies (mqtt_client, sigv4).

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
crypto ^2.1.3 2.1.4
flutter 0.0.0
flutter_cognito_plugin ^1.0.2 1.0.2
mqtt_client ^5.5.0 5.6.3 6.0.0
plugin_scaffold ^2.0.0 2.0.0
sigv4 ^1.0.0 1.0.0 3.1.2
typed_data ^1.1.6 1.1.6
Transitive dependencies
charcode 1.1.3
collection 1.14.11 1.14.12
convert 2.1.1
event_bus 1.1.1
logging 0.11.4
meta 1.1.8
path 1.6.4
sky_engine 0.0.99
vector_math 2.0.8
Dev dependencies
flutter_test