Aws-iot-device-sdk-python-v2: API Documentation

Created on 31 Jan 2020  ·  8Comments  ·  Source: aws/aws-iot-device-sdk-python-v2

Hi, and thanks for the lib!

Is there an API documentation for v2 like we have for v1?
https://s3.amazonaws.com/aws-iot-device-sdk-python-docs/html/index.html

Can I generate it somehow from the code maybe?

documentation

Most helpful comment

Thanks for the feedback. We are working on documentation and will have it ready shortly.

All 8 comments

Hey,

We're still working on the documentation for the V2 SDK. If there's something in particular that you would like us to be sure is covered, just let us know!

Thanks,
Ryan

@rccarper I would like to know how to set username and password for mqtt over wss.

Hi @rccarper - it'd be great to see an example of how to use a provisioning claim with the V2 SDK to authenticate over MQTT and receive a device-cert/private-key and then re-authenticate using those. Thanks!

From the docs:
https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html
image

@rccarper We still need docs! It's understandable if this is in heavy development but it's rather unacceptable now that the old v1 SDK is no longer maintained.

I'd also really like to see API docs for v2. I'm working with some of the samples where I've got failures and trying to trace back to what objects and methods are doing which is painful without it.

+1

+1

Thanks for the feedback. We are working on documentation and will have it ready shortly.

Was this page helpful?
0 / 5 - 0 ratings