Version update for stat command

.gitea/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
         run: tox
       - name: Upload na pypi
         env:
-          TWINE_USERNAME: ${{ secret.PYPI_USER }}
-          TWINE_PASSWORD: ${{ secret.PYPI_PASSWORD }}
+          TWINE_USERNAME: ${{ secrets.PYPI_USER }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
         if: github.ref_type == 'tag'
         run: python3 -m twine upload dist/*

githooks/pre-commit

@@ -8,4 +8,4 @@ VERSION=$(grep version setup.cfg | sed 's/.*= *//')
 sed -i "s/^__version__ = .*/__version__ = '${VERSION}'/"  src/lmwsip/__init__.py
 git add src/lmwsip/__init__.py
 
-tox
+tox -p

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = lmwsip
-version = 0.9.6
+version = 0.9.9
 author = Marcel Nijenhof
 author_email = pypi@marceln.org
 description = Interface for the lmw sip protocol

src/lmwsip/__init__.py

@@ -12,7 +12,7 @@ from datetime import datetime, timedelta
 from dateutil import tz
 
 """ Version info changed by git hook """
-__version__ = '0.9.6'
+__version__ = '0.9.9'
 
 class LmwSip:
     """Class to connect to the LMW Standard Interface prototcol (sip)
@@ -27,7 +27,12 @@ Support for:
     ti
     cmd(wn, vw, as)
 
+lmwParameters:
+ - Type: WN, VW, AS
+ - Array size: [1-201]
+ - Periode: 1, 10
 """
+
     lmwParameters = {
         'Tm02_MV': ('VW', 1, 0),
         'xH1': ('WN', 1, 1),
@@ -593,7 +598,7 @@ Opens the connection and logs in.
                  "time_of_day": time.strftime("%H:%M", time.gmtime(now)) }
 
     def connect(self):
-        """connect()
+        """Setup the network connection
 
 connects to lmw with tcp using the values of the object creation.
 """
@@ -629,7 +634,7 @@ connects to lmw with tcp using the values of the object creation.
         self._socket = None
 
     def send(self, sipcmd):
-        """send(sipcmd)
+        """Send a sip command to the server
 
 send a sip command to the server
 """
@@ -659,7 +664,7 @@ send a sip command to the server
             raise LmwSipConnectError("LmwSip.telnetheader: Socket connection lost")
 
     def recv(self):
-        """recv()
+        """Recieve the results
 
 recieve a answer from the sip server
 """
@@ -702,7 +707,7 @@ recieve a answer from the sip server
         return(stringbuf)
 
     def login(self):
-        """login()
+        """Login the sip server
 
 Login lmw using the object creation user, password.
 Raises a LmwLoginFailure exception on failure
@@ -726,7 +731,7 @@ Raises a LmwLoginFailure exception on failure
         self.login()
 
     def reconnectcheck(self):
-        """reconnectcheck()
+        """Check if we need to reconnect.
 
 Checks if a reconnect is nessecery.
 
@@ -744,7 +749,7 @@ There are two timeouts:
             self.reconnect()
 
     def sendrecv(self, cmd):
-        """sendrecv(cmd)
+        """Send a a command and recieve the result.
 
 send the command and recieve the answer. 
 retry on socket failure.
@@ -773,7 +778,7 @@ retry on socket failure.
         return(ret)
 
     def ti(self):
-        """ti()
+        """Recieve the time from the sipserver.
 
 Request the time from lmw and returns the string.
 
@@ -785,7 +790,7 @@ Raises a LmwCmdWarn of failure
 
     def cmd(self, process, location, parameter, time_delta, day,
                                                 time_of_day, cmd_type="DATA"):
-        """cmd(process, location, parameter, time_delta, day, time_of_day)
+        """Create a sip command from the paramters
 
 Send a cmd to LMW and returns the lmw string
 
@@ -817,9 +822,35 @@ Returns:
             raise LmwCmdWarn(cmdstr, d)
         return (d[2:-1])
 
+    def cmdWrite(self, process, location, parameter, time_delta, day,
+                 time_of_day, values):
+        """Write data to LMW
+
+    process:      <WNT|VWT|AST>
+    location:     <lmw location (e.g. HOEK)>
+    parameter:    <lmw parameter (e.g. H10)>
+    time_delta:   <Time windows (max 23:59, e.g. +01:00>
+    day:          <Date>
+    time_of_day:  <Time>
+    data:         Values to be writen (e.g. 33/10;35/10).
+
+Example:
+    lmw.cmdWrite("WNT", "HOEK", "H10", "+00:20", "13-08-2018", "16:00", "33/10;35/10")
+
+Returns:
+    The LMW answer string
+"""
+        cmdstr=process + " " + self.meetnet + "," + location + "," + \
+               parameter + "," + time_delta + "," + day + "," + \
+               time_of_day + "," + values + "\r" 
+        d = self.sendrecv(cmdstr)
+        if (d[0] != '!'):
+            raise LmwCmdWarn(cmdstr, d)
+        return (d[2:-1])
+
     def valueStr(self, process, location, parameter, day = None,
                     time_of_day = None):
-        """value(process, location, parameter, [day], [time_of_day]):
+        """Get string of values from sip
 
 Parameters:
     process:      <WN|VW|AS>
@@ -831,7 +862,7 @@ Parameters:
 The default returns the last value string including quality.
 
 Example:
-    lmw.data_string("WN", "HOEK", "H10")
+    lmw.valueStr("WN", "HOEK", "H10")
  
 Returns a single string value with quality
 """
@@ -846,7 +877,7 @@ Returns a single string value with quality
 
     def value(self, process, location, parameter, day = None,
                     time_of_day = None):
-        """value(process, location, parameter, [day], [time_of_day]):
+        """Get one value from sip
 
 Parameters:
     process:      <WN|VW|AS>
@@ -858,7 +889,7 @@ Parameters:
 The default returns the last value.
 
 Example:
-    lmw.data_string("WN", "HOEK", "H10")
+    lmw.value("WN", "HOEK", "H10")
  
 Returns a single string value or None
 """
@@ -873,6 +904,26 @@ Returns a single string value or None
         #
         return(value)
 
+    def stat(self, process, location, parameter):
+        """Get the last measurement or the start en end of forecasts.
+
+Parameters:
+    process:      <WN|VW|AS>
+    location:     <lmw location (e.g. HOEK)>
+    parameter:    <lmw parameter (e.g. H10)>
+The default returns the last value.
+
+Example:
+    lmw.stat("WN", "HOEK", "H10")
+ 
+Returns a single string value or None
+"""
+        stat="%s %s,%s,%s,STAT\r"  % (process, self.meetnet, location, parameter)
+        d = self.sendrecv(stat)
+        if d[0] != '!':
+            raise LmwCmdWarn(stat, d)
+        return (d[2:-1])
+
     def _lmwdelta_(self, window):
         h = 24*window.days + window.seconds // 3600
         m = (window.seconds % 3600)//60
@@ -890,7 +941,7 @@ Returns a single string value or None
 
     def timeSerie(self, process, location, parameter,
                         startTime, endTime, cmd_type="DATB"):
-        """timeSerie(process, location, parameter, startTime, endTime, cmd_type="DATA")
+        """Get a python data structure with the results.
 
 Parameters:
     process:      <WN|VW|AS>
@@ -907,7 +958,7 @@ The times should have correct timezone information. Otherwise local timezone
 is assumed. Timezones are converted to 'GMT+1' for the sip commands.
 
 Example:
-    lmw.data_string("WN", "HOEK", "H10", ...)
+    lmw.timeSerie("WN", "HOEK", "H10", ...)
  
 Returns a LmwtimeSerie object
 
@@ -959,7 +1010,7 @@ Errors:
         return(res)
 
     def logout(self):
-        """logout()
+        """Logut of the sip server,
 
 Logs of
 """
@@ -983,7 +1034,7 @@ Note:
 """
 
     def __init__(self, start, delta, values=""):
-        """lmwTimeSerie(start, delta, values)
+        """lmwTimeSerie init
 
 Create a lmwTimeSerie object with:
     start:  Start time
@@ -996,7 +1047,7 @@ Create a lmwTimeSerie object with:
             self.addvalues(start, values)
 
     def addvalues(self, start, values):
-        """addvalues(start, delta, values)
+        """Add values
 
 Add values to a timeserie
     start:  Start time

tests/main.py

@@ -77,10 +77,22 @@ class lmwsipTest(unittest.TestCase):
         with self.assertRaises(lmwsip.LmwCmdWarn):
             self.assertEqual(type(self.sip.cmd("NOP", "DUMMY", "H10", "+00:59", "2020-01-01", "00:00")), str)
 
+    def test_cmdWrite(self):
+        self.login()
+        self.assertEqual(type(self.sip.cmdWrite("WN", "DUMMY", "H10", "+00:20", "2020-01-01", "00:00", "35/10;33/10")), str)
+
     def test_value(self):
         self.login()
         self.assertEqual(type(self.sip.value("WN", "DUMMY", "H10")), str)
 
+    def test_stat_wn(self):
+        self.login()
+        self.assertEqual(type(self.sip.stat("WN", "DUMMY", "H10")), str)
+
+    def test_stat_vw(self):
+        self.login()
+        self.assertEqual(type(self.sip.stat("VW", "DUMMY", "H10V")), str)
+
     def test_value1min(self):
         self.login()
         self.assertEqual(type(self.sip.value("WN", "DUMMY", "H1")), str)

tests/stubSipServer.py

@@ -13,6 +13,12 @@ Implements the following commands:
   CMD> TI LMW
   ANS< ! 20-JAN-01 00:00:00
 
+  CMD> WN LMW,DUMMY,H10,STAT
+  ANS< ! 20-JAN-01 00:00
+
+  CMD> VW LMW,DUMMY,H10V,STAT
+  ANS< ! 20-JAN-01 00:00;20-JAN-01 01:00
+
   CMD> WN LMW,DUMMY,H10,+HH:MM,yyyy-mm-dd,HH:MM,DATA
   ANS< ! 1/10,;2/10;....
 
@@ -48,7 +54,7 @@ logoutcount=0
 
 class sipProtocol(socketserver.BaseRequestHandler):
     def match(self, m):
-        return(self.data.find(m.encode()) == 0)
+        return(self.data.find(m.encode()) != -1)
         
     def send(self, a):
         a = "%s\r" % a
@@ -86,12 +92,19 @@ class sipProtocol(socketserver.BaseRequestHandler):
         global logoutcount
         self.read()
         while self.data:
-            if self.match("LI USER,PASS"):
+            if self.match("CLOSE"):
+                self.request.close()
+            elif self.match("LI USER,PASS"):
                 self.send("!")
             elif self.match("TI LMW"):
                 self.send("! 20-JAN-01 00:00:00")
             elif self.match("WN LMW,DUMMY,H10,"):
+                if self.match("STAT"):
+                    self.send("! 20-JAN-01 00:00")
+                else:
                     self.meting(10)
+            elif self.match("VW LMW,DUMMY,H10V,STAT"):
+                self.send("! 20-JAN-01 00:00;20-JAN-01 01:00")
             elif self.match("WN LMW,DUMMY,H1,"):
                 self.meting(1)
             elif self.match("LOGOUTCOUNT"):
@@ -99,8 +112,6 @@ class sipProtocol(socketserver.BaseRequestHandler):
             elif self.match("LO"):
                 logoutcount+=1
                 self.send("!")
-            elif self.match("CLOSE"):
-                self.request.close()
             else:
                 self.send("? ERROR")
             self.read()