Updated Readme

miman · Jun 25, 2020 · 4eb76e9 · 4eb76e9
1 parent a10ea91
commit 4eb76e9
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 4 deletions.
diff --git a/cntrl-gpio-pin-lambda-python/README.md b/cntrl-gpio-pin-lambda-python/README.md
@@ -1,4 +1,4 @@
-# rpi-greengrass
+# cntrl-gpio-pin-lambda-python
 Lambda functions for Greengrass running on an AWS greengrass device accessing external hardware
 
 This project contains a Lambda polling the state of a button (on PIN 24) and this state will then control if a LED (on PIN 23) is on or off.

diff --git a/ggs-gpio-test-lambda-nodejs/README.md b/ggs-gpio-test-lambda-nodejs/README.md
@@ -1,4 +1,4 @@
-# rpi-greengrass
+# ggs-gpio-test-lambda-nodejs
 Lambda functions for Greengrass running on an AWS greengrass device accessing external hardware
 
 This project contains a Lambda polling the state of a button (on PIN 24) and this state will then control if a LED (on PIN 23) is on or off.

diff --git a/ggs-mqtt-listen-lambda-nodejs/README.md b/ggs-mqtt-listen-lambda-nodejs/README.md
@@ -1,4 +1,4 @@
-# rpi-greengrass
+# ggs-mqtt-listen-lambda-nodejs
 Lambda functions for Greengrass running on an AWS greengrass device accessing external hardware
 
 This project contains a Lambda echoing the data received on MQTT Topic ***mqtt/test*** to IoT Cloud Topic ***hello-world***

diff --git a/hello-world/README.md b/hello-world/README.md
@@ -5,4 +5,11 @@ They only send a hardcoded string to the IoT Core backend over MQTT (no usage of
 
 The different projects are just implemented in different languages
 
+Sub-modules
+* [example-lambda-nodejs](./example-lambda-nodejs/README.md)
+    * Code in Javascript
+* [example-lambda-python](./example-lambda-python/README.md)
+    * Code in Python
+
+
 [Back to Main page](../README.md)
diff --git a/hello-world/example-lambda-nodejs/README.md b/hello-world/example-lambda-nodejs/README.md
@@ -0,0 +1,29 @@
+# example-lambda-nodejs
+Lambda functions for Greengrass running on an AWS greengrass device accessing external hardware
+
+This project contains a Lambda posting a text msg to the Topic ***hello/world*** to **IoT Cloud** once every 5 seconds.
+
+## Prerequisites
+
+### Greengrass SDK
+Observer that you MUST copy the greengrasssdk folder from the [Javascript SDK](https://github.com/aws/aws-greengrass-core-sdk-js/) to this folder before you can create a deployment package !
+
+### Resources
+No resources needs to be created for this project
+
+### Subscriptions
+You MUST add a subscription for ***hello/world*** with this Lambda as **Source** & IoT Cloud as **Target**
+
+## Usage
+Run the **zip-ggs-module.bat** to create a zip file that can be uploaded to the Lambda function
+
+OBS.
+When the Lambda has been uploaded you MUST do the following 2 steps before you can deploy theLambda to a Greengrass device
+1. Create a version
+2. Create an Alias
+
+The alias should then be choosen when creating/updating the Lambda in the Greegrass group before deploying it.
+
+Remember that the Subscriptions MUST be updated with the new version for the Lambda to work !!
+
+[Back to Main page](../README.md)
diff --git a/hello-world/example-lambda-python/README.md b/hello-world/example-lambda-python/README.md
@@ -0,0 +1,29 @@
+# example-lambda-python
+Lambda functions for Greengrass running on an AWS greengrass device accessing external hardware
+
+This project contains a Lambda posting a text msg to the Topic ***hello/world*** to **IoT Cloud** once every 5 seconds.
+
+## Prerequisites
+
+### Greengrass SDK
+Observer that you MUST copy the greengrasssdk folder from the [Python SDK](https://github.com/aws/aws-greengrass-core-sdk-python/) to this folder before you can create a deployment package !
+
+### Resources
+No resources needs to be created for this project
+
+### Subscriptions
+You MUST add a subscription for ***hello/world*** with this Lambda as **Source** & IoT Cloud as **Target**
+
+## Usage
+Run the **zip-ggs-module.bat** to create a zip file that can be uploaded to the Lambda function
+
+OBS.
+When the Lambda has been uploaded you MUST do the following 2 steps before you can deploy theLambda to a Greengrass device
+1. Create a version
+2. Create an Alias
+
+The alias should then be choosen when creating/updating the Lambda in the Greegrass group before deploying it.
+
+Remember that the Subscriptions MUST be updated with the new version for the Lambda to work !!
+
+[Back to Main page](../README.md)
diff --git a/rfid-rc522-lambda-python/README.md b/rfid-rc522-lambda-python/README.md
@@ -1,4 +1,4 @@
-# rpi-greengrass
+# rfid-rc522-lambda-python
 Lambda functions for Greengrass running on an AWS greengrass device accessing external hardware
 
 This project contains a Lambda polling RC522 RFID reader & sending RFID tags to IoT Core over MQTT