Greengrass v2 IPC Connection and Sample #144
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR incorporates the recommended code pieces or
IPCUtils
from the official documentation page:https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-requirements
We can simplify and streamline the whole setup and user-facing API by moving and fully integrating this code snippet / requirement from the documentation page into the
awsiotsdk
and providing a wrapper function.The new
awsiot.greengrasscoreipc.connect()
function is "ready to use" without function arguments, but can also be supplied with arguments to customize the behaviour of the returnedGreengrassCoreIPCClient
. You can also pass in aLifecycleHandler
, which the original documentation-based code snippet did not explain or provide.The new example
ipc_greengrass.py
is a simple GGv2 component which periodically publishes small json-based telementry events to IoT Core - throught the GGv2 IPC connection layer. The necessary component recipe snippets are included in the comment block at the top of the sample.This PR includes 3 commits (feel free to cherry pick):
greengrasscoreipc
documentation RST filesFollow-up action items after this PR is merged and a new
awsiotsdk
version is released:awsiotsdk
versionIPCUtils
code from the docsBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.