Staging (#370)

* Bump version: 1.2.1 → 1.2.2

* Eeprom default (#364)

* separating key dataclass in progress

* replaced default bin image #363

* key module datalcass created #363

* modified default bin so all string type message are empty by default

* fixed key proto file

* Bump version: 1.2.2 → 1.2.3

* Bump version: 1.2.2 → 1.2.3

* Dev hardware test (#368)

* name of requirements.txt changed, digital io test fixed, eeprom user space test fixed

* osensa eeprom test fix

* adc, rtd hardware test

* delete test_adc_read.py, revised digital io test

* added hardware test workflow which requires publish

* hardware test passing

* pylint fix

* label added to route job to the hardware test unit

* Dev documentation (#369)

* Update eeprom_constants.py

* added documentation

* added special Note to the PWM readme

* suggested fix

* frequency type to float

* Bump version: 1.2.3 → 1.2.4

* Update build-and-publish-TestPyPI.yml

* Bump version: 1.2.4 → 1.2.5

---------

Co-authored-by: bot-edgepi <bot@edgepi.com>

Author: sjpark608

.bumpversion.cfg

@@ -1,3 +1,3 @@
 [bumpversion]
 tag_name = rc/v{new_version}
-current_version = 1.2.2
+current_version = 1.2.5

.github/workflows/build-and-publish-TestPyPI.yml

@@ -69,3 +69,26 @@ jobs:
         git config user.email ${{ env.commit_email }}
         git cherry-pick ${{ env.bump_commit }}
         git push origin dev
+  Hardware_Test:
+    needs: publish
+    name: Hardware Tests
+    runs-on: [self-hosted, linux, ARM64, hw-test]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: |
+          python -m venv venv_hardware_test
+          source venv_hardware_test/bin/activate
+          python -m pip install --upgrade pip
+          python -m pip install pytest
+          if [ -f requirements_hw_test.txt ]; then pip install -r requirements_hw_test.txt; fi
+      - name: Test with pytest
+        run: |
+          source venv_hardware_test/bin/activate
+          python -m pytest ./tests/hardware_tests

requirements_integration.txt renamed to requirements_hw_test.txt

@@ -7,7 +7,7 @@
 
 setuptools.setup(
     name="edgepi-python-sdk",
-    version="1.2.2",
+    version="1.2.5",
     author="S.Park",
     author_email="spark@osensa.com",
     description="EdgePi Python SDK package",

setup.py

@@ -6,18 +6,14 @@
     dac_module_pb2,
     adc_module_pb2,
     rtd_module_pb2,
-    tc_module_pb2
+    tc_module_pb2,
+    keys_pb2
 )
 from edgepi.eeprom.protobuf_assets.eeprom_data_classes.eeprom_dac_module import DACModule
 from edgepi.eeprom.protobuf_assets.eeprom_data_classes.eeprom_adc_module import ADCModule
 from edgepi.eeprom.protobuf_assets.eeprom_data_classes.eeprom_rtd_module import RTDModule
 from edgepi.eeprom.protobuf_assets.eeprom_data_classes.eeprom_tc_module import TCModule
-
-@dataclass
-class AwsKeys:
-    """Key Pair dataclass"""
-    private_key:str = None
-    certificate:str = None
+from edgepi.eeprom.protobuf_assets.eeprom_data_classes.eeprom_key_module import AwsKeys
 
 @dataclass
 class EepromDataClass:
@@ -28,8 +24,8 @@ class EepromDataClass:
     adc2_calib_params: ADCModule = None
     rtd_calib_params: RTDModule = None
     tc_calib_params: TCModule = None
-    config_key: AwsKeys = None
-    data_key: AwsKeys = None
+    config_key: AwsKeys = AwsKeys(None, None)
+    data_key: AwsKeys = AwsKeys(None, None)
     serial:str = None
     model:str = None
     cm_part_number: str = None
@@ -43,13 +39,9 @@ def populate_eeprom_module(self, eeprom_pb:edgepi_module_pb2):
         self.__populate_adc2_module(eeprom_pb.adc2_module)
         self.__populate_rtd_module(eeprom_pb.rtd_module)
         self.__populate_tc_module(eeprom_pb.tc_module)
+        self.__populate_config_key_module(eeprom_pb.config_keys)
+        self.__populate_data_key_module(eeprom_pb.data_keys)
 
-        if self.config_key is not None:
-            eeprom_pb.config_keys.certificate = self.config_key.certificate
-            eeprom_pb.config_keys.private_key = self.config_key.private_key
-        if self.data_key is not None:
-            eeprom_pb.data_keys.certificate = self.data_key.certificate
-            eeprom_pb.data_keys.private_key = self.data_key.private_key
         if self.serial is not None:
             eeprom_pb.serial_number = self.serial
         if self.model is not None:
@@ -90,6 +82,18 @@ def __populate_tc_module(self, tc_pb: tc_module_pb2):
             return
         self.tc_calib_params.populate_tc_module_pb(tc_pb)
 
+    def __populate_config_key_module(self, key_pb: keys_pb2):
+        """Serialize Config Keys"""
+        if self.config_key is None:
+            return
+        self.config_key.populate_keys_pb(key_pb)
+
+    def __populate_data_key_module(self, key_pb: keys_pb2):
+        """Serialize Data Keys"""
+        if self.data_key is None:
+            return
+        self.data_key.populate_keys_pb(key_pb)
+
     @staticmethod
     def extract_eeprom_data(eeprom_pb:edgepi_module_pb2):
         """De-serialize"""
@@ -100,14 +104,14 @@ def extract_eeprom_data(eeprom_pb:edgepi_module_pb2):
         eeprom_data.rtd_calib_params = EepromDataClass.extract_rtd_data(eeprom_pb.rtd_module)
         eeprom_data.tc_calib_params = EepromDataClass.extract_tc_data(eeprom_pb.tc_module)
 
+        if eeprom_pb.HasField("config_keys"):
+            eeprom_data.config_key = EepromDataClass.extract_config_key(eeprom_pb.config_keys)
+        if eeprom_pb.HasField("data_keys"):
+            eeprom_data.data_key = EepromDataClass.extract_data_key(eeprom_pb.data_keys)
         if eeprom_pb.HasField("serial_number"):
             eeprom_data.serial = eeprom_pb.serial_number
         if eeprom_pb.HasField("model"):
             eeprom_data.model = eeprom_pb.model
-        if eeprom_pb.HasField("config_keys"):
-            eeprom_data.config_key = eeprom_pb.config_keys
-        if eeprom_pb.HasField("data_keys"):
-            eeprom_data.data_key = eeprom_pb.data_keys
         if eeprom_pb.HasField("cm_part_number"):
             eeprom_data.cm_part_number = eeprom_pb.cm_part_number
         if eeprom_pb.HasField("tb_part_number"):
@@ -145,3 +149,13 @@ def extract_tc_data(tc_pb: tc_module_pb2):
         if tc_pb is None:
             return
         return TCModule.extract_tc_calib_params(tc_pb)
+
+    @staticmethod
+    def extract_config_key(key_pb: keys_pb2):
+        """De-serialize Config Keys"""
+        return AwsKeys.extract_keys(key_pb)
+
+    @staticmethod
+    def extract_data_key(key_pb: keys_pb2):
+        """De-serialize Data Keys"""
+        return AwsKeys.extract_keys(key_pb)

src/edgepi/eeprom/edgepi_eeprom_data.py

@@ -4,19 +4,67 @@
 
 # page write cycle time requirements https://www.onsemi.com/pdf/datasheet/cat24c256-d.pdf
 PAGE_WRITE_CYCLE_TIME=0.01
-DEFAULT_EEPROM_BIN_B64 = b"CmAKCg0AAIA/FQAAAAASCg0AAIA/FQAAAAAaCg0AAIA/FQAAAAAiCg0AAIA/FQAAAAAqCg0A\
-                       AIA/FQAAAAAyCg0AAIA/FQAAAAA6Cg0AAIA/FQAAAABCCg0AAIA/FQAAAAASkAEKCg0AAIA/FQAA\
-                       AAASCg0AAIA/FQAAAAAaCg0AAIA/FQAAAAAiCg0AAIA/FQAAAAAqCg0AAIA/FQAAAAAyCg0AAIA/\
-                       FQAAAAA6Cg0AAIA/FQAAAABCCg0AAIA/FQAAAABKCg0AAIA/FQAAAABSCg0AAIA/FQAAAABaCg0A\
-                       AIA/FQAAAABiCg0AAIA/FQAAAAAakAEKCg0AAIA/FQAAAAASCg0AAIA/FQAAAAAaCg0AAIA/FQAA\
-                       AAAiCg0AAIA/FQAAAAAqCg0AAIA/FQAAAAAyCg0AAIA/FQAAAAA6Cg0AAIA/FQAAAABCCg0AAIA/\
-                       FQAAAABKCg0AAIA/FQAAAABSCg0AAIA/FQAAAABaCg0AAIA/FQAAAABiCg0AAIA/FQAAAAAiEQoK\
-                       DQAAgD8VAAAAABUAAPpEKmAKCg0AAIA/FQAAAAASCg0AAIA/FQAAAAAaCg0AAIA/FQAAAAAiCg0A\
-                       AIA/FQAAAAAqCg0AAIA/FQAAAAAyCg0AAIA/FQAAAAA6Cg0AAIA/FQAAAABCCg0AAIA/FQAAAAAy\
-                       NAoWVGhpcyBpcyBDb25maWcgUHJpdmF0ZRIaVGhpcyBpcyBDb25maWcgQ2VydGlmaWNhdGU6MAoU\
-                       VGhpcyBpcyBEYXRhIFByaXZhdGUSGFRoaXMgaXMgRGF0YSBDZXJ0aWZpY2F0ZUIVVGhpcyBpcyBT\
-                       ZXJpYWwgTnVtYmVyShxUaGlzIGlzIGNtIGJvYXJkIHBhcnQgbnVtYmVyUhZUaGlzIGlzIHRiIHBh\
-                       cnQgbnVtYmVyWhdUaGlzIGlzIGNtNCBwYXJ0IG51bWJlcmIUVGhpcyBpcyBNb2RlbCBOdW1iZXI="
+DEFAULT_EEPROM_BIN_B64 = b'CmAKCg0AAIA/FQAAAAASCg0AAIA/FQAAAAAaCg0AAIA/FQAAAAAiCg0AAIA/FQAAAAAqCg0A\
+AIA/FQAAAAAyCg0AAIA/FQAAAAA6Cg0AAIA/FQAAAABCCg0AAIA/FQAAAAASkAEKCg0AAIA/FQAAAAASCg0AAIA/FQAAAAAaCg0\
+AAIA/FQAAAAAiCg0AAIA/FQAAAAAqCg0AAIA/FQAAAAAyCg0AAIA/FQAAAAA6Cg0AAIA/FQAAAABCCg0AAIA/FQAAAABKCg0AAI\
+A/FQAAAABSCg0AAIA/FQAAAABaCg0AAIA/FQAAAABiCg0AAIA/FQAAAAAakAEKCg0AAIA/FQAAAAASCg0AAIA/FQAAAAAaCg0AA\
+IA/FQAAAAAiCg0AAIA/FQAAAAAqCg0AAIA/FQAAAAAyCg0AAIA/FQAAAAA6Cg0AAIA/FQAAAABCCg0AAIA/FQAAAABKCg0AAIA/\
+FQAAAABSCg0AAIA/FQAAAABaCg0AAIA/FQAAAABiCg0AAIA/FQAAAAAiEQoKDQAAgD8VAAAAABUAAPpEKmAKCg0AAIA/FQAAAAA\
+SCg0AAIA/FQAAAAAaCg0AAIA/FQAAAAAiCg0AAIA/FQAAAAAqCg0AAIA/FQAAAAAyCg0AAIA/FQAAAAA6Cg0AAIA/FQAAAABCCg\
+0AAIA/FQAAAAA='
+
+"""
+Defaul EEPROM Dataclass
+dac_calib_params
+    dac_ch1
+        gain = 1
+        offset = 0
+    ~
+    dac_ch8
+        gain = 1
+        offset = 0
+adc1_calib_params
+    adc_ch_1
+        gain = 1
+        offset = 0
+    ~
+    adc_ch_8
+        gain = 1
+        offset = 0
+    diff1
+        gain = 1
+        offset = 0
+    ~
+    diff4
+adc2_calib_params
+    same as adc1_calib_params
+rtd_calib_params
+    rtd
+        gain = 1
+        offset = 0
+    rtd_resistor = 2000
+tc_calib_params
+    tc_B
+        gain = 1
+        offset = 0
+    ~
+    tc_T
+        gain = 1
+        offset = 0
+config_key
+    private_key = None
+    certificate = None
+data_key
+    private_key = None
+    certificate = None
+serial = None
+model = None
+cm_part_number = None
+tb_part_number = None
+cm4_part_number = None
+"""
+
+
 
 class EEPROMInfo(Enum):
     """

src/edgepi/eeprom/eeprom_constants.py

@@ -0,0 +1,28 @@
+"""EEPROM key module Dataclass"""
+from dataclasses import dataclass
+from edgepi.eeprom.protobuf_assets.generated_pb2 import keys_pb2
+
+
+
+@dataclass
+class AwsKeys:
+    """Key Pair dataclass"""
+    private_key:str = None
+    certificate:str = None
+
+    def populate_keys_pb(self, key_pb: keys_pb2):
+        """serialize method"""
+        if self.private_key is not None:
+            key_pb.private_key = self.private_key
+        if self.certificate is not None:
+            key_pb.certificate = self.certificate
+
+    @staticmethod
+    def extract_keys(key_pb: keys_pb2):
+        """De-serialize method"""
+        key_mod = AwsKeys()
+        if key_pb.HasField("private_key"):
+            key_mod.private_key = key_pb.private_key
+        if key_pb.HasField("certificate"):
+            key_mod.certificate = key_pb.certificate
+        return key_mod

src/edgepi/eeprom/protobuf_assets/eeprom_data_classes/eeprom_key_module.py

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
 message AwsKeys {
-    string private_key = 1;
-    string certificate = 2;
+    optional string private_key = 1;
+    optional string certificate = 2;
 }