Readme toegevoegd

This commit is contained in:
Marcel Nijenhof
2019-02-14 23:05:34 +01:00
parent 951f2cdf9a
commit 6b037f1905

31
README.md Normal file
View File

@@ -0,0 +1,31 @@
# 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.