├── .gitignore ├── Development ├── sim-config-default.cfg └── InverterSimulator.py ├── LiveStats.py ├── config-org.cfg ├── PluginLoader.py ├── outputs ├── ConsoleOutput.py ├── CSVOutput.py ├── MysqlOutput.py └── PVoutputOutput.py ├── Resources └── table.sql ├── README.md ├── InverterMsg.py ├── OmnikExport.py └── LICENSE.md /.gitignore: -------------------------------------------------------------------------------- 1 | ## General 2 | 3 | ## Linux 4 | .* 5 | !.gitignore 6 | *~ 7 | 8 | ## Python 9 | *.py[cod] 10 | 11 | 12 | ## App specific 13 | config.cfg 14 | omnik-export.log 15 | Development/sim-config.cfg 16 | -------------------------------------------------------------------------------- /Development/sim-config-default.cfg: -------------------------------------------------------------------------------- 1 | ################################## 2 | ### Settings for the simulator ### 3 | ################################## 4 | 5 | [simulator] 6 | # IP address to bind the server to 7 | ip = 127.0.0.1 8 | # Default for a Omnik with Wifi module 9 | port = 8899 10 | 11 | 12 | [mysql] 13 | # Enable for READING to a mysql database 14 | mysql_host = 127.0.0.1 15 | mysql_user = 16 | mysql_pass = 17 | mysql_db = 18 | -------------------------------------------------------------------------------- /LiveStats.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | """OmnikExport LiveStats 3 | 4 | Get data from the omniksol inverter and output to console. This is a small 5 | utility program that just changes the config to output anything to console. 6 | """ 7 | import OmnikExport 8 | 9 | 10 | if __name__ == "__main__": 11 | omnik_exporter = OmnikExport.OmnikExport('config.cfg') 12 | 13 | omnik_exporter.override_config('general', 'enabled_plugins', 14 | 'ConsoleOutput') 15 | omnik_exporter.override_config('log', 'type', 'console') 16 | omnik_exporter.override_config('log', 'level', 'debug') 17 | omnik_exporter.run() 18 | -------------------------------------------------------------------------------- /config-org.cfg: -------------------------------------------------------------------------------- 1 | ################ 2 | ### Settings ### 3 | ################ 4 | 5 | [general] 6 | # General:enabled_plugins 7 | # Choose which outputs to use 8 | # Possible options: MysqlOutput,PVoutputOutput,ConsoleOutput,CSVOutput 9 | enabled_plugins = 10 | 11 | [inverter] 12 | # IP address of your Omnik inverter 13 | ip = 192.168.1.10 14 | # Default for a Omnik with Wifi module 15 | port = 8899 16 | # S/N of the wifi kit 17 | wifi_sn = 602123456 18 | #use temperature of inverter for pvoutput 19 | use_temperature = true 20 | 21 | [mysql] 22 | # Host where the mysql server is active 23 | host = 127.0.0.1 24 | user = 25 | pass = 26 | database = 27 | 28 | [pvout] 29 | # These two can be found at http://pvoutput.org/account.jsp 30 | apikey = NOTAREALAPIKEY86e2258d4e29169fb79cf18b00 31 | sysid = 12345 32 | 33 | [csv] 34 | disable_header = false 35 | 36 | [log] 37 | # Log:Output 38 | # Possible options: none,console,file (combinations are possible) 39 | # Use none to disable logging 40 | type = console 41 | 42 | # Log:level 43 | # Possible options: critical, error, warning, info, debug 44 | level = debug 45 | 46 | # Log:filename 47 | # Output file for file logger 48 | filename = omnik-export.log 49 | -------------------------------------------------------------------------------- /PluginLoader.py: -------------------------------------------------------------------------------- 1 | # from https://gist.github.com/will-hart/5899567 2 | 3 | 4 | class PluginMount(type): 5 | """ 6 | A plugin mount point derived from: 7 | http://martyalchin.com/2008/jan/10/simple-plugin-framework/ 8 | Acts as a metaclass which creates anything inheriting from Plugin 9 | """ 10 | 11 | def __init__(cls, name, bases, attrs): 12 | """Called when a Plugin derived class is imported""" 13 | super(PluginMount, cls).__init__(name) 14 | 15 | if not hasattr(cls, 'plugins'): 16 | # Called when the metaclass is first instantiated 17 | cls.plugins = [] 18 | else: 19 | # Called when a plugin class is imported 20 | cls.register_plugin(cls) 21 | 22 | def register_plugin(cls, new_plugin): 23 | """Add the plugin to the plugin list and perform any registration 24 | logic""" 25 | 26 | # create a plugin instance and store it 27 | instance = new_plugin() 28 | 29 | # save the plugin reference 30 | cls.plugins.append(instance) 31 | 32 | 33 | class Plugin(object): 34 | """A plugin which must provide a process_message() method""" 35 | __metaclass__ = PluginMount 36 | 37 | config = None 38 | logger = None 39 | -------------------------------------------------------------------------------- /outputs/ConsoleOutput.py: -------------------------------------------------------------------------------- 1 | import PluginLoader 2 | 3 | 4 | class ConsoleOutput(PluginLoader.Plugin): 5 | """Outputs the data from the Omnik inverter to stdout""" 6 | 7 | def process_message(self, msg): 8 | """Output the information from the inverter to stdout. 9 | 10 | Args: 11 | msg (InverterMsg.InverterMsg): Message to process 12 | """ 13 | print "ID: {0}".format(msg.id) 14 | 15 | print "E Today: {0:>5} Total: {1:<5}".format(msg.e_today, msg.e_total) 16 | print "H Total: {0:>5} Temp: {1:<5}"\ 17 | .format(msg.h_total, msg.temperature) 18 | 19 | print "PV1 V: {0:>5} I: {1:>4}".format(msg.v_pv(1), msg.i_pv(1)) 20 | print "PV2 V: {0:>5} I: {1:>4}".format(msg.v_pv(2), msg.i_pv(2)) 21 | print "PV3 V: {0:>5} I: {1:>4}".format(msg.v_pv(3), msg.i_pv(3)) 22 | 23 | print "L1 P: {0:>5} V: {1:>5} I: {2:>4} F: {3:>5}"\ 24 | .format(msg.p_ac(1), msg.v_ac(1), msg.i_ac(1), msg.f_ac(1)) 25 | print "L2 P: {0:>5} V: {1:>5} I: {2:>4} F: {3:>5}"\ 26 | .format(msg.p_ac(2), msg.v_ac(2), msg.i_ac(2), msg.f_ac(2)) 27 | print "L3 P: {0:>5} V: {1:>5} I: {2:>4} F: {3:>5}"\ 28 | .format(msg.p_ac(3), msg.v_ac(3), msg.i_ac(3), msg.f_ac(3)) 29 | -------------------------------------------------------------------------------- /Resources/table.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE `minutes` ( 2 | `id` int(11) NOT NULL AUTO_INCREMENT, 3 | `InvID` varchar(16) NOT NULL, 4 | `timestamp` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00', 5 | `ETotal` decimal(7,1) NOT NULL DEFAULT '-1.0', 6 | `EToday` decimal(4,2) NOT NULL DEFAULT '-1.00', 7 | `Temp` decimal(4,1) NOT NULL DEFAULT '-1.0', 8 | `HTotal` int(8) NOT NULL DEFAULT '-1', 9 | `VPV1` decimal(4,1) NOT NULL DEFAULT '-1.0', 10 | `VPV2` decimal(4,1) NOT NULL DEFAULT '-1.0', 11 | `VPV3` decimal(4,1) NOT NULL DEFAULT '-1.0', 12 | `IPV1` decimal(3,1) NOT NULL DEFAULT '-1.0', 13 | `IPV2` decimal(3,1) NOT NULL DEFAULT '-1.0', 14 | `IPV3` decimal(3,1) NOT NULL DEFAULT '-1.0', 15 | `VAC1` decimal(4,1) NOT NULL DEFAULT '-1.0', 16 | `VAC2` decimal(4,1) NOT NULL DEFAULT '-1.0', 17 | `VAC3` decimal(4,1) NOT NULL DEFAULT '-1.0', 18 | `IAC1` decimal(3,1) NOT NULL DEFAULT '-1.0', 19 | `IAC2` decimal(3,1) NOT NULL DEFAULT '-1.0', 20 | `IAC3` decimal(3,1) NOT NULL DEFAULT '-1.0', 21 | `FAC1` decimal(4,2) NOT NULL DEFAULT '-1.00', 22 | `FAC2` decimal(4,2) NOT NULL DEFAULT '-1.00', 23 | `FAC3` decimal(4,2) NOT NULL DEFAULT '-1.00', 24 | `PAC1` int(11) NOT NULL DEFAULT '-1', 25 | `PAC2` int(11) NOT NULL DEFAULT '-1', 26 | `PAC3` int(11) NOT NULL DEFAULT '-1', 27 | `ServerStamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, 28 | PRIMARY KEY (`id`) 29 | ) 30 | -------------------------------------------------------------------------------- /outputs/CSVOutput.py: -------------------------------------------------------------------------------- 1 | import PluginLoader 2 | from datetime import datetime 3 | 4 | 5 | class CSVOutput(PluginLoader.Plugin): 6 | """Outputs the data from the Omnik inverter to stdout in csv format""" 7 | 8 | def process_message(self, msg): 9 | """Output the information from the inverter to stdout in csv format. 10 | 11 | Args: 12 | msg (InverterMsg.InverterMsg): Message to process 13 | """ 14 | if not self.config.getboolean('csv', 'disable_header'): 15 | print "DateTime,Id,Temp,VPV1,VPV2,VPV3,IPV1,IPV2,IPV3,IAC1,IAC2,IAC3," \ 16 | "VAC1,VAC2,VAC3,FAC1,PAC1,FAC2,PAC2,FAC3,PAC3," \ 17 | "ETODAY,ETOTAL,HTOTAL" 18 | 19 | timestamp = datetime.now().strftime('%Y-%m-%d %H:%M'); 20 | print ("{0},{1},{2},{3},{4},{5},{6},{7},{8},{9}," + 21 | "{10},{11},{12},{13},{14},{15},{16},{17},{18},{19}," + 22 | "{20},{21},{22},{23}")\ 23 | .format(timestamp, msg.id, msg.temperature, 24 | msg.v_pv(1), msg.v_pv(2), msg.v_pv(3), 25 | msg.i_pv(1), msg.i_pv(2), msg.i_pv(3), 26 | msg.i_ac(1), msg.i_ac(2), msg.i_ac(3), 27 | msg.v_ac(1), msg.v_ac(2), msg.v_ac(3), 28 | msg.f_ac(1), msg.p_ac(1), 29 | msg.f_ac(2), msg.p_ac(2), 30 | msg.f_ac(3), msg.p_ac(3), 31 | msg.e_today, msg.e_total, msg.h_total) 32 | -------------------------------------------------------------------------------- /outputs/MysqlOutput.py: -------------------------------------------------------------------------------- 1 | import PluginLoader 2 | import datetime 3 | 4 | 5 | class MysqlOutput(PluginLoader.Plugin): 6 | """Stores the data from the Omnik inverter into a mysql database""" 7 | 8 | def process_message(self, msg): 9 | """Store the information from the inverter in a mysql database. 10 | 11 | Args: 12 | msg (InverterMsg.InverterMsg): Message to process 13 | """ 14 | import MySQLdb 15 | 16 | self.logger.debug('Connect to database') 17 | con = MySQLdb.connect(self.config.get('mysql', 'host'), 18 | self.config.get('mysql', 'user'), 19 | self.config.get('mysql', 'pass'), 20 | self.config.get('mysql', 'database')) 21 | 22 | with con: 23 | cur = con.cursor() 24 | self.logger.debug('Executing SQL statement on database') 25 | cur.execute("""INSERT INTO minutes 26 | (InvID, timestamp, ETotal, EToday, Temp, HTotal, VPV1, VPV2, VPV3, 27 | IPV1, IPV2, IPV3, VAC1, VAC2, VAC3, IAC1, IAC2, IAC3, FAC1, FAC2, 28 | FAC3, PAC1, PAC2, PAC3) 29 | VALUES 30 | (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, 31 | %s, %s, %s, %s, %s, %s, %s);""", 32 | (msg.id, datetime.datetime.now(), msg.e_total, 33 | msg.e_today, msg.temperature, msg.h_total, 34 | msg.v_pv(1), msg.v_pv(2), msg.v_pv(3), 35 | msg.i_pv(1), msg.i_pv(2), msg.i_pv(3), 36 | msg.v_ac(1), msg.v_ac(2), msg.v_ac(3), 37 | msg.i_ac(1), msg.i_ac(2), msg.i_ac(3), 38 | msg.f_ac(1), msg.f_ac(2), msg.f_ac(3), 39 | msg.p_ac(1), msg.p_ac(2), msg.p_ac(3) 40 | )) 41 | -------------------------------------------------------------------------------- /outputs/PVoutputOutput.py: -------------------------------------------------------------------------------- 1 | import PluginLoader 2 | import datetime 3 | import urllib 4 | import urllib2 5 | 6 | 7 | class PVoutputOutput(PluginLoader.Plugin): 8 | """Sends the data from the Omnik inverter to PVoutput.org""" 9 | 10 | def process_message(self, msg): 11 | """Send the information from the inverter to PVoutput.org. 12 | 13 | Args: 14 | msg (InverterMsg.InverterMsg): Message to process 15 | 16 | """ 17 | now = datetime.datetime.now() 18 | 19 | if (now.minute % 5) == 0: # Only run at every 5 minute interval 20 | self.logger.info('Uploading to PVoutput') 21 | 22 | url = "http://pvoutput.org/service/r2/addstatus.jsp" 23 | 24 | if self.config.getboolean('inverter', 'use_temperature'): 25 | get_data = { 26 | 'key': self.config.get('pvout', 'apikey'), 27 | 'sid': self.config.get('pvout', 'sysid'), 28 | 'd': now.strftime('%Y%m%d'), 29 | 't': now.strftime('%H:%M'), 30 | 'v1': msg.e_today * 1000, 31 | 'v2': msg.p_ac(1), 32 | 'v5': msg.temperature, 33 | 'v6': msg.v_pv(1) 34 | } 35 | else: 36 | get_data = { 37 | 'key': self.config.get('pvout', 'apikey'), 38 | 'sid': self.config.get('pvout', 'sysid'), 39 | 'd': now.strftime('%Y%m%d'), 40 | 't': now.strftime('%H:%M'), 41 | 'v1': msg.e_today * 1000, 42 | 'v2': msg.p_ac(1), 43 | 'v6': msg.v_pv(1) 44 | } 45 | 46 | get_data_encoded = urllib.urlencode(get_data) 47 | 48 | request_object = urllib2.Request(url + '?' + get_data_encoded) 49 | response = urllib2.urlopen(request_object) 50 | 51 | self.logger.info(response.read()) # Show the response 52 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Omnik Data Logger 2 | ===== 3 | Omnik Data Logger is a small script for uploading data from a Omniksol Solar 4 | inverter, equipped with a wifi module, to a database and/or to PVoutput.org. 5 | 6 | This script is designed to be run as a cronjob every minute. Every time this 7 | script is run the data from the inverter will be send to the database. And with 8 | a five minute interval the data will also be uploaded to PVoutput.org as a live 9 | status. 10 | 11 | ## Supported inverters 12 | Users reported that this script works for wifi kits with a s/n starting with 13 | 602xxxxxx to 606xxxxxx. With wifi kits in the range 601xxxxxx it is not 14 | possible to get the data directly from the inverter. So sniffing the data send 15 | to the omnik portal is required, see OmnikMQTT by wouterbaake 16 | (https://github.com/wouterbaake/OmnikMQTT) . 17 | 18 | Owners of a Wifi kit starting with s/n 402xxxxxxx should checkout 19 | Omnikol-PV-Logger by t3kpunk (https://github.com/t3kpunk/Omniksol-PV-Logger). 20 | 21 | ## Installation and Setup 22 | 23 | * Install Python 24 | * Git clone the source with `git clone https://github.com/Woutrrr/Omnik-Data-Logger.git` 25 | * Copy the config-org.cfg to config.cfg 26 | * Change the settings in config.cfg 27 | * Test your settings with `python LiveStats.py`, when successful you should see 28 | data from your inverter 29 | * Run the script with `python OmnikExport.py` or better set a scheduled task or 30 | cronjob. 31 | 32 | ### Example cronjob 33 | With these options this will execute the script every minute. 34 | 35 | `* * * * * /usr/bin/python /home/username/Omnik-Data-Logger/OmnikExport.py` 36 | 37 | ### Why copy config-org.cfg, can't I edit it directly? 38 | Yes you can edit config-org.cfg directly. However if you want to update the 39 | script your settings will be overwritten with the default values. By creating 40 | config.cfg, you can preserve your settings when upgrading. 41 | 42 | ## Development 43 | To help with development when no sun is present a small simulator script can be 44 | found in the folder Development. This script works by reading values from to 45 | database used by de MysqlOutput, but with the time shifted 6 hours back. To use 46 | the simulator, you should use the MysqlOutput to fill the database and configure 47 | database settings in de sim-config.cfg file. 48 | -------------------------------------------------------------------------------- /Development/InverterSimulator.py: -------------------------------------------------------------------------------- 1 | import SocketServer 2 | import struct 3 | import ConfigParser, os 4 | import MySQLdb as mdb 5 | 6 | ''' 7 | Functions to convert the values to their binary representation 8 | ''' 9 | def packShort(data): 10 | if data == -1 or data == -10 or data == -100: # The omnik uses 65535 as -1 11 | data = 65535 12 | return struct.pack('!H', data); 13 | 14 | def packLong(data): 15 | return struct.pack('!I', data); 16 | 17 | 18 | ''' 19 | Class to send the simulated inverter messages 20 | ''' 21 | class MyTCPHandler(SocketServer.BaseRequestHandler): 22 | 23 | def handle(self): 24 | # self.request is the TCP socket connected to the client 25 | print self.client_address[0] + ' connected' 26 | self.data = '' 27 | while 1: 28 | data = self.request.recv(1024) 29 | if not data: break # if no data is received, break and close the connection 30 | 31 | self.data += data 32 | self.data = self.data[-16:] 33 | ''' 34 | If the 16 byte string starts with a specific binary string assume the rest is ok. No need 35 | to check if the serial matches. 36 | ''' 37 | if self.data[:4] == '\x68\x02\x40\x30': 38 | with con: 39 | cur = con.cursor(mdb.cursors.DictCursor) 40 | cur.execute("SELECT * FROM minutes WHERE ServerStamp > NOW() - INTERVAL 6 HOUR - INTERVAL 5 MINUTE LIMIT 0, 1") 41 | rows = cur.fetchall() 42 | row = rows[0] 43 | 44 | print 'Request at ' + row['ServerStamp'].strftime('%Y-%m-%d %H:%M:%S') 45 | 46 | # Create InverterMsg 47 | data2 = 'hUA\xb0\xa6h\xe6#\xa6h\xe6#\x81\x02\x01' + row['InvID'] + packShort(row['Temp']*10) \ 48 | + packShort(row['VPV1']*10) + packShort(row['VPV2']*10) + packShort(row['VPV3']*10) \ 49 | + packShort(row['IPV1']*10) + packShort(row['IPV2']*10) + packShort(row['IPV3']*10) \ 50 | + packShort(row['IAC1']*10) + packShort(row['IAC2']*10) + packShort(row['IAC3']*10) \ 51 | + packShort(row['VAC1']*10) + packShort(row['VAC2']*10) + packShort(row['VAC3']*10) \ 52 | + packShort(row['FAC1']*100) + packShort(row['PAC1']) \ 53 | + packShort(row['FAC2']*100) + packShort(row['PAC2']) \ 54 | + packShort(row['FAC3']*100) + packShort(row['PAC3']) \ 55 | + packShort(row['EToday']*100) \ 56 | + packLong(row['ETotal']*10) \ 57 | + packLong(row['HTotal']) \ 58 | + '\x00\x01\x00\x00\x00\x00\xff\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00&\x16h\x11A\xf0\xa6h\xe6#\xa6h\xe6#DATA SEND IS OK\r\na\x16\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff' 59 | self.request.sendall(data2) # Send the message 60 | 61 | print self.client_address[0] + ' disconnected' 62 | self.request.close() 63 | 64 | 65 | if __name__ == "__main__": 66 | # Load the setting 67 | mydir = os.path.dirname(os.path.abspath(__file__)) 68 | 69 | config = ConfigParser.RawConfigParser() 70 | config.read([mydir + '/sim-config-default.cfg', mydir + '/sim-config.cfg']) 71 | 72 | con = mdb.connect(config.get('mysql','mysql_host'), config.get('mysql','mysql_user'), 73 | config.get('mysql','mysql_pass'), config.get('mysql','mysql_db')) 74 | 75 | HOST, PORT = config.get('simulator','ip'), config.getint('simulator','port') 76 | # Create the server, binding to localhost on port 9999 77 | server = SocketServer.TCPServer((HOST, PORT), MyTCPHandler) 78 | 79 | # Activate the server; this will keep running until you 80 | # interrupt the program with Ctrl-C 81 | server.serve_forever() 82 | 83 | -------------------------------------------------------------------------------- /InverterMsg.py: -------------------------------------------------------------------------------- 1 | import struct # Converting bytes to numbers 2 | 3 | 4 | class InverterMsg(object): 5 | """Decode the response message from an omniksol inverter.""" 6 | raw_msg = "" 7 | 8 | def __init__(self, msg, offset=0): 9 | self.raw_msg = msg 10 | self.offset = offset 11 | 12 | def __get_string(self, begin, end): 13 | """Extract string from message. 14 | 15 | Args: 16 | begin (int): starting byte index of string 17 | end (int): end byte index of string 18 | 19 | Returns: 20 | str: String in the message from start to end 21 | """ 22 | return self.raw_msg[begin:end] 23 | 24 | def __get_short(self, begin, divider=10): 25 | """Extract short from message. 26 | 27 | The shorts in the message could actually be a decimal number. This is 28 | done by storing the number multiplied in the message. So by dividing 29 | the short the original decimal number can be retrieved. 30 | 31 | Args: 32 | begin (int): index of short in message 33 | divider (int): divider to change short to float. (Default: 10) 34 | 35 | Returns: 36 | int or float: Value stored at location `begin` 37 | """ 38 | num = struct.unpack('!H', self.raw_msg[begin:begin + 2])[0] 39 | if num == 65535: 40 | return -1 41 | else: 42 | return float(num) / divider 43 | 44 | def __get_long(self, begin, divider=10): 45 | """Extract long from message. 46 | 47 | The longs in the message could actually be a decimal number. By 48 | dividing the long, the original decimal number can be extracted. 49 | 50 | Args: 51 | begin (int): index of long in message 52 | divider (int): divider to change long to float. (Default : 10) 53 | 54 | Returns: 55 | int or float: Value stored at location `begin` 56 | """ 57 | return float( 58 | struct.unpack('!I', self.raw_msg[begin:begin + 4])[0]) / divider 59 | 60 | @property 61 | def id(self): 62 | """ID of the inverter.""" 63 | return self.__get_string(15, 31) 64 | 65 | @property 66 | def temperature(self): 67 | """Temperature recorded by the inverter.""" 68 | return self.__get_short(31) 69 | 70 | @property 71 | def power(self): 72 | """Power output""" 73 | print self.__get_short(59) 74 | 75 | @property 76 | def e_total(self): 77 | """Total energy generated by inverter in kWh""" 78 | return self.__get_long(71) 79 | 80 | def v_pv(self, i=1): 81 | """Voltage of PV input channel. 82 | 83 | Available channels are 1, 2 or 3; if not in this range the function will 84 | default to channel 1. 85 | 86 | Args: 87 | i (int): input channel (valid values: 1, 2, 3) 88 | 89 | Returns: 90 | float: PV voltage of channel i 91 | """ 92 | if i not in range(1, 4): 93 | i = 1 94 | num = 33 + (i - 1) * 2 95 | return self.__get_short(num) 96 | 97 | def i_pv(self, i=1): 98 | """Current of PV input channel. 99 | 100 | Available channels are 1, 2 or 3; if not in this range the function will 101 | default to channel 1. 102 | 103 | Args: 104 | i (int): input channel (valid values: 1, 2, 3) 105 | 106 | Returns: 107 | float: PV current of channel i 108 | """ 109 | if i not in range(1, 4): 110 | i = 1 111 | num = 39 + (i - 1) * 2 112 | return self.__get_short(num) 113 | 114 | def i_ac(self, i=1): 115 | """Current of the Inverter output channel 116 | 117 | Available channels are 1, 2 or 3; if not in this range the function will 118 | default to channel 1. 119 | 120 | Args: 121 | i (int): output channel (valid values: 1, 2, 3) 122 | 123 | Returns: 124 | float: AC current of channel i 125 | 126 | """ 127 | if i not in range(1, 4): 128 | i = 1 129 | num = 45 + (i - 1) * 2 130 | return self.__get_short(num) 131 | 132 | def v_ac(self, i=1): 133 | """Voltage of the Inverter output channel 134 | 135 | Available channels are 1, 2 or 3; if not in this range the function will 136 | default to channel 1. 137 | 138 | Args: 139 | i (int): output channel (valid values: 1, 2, 3) 140 | 141 | Returns: 142 | float: AC voltage of channel i 143 | """ 144 | if i not in range(1, 4): 145 | i = 1 146 | num = 51 + (i - 1) * 2 147 | return self.__get_short(num) 148 | 149 | def f_ac(self, i=1): 150 | """Frequency of the output channel 151 | 152 | Available channels are 1, 2 or 3; if not in this range the function will 153 | default to channel 1. 154 | 155 | Args: 156 | i (int): output channel (valid values: 1, 2, 3) 157 | 158 | Returns: 159 | float: AC frequency of channel i 160 | """ 161 | if i not in range(1, 4): 162 | i = 1 163 | num = 57 + (i - 1) * 4 164 | return self.__get_short(num, 100) 165 | 166 | def p_ac(self, i=1): 167 | """Power output of the output channel 168 | 169 | Available channels are 1, 2 or 3; if no tin this range the function will 170 | default to channel 1. 171 | 172 | Args: 173 | i (int): output channel (valid values: 1, 2, 3) 174 | 175 | Returns: 176 | float: Power output of channel i 177 | """ 178 | if i not in range(1, 4): 179 | i = 1 180 | num = 59 + (i - 1) * 4 181 | return int(self.__get_short(num, 1)) # Don't divide 182 | 183 | @property 184 | def e_today(self): 185 | """Energy generated by inverter today in kWh""" 186 | return self.__get_short(69, 100) # Divide by 100 187 | 188 | @property 189 | def h_total(self): 190 | """Hours the inverter generated electricity""" 191 | return int(self.__get_long(75, 1)) # Don't divide 192 | -------------------------------------------------------------------------------- /OmnikExport.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | """OmnikExport program. 3 | 4 | Get data from an omniksol inverter with 602xxxxx - 606xxxx ans save the data in 5 | a database or push to pvoutput.org. 6 | """ 7 | import socket # Needed for talking to inverter 8 | import sys 9 | import logging 10 | import logging.config 11 | import ConfigParser 12 | import os 13 | from PluginLoader import Plugin 14 | import InverterMsg # Import the Msg handler 15 | 16 | 17 | class OmnikExport(object): 18 | """ 19 | Get data from Omniksol inverter and store the data in a configured output 20 | format/location. 21 | 22 | """ 23 | 24 | config = None 25 | logger = None 26 | 27 | def __init__(self, config_file): 28 | # Load the setting 29 | config_files = [self.__expand_path('config-default.cfg'), 30 | self.__expand_path(config_file)] 31 | 32 | self.config = ConfigParser.RawConfigParser() 33 | self.config.read(config_files) 34 | 35 | def run(self): 36 | """Get information from inverter and store is configured outputs.""" 37 | 38 | self.build_logger(self.config) 39 | 40 | # Load output plugins 41 | # Prepare path for plugin loading 42 | sys.path.append(self.__expand_path('outputs')) 43 | 44 | Plugin.config = self.config 45 | Plugin.logger = self.logger 46 | 47 | enabled_plugins = self.config.get('general', 'enabled_plugins')\ 48 | .split(',') 49 | for plugin_name in enabled_plugins: 50 | plugin_name = plugin_name.strip() 51 | self.logger.debug('Importing output plugin ' + plugin_name) 52 | __import__(plugin_name) 53 | 54 | # Connect to inverter 55 | ip = self.config.get('inverter', 'ip') 56 | port = self.config.get('inverter', 'port') 57 | 58 | for res in socket.getaddrinfo(ip, port, socket.AF_INET, 59 | socket.SOCK_STREAM): 60 | family, socktype, proto, canonname, sockadress = res 61 | try: 62 | self.logger.info('connecting to {0} port {1}'.format(ip, port)) 63 | inverter_socket = socket.socket(family, socktype, proto) 64 | inverter_socket.settimeout(10) 65 | inverter_socket.connect(sockadress) 66 | except socket.error as msg: 67 | self.logger.error('Could not open socket') 68 | self.logger.error(msg) 69 | sys.exit(1) 70 | 71 | wifi_serial = self.config.getint('inverter', 'wifi_sn') 72 | inverter_socket.sendall(OmnikExport.generate_string(wifi_serial)) 73 | data = inverter_socket.recv(1024) 74 | inverter_socket.close() 75 | 76 | msg = InverterMsg.InverterMsg(data) 77 | 78 | self.logger.info("ID: {0}".format(msg.id)) 79 | 80 | for plugin in Plugin.plugins: 81 | self.logger.debug('Run plugin' + plugin.__class__.__name__) 82 | plugin.process_message(msg) 83 | 84 | def build_logger(self, config): 85 | # Build logger 86 | """ 87 | Build logger for this program 88 | 89 | 90 | Args: 91 | config: ConfigParser with settings from file 92 | """ 93 | log_levels = dict(debug=10, info=20, warning=30, error=40, critical=50) 94 | log_dict = { 95 | 'version': 1, 96 | 'formatters': { 97 | 'f': {'format': '%(asctime)s %(levelname)s %(message)s'} 98 | }, 99 | 'handlers': { 100 | 'none': {'class': 'logging.NullHandler'}, 101 | 'console': { 102 | 'class': 'logging.StreamHandler', 103 | 'formatter': 'f' 104 | }, 105 | 'file': { 106 | 'class': 'logging.FileHandler', 107 | 'filename': self.__expand_path(config.get('log', 108 | 'filename')), 109 | 'formatter': 'f'}, 110 | }, 111 | 'loggers': { 112 | 'OmnikLogger': { 113 | 'handlers': config.get('log', 'type').split(','), 114 | 'level': log_levels[config.get('log', 'level')] 115 | } 116 | } 117 | } 118 | logging.config.dictConfig(log_dict) 119 | self.logger = logging.getLogger('OmnikLogger') 120 | 121 | def override_config(self, section, option, value): 122 | """Override config settings""" 123 | self.config.set(section, option, value) 124 | 125 | @staticmethod 126 | def __expand_path(path): 127 | """ 128 | Expand relative path to absolute path. 129 | 130 | Args: 131 | path: file path 132 | 133 | Returns: absolute path to file 134 | 135 | """ 136 | if os.path.isabs(path): 137 | return path 138 | else: 139 | return os.path.dirname(os.path.abspath(__file__)) + "/" + path 140 | 141 | @staticmethod 142 | def generate_string(serial_no): 143 | """Create request string for inverter. 144 | 145 | The request string is build from several parts. The first part is a 146 | fixed 4 char string; the second part is the reversed hex notation of 147 | the s/n twice; then again a fixed string of two chars; a checksum of 148 | the double s/n with an offset; and finally a fixed ending char. 149 | 150 | Args: 151 | serial_no (int): Serial number of the inverter 152 | 153 | Returns: 154 | str: Information request string for inverter 155 | """ 156 | response = '\x68\x02\x40\x30' 157 | 158 | double_hex = hex(serial_no)[2:] * 2 159 | hex_list = [double_hex[i:i + 2].decode('hex') for i in 160 | reversed(range(0, len(double_hex), 2))] 161 | 162 | cs_count = 115 + sum([ord(c) for c in hex_list]) 163 | checksum = hex(cs_count)[-2:].decode('hex') 164 | response += ''.join(hex_list) + '\x01\x00' + checksum + '\x16' 165 | return response 166 | 167 | 168 | if __name__ == "__main__": 169 | omnik_exporter = OmnikExport('config.cfg') 170 | omnik_exporter.run() 171 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------