/README.txt

 1
 2===============================
 3 SunnyWebBox - RPC with Python
 4===============================
 5
 6Introduction
 7------------
 8
 9**This software is not much tested and should be used with care!**
10
11The `Sunny WebBox`_ (made by SMA Solar Technology) is a monitoring system for 
12solar plants which offers RPC (remote procedure calls) to access the data of 
13the box. These calls are made of JSON objects which are transported by HTTP
14or a UDP stream.
15
16This python module provides a classes that can be used to communicate with a 
17Sunny WebBox. You can use the classes SunnyWebBoxHTTP and SunnyWebBoxUDPStream 
18in your own code. 
19
20A small sample program is used if you run the module as a script. The hostname 
21or address must be provided as a parameter.
22
23    Example: python SunnyWebBox.py 123.123.123.123
24    
25Use the --help switch to learn about options for the udp mode and password.
26
27There's not much documentation yet. You should try to read and understand the 
28code of the classes and the sample program to get an idea of the data 
29structures.
30
31The RPC API is documented here (well, kind of...):
32    
33    http://files.sma.de/dl/2585/SWebBoxRPC-BA-en-14.pdf
34
35
36HTTP or UDP?
37------------
38The HTTP version is more reliable but may be slower and has more overhead. 
39UDP will not work behind routers, firewalls and NAT devices unless you 
40configure port forwarding. The UDP packets may get big for some requests which 
41may cause problems.
42
43    
44License and Author
45------------------
46
47License: `BSD License`_
48
49Author:  Joerg Raedler joerg@j-raedler.de
50
51
52.. _`Sunny WebBox`: http://www.sma.de/en/products/monitoring-systems/sunny-webbox.html
53.. _`BSD License`: http://www.opensource.org/licenses/bsd-license.php