Merge pull request #36 from gregbreen/stm32-nucleo-wl55jc

GH-31 ST Nucleo-WL55JC binary decoder

Author: asvand

README.md

@@ -85,6 +85,8 @@ The sample [Decoding binary payloads from LoRaWAN devices](transform_binary_payl
   - Adeunis Dry Contacts
 - **Weather station**
   - MeteoHelix Iot Pro
+- **Development Board**
+  - ST Nucleo-WL55JC
 
 [Contributions](CONTRIBUTING.md) to example binary decoders are welcome.
 

transform_binary_payload/README.md

@@ -24,6 +24,7 @@ This repository contains resources to quickly onboard included LoRaWAN devices o
   - Adeunis Dry Contacts
   - Laird Sentrius RS1xx
   - MeteoHelix Iot Pro
+  - ST Nucleo-WL55JC
 
 - AWS Lambda functions in [Python 3](transform_binary_payload/src-iotrule-transformation) and [Node.js](transform_binary_payload/src-iotrule-transformation-node) that will be invoked by the AWS IoT Rule to perform binary decoding
 
@@ -73,6 +74,7 @@ Example binary decoders for the following devices are included in this sample:
 | Adeunis      | Dry Contacts                      | adeunis_dc_v2      | x        |         |
 | Laird        | Sentrius RS1xx                    | sentrius_rs1xx     | x        |         |
 | BaraniDesign | MeteoHelix Iot Pro                | meteo_helix        | x        |         |
+| ST           | Nucleo-WL55JC                     | st_nucleo_wl55jc   | x        |         |
 
 
 ## Approach A: using simulated decoder
@@ -321,6 +323,7 @@ Please perform the following steps to deploy a sample application:
       | Adeunis      | Dry Contacts                      | adeunis_dc_v2      | x        |         |
       | Laird        | Sentrius RS1xx                    | sentrius_rs1xx     | x        |         |
       | BaraniDesign | MeteoHelix Iot Pro                | meteo_helix        | x        |         |
+      | ST           | Nucleo-WL55JC                     | st_nucleo_wl55jc   | x        |         |
 
     Please note that `sam deploy --guided` should be only executed for a first deployment. To redeploy after that please use `sam deploy`.
 
@@ -363,6 +366,7 @@ Please perform the following steps to deploy a sample application:
     | Adeunis      | Dry Contacts                       | QMAAAQACAAMABKU=                                                  |
     | Laird        | Sentrius RS1xx                     | AQAeAUEZAgAAAAA=                                                  |
     | BaraniDesign | MeteoHelix Iot Pro                 | cScjZ0+jGvrTA/A=                                                  |
+    | ST           | Nucleo-WL55JC                      | ACcQGAH0AAAAAA==                                                  |
 
     The payload is structured in a same way as it will be ingested by AWS IoT Core for LoRaWAN. Please replace the `<Sample PayloadData>` with the value of "Sample PayloadData>" from the following table:
 
@@ -665,7 +669,7 @@ Please perform following steps to implement your own binary transformation model
     ```
  
 4. Edit `src-iotrule-transformation/app.py` and
-    1. Add `import mymanufacturer_mydevice.py` 
+    1. Add `import mymanufacturer_mydevice` 
     2. Add "mymanufacturer_mydevice" value to VALID_PAYLOAD_DECODER_NAMES
 
 5. This sample uses AWS SAM to build and deploy all necessary resources (e.g. AWS Lambda function, AWS IoT Rule, AWS IAM Roles) to your AWS account. Please perform the following commands to build the SAM artifacts:

transform_binary_payload/src-iotrule-transformation/app.py

@@ -54,6 +54,7 @@
 import meteo_helix
 import dragino_lsn50
 import dragino_llms01
+import st_nucleo_wl55jc
 
 # Allowed payload type values. This array will be used for validation of the "type" attribute for a
 # handle of a Lambda function. For each value in the list below, you should import a module with the
@@ -68,7 +69,7 @@
                                "dragino_lht65", "dragino_lgt92", "dragino_lse01", "dragino_lbt1", "dragino_lds01","dragino_laq4",
                                "dragino_lsn50", "dragino_llms01",
                                "elsys", "globalsat_lt100", "nas_um3080", "adeunis_ftd2", "adeunis_dc_v2",
-                               "sentrius_rs1xx", "meteo_helix"]
+                               "sentrius_rs1xx", "meteo_helix", "st_nucleo_wl55jc"]
 
 # Function name for logging
 FUNCTION_NAME = "ConvertBinaryPayload"

transform_binary_payload/src-payload-decoders/python/st_nucleo_wl55jc.py

@@ -0,0 +1,54 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: MIT-0
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this
+# software and associated documentation files (the "Software"), to deal in the Software
+# without restriction, including without limitation the rights to use, copy, modify,
+# merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+import base64
+import time
+import math
+
+
+def dict_from_payload(base64_input: str, fport: int = None):
+    """ Decodes a base64-encoded binary payload into JSON.
+            Parameters 
+            ----------
+            base64_input : str
+                Base64-encoded binary payload
+            fport: int
+                FPort as provided in the metadata. Please note the fport is optional and can have value "None", if not provided by the LNS or invoking function. 
+
+                If  fport is None and binary decoder can not proceed because of that, it should should raise an exception.
+
+            Returns
+            -------
+            JSON object with key/value pairs of decoded attributes
+
+        """
+
+    decoded = base64.b64decode(base64_input)
+
+    led = "Off" if decoded[0] == 0 else "On"
+    pressure = int.from_bytes(decoded[1:3], byteorder='big', signed=False) / 10
+    temperature = int.from_bytes(decoded[3:4], byteorder='big', signed=True)
+    humidity = int.from_bytes(decoded[4:6], byteorder='big', signed=False) / 10
+
+    result = {
+        "led": led,
+        "pressure": pressure,
+        "temperature": temperature,
+        "humidity": humidity
+    }
+
+    return result