Files
lmwsip/README.md
2020-07-26 22:26:11 +02:00

87 lines
1.7 KiB
Markdown

# lmwsip
## Introduction
lmwsip is a python library for the lmw sip protocol.
## Library
The lmwsip.py library contains the class LmwSip to connect to the
LMW meetnet using de SIP protocol. The library contains documentation
how to use it.
## Tools
### lmwsip-test
A small test program containing some functions to test the library.
### siprun
A prgram to run SIP command files.
See "siprun -H" for usage information.
#### hoek-h10.sip
A sample sip command file to request the waterlevel at hoek van holland
from the last hour
## Username password
All files contain "USER", "PASS".
These values should be replaced by real credentials.
Otherwise the connection fails.
## Examples
### Library
#### Use send (low level)
``` python
from lmwsip import LmwSip
sip = LmwSip(ssl=True, host="sip-lmw.rws.nl", port=443)
sip.send("LI user,pass\r")
print("< [%s]" % (sip.recv().strip('\r')))
sip.send("TI LMW\r")
print("< [%s]" % (sip.recv().strip('\r')))
sip.send("LO\r")
print("< [%s]" % (sip.recv().strip('\r')))
```
#### Use value
``` python
from lmwsip import LmwSip
sip = LmwSip("USER", "PASS")
print(sip.ti())
print(sip.value("WN", "HOEK", "H10"))
sip.logout()
```
#### Use timeseries
``` python
from lmwsip import LmwSip
from datetime import datetime, timedelta
from pprint import pprint
end = datetime.now()
start = end - timedelta(hours=1)
sip = LmwSip("USER", "PASS")
pprint(sip.timeSerie("WN", "HOEK", "H10", start, end).ts)
```
### siprun
```
$ ./siprun -h sip-lmw.ad.rws.nl -s -p 443 hoek-h10.sip
> [LI USER,PASS]
< [! ]
> [TI LMW]
< [! 05-SEP-19 08:24:43]
> [WN LMW,HOEK,H10,-25:00,05-09-2019,08:10,DATA]
< [? 0211 Waarnemingen vallen buiten opslag range]
> [LO]
< [! ]
```