sascha_hemi/pycom-documentation
1
0
Fork 0
mirror of https://github.com/sascha-hemi/pycom-documentation.git synced 2026-03-21 11:06:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [master] 4 pages and 2 assets modified

Browse Source
This commit is contained in:
Daniel Spindelbauer
2018-11-05 11:46:43 +00:00
committed by gitbook-bot
parent 4c46261692
commit ca545e345d
6 changed files with 47 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
.gitbook/assets/05_aws_integration.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 132 KiB

BIN
.gitbook/assets/06_aws_integration.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 45 KiB

2
SUMMARY.md
View File

@@ -188,6 +188,8 @@
* [DevKit contract](pybytes/connect/sigfox/devkit.md)
* [Custom contract](pybytes/connect/sigfox/custom.md)
* [Visualise data from your device](pybytes/dashboard.md)
* [Integrations](pybytes/integrations/README.md)
* [Amazon IoT](pybytes/integrations/amazon-iot.md)
## Documentation Notes

8
pybytes/integrations/README.md Normal file
View File

@@ -0,0 +1,8 @@
# Integrations
## Integration with external services <a id="integration-with-external-services"></a>
Pybytes offers a way to interact with external IoT platform or custom services, like the following:
* ​[AWS IoT](/v/development_release/pybytes/integrations/amazon-iot): a managed cloud platform that lets connected devices easily and securely interact with cloud applications and other devices

36
pybytes/integrations/amazon-iot.md Normal file
View File

@@ -0,0 +1,36 @@
# Amazon IoT
Whenever one of your integrated devices sends a message to our broker, we republish the binary payload to the endpoint specified for its integration.
## Integrate your devices <a id="integrate-your-devices"></a>
1. Go in the sidebar, click on _New Integration_ and then on _Amazon Web Services_
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIL0iGdl11z7Jos_jpX%2F-LQ-UAflx-H1r4pkZhzv%2F-LQ-Uat_I9wiYDBCpz_K%2F01_aws_integration.png?alt=media&token=ed8a7737-e0e8-42fc-83a5-8fddffaa3316)
1. Fill in the form choosing an [AWS region](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) and your AWS credentials. You can optionally choose to save them inside the local storage for future use. Once you're done, click _Login_
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIL0iGdl11z7Jos_jpX%2F-LQ-UAflx-H1r4pkZhzv%2F-LQ-UkDEF_fpCDq7bw2Y%2F02_aws_integration.png?alt=media&token=7f9ab8ae-fc98-47fb-a84a-681a0b83d008)
1. In this step, you have to specify the [AWS group](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) name \(just alphanumeric letter, dashes and underscore are allowed\), the custom topic and the devices you want to bind to AWS. When you're ready, click _Create_
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIL0iGdl11z7Jos_jpX%2F-LQ-UAflx-H1r4pkZhzv%2F-LQ-Uo4CkJdFy3JPbh91%2F03_aws_integration.png?alt=media&token=a3589c47-c77c-4f91-9675-a25ba6d89208)
1. If everything's worked as expected, you should be able to see a summary of your integration like the following:
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIL0iGdl11z7Jos_jpX%2F-LQ-UAflx-H1r4pkZhzv%2F-LQ-UqcDBS4h1BTCqWiZ%2F04_aws_integration.png?alt=media&token=3847a597-83b1-4ddd-a2c9-7d3f6948c4d3)
1. The corresponding AWS Thing and AWS Group has been created as well, you just have to [log in to the console](https://console.aws.amazon.com/console/home?nc2=h_ct&src=header-signin) and choose the same region of your devices from the topbar. You'll be able to explore groups and things' details.
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIL0iGdl11z7Jos_jpX%2F-LQY9TjXsTcZzaZ7pMS0%2F-LQY9Yf2cyvfHAJYQcUM%2F05_aws_integration.png?generation=1541409488774926&alt=media)
1. The device's name is specified as an attribute of the thing.
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIL0iGdl11z7Jos_jpX%2F-LQY9TjXsTcZzaZ7pMS0%2F-LQY9Yf5HQWCqCsWEQwo%2F06_aws_integration.png?generation=1541409488706134&alt=media)
## Final considerations <a id="final-considerations"></a>
In order to save the data received by AWS, [you must set up a rule](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html). You can also test that everything's working with the [AWS IoT MQTT client](https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html). Please notice that it's not possible to download the private key from AWS once it has been generated, by the way we securely store it inside our database. We may consider to allow its download in the future, so that you could also directly send your device to AWS, by passing Pybytes.
**Warning**: do not delete AWS things or groups directly from AWS user interface, otherwise the integration with Pybytes will stop working. Always use Pybytes interface to delete AWS things or groups.

1
pybytes/introduction.md
View File

@@ -28,4 +28,5 @@ In a nutshell, Pybytes is an environment designed to optimise your IoT applicati
* [Getting started with Pybytes](getstarted.md)
* [Connect your Pycom module to Pybytes](connect/)
* [Visualise data from your device](dashboard.md)
* ​[Integrations with external services](integrations/)​