Merge pull request #20 from cuplsensor/dev

Dev

Author: malcolmmackay

setup.py

@@ -6,7 +6,7 @@
 
 setuptools.setup(
     name="cuplcodec",
-    version="2.0.3",
+    version="2.0.4",
     author="Malcolm Mackay",
     author_email="malcolm@plotsensor.com",
     description="Package for creating and decoding URLs that contain temperature and humidity samples.",

wscodec/encoder/pyencoder/encoderfactory.py

@@ -0,0 +1,62 @@
+from datetime import datetime
+from .instrumented import InstrumentedSampleT, InstrumentedSampleTRH, InstrumentedSample
+
+
+def encode(format,
+           serial,
+           secretkey,
+           baseurl,
+           smplintervalmins,
+           resetsalltime,
+           batteryadc,
+           resetcause,
+           usehmac,
+           httpsdisable,
+           tagerror) -> InstrumentedSample:
+    """
+    Python-wrapped encoder factory.
+
+    Returns
+    --------
+    InstrumentedSample
+        An object containing a list of timestamped environmental sensor samples.
+
+    """
+
+    encoder = _get_encoder(format)(serial=serial,
+                                   secretkey=secretkey,
+                                   baseurl=baseurl,
+                                   smplintervalmins=smplintervalmins,
+                                   resetsalltime=resetsalltime,
+                                   batteryadc=batteryadc,
+                                   resetcause=resetcause,
+                                   usehmac=usehmac,
+                                   httpsdisable=httpsdisable,
+                                   tagerror=tagerror,
+                                   format=format)
+    return encoder
+
+
+def _get_encoder(format: int):
+    """
+        Parameters
+        -----------
+        formatcode:
+            Value of the codec format field. Specifies which decoder shall be returned.
+
+        Return
+        -------
+        Decoder class for the given format code.
+
+        """
+    encoders = {
+        InstrumentedSampleTRH.FORMAT_HDC2021_TRH: InstrumentedSampleTRH,
+        InstrumentedSampleT.FORMAT_HDC2021_TEMPONLY: InstrumentedSampleT
+    }
+    try:
+        encoder = encoders[format]
+    except KeyError:
+        # We need to test sending an unsupported format code.
+        encoder = encoders[InstrumentedSampleTRH.FORMAT_HDC2021_TRH]
+
+    return encoder

wscodec/encoder/pyencoder/instrumented.py

@@ -145,6 +145,8 @@ def rhsample(self, countermax, counterstep):
 
 
 class InstrumentedSampleT(InstrumentedSample):
+    FORMAT_HDC2021_TEMPONLY = 2
+
     def __init__(self,
                  serial='ABCDEFGH',
                  secretkey='AAAACCCC11112222',
@@ -155,14 +157,15 @@ def __init__(self,
                  resetcause=0,
                  usehmac=True,
                  httpsdisable=False,
-                 tagerror=False
+                 tagerror=False,
+                 format=FORMAT_HDC2021_TEMPONLY
                  ):
         super(InstrumentedSampleT, self).__init__(baseurl,
                                                   serial,
                                                   secretkey,
                                                   smplintervalmins,
                                                   batteryadc=batteryadc,
-                                                  format=2,
+                                                  format=format,
                                                   resetsalltime=resetsalltime,
                                                   usehmac=usehmac,
                                                   httpsdisable=httpsdisable)
@@ -179,6 +182,8 @@ def pushsamples(self, num):
 
 
 class InstrumentedSampleTRH(InstrumentedSample):
+    FORMAT_HDC2021_TRH = 1
+
     def __init__(self,
                  serial='ABCDEFGH',
                  secretkey='AAAACCCC11112222',
@@ -189,14 +194,15 @@ def __init__(self,
                  resetcause=0,
                  usehmac=True,
                  httpsdisable=False,
-                 tagerror=False
+                 tagerror=False,
+                 format=FORMAT_HDC2021_TRH
                  ):
         super(InstrumentedSampleTRH, self).__init__(baseurl,
                                                     serial,
                                                     secretkey,
                                                     smplintervalmins,
                                                     batteryadc=batteryadc,
-                                                    format=1,
+                                                    format=format,
                                                     resetsalltime=resetsalltime,
                                                     usehmac=usehmac,
                                                     httpsdisable=httpsdisable)