Merge branch 'staging'

Author: sjpark608

.bumpversion.cfg

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

README.md

@@ -19,26 +19,26 @@ $ python3 -m pip install edgepi-python-sdk
 ## Example Code
 The EdgePi SDK provides a wide range of functionality to users, allowing interaction with the many modules onboard the EdgePi. One such module, the ADC, can be used to read voltage continuously from any of the eight EdgePi analog input pins:
 
-```
-from edgepi.adc.edgepi_adc import EdgePiADC
-from edgepi.adc.adc_constants import ADCChannel, ConvMode, ADCNum
+```python
+from edgepi.dac.edgepi_adc import EdgePiADC
+from edgepi.adc.adc_constants import ADCChannel, ConvMode
 
 # initialize ADC
 edgepi_adc = EdgePiADC()
 
-# configure ADC to sample analog input pin AIN3
+# configure ADC to sample input pin 4 (the input pins are 0-indexed)
 edgepi_adc.set_config(adc_1_analog_in=ADCChannel.AIN3, conversion_mode=ConvMode.CONTINUOUS)
 
-# send command to start continuous conversions
-edgepi_adc.start_conversions(ADCNum.ADC_1)
+# send command to start automatic conversions
+edgepi_adc.start_conversions()
 
 # perform 10 voltage reads
 for _ in range(10):
-  out = edgepi_adc.read_voltage(ADCNum.ADC_1)
+  out = edgepi_adc.read_voltage()
   print(out)
 
-# stop continuous conversions
-edgepi_adc.stop_conversions(ADCNum.ADC_1)
+# stop automatic conversions
+edgepi_adc.stop_conversions()
 ```
 For further details on this and other modules, please refer to each module's documentation by following the links provided in the `Implemented Modules` section below.
 # Implemented Modules

pytest.ini

@@ -1,6 +1,6 @@
 [pytest]
 ; faulthandler_timeout=5
-; log_cli=TRUE
+log_cli=False
 log_level=INFO
 log_format=%(asctime)s %(levelname)s [%(filename)s:%(lineno)d] %(message)s
 # **********************

requirements_test.txt

@@ -12,4 +12,4 @@ tomli==2.0.1
 bitstring==3.1.9
 pytest-mock==3.7.0
 pytest-cov==3.0.0
-protobuf==3.20.3
+protobuf==4.21.12

setup.py

@@ -7,7 +7,7 @@
 
 setuptools.setup(
     name="edgepi-python-sdk",
-    version="1.1.17",
+    version="1.2.1",
     author="S.Park",
     author_email="spark@osensa.com",
     description="EdgePi Python SDK package",
@@ -25,5 +25,5 @@
     packages=setuptools.find_packages(where="src", exclude=["test_edgepi"]),
     package_dir={"": "src"},
     python_requires=">=3.6",
-    install_requires=["python-periphery >= 2.3.0", "bitstring >= 3.1.9", "protobuf==3.20.*"],
+    install_requires=["python-periphery >= 2.3.0", "bitstring >= 3.1.9", "protobuf>=3.20"],
 )

src/edgepi/adc/README.md

@@ -6,15 +6,15 @@ Note, the EdgePi ADC can be used with two different sampling modes: pulse conver
 
 ### Reading Voltage from Analog Input Pin: Pulse Conversion Mode
 In pulse conversion mode, a sampling event must be manually triggered. This can be achieved as follows.
-```
-from edgepi.dac.edgepi_adc import EdgePiADC
-from edgepi.adc.adc_constants import ADCChannel, ConvMode
+```python
+from edgepi.adc.edgepi_adc import EdgePiADC
+from edgepi.adc.adc_constants import AnalogIn, ConvMode, ADC1DataRate
 
 # initialize ADC
 edgepi_adc = EdgePiADC()
 
-# configure ADC to sample input pin 4 (the input pins are 0-indexed)
-edgepi_adc.set_config(adc_1_analog_in=ADCChannel.AIN3, conversion_mode=ConvMode.PULSE)
+# configure ADC to sample A-IN 1 (Refer to the EdgePi label for details)
+edgepi_adc.set_config(adc_1_analog_in=AnalogIn.AIN1, conversion_mode=ConvMode.PULSE, adc_1_data_rate=ADC1DataRate.SPS_38400)
 
 # trigger sampling event
 out = edgepi_adc.single_sample()
@@ -25,28 +25,102 @@ print(out)
 In continuous conversion mode, sampling events occur automatically. However, after configuring the ADC
 to perform continuous conversion, the user must send a command to start the conversions, and
 sampling data must also be manually by the user.
+```python
+from edgepi.adc.edgepi_adc import EdgePiADC
+from edgepi.adc.adc_constants import AnalogIn, ConvMode, ADCNum, ADC1DataRate
+
+# initialize ADC
+edgepi_adc = EdgePiADC()
+
+# configure ADC to sample A-IN 1 (Refer to the EdgePi label for details)
+edgepi_adc.set_config(adc_1_analog_in=AnalogIn.AIN1, conversion_mode=ConvMode.CONTINUOUS, adc_1_data_rate=ADC1DataRate.SPS_38400)
+
+# send command to start automatic conversions
+edgepi_adc.start_conversions(ADCNum.ADC_1)
+
+# perform 10 voltage reads
+for _ in range(10):
+  out = edgepi_adc.read_voltage(ADCNum.ADC_1)
+  print(out)
+  
+# stop automatic conversions
+edgepi_adc.stop_conversions(ADCNum.ADC_1)
 ```
-from edgepi.dac.edgepi_adc import EdgePiADC
-from edgepi.adc.adc_constants import ADCChannel, ConvMode
+### Reading Voltage from Analog Input Pin: Continuous Conversion Mode and Differential
+```python
+from edgepi.adc.edgepi_adc import EdgePiADC
+from edgepi.adc.adc_constants import AnalogIn, ConvMode, ADCNum, ADC1DataRate, DiffMode
 
 # initialize ADC
 edgepi_adc = EdgePiADC()
 
-# configure ADC to sample input pin 4 (the input pins are 0-indexed)
-edgepi_adc.set_config(adc_1_analog_in=ADCChannel.AIN3, conversion_mode=ConvMode.CONTINUOUS)
+# configure ADC to sample A-IN 1 (Refer to the EdgePi label for details)
+edgepi_adc.set_config(adc_1_analog_in=AnalogIn.AIN1, conversion_mode=ConvMode.CONTINUOUS, adc_1_data_rate=ADC1DataRate.SPS_38400)
+# Configure inputs to differential between A/DIN5 and A/DIN6
+edgepi_adc.select_differential(ADCNum.ADC_1,DiffMode.DIFF_3)
 
 # send command to start automatic conversions
-edgepi_adc.start_conversions()
+edgepi_adc.start_conversions(ADCNum.ADC_1)
 
 # perform 10 voltage reads
 for _ in range(10):
-  out = edgepi_adc.read_voltage()
+  out = edgepi_adc.read_voltage(ADCNum.ADC_1)
   print(out)
 
 # stop automatic conversions
-edgepi_adc.stop_conversions()
+edgepi_adc.stop_conversions(ADCNum.ADC_1)
 ```
 ___
+
+### Reading RTD Measurements: Pulse Conversion Mode
+Input 4-8 can be configured to read three-leaded RTD sensor.
+```python
+from edgepi.adc.edgepi_adc import EdgePiADC
+from edgepi.adc.adc_constants import AnalogIn, ConvMode, ADCNum
+
+# initialize ADC
+edgepi_adc = EdgePiADC()
+
+edgepi_adc.set_config(conversion_mode=ConvMode.PULSE)
+# Both ADC_1 and ADC_2 are available but only one of them is used at a time. It uses ADC_2 by default
+edgepi_adc.set_rtd(True, ADCNum.ADC_2)
+
+# trigger sampling event
+edgepi_adc.single_sample_rtd()
+
+# Disable RTD
+edgepi_adc.set_rtd(False, ADCNum.ADC_2)
+
+```
+### Reading RTD Measurements: Continuous Conversion Mode
+Input 4-8 can be configured to read three-leaded RTD sensor.
+```python
+from edgepi.adc.edgepi_adc import EdgePiADC
+from edgepi.adc.adc_constants import AnalogIn, ConvMode, ADCNum
+
+# initialize ADC
+edgepi_adc = EdgePiADC()
+
+edgepi_adc.set_config(conversion_mode=ConvMode.CONTINUOUS)
+# Both ADC_1 and ADC_2 are available but only one of them is used at a time
+edgepi_adc.set_rtd(True, ADCNum.ADC_2)
+
+# send command to start automatic conversions
+edgepi_adc.start_conversions(ADCNum.ADC_2)
+
+# perform 10 voltage reads
+for _ in range(10):
+  out = edgepi_adc.read_rtd_temperature()
+  print(out)
+  
+# stop automatic conversions
+edgepi_adc.stop_conversions(ADCNum.ADC_2)
+# Disable RTD
+edgepi_adc.set_rtd(False, ADCNum.ADC_2)
+
+```
+___
+
 ## Using ADC Module
 This section introduces ADC functionality available to users.
 

src/edgepi/adc/adc_commands.py

@@ -20,7 +20,6 @@ def read_register_command(self, address: int, num: int):
         """Trigger ADC register read"""
         self.check_for_int([address, num])
         command = [ADCComs.COM_RREG.value + address, num - 1]
-        _logger.debug("RREG command to send is %s", (command + [255] * num))
         return command + [255] * num
 
     def write_register_command(self, address, values):
@@ -29,7 +28,6 @@ def write_register_command(self, address, values):
         all(self.check_range(value, 0, 255) for value in values)
         self.check_for_int(values)
         command = [ADCComs.COM_WREG.value + address, len(values) - 1]
-        _logger.debug("WREG Command to send is %s", (command + values))
         return command + values
 
     def start_adc(self, adc_num: ADCNum):

src/edgepi/adc/adc_constants.py

@@ -65,6 +65,20 @@ class ADCReg(Enum):
     REG_ADC2FSC0 = 0x19
     REG_ADC2FSC1 = 0x1A
 
+@unique
+class AnalogIn(Enum):
+    """EdgePi Analog Input Number"""
+
+    AIN1 = 0
+    AIN2 = 1
+    AIN3 = 2
+    AIN4 = 3
+    AIN5 = 4
+    AIN6 = 5
+    AIN7 = 6
+    AIN8 = 7
+    AINCOM = 10
+    FLOAT = 0xF
 
 @unique
 class ADCChannel(Enum):
@@ -313,30 +327,59 @@ class REFMUX(Enum):
     NEG_REF_EXT_AIN5 = OpCode(0x3, ADCReg.REG_REFMUX.value, ADCMasks.RMUXN_BITS.value)
     NEG_REF_INT_VAVSS = OpCode(0x4, ADCReg.REG_REFMUX.value, ADCMasks.RMUXN_BITS.value)
 
+class ADC2REFMUX(Enum):
+    """Settings for ADC2 REFMUX register (ADC2 Configuration register 5:3 bits)"""
+    INTERNAL_2P5 = OpCode(0x00, ADCReg.REG_ADC2CFG.value, ADCMasks.RMUXP_BITS.value)
+    AIN0_AIN1 = OpCode(0x08, ADCReg.REG_ADC2CFG.value, ADCMasks.RMUXP_BITS.value)
+    AIN2_AIN3 = OpCode(0x10, ADCReg.REG_ADC2CFG.value, ADCMasks.RMUXP_BITS.value)
+    AIN4_AIN5 = OpCode(0x18, ADCReg.REG_ADC2CFG.value, ADCMasks.RMUXP_BITS.value )
+    INT_VAVDD_VAVSS = OpCode(0x20, ADCReg.REG_ADC2CFG.value, ADCMasks.RMUXP_BITS.value )
 
 class RTDModes(Enum):
     "ADC.__config args for for turning RTD mode on/off"
     RTD_ON = {
-        "adc_1_analog_in": ADCChannel.AIN5,
-        "adc_1_mux_n": ADCChannel.AIN6,
         "idac_1_mux": IDACMUX.IDAC1_AIN8,
         "idac_2_mux": IDACMUX.IDAC2_AIN9,
         "idac_1_mag": IDACMAG.IDAC1_500,
         "idac_2_mag": IDACMAG.IDAC2_500,
-        "pos_ref_inp": REFMUX.POS_REF_EXT_AIN4,
-        "neg_ref_inp": REFMUX.NEG_REF_INT_VAVSS,
     }
     RTD_OFF = {
-        "adc_1_analog_in": ADCChannel.FLOAT,
-        "adc_1_mux_n": ADCChannel.AINCOM,
         "idac_1_mux": IDACMUX.IDAC1_NO_CONNECT,
         "idac_2_mux": IDACMUX.IDAC2_NO_CONNECT,
         "idac_1_mag": IDACMAG.IDAC1_OFF,
         "idac_2_mag": IDACMAG.IDAC2_OFF,
         "pos_ref_inp": REFMUX.POS_REF_INT_2P5,
         "neg_ref_inp": REFMUX.NEG_REF_INT_2P5,
+        "adc2_ref_inp": ADC2REFMUX.INTERNAL_2P5,
     }
 
+class ADC1RtdConfig(Enum):
+    "ADC1.__config args for for turning RTD mode on/off"
+    ON = {
+        "adc_1_ch": ADCChannel.AIN7,
+        "adc_1_mux_n": ADCChannel.AIN6,
+        "pos_ref_inp": REFMUX.POS_REF_EXT_AIN4,
+        "neg_ref_inp": REFMUX.NEG_REF_EXT_AIN5,
+    }
+    OFF = {
+        "adc_1_ch": ADCChannel.FLOAT,
+        "adc_1_mux_n": ADCChannel.AINCOM,
+        "pos_ref_inp": REFMUX.POS_REF_INT_2P5,
+        "neg_ref_inp": REFMUX.NEG_REF_INT_2P5,
+    }
+
+class ADC2RtdConfig(Enum):
+    "ADC2.__config args for for turning RTD mode on/off"
+    ON = {
+        "adc_2_ch": ADCChannel.AIN7,
+        "adc_2_mux_n": ADCChannel.AIN6,
+        "adc2_ref_inp": ADC2REFMUX.AIN4_AIN5,
+    }
+    OFF = {
+        "adc_2_ch": ADCChannel.FLOAT,
+        "adc_2_mux_n": ADCChannel.AINCOM,
+        "adc2_ref_inp": ADC2REFMUX.INTERNAL_2P5,
+    }
 
 class AllowedChannels(Enum):
     """Available channels for reading depend on whether RTD is enabled or not"""
@@ -346,7 +389,6 @@ class AllowedChannels(Enum):
         ADCChannel.AIN1,
         ADCChannel.AIN2,
         ADCChannel.AIN3,
-        ADCChannel.AIN7,
         ADCChannel.AINCOM,
         ADCChannel.FLOAT,
     ]

src/edgepi/adc/adc_conv_time.py

@@ -183,14 +183,21 @@
 }
 
 
-# continuous conversion delay times for ADC2 (ADC2 only uses continuous mode)
-ADC2_DELAYS = {
+# initial conversion delay times for ADC2 (ADC2 only uses initial mode)
+ADC2_INITIAL_DELAYS = {
     DR2.SPS_10.value.op_code: 121,
     DR2.SPS_100.value.op_code: 31.2,
     DR2.SPS_400.value.op_code: 8.71,
     DR2.SPS_800.value.op_code: 4.97,
 }
 
+ADC2_CONT_DELAYS = {
+    DR2.SPS_10.value.op_code: 100,
+    DR2.SPS_100.value.op_code: 10,
+    DR2.SPS_400.value.op_code: 2.5,
+    DR2.SPS_800.value.op_code: 1.25,
+}
+
 
 def expected_initial_time_delay(adc_num: ADCNum, data_rate: int, filter_mode: int):
     """
@@ -213,7 +220,8 @@ def expected_initial_time_delay(adc_num: ADCNum, data_rate: int, filter_mode: in
 
     # no initial figures given in documentation, but estimate initial delay
     # is 3 times longer than subsequent conversion delays
-    return ADC2_DELAYS[data_rate] * 3
+    return ADC2_INITIAL_DELAYS[data_rate]
+
 
 
 def expected_continuous_time_delay(adc_num: ADCNum, data_rate: int):
@@ -232,4 +240,4 @@ def expected_continuous_time_delay(adc_num: ADCNum, data_rate: int):
     if adc_num == ADCNum.ADC_1:
         return ADC1_CONT_DELAYS[data_rate]
 
-    return ADC2_DELAYS[data_rate]
+    return ADC2_CONT_DELAYS[data_rate]