question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Document going from nothing to a working sample in the readme

See original GitHub issue

Is your feature request related to a problem? Please describe. For each sample, add a readme that gives explicit step-by-step instructions to go from nothing to a working sample Describe the solution you’d like Example of solution, a bit simplified:


Fleet provisioning:

Prerequisite

You need to set up a fleet provision template in the aws console or via terminal https://docs.aws.amazon.com/freertos/latest/lib-ref/c-sdk/provisioning/provisioning_tests.html#provisioning_system_tests_setup

Quickstart

The certificate request is transferred over mqtt(?).

  1. install the SDK

npm install aws-iot-device-sdk-js-v2

  1. main flow:
//iotidentity is used for certificate creation and registering things(?)
import iotidentity from 'aws-iot-device-sdk-js-v2'
//creates the sertificate
iotidentity.publishCreateKeysAndCertificate(input a, input b)
//creates the thing
iotidentity.publishRegisterThing(input a, input b, input c)

input b: QoS describes levels of QoS in the MQTT message.

  • Level 0, completes as soon as the packet is sent.
  • Level 1, completes when PUBACK is received.
  • Level 2 is not supported by AWS IoT.

Sample

  • Sample

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:5 (1 by maintainers)

github_iconTop GitHub Comments

4reactions
runemadsencommented, Sep 9, 2020

I just want to 👍 this one. The old aws-iot-device-sdk-js package describes exactly how to use it with nice code examples for everything. I have been using aws-iot-device-sdk-js for years, and after looking at the documentation for v2 for an hour, I have honestly no clue on how to use it.

2reactions
runemadsencommented, Sep 11, 2020

Thanks! I think what people are looking for is a written walk-through with code examples that explains the node API. These samples, despite being much better than nothing, are pretty complex and written in Typescript. Take a look at the README for v1. That’s the kind of documentation that makes it easy to get started.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Write a Good README File for Your GitHub Project
Go the extra mile and write tests for your application. Then provide code examples and how to run them. This will help show...
Read more >
README.md template | Documenting your project - Drupal
Information about content and formatting of project README files.
Read more >
README File – Everything you Need to Know - Great Learning
A README file is a text file that describes and launches a project. It comprises information that is frequently needed to grasp the...
Read more >
Homework: Writing a README
The name README is self-explanatory — it's a document that users should read to get more information about the contents of a project....
Read more >
How to write a good README for your GitHub project?
Today we will focus on good practices of writing such a file - with a few examples, and a ready to use template....
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found