├── .gitignore ├── Development ├── Communication.txt ├── InverterSimulator.py ├── packet-fields.txt └── sim-config-default.cfg ├── Ethernet_Card ├── 2017-10-12 15.03.38.jpg ├── 2017-10-12 15.04.12.jpg ├── 2017_ UserManual_OMNIK_Ethernet_Card_EN_V1.pdf └── Omnik ethernet Card TL2___01.JPG ├── InverterExport.py ├── InverterLib.py ├── InverterMsg.py ├── InverterServer.py ├── LICENSE.md ├── LiveStats.py ├── PluginLoader.py ├── README.md ├── Resources ├── mysql.sql └── postgresql.sql ├── ScanLoggers.py ├── config-org.cfg └── outputs ├── CSVOutput.py ├── CSVOutput2File.py ├── ConsoleOutput.py ├── DomoticzOutput.py ├── MQTTOutput.py ├── MysqlOutput.py ├── PVoutputOutput.py └── PostgreSQLOutput.py /.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 | inverter-export.log 16 | Development/sim-config.cfg 17 | ## ignore all subfolders 18 | Development/** 19 | !Development/* 20 | 21 | ## WireShark 22 | *.pcap 23 | *.pcapng 24 | -------------------------------------------------------------------------------- /Development/Communication.txt: -------------------------------------------------------------------------------- 1 | Wi-Fi Kit (inside Omnik 4000TL2) data: 2 | IP: 192.168.224.34 3 | MAC: ACCF2314DD11 4 | S/N: 1601299688 = hex:5F71E4E8 = rev hex:E8E4715F 5 | 6 | Inverter S/N: NLBN4020146J3002 7 | 8 | --- To find the logger(s) on the network --- 9 | Sent UDP data to (local) BROADCAST address and port: 48899 to query WiFi-Kit data logger(s) 10 | 11 | Datagram to send to UDP port 48899: 12 | HEX: 57 49 46 49 4b 49 54 2d 32 31 34 30 32 38 2d 52 45 41 44 13 | ASCII: WIFIKIT-214028-READ 14 | (Fun part: 214028 is the postal code of the city where the iGEN factory is located :-) 15 | 16 | The WiFi-Kit will respond with a UDP datagram containing it's IP address, Base MAC address and S/N: 17 | 18 | HEX: 31 39 32 2e 31 36 38 2e 32 32 34 2e 33 34 2c 41 43 43 46 32 33 31 34 44 44 31 30 2c 31 36 30 31 32 39 39 36 38 38 19 | ASCII: 192.168.224.34,ACCF2314DD10,1601299688 20 | 21 | These response data frames are the same as sent to www.solarmandata.com:10004 and/or a specified server/port in the logger server config page. 22 | Only the last OK frame is different, The logger firmware version is sent 23 | 24 | --- To get data from the logger --- 25 | Connect to TCP port 8899 on the WiFi-Kit IP. 26 | 27 | Then sent the following DATA (16 bytes) to trigger the logger. 28 | HEX: 68 (V4 headCode) 29 | HEX: 02 (dataFieldLength) 30 | HEX: 41 b1 (contrlCode) 31 | HEX: e8 e4 71 5f (reversed hex notation of the logger s/n) 32 | HEX: e8 e4 71 5f (reversed hex notation of the logger s/n) 33 | HEX: 01 00 (command) 34 | HEX: 2d (checksum) 35 | HEX: 16 (V4 endCode) 36 | 37 | Command: len(raw) len(dfl) Reply 38 | 0000 No response 39 | 0001 183 169 inverter data frame 40 | 0002 25 11 ERR=-1 41 | 0003 No response 42 | 0004 257 0 empty frame with only cs/endCode then inverter sn and some data 43 | high byte seems to be ignored 44 | 45 | This response frame is repeated for every connected inverter. (also to a server) 46 | Response (183 bytes): 47 | HEX: 68 (headCode) 48 | HEX: a9 (dataFieldLength) 49 | HEX: 41 b0 (contrlCode) 50 | HEX: e8 e4 71 5f (reversed hex notation of the logger s/n) 51 | HEX: e8 e4 71 5f (reversed hex notation of the logger s/n) 52 | HEX: 81 53 | HEX: 02 54 | HEX: 01 55 | HEX: 4e 4c 42 4e 34 30 32 30 31 34 36 4a 33 30 30 32 (Inverter Serial) 56 | HEX: 01 31 Temp 57 | HEX: 0a 94 PV_V1 58 | HEX: 0a 2c PV_V2 59 | HEX: 00 00 PV_V3 60 | HEX: 00 0a PV_I1 61 | HEX: 00 09 PV_I2 62 | HEX: 00 00 PV_I3 63 | HEX: 00 13 AC_I1 64 | HEX: 00 00 AC_I2 65 | HEX: 00 00 AC_I3 66 | HEX: 08 d8 AC_V1 67 | HEX: 00 00 AC_V2 68 | HEX: 00 00 AC_V3 69 | HEX: 13 85 AC_F1 70 | HEX: 01 37 AC_P1 71 | HEX: 00 00 AC_F2 72 | HEX: 00 00 AC_P2 73 | HEX: 00 00 AC_F3 74 | HEX: 00 00 AC_P3 75 | HEX: 00 2b e_today 76 | HEX: 00 00 70 9a e_total 77 | HEX: 00 00 15 dd h_total 78 | HEX: 00 01 mode (79) 79 | HEX: 00 00 GVFaultValue (81) 80 | HEX: 00 00 GFFaultValue (83) 81 | HEX: 00 00 GZFaultValue (85) 82 | HEX: 00 00 TmpFaultValue (87) 83 | HEX: 00 00 PVFaultValue (89) 84 | HEX: 00 00 GFCIFaultValue (91) 85 | HEX: 00 00 00 00 errorMsg (93) 86 | HEX: 00 00 00 00 ??? (97) 87 | HEX: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 Inverter main firmware version (101) 88 | HEX: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 Inverter slave firmware version (121) 89 | HEX: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ??? (141) (not in older loggers) 90 | HEX: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ??? (161) (not in older loggers) 91 | HEX: f4 (checksum) 92 | HEX: 16 (Data end flag) 93 | 94 | 95 | Response (143 bytes): 96 | HEX: 68 (headCode) 97 | HEX: 81 (dataFieldLength) 98 | HEX: 51 b0 (contrlCode) 99 | HEX: de 3d 10 1e (reversed hex notation of the logger s/n) 100 | HEX: de 3d 10 1e (reversed hex notation of the logger s/n) 101 | HEX: 81 102 | HEX: 02 103 | HEX: 01 104 | HEX: 4e 4c 44 4e 32 30 32 30 31 34 36 36 32 31 35 39 (Inverter Serial) 105 | HEX: 01 35 Temp 106 | HEX: 0a 5b PV_V1 107 | HEX: 00 00 PV_V2 108 | HEX: ff ff PV_V3 109 | HEX: 00 05 PV_I1 110 | HEX: 00 b4 PV_I2 111 | HEX: ff ff PV_I3 112 | HEX: 00 05 AC_I1 113 | HEX: ff ff AC_I2 114 | HEX: ff ff AC_I3 115 | HEX: 08 ff AC_V1 116 | HEX: ff ff AC_V2 117 | HEX: ff ff AC_V3 118 | HEX: 13 8f AC_F1 119 | HEX: 00 80 AC_P1 120 | HEX: ff ff AC_F2 121 | HEX: ff ff AC_P2 122 | HEX: ff ff AC_F3 123 | HEX: ff ff AC_P3 124 | HEX: 00 77 e_today 125 | HEX: 00 01 03 7b e_total 126 | HEX: 00 00 2f 6d h_total 127 | HEX: 00 01 mode (79) 128 | HEX: 00 00 GVFaultValue (81) 129 | HEX: 00 00 GFFaultValue (83) 130 | HEX: ff ff GZFaultValue (85) 131 | HEX: 00 00 TmpFaultValue (87) 132 | HEX: 00 00 PVFaultValue (89) 133 | HEX: 00 00 GFCIFaultValue (91) 134 | HEX: 00 00 00 00 errorMsg 135 | HEX: 00 00 00 00 ??? (97) 136 | HEX: 4e 4c 31 2d 56 31 2e 30 2d 30 30 36 37 2d 34 00 00 00 00 00 NL1-V1.0-0067-4 137 | HEX: 56 31 2e 36 2d 30 30 31 38 00 00 00 00 00 00 00 00 00 00 00 V1.6-0018 138 | HEX: 42 (checksum) 139 | HEX: 16 (Data end flag) 140 | 141 | 142 | This response frame is send after all data is sent. 143 | Response (99 bytes): 144 | HEX: 68 (headCode) 145 | HEX: 11 (dataFieldLength) 146 | HEX: 41 f0 (contrlCode) 147 | HEX: e8 e4 71 5f (reversed hex notation of the logger s/n) 148 | HEX: e8 e4 71 5f (reversed hex notation of the logger s/n) 149 | HEX: 44 41 54 41 20 53 45 4e 44 20 49 53 20 4f 4b 0d 0a DATA SEND IS OK 150 | HEX: 6b (checksum) 151 | HEX: 16 (Data end flag) 152 | HEX: ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 153 | HEX: ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 154 | HEX: ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 155 | HEX: ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 156 | 157 | 158 | This response frame is send when the connected inverter(s) are in sleep mode. 159 | Response (32 bytes): 160 | HEX: 68 12 51 f0 (command header) 161 | HEX: de 3d 10 1e (reversed hex notation of the logger s/n) 162 | HEX: de 3d 10 1e (reversed hex notation of the logger s/n) 163 | HEX: 4e 4f 20 49 4e 56 45 52 54 45 52 20 44 41 54 41 0d 0a NO INVERTER DATA 164 | HEX: 62 (checksum) 165 | HEX: 16 (Data end flag) 166 | 167 | 168 | This data frame is send after all data is sent to a server. It contains the firmware version of the logger. 169 | Response (55 bytes): 170 | HEX: 68 29 51 b1 (command header) 171 | HEX: de 3d 10 1e (reversed hex notation of the logger s/n) 172 | HEX: de 3d 10 1e (reversed hex notation of the logger s/n) 173 | HEX: 80 01 (command end) 174 | HEX: 48 34 2e 30 31 2e 35 31 59 34 2e 30 2e 30 31 57 31 2e 30 2e 34 38 28 32 30 31 36 2d 30 31 2d 32 38 31 2d 44 29 00 00 H4.01.51Y4.0.01W1.0.48(2016-01-281-D) 175 | HEX: b8 (checksum) 176 | HEX: 16 (Data end flag) 177 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Development/packet-fields.txt: -------------------------------------------------------------------------------- 1 | # Offset mapping to what fields are returned in the data frame version 4 2 | # Empty values are returned as 00/0000/00000000 or FF/FFFF/FFFFFFFF 3 | # (frame version 5 has hex(a5) as headCode and hex(15) as endCode) 4 | 5 | Value Offset Length Divider Unit Description 6 | headCode 0 1 1 hex(68) 7 | dataFieldLength 1 1 1 hex(a9) 8 | contrlCode 2 2 1 hex(41 b0) 9 | sn 4 4 1 reversed hex notation of the s/n 10 | sn 8 4 1 reversed hex notation of the s/n 11 | Data format ID 12 1 1 hex(81) 12 | unkown_1 13 1 1 hex(02) 13 | unkown_2 14 1 1 hex(01) (if hex(06) then f_ac divider changes to 10) 14 | 15 | id 15 16 1 ID of the inverter. 16 | temperature 31 2 10 oC Temperature recorded by the inverter. 17 | v_pv1 33 2 10 V Voltage of PV input channel 1. 18 | v_pv2 35 2 10 V Voltage of PV input channel 2. 19 | v_pv3 37 2 10 V Voltage of PV input channel 3. 20 | i_pv1 39 2 10 A Current of PV input channel 1. 21 | i_pv2 41 2 10 A Current of PV input channel 2. 22 | i_pv3 43 2 10 A Current of PV input channel 3. 23 | i_ac1 45 2 10 A Current of the Inverter AC output channel 1. 24 | i_ac2 47 2 10 A Current of the Inverter AC output channel 2. 25 | i_ac3 49 2 10 A Current of the Inverter AC output channel 3. 26 | v_ac1 51 2 10 V Voltage of the Inverter AC output channel 1. 27 | v_ac2 53 2 10 V Voltage of the Inverter AC output channel 2. 28 | v_ac3 55 2 10 V Voltage of the Inverter AC output channel 3. 29 | f_ac1 57 2 100 Hz Frequency of the AC output channel 1. 30 | p_ac1 59 2 1 W Power output of the AC output channel 1. 31 | f_ac2 62 2 100 Hz Frequency of the AC output channel 2. 32 | p_ac2 63 2 1 W Power output of the AC output channel 2. 33 | f_ac3 65 2 100 Hz Frequency of the AC output channel 3. 34 | p_ac3 67 2 1 W Power output of the AC output channel 3. 35 | e_today 69 2 100 kWh Energy generated by inverter today. 36 | e_total 71 4 10 kWh Total energy generated by inverter. 37 | h_total 75 4 1 h Hours the inverter generated electricity. 38 | mode 79 2 1 Operation Mode of inverter, 1=Generating power. 39 | GVFaultValue 81 2 10 V Grid voltage fault value. 40 | GFFaultValue 83 2 100 Hz Grid frequency fault value. 41 | GZFaultValue 85 2 1000 Ohm Grid impedance fault value. 42 | TmpFaultValue 87 2 10 oC Temperature fault value. 43 | PVFaultValue 89 2 10 V PV voltage fault value. 44 | GFCIFaultValue 91 2 1000 A GFCI current fault value. 45 | errorMsg 93 4 1 errorMsg binary index value. 46 | main_fwver 101 20 1 Inverter main firmware version. 47 | slave_fwver 121 20 1 Inverter slave firmware version. 48 | 49 | checksum (len-1) 1 1 checksum of all bytes except headCode, checksum and endCode 50 | endCode (len) 1 1 hex(16) 51 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Ethernet_Card/2017-10-12 15.03.38.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/XtheOne/Inverter-Data-Logger/aca616931090ee9de4ae69076c6ec56bc42c4e38/Ethernet_Card/2017-10-12 15.03.38.jpg -------------------------------------------------------------------------------- /Ethernet_Card/2017-10-12 15.04.12.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/XtheOne/Inverter-Data-Logger/aca616931090ee9de4ae69076c6ec56bc42c4e38/Ethernet_Card/2017-10-12 15.04.12.jpg -------------------------------------------------------------------------------- /Ethernet_Card/2017_ UserManual_OMNIK_Ethernet_Card_EN_V1.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/XtheOne/Inverter-Data-Logger/aca616931090ee9de4ae69076c6ec56bc42c4e38/Ethernet_Card/2017_ UserManual_OMNIK_Ethernet_Card_EN_V1.pdf -------------------------------------------------------------------------------- /Ethernet_Card/Omnik ethernet Card TL2___01.JPG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/XtheOne/Inverter-Data-Logger/aca616931090ee9de4ae69076c6ec56bc42c4e38/Ethernet_Card/Omnik ethernet Card TL2___01.JPG -------------------------------------------------------------------------------- /InverterExport.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | """InverterExport program. 3 | 4 | Get data from a Wi-Fi kit logger and save/send the data to the defined plugin(s) 5 | """ 6 | import socket # Needed for talking to logger 7 | import sys 8 | import logging 9 | import logging.config 10 | import sys 11 | if sys.version[:1] == '2': 12 | import ConfigParser as configparser 13 | else: 14 | import configparser 15 | import optparse 16 | import os 17 | import re 18 | from PluginLoader import Plugin 19 | import InverterMsg # Import the Msg handler 20 | import InverterLib # Import the library 21 | 22 | class InverterExport(object): 23 | """ 24 | Get data from the inverter(s) and store the data in a configured output 25 | format/location. 26 | 27 | """ 28 | 29 | config = None 30 | logger = None 31 | 32 | def __init__(self, config_file): 33 | # Load the setting 34 | config_files = [InverterLib.expand_path('config-default.cfg'), 35 | InverterLib.expand_path(config_file)] 36 | 37 | self.config = configparser.RawConfigParser() 38 | self.config.read(config_files) 39 | 40 | # add command line option -p / --plugins to override the output plugins used 41 | parser = optparse.OptionParser() 42 | parser.add_option('-p', '--plugins', 43 | action="store", dest="plugins", 44 | help="output plugins to use") 45 | 46 | self.options, self.args = parser.parse_args() 47 | 48 | def run(self): 49 | """Get information from inverter and store is configured outputs.""" 50 | 51 | self.build_logger(self.config) 52 | 53 | # Load output plugins 54 | # Prepare path for plugin loading 55 | sys.path.append(InverterLib.expand_path('outputs')) 56 | 57 | Plugin.config = self.config 58 | Plugin.logger = self.logger 59 | 60 | enabled_plugins = self.config.get('general', 'enabled_plugins')\ 61 | .split(',') 62 | 63 | # if -p / --plugin option giving at command line, override enabled plugins 64 | if self.options.plugins: 65 | enabled_plugins = self.options.plugins.split(',') 66 | 67 | for plugin_name in enabled_plugins: 68 | plugin_name = plugin_name.strip() 69 | self.logger.debug('Importing output plugin ' + plugin_name) 70 | __import__(plugin_name) 71 | 72 | # Connect to logger 73 | if not self.config.has_option('logger', 'gateways'): 74 | self.logger.error('no gateways defined in configuration file, exiting.') 75 | return [] 76 | 77 | if(self.config.get('logger', 'gateways') == 'auto'): 78 | # get loggers 79 | gateway_list = InverterLib.getLoggers().split(',') 80 | if (len(gateway_list) < 2): 81 | self.logger.error('No loggers found: {0}, exiting.'.format(gateway_list)) 82 | return [] 83 | self.logger.info('Loggers found on the network: {0}.'.format(gateway_list)) 84 | else: 85 | gateway_list = self.config.get('logger', 'gateways').split(',') 86 | if (len(gateway_list) % 2): 87 | self.logger.error('incorrect number of values in configuration file for gateways: {0}, exiting.'.format(gateway_list)) 88 | return [] 89 | 90 | for i in range(0, len(gateway_list), 2): 91 | ip = gateway_list[i] 92 | sn = gateway_list[i+1] 93 | 94 | self.logger.info('Connecting to logger with IP: {0} and SN {1}'.format(ip, sn)) 95 | 96 | port = self.config.get('logger', 'port') 97 | timeout = self.config.getfloat('logger', 'timeout') 98 | 99 | next = False 100 | for res in socket.getaddrinfo(ip, port, socket.AF_INET, 101 | socket.SOCK_STREAM): 102 | family, socktype, proto, canonname, sockadress = res 103 | try: 104 | self.logger.info('connecting to {0} port {1}'.format(ip, port)) 105 | logger_socket = socket.socket(family, socktype, proto) 106 | logger_socket.settimeout(timeout) 107 | logger_socket.connect(sockadress) 108 | except socket.error as msg: 109 | self.logger.error('Could not open socket') 110 | self.logger.error(msg) 111 | self.logger.error('Error connecting to logger with IP: {0} and SN {1}, trying next logger.'.format(ip, sn)) 112 | next = True 113 | break 114 | if (next): 115 | continue 116 | 117 | data = InverterLib.createV4RequestFrame(int(sn)) 118 | logger_socket.sendall(data) 119 | 120 | #dump raw data to log 121 | self.logger.debug('RAW sent Packet (len={0}): '.format(len(data))+':'.join(hex(ord(chr(x)))[2:].zfill(2) for x in bytearray(data))+' '+re.sub('[^\x20-\x7f]', '', ''.join(chr(x) for x in bytearray(data)))) 122 | 123 | okflag = False 124 | while (not okflag): 125 | 126 | try: 127 | data = logger_socket.recv(1024) 128 | except socket.timeout as e: 129 | self.logger.error('Timeout connecting to logger with IP: {0} and SN {1}, trying next logger.'.format(ip, sn)) 130 | okflag = True 131 | continue 132 | 133 | #dump raw data to log 134 | self.logger.debug('RAW received Packet (len={0}): '.format(len(data))+':'.join(hex(ord(chr(x)))[2:].zfill(2) for x in bytearray(data))+' '+re.sub('[^\x20-\x7f]', '', ''.join(chr(x) for x in bytearray(data)))) 135 | 136 | msg = InverterMsg.InverterMsg(data) 137 | 138 | #log DATA length 139 | self.logger.debug('DATA len={0}: '.format(msg.len)) 140 | 141 | if (msg.msg)[:9] == 'DATA SEND': 142 | self.logger.debug("Exit Status: {0}".format(msg.msg)) 143 | logger_socket.close() 144 | okflag = True 145 | continue 146 | 147 | if (msg.msg)[:11] == 'NO INVERTER': 148 | self.logger.debug("Inverter(s) are in sleep mode: {0} received".format(msg.msg)) 149 | logger_socket.close() 150 | okflag = True 151 | continue 152 | 153 | self.logger.info("Inverter ID: {0}".format(msg.id)) 154 | if (msg.len > 140): 155 | self.logger.info("Inverter main firmware version: {0}".format(msg.main_fwver)) 156 | self.logger.info("Inverter slave firmware version: {0}".format(msg.slave_fwver)) 157 | self.logger.info("RUN State: {0}".format(msg.run_state)) 158 | 159 | for plugin in Plugin.plugins: 160 | self.logger.debug('Run plugin' + plugin.__class__.__name__) 161 | plugin.process_message(msg) 162 | 163 | def build_logger(self, config): 164 | # Build logger 165 | """ 166 | Build logger for this program 167 | 168 | 169 | Args: 170 | config: configparser with settings from file 171 | """ 172 | log_levels = dict(notset=0, debug=10, info=20, warning=30, error=40, critical=50) 173 | log_dict = { 174 | 'version': 1, 175 | 'formatters': { 176 | 'f': {'format': '%(asctime)s %(levelname)s %(message)s'} 177 | }, 178 | 'handlers': { 179 | 'none': {'class': 'logging.NullHandler'}, 180 | 'console': { 181 | 'class': 'logging.StreamHandler', 182 | 'formatter': 'f' 183 | }, 184 | 'file': { 185 | 'class': 'logging.FileHandler', 186 | 'filename': InverterLib.expand_path(config.get('log', 187 | 'filename')), 188 | 'formatter': 'f'}, 189 | }, 190 | 'loggers': { 191 | 'InverterLogger': { 192 | 'handlers': config.get('log', 'type').split(','), 193 | 'level': log_levels[config.get('log', 'level')] 194 | } 195 | } 196 | } 197 | logging.config.dictConfig(log_dict) 198 | self.logger = logging.getLogger('InverterLogger') 199 | 200 | def override_config(self, section, option, value): 201 | """Override config settings""" 202 | self.config.set(section, option, value) 203 | 204 | if __name__ == "__main__": 205 | inverter_exporter = InverterExport('config.cfg') 206 | inverter_exporter.run() 207 | -------------------------------------------------------------------------------- /InverterLib.py: -------------------------------------------------------------------------------- 1 | import socket 2 | import struct 3 | import os 4 | import binascii 5 | import sys 6 | 7 | if sys.version[0] == '2': 8 | reload(sys) 9 | sys.setdefaultencoding('cp437') 10 | 11 | def getNetworkIp(): 12 | s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) 13 | s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) 14 | s.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1) 15 | s.connect(('', 0)) 16 | return s.getsockname()[0] 17 | 18 | def createV4RequestFrame(logger_sn): 19 | """Create request frame for inverter logger. 20 | 21 | The request string is build from several parts. The first part is a 22 | fixed 4 char string; the second part is the reversed hex notation of 23 | the s/n twice; then again a fixed string of two chars; a checksum of 24 | the double s/n with an offset; and finally a fixed ending char. 25 | 26 | Args: 27 | logger_sn (int): Serial number of the inverter 28 | 29 | Returns: 30 | str: Information request string for inverter 31 | """ 32 | #frame = (headCode) + (dataFieldLength) + (contrlCode) + (sn) + (sn) + (command) + (checksum) + (endCode) 33 | frame_hdr = binascii.unhexlify('680241b1') #from SolarMan / new Omnik app 34 | command = binascii.unhexlify('0100') 35 | defchk = binascii.unhexlify('87') 36 | endCode = binascii.unhexlify('16') 37 | 38 | tar = bytearray.fromhex(hex(logger_sn)[8:10] + hex(logger_sn)[6:8] + hex(logger_sn)[4:6] + hex(logger_sn)[2:4]) 39 | frame = bytearray(frame_hdr + tar + tar + command + defchk + endCode) 40 | 41 | checksum = 0 42 | frame_bytes = bytearray(frame) 43 | for i in range(1, len(frame_bytes) - 2, 1): 44 | checksum += frame_bytes[i] & 255 45 | frame_bytes[len(frame_bytes) - 2] = int((checksum & 255)) 46 | return bytearray(frame_bytes) 47 | 48 | def expand_path(path): 49 | """ 50 | Expand relative path to absolute path. 51 | 52 | Args: 53 | path: file path 54 | 55 | Returns: absolute path to file 56 | 57 | """ 58 | if os.path.isabs(path): 59 | return path 60 | else: 61 | return os.path.dirname(os.path.abspath(__file__)) + "/" + path 62 | 63 | def getLoggers(): 64 | # Create the datagram socket 65 | sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) 66 | sock.bind((getNetworkIp(), 48899)) 67 | # Set a timeout so the socket does not block indefinitely when trying to receive data. 68 | sock.settimeout(3) 69 | # Set the time-to-live for messages to 1 so they do not go past the local network segment. 70 | ttl = struct.pack('b', 1) 71 | sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, ttl) 72 | sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) 73 | sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1) 74 | SendData = "WIFIKIT-214028-READ" # Lotto/TM = "AT+YZAPP=214028,READ" 75 | 76 | gateways = '' 77 | try: 78 | # Send data to the broadcast address 79 | sent = sock.sendto(SendData, ('', 48899)) 80 | # Look for responses from all recipients 81 | while True: 82 | try: 83 | data, server = sock.recvfrom(1024) 84 | except socket.timeout: 85 | break 86 | else: 87 | if (data == SendData): continue #skip sent data 88 | a = data.split(',') 89 | wifi_ip, wifi_mac, wifi_sn = a[0],a[1],a[2] 90 | if (len(gateways)>1): 91 | gateways = gateways+',' 92 | gateways = gateways+wifi_ip+','+wifi_sn 93 | 94 | finally: 95 | sock.close() 96 | return gateways 97 | -------------------------------------------------------------------------------- /InverterMsg.py: -------------------------------------------------------------------------------- 1 | import struct # Converting bytes to numbers 2 | import re 3 | import binascii 4 | 5 | #V4 table 6 | offset = { 7 | 1: 1, #len(1) 8 | 2: 12, #msg(12) 9 | 3: 15, #id(15) 10 | 4: 31, #temperature(31) 11 | 5: 33, #v_pv(33,35,37) 12 | 6: 39, #i_pv(39,41,43) 13 | 7: 45, #i_ac(45,47,49) 14 | 8: 51, #v_ac(51,53,55) 15 | 9: 57, #f_ac(57,62,65) 16 | 10: 59, #p_ac(59,63,67) 17 | 11: 69, #e_today(69) 18 | 12: 71, #e_total(71) 19 | 13: 75, #h_total(75) 20 | 14: 79, #run_state(79) 21 | 15: 81, #GVFaultValue(81) 22 | 16: 83, #GVFaultValue(83) 23 | 17: 85, #GZFaultValue(85) 24 | 18: 87, #TmpFaultValue(87) 25 | 19: 89, #PVFaultValue(89) 26 | 20: 91, #GFCIFaultValue(91) 27 | 21: 93, #errorMsg(93) 28 | 22:101, #main_fwver(101) 29 | 23:121,}#slave_fwver(121) 30 | 31 | class InverterMsg(object): 32 | """Decode the response message from an inverter logger.""" 33 | raw_msg = "" 34 | 35 | def __init__(self, msg, offset=0): 36 | self.raw_msg = msg 37 | self.offset = offset 38 | 39 | def __get_string(self, begin, end): 40 | """Extract string from message. 41 | 42 | Args: 43 | begin (int): starting byte index of string 44 | end (int): end byte index of string 45 | 46 | Returns: 47 | str: String in the message from start to end 48 | """ 49 | return self.raw_msg[begin:end].decode('cp437') 50 | # 51 | def __get_int(self, begin): 52 | """Extract byte value from message. 53 | 54 | Args: 55 | begin (int): starting byte index of string 56 | 57 | Returns: 58 | int: value at offset 59 | """ 60 | if (len(self.raw_msg) < begin): 61 | return 0 62 | return int(binascii.hexlify(bytearray(self.raw_msg[begin:begin+1])), 16) 63 | # 64 | def __get_short(self, begin, divider=10): 65 | """Extract short from message. 66 | 67 | The shorts in the message could actually be a decimal number. This is 68 | done by storing the number multiplied in the message. So by dividing 69 | the short the original decimal number can be retrieved. 70 | 71 | Args: 72 | begin (int): index of short in message 73 | divider (int): divider to change short to float. (Default: 10) 74 | 75 | Returns: 76 | int or float: Value stored at location `begin` 77 | """ 78 | num = struct.unpack('!H', self.raw_msg[begin:begin + 2])[0] 79 | if num > 32767: 80 | return float(-(65536 - num)) / divider 81 | else: 82 | return float(num) / divider 83 | 84 | def __get_long(self, begin, divider=10): 85 | """Extract long from message. 86 | 87 | The longs in the message could actually be a decimal number. By 88 | dividing the long, the original decimal number can be extracted. 89 | 90 | Args: 91 | begin (int): index of long in message 92 | divider (int): divider to change long to float. (Default : 10) 93 | 94 | Returns: 95 | int or float: Value stored at location `begin` 96 | """ 97 | return float( 98 | struct.unpack('!I', self.raw_msg[begin:begin + 4])[0]) / divider 99 | 100 | @property 101 | def len(self): 102 | """received data len msg.""" 103 | return self.__get_int(offset[1]) 104 | 105 | @property 106 | def msg(self): 107 | """received status msg.""" 108 | return self.__get_string(offset[2], self.len+offset[2]) 109 | 110 | @property 111 | def id(self): 112 | """ID of the inverter.""" 113 | return self.__get_string(offset[3], offset[3]+16).lstrip().rstrip() #Strip spaces from shorter or padded inverter SN 114 | 115 | @property 116 | def temp(self): 117 | """Temperature recorded by the inverter.""" 118 | return self.__get_short(offset[4], 10) 119 | 120 | @property 121 | def e_today(self): 122 | """Energy generated by inverter today in kWh""" 123 | return self.__get_short(offset[11], 100) # Divide by 100 124 | 125 | @property 126 | def e_total(self): 127 | """Total energy generated by inverter in kWh""" 128 | return self.__get_long(offset[12]) 129 | 130 | @property 131 | def h_total(self): 132 | """Hours the inverter generated electricity""" 133 | return int(self.__get_long(offset[13], 1)) # Don't divide 134 | 135 | @property 136 | def run_state(self): 137 | """RUN State""" 138 | return int(self.__get_short(offset[14], 1)) 139 | 140 | @property 141 | def GVFaultValue(self): 142 | """Grid voltage fault value in V""" 143 | return self.__get_short(offset[15], 10) # Divide by 10 144 | 145 | @property 146 | def GVFaultValue(self): 147 | """Grid frequency fault value in Hz""" 148 | return self.__get_short(offset[16], 100) # Divide by 100 149 | 150 | @property 151 | def GZFaultValue(self): 152 | """Grid impedance fault value in Ohm""" 153 | return self.__get_short(offset[17], 1000) # Divide by 1000 154 | 155 | @property 156 | def TmpFaultValue(self): 157 | """Temperature fault value in oC""" 158 | return self.__get_short(offset[18], 10) # Divide by 10 159 | 160 | @property 161 | def PVFaultValue(self): 162 | """PV voltage fault value in V""" 163 | return self.__get_short(offset[19], 10) # Divide by 10 164 | 165 | @property 166 | def GFCIFaultValue(self): 167 | """GFCI current fault value in A""" 168 | return self.__get_short(offset[20], 1000) # Divide by 1000 169 | 170 | @property 171 | def errorMsg(self): 172 | """errorMsg binary index value""" 173 | return int(self.__get_long(offset[21])) 174 | 175 | @property 176 | def main_fwver(self): 177 | """Inverter main firmware version.""" 178 | if (self.__get_int(offset[22]) == 0): return "" 179 | return re.sub('[^\x20-\x7f]', '', self.__get_string(offset[22], offset[22]+19)) 180 | 181 | @property 182 | def slave_fwver(self): 183 | """Inverter slave firmware version.""" 184 | if (self.__get_int(offset[23]) == 0): return "" 185 | return re.sub('[^\x20-\x7f]', '', self.__get_string(offset[23], offset[23]+19)) 186 | 187 | def v_pv(self, i=1): 188 | """Voltage of PV input channel. 189 | 190 | Available channels are 1, 2 or 3; if not in this range the function will 191 | default to channel 1. 192 | 193 | Args: 194 | i (int): input channel (valid values: 1, 2, 3) 195 | 196 | Returns: 197 | float: PV voltage of channel i 198 | """ 199 | if i not in range(1, 4): 200 | i = 1 201 | num = offset[5] + (i - 1) * 2 202 | return self.__get_short(num) 203 | 204 | def i_pv(self, i=1): 205 | """Current of PV input channel. 206 | 207 | Available channels are 1, 2 or 3; if not in this range the function will 208 | default to channel 1. 209 | 210 | Args: 211 | i (int): input channel (valid values: 1, 2, 3) 212 | 213 | Returns: 214 | float: PV current of channel i 215 | """ 216 | if i not in range(1, 4): 217 | i = 1 218 | num = offset[6] + (i - 1) * 2 219 | return self.__get_short(num) 220 | 221 | def i_ac(self, i=1): 222 | """Current of the Inverter output channel 223 | 224 | Available channels are 1, 2 or 3; if not in this range the function will 225 | default to channel 1. 226 | 227 | Args: 228 | i (int): output channel (valid values: 1, 2, 3) 229 | 230 | Returns: 231 | float: AC current of channel i 232 | 233 | """ 234 | if i not in range(1, 4): 235 | i = 1 236 | num = offset[7] + (i - 1) * 2 237 | return self.__get_short(num) 238 | 239 | def v_ac(self, i=1): 240 | """Voltage of the Inverter output channel 241 | 242 | Available channels are 1, 2 or 3; if not in this range the function will 243 | default to channel 1. 244 | 245 | Args: 246 | i (int): output channel (valid values: 1, 2, 3) 247 | 248 | Returns: 249 | float: AC voltage of channel i 250 | """ 251 | if i not in range(1, 4): 252 | i = 1 253 | num = offset[8] + (i - 1) * 2 254 | return self.__get_short(num) 255 | 256 | def f_ac(self, i=1): 257 | """Frequency of the output channel 258 | 259 | Available channels are 1, 2 or 3; if not in this range the function will 260 | default to channel 1. 261 | 262 | Args: 263 | i (int): output channel (valid values: 1, 2, 3) 264 | 265 | Returns: 266 | float: AC frequency of channel i 267 | """ 268 | if i not in range(1, 4): 269 | i = 1 270 | num = offset[9] + (i - 1) * 4 271 | return self.__get_short(num, 100) 272 | 273 | def p_ac(self, i=1): 274 | """Power output of the output channel 275 | 276 | Available channels are 1, 2 or 3; if no tin this range the function will 277 | default to channel 1. 278 | 279 | Args: 280 | i (int): output channel (valid values: 1, 2, 3) 281 | 282 | Returns: 283 | float: Power output of channel i 284 | """ 285 | if i not in range(1, 4): 286 | i = 1 287 | num = offset[10] + (i - 1) * 4 288 | return int(self.__get_short(num, 1)) # Don't divide 289 | -------------------------------------------------------------------------------- /InverterServer.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | """InverterExport program. 3 | 4 | Get data from a Wi-Fi kit logger and save/send the data to the defined plugin(s) 5 | """ 6 | import socket # Needed for talking to logger 7 | import sys 8 | import logging 9 | import logging.config 10 | import sys 11 | if sys.version[:1] == '2': 12 | import ConfigParser as configparser 13 | else: 14 | import configparser 15 | import optparse 16 | import os 17 | import re 18 | import errno 19 | from PluginLoader import Plugin 20 | import InverterMsg # Import the Msg handler 21 | import InverterLib # Import the library 22 | 23 | class InverterExport(object): 24 | """ 25 | Get data from the inverter(s) and store the data in a configured output 26 | format/location. 27 | 28 | """ 29 | 30 | config = None 31 | logger = None 32 | 33 | def __init__(self, config_file): 34 | # Load the setting 35 | config_files = [InverterLib.expand_path('config-default.cfg'), 36 | InverterLib.expand_path(config_file)] 37 | 38 | self.config = configparser.RawConfigParser() 39 | self.config.read(config_files) 40 | 41 | # add command line option -p / --plugins to override the output plugins used 42 | parser = optparse.OptionParser() 43 | parser.add_option('-p', '--plugins', 44 | action="store", dest="plugins", 45 | help="output plugins to use") 46 | 47 | self.options, self.args = parser.parse_args() 48 | 49 | def run(self): 50 | """Get information from inverter and store is configured outputs.""" 51 | 52 | self.build_logger(self.config) 53 | 54 | # Load output plugins 55 | # Prepare path for plugin loading 56 | sys.path.append(InverterLib.expand_path('outputs')) 57 | 58 | Plugin.config = self.config 59 | Plugin.logger = self.logger 60 | 61 | enabled_plugins = self.config.get('general', 'enabled_plugins')\ 62 | .split(',') 63 | 64 | # if -p / --plugin option giving at command line, override enabled plugins 65 | if self.options.plugins: 66 | enabled_plugins = self.options.plugins.split(',') 67 | 68 | for plugin_name in enabled_plugins: 69 | plugin_name = plugin_name.strip() 70 | self.logger.debug('Importing output plugin ' + plugin_name) 71 | __import__(plugin_name) 72 | 73 | # Connect to logger 74 | if not self.config.has_option('server', 'listen_address'): 75 | self.logger.error('no listen address defined in configuration file, exiting.') 76 | return [] 77 | 78 | if not self.config.has_option('server', 'listen_port'): 79 | self.logger.error('no listen port defined in configuration file, exiting.') 80 | return [] 81 | 82 | port = int(self.config.get('server', 'listen_port')) 83 | liip = self.config.get('server', 'listen_address') 84 | 85 | self.logger.info('Start listening on IP: {0} and Port {1}'.format(liip, port)) 86 | self.logger.info('Use CTRL-Break to exit.') 87 | 88 | logger_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 89 | logger_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) 90 | logger_socket.bind((liip, port)) 91 | logger_socket.listen(1) 92 | 93 | while (True): 94 | # Wait for a connection 95 | self.logger.debug('waiting for a connection.') 96 | conn,addr = logger_socket.accept() 97 | 98 | self.logger.debug('connection from: {0}'.format(addr)) 99 | 100 | okflag = False 101 | while (not okflag): 102 | try: 103 | data = conn.recv(1024) 104 | #when disconnected 105 | if(len(data) == 0): 106 | self.logger.debug('Socket disconnected') 107 | okflag = True 108 | continue 109 | 110 | except socket.error as e: 111 | err = e.args[0] 112 | if err == errno.EAGAIN or err == errno.EWOULDBLOCK: 113 | sleep(1) 114 | self.logger.error('No data available. err = {0}'.format(err)) 115 | okflag = True 116 | continue 117 | else: 118 | # a "real" error occurred 119 | self.logger.error('Socket error. err = {0}'.format(err)) 120 | okflag = True 121 | continue 122 | 123 | if(len(data) < 13): 124 | self.logger.error("Too short frame received: {0} bytes".format(len(data))) 125 | okflag = True 126 | continue 127 | 128 | #dump raw data to log 129 | self.logger.debug('RAW received Packet (len={0}): '.format(len(data))+':'.join(hex(ord(chr(x)))[2:].zfill(2) for x in bytearray(data))+' '+re.sub('[^\x20-\x7f]', '', ''.join(chr(x) for x in bytearray(data)))) 130 | 131 | msg = InverterMsg.InverterMsg(data) 132 | 133 | #log DATA length 134 | self.logger.debug('DATA len={0}: '.format(msg.len)) 135 | 136 | if (msg.msg)[:9] == 'DATA SEND': 137 | self.logger.debug("Exit Status: {0}".format(msg.msg)) 138 | okflag = True 139 | continue 140 | 141 | if (msg.msg)[:11] == 'NO INVERTER': 142 | self.logger.debug("Inverter is in sleep mode: {0} received".format(msg.msg)) 143 | okflag = True 144 | continue 145 | 146 | self.logger.info("Inverter ID: {0}".format(msg.id)) 147 | if (msg.len > 140): 148 | self.logger.info("Inverter main firmware version: {0}".format(msg.main_fwver)) 149 | self.logger.info("Inverter slave firmware version: {0}".format(msg.slave_fwver)) 150 | self.logger.info("RUN State: {0}".format(msg.run_state)) 151 | 152 | for plugin in Plugin.plugins: 153 | self.logger.debug('Run plugin' + plugin.__class__.__name__) 154 | plugin.process_message(msg) 155 | 156 | def build_logger(self, config): 157 | # Build logger 158 | """ 159 | Build logger for this program 160 | 161 | 162 | Args: 163 | config: configparser with settings from file 164 | """ 165 | log_levels = dict(notset=0, debug=10, info=20, warning=30, error=40, critical=50) 166 | log_dict = { 167 | 'version': 1, 168 | 'formatters': { 169 | 'f': {'format': '%(asctime)s %(levelname)s %(message)s'} 170 | }, 171 | 'handlers': { 172 | 'none': {'class': 'logging.NullHandler'}, 173 | 'console': { 174 | 'class': 'logging.StreamHandler', 175 | 'formatter': 'f' 176 | }, 177 | 'file': { 178 | 'class': 'logging.FileHandler', 179 | 'filename': InverterLib.expand_path(config.get('log', 180 | 'filename')), 181 | 'formatter': 'f'}, 182 | }, 183 | 'loggers': { 184 | 'InverterLogger': { 185 | 'handlers': config.get('log', 'type').split(','), 186 | 'level': log_levels[config.get('log', 'level')] 187 | } 188 | } 189 | } 190 | logging.config.dictConfig(log_dict) 191 | self.logger = logging.getLogger('InverterLogger') 192 | 193 | def override_config(self, section, option, value): 194 | """Override config settings""" 195 | self.config.set(section, option, value) 196 | 197 | if __name__ == "__main__": 198 | inverter_exporter = InverterExport('config.cfg') 199 | inverter_exporter.run() 200 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /LiveStats.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | """InverterExport LiveStats 3 | 4 | Get data from the inverter logger and output to console. This is a small 5 | utility program that just changes the config to output anything to console. 6 | """ 7 | import InverterExport 8 | 9 | 10 | if __name__ == "__main__": 11 | inverter_exporter = InverterExport.InverterExport('config.cfg') 12 | 13 | inverter_exporter.override_config('general', 'enabled_plugins', 14 | 'ConsoleOutput') 15 | inverter_exporter.override_config('log', 'type', 'console') 16 | inverter_exporter.override_config('log', 'level', 'debug') 17 | inverter_exporter.run() 18 | -------------------------------------------------------------------------------- /PluginLoader.py: -------------------------------------------------------------------------------- 1 | # from https://gist.github.com/will-hart/5899567 2 | # Needs six module, run: pip install six 3 | from six import add_metaclass 4 | 5 | class PluginMount(type): 6 | """ 7 | A plugin mount point derived from: 8 | http://martyalchin.com/2008/jan/10/simple-plugin-framework/ 9 | Acts as a metaclass which creates anything inheriting from Plugin 10 | """ 11 | 12 | def __init__(cls, name, bases, attrs): 13 | """Called when a Plugin derived class is imported""" 14 | super(PluginMount, cls).__init__(name) 15 | 16 | if not hasattr(cls, 'plugins'): 17 | # Called when the metaclass is first instantiated 18 | cls.plugins = [] 19 | else: 20 | # Called when a plugin class is imported 21 | cls.register_plugin(cls) 22 | 23 | def register_plugin(cls, new_plugin): 24 | """Add the plugin to the plugin list and perform any registration 25 | logic""" 26 | 27 | # create a plugin instance and store it 28 | instance = new_plugin() 29 | 30 | # save the plugin reference 31 | cls.plugins.append(instance) 32 | 33 | @add_metaclass(PluginMount) 34 | class Plugin(object): 35 | """A plugin which must provide a process_message() method""" 36 | 37 | config = None 38 | logger = None 39 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Inverter Data Logger 2 | Inverter Data Logger is a small script for uploading data from a 3 | Omnik, Hosola, Goodwe, Solax, Ginlong, Samil, Sofar or Power-One 4 | Solar inverter, equipped with a wifi module or connected to a Wi-Fi data logger 5 | from [iGEN tech](http://solarmanpv.com/index_en.html), to a database, [Domoticz](http://domoticz.com/) 6 | and/or to [PVoutput.org](https://pvoutput.org/). 7 | 8 | This script is designed to be run as a cronjob (or scheduled tasks on Windows) every minute. 9 | Every time this script is run the data from the inverter(s) will be send to the enabled plugin(s). 10 | And with a five minute interval the data will also be uploaded to PVoutput.org as a live status when enabled. 11 | 12 | As an alternative a server script can be run which listens for incomming connections from the logger. 13 | 14 | ## Origin 15 | This is based on the original work of Wouter van der Zwan and includes some improvements made by others. 16 | 17 | ## Supported inverters 18 | - Users reported that this script works for wifi kits with a s/n starting with 602xxxxxx to 606xxxxxx. 19 | - Also tested with a Wifi kit in a Hosola inverter in the 611xxxxx/617xxxxx range. 20 | - Also works for newer 1601xxxxxx WiFi kit as used in the Omnik TL2 inverters. 21 | - Also works with iGEN Wi-Fi external loggers with s/n starting with 504xxxxxx 22 | 23 | With wifi kits in the range 601xxxxxx it is **not** possible to get the data directly from the 24 | inverter. So sniffing the data send to the Omnik portal is required, see [OmnikMQTT by 25 | wouterbaake](https://github.com/wouterbaake/OmnikMQTT) . 26 | 27 | Owners of a Wifi kit starting with s/n 402xxxxxxx should checkout 28 | [Omnikol-PV-Logger by t3kpunk](https://github.com/t3kpunk/Omniksol-PV-Logger). 29 | 30 | ## Installation and Setup 31 | * Install Python (tested with python-2.7.14 and python-3.6.4) 32 | * Git clone the source with `git clone https://github.com/XtheOne/Inverter-Data-Logger.git` 33 | * Install python libs: `pip install six` and if you use MQTT install `pip install paho-mqtt` for PVoutput add: `pip install pytz` 34 | * Copy the `config-org.cfg` to `config.cfg` 35 | * Change the settings in `config.cfg` (See '[Configuration](#configuration)') 36 | * Test your settings with `python LiveStats.py`, when successful you should see data from your inverter. 37 | * Run the script with `python InverterExport.py` or better set a scheduled task or cronjob. (See '[Setting cronjob](#setting-cronjob)') 38 | * Or run the server script with `python InverterServer.py` 39 | 40 | ## Configuration 41 | 42 | open config.cfg 43 | 44 | There a few settings that you have to change to get a minimal working script: 45 | 46 | set a fixed IP for one or more inverters like the example, or let the script do a auto-scan: 47 | ``` 48 | [logger] 49 | # ip,sn,ip,sn,ip,sn or auto 50 | # IP address of your inverter(s) data logger and S/N of the wifi kit(s) 51 | #gateways = 192.168.1.10,602123456, 192.168.1.11,602987654 52 | # Automatically detect logger(s) on the local network 53 | gateways = auto 54 | # Default for the Wifi module/logger/gateway 55 | port = 8899 56 | # time to wait for inverter logger response 57 | timeout = 3 58 | ``` 59 | Besure that you have the S/N ready from the inverterm in case that you user the manual input. You can find it in the webpage of your inverter or on the inverter case. 60 | 61 | ### Setup Domoticz support 62 | To enable Domoticz support, enable the DomoticzOutput plugin in the config file. 63 | Then Create the following new hardware: 64 | * Name: Inverter Virtual 65 | * Type: Dummy (Does nothing, use for virtual switches only) 66 | * Data Timeout: Disabled 67 | 68 | Now Create the following Virtual Sensors: 69 | 70 | | Identifier | Sensor Type | Name | 71 | | ------------------------ | ---------------------------- | ---------------------- | 72 | | Electric_meter_idx | Electric (Instant + Counter) | Actual Output Power (after creation, set 'Type:' to 'Return' and 'Energy read:' to 'From device') | 73 | | PV1_voltage_idx | Voltage | DC Voltage PV1 | 74 | | PV2_voltage_idx | Voltage | DC Voltage PV2 | 75 | | PV1_current_idx | Ampere (1 Phase) | DC Current PV1 | 76 | | PV2_current_idx | Ampere (1 Phase) | DC Current PV2 | 77 | | AC1_voltage_idx | Voltage | AC Output Voltage | 78 | | AC1_current_idx | Ampere (1 Phase) | AC Output Current | 79 | | AC1_power_idx | Usage (Electric) | AC Output Power | 80 | | AC1_frequency_idx | Custom Sensor (Hertz) | AC Frequency | 81 | | --- Optional sensors --- | | | 82 | | Temp_idx | Temperature | Temperature | 83 | | H_total_idx | Custom Sensor (Hours) | Total run Hours | 84 | | PV123_voltage_idx | Ampere (3 Phase) | DC Voltage PV1/2/3 (No 3 phase voltage device exists...) | 85 | | PV123_current_idx | Ampere (3 Phase) | DC Current PV1/2/3 | 86 | | AC123_voltage_idx | Ampere (3 Phase) | AC 1/2/3 Output Voltage (No 3 phase voltage device exists...) | 87 | | AC123_current_idx | Ampere (3 Phase) | AC 1/2/3 Output Current | 88 | | AC123_power_idx | Usage (Electric) | AC Output Power (total for 3 phase inverter) | 89 | | E_today_idx | Custom Sensor (kWh) | Energy today | 90 | | E_total_idx | Custom Sensor (kWh) | Total Energy | 91 | | E_total_c_idx | Counter | Energy production (after creation, set Type to 'Energy Generated') | 92 | 93 | Now go to Devices and fill the Idx of these virtual sensors into the config file. 94 | This is for a single phase inverter with 2 PV strings and basic values, more virtual sensors can be added for other identifiers. 95 | 96 | ## Server config 97 | To use the Server script configure the listen IP and port and use these in the Wi-Fi-logger. 98 | Configure Remote Server B or C in the Wi-Fi- logger to point to the InverterServer IP and Port using TCP protocol. 99 | 100 | ### Setting cronjob 101 | #### For Linux/Unix 102 | This crontab line with these options this will execute the script every minute. 103 | * crontab -e 104 | * Add row: `* * * * * /usr/bin/python /home/username/Inverter-Data-Logger/InverterExport.py` 105 | 106 | #### For Windows 107 | This scheduled task with these options this will execute the script every minute. 108 | * Start (or My Computer) -> Control Panel -> Scheduled Tasks -> Add Scheduled Task -> 109 | or 110 | * Start -> All Programs -> Administrative Tools -> Task Scheduler -> Action -> New Task -> 111 | * General (tab) -> 112 | * Name: InverterExport 113 | * Description: Attempt to fire up the solar inverter exporter. 114 | * Select 'Run whether user is logged on or not' and 'Do not store password.' 115 | * Select 'Run with highest privileges.' 116 | * Triggers (tab) -> New -> 117 | * Begin the task: 'On a schedule' 118 | * Settings: 'Daily' '00:00:00 AM'. Recur every: 1 days. 119 | * Repeat task every: '1 minutes' for a duration of: '1 day' (or 'Indefinitely') 120 | * 'Enabled' 121 | * -> OK. 122 | * Actions (tab) -> New -> 123 | * Action: 'Start a program' 124 | * Program/script: C:\Inverter-Data-Logger\InverterExport.py 125 | * -> OK. 126 | * Conditions (tab) -> 127 | * choose your own options. 128 | * Settings (tab) -> 129 | * 'Allow task to be run on demand' 130 | * 'Stop the task if it runs longer than: '2 days' 131 | * If the task is already running, then the following rule applies: 'Do not start a new instance' 132 | * -> OK 133 | 134 | NOTE: If you need to kill the process manually: open Task Manager > Processes > Tick 'Show Processes from all users' > right click 'python.exe' > select 'End Process'. 135 | 136 | ### Why copy config-org.cfg, can't I edit it directly? 137 | Yes you can edit `config-org.cfg` directly. However, if you want to update the 138 | script your settings will be overwritten with the default values. By creating 139 | `config.cfg`, you can preserve your settings when upgrading. 140 | 141 | ## Development 142 | To help with development when no sun is present a small simulator script can be 143 | found in the folder Development. This script works by reading values from to 144 | database used by the MysqlOutput, but with the time shifted 6 hours back. To use 145 | the simulator, you should use the MysqlOutput to fill the database and configure 146 | database settings in de `sim-config.cfg` file. 147 | -------------------------------------------------------------------------------- /Resources/mysql.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 | -------------------------------------------------------------------------------- /Resources/postgresql.sql: -------------------------------------------------------------------------------- 1 | create table inverter_reading ( 2 | inverter text not null, 3 | timestamp timestamptz not null, 4 | kwh_total numeric not null, 5 | kwh_today numeric not null, 6 | inverter_temperature numeric not null, 7 | inverter_hours integer not null, 8 | 9 | pv1_voltage numeric not null, 10 | pv2_voltage numeric not null, 11 | pv3_voltage numeric not null, 12 | 13 | pv1_current numeric not null, 14 | pv2_current numeric not null, 15 | pv3_current numeric not null, 16 | 17 | ac1_voltage numeric not null, 18 | ac2_voltage numeric not null, 19 | ac3_voltage numeric not null, 20 | 21 | ac1_current numeric not null, 22 | ac2_current numeric not null, 23 | ac3_current numeric not null, 24 | 25 | ac1_frequency numeric not null, 26 | ac2_frequency numeric not null, 27 | ac3_frequency numeric not null, 28 | 29 | ac1_power numeric not null, 30 | ac2_power numeric not null, 31 | ac3_power numeric not null, 32 | 33 | primary key (inverter, timestamp) 34 | ); 35 | -------------------------------------------------------------------------------- /ScanLoggers.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | """Logger search program. 3 | 4 | Find an IGEN Wi-Fi kit logger and query the connected inverter(s). 5 | """ 6 | import socket # Needed for talking to logger 7 | import struct 8 | import sys 9 | import InverterMsg # Import the Msg handler 10 | import InverterLib # Import the library 11 | 12 | def get_inverter_sn(logger_sn, logger_ip): 13 | data = InverterLib.createV4RequestFrame(int(logger_sn)) 14 | # print >>sys.stdout, 'DATA = %s' % data 15 | logger_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 16 | logger_socket.settimeout(3) 17 | # Connect the socket to the port where the server is listening 18 | logger_socket.connect((logger_ip, 8899)) 19 | logger_socket.sendall(data) 20 | 21 | print >>sys.stdout, 'Listing Inverter(s) connected to this WiFi logger' 22 | okflag = False 23 | while (not okflag): 24 | data = logger_socket.recv(1500) 25 | msg = InverterMsg.InverterMsg(data) 26 | 27 | if (msg.msg)[:9] == 'DATA SEND': 28 | logger_socket.close() 29 | okflag = True 30 | continue 31 | 32 | print >>sys.stdout, 'Inverter SN = %s' % msg.id 33 | print >>sys.stdout, 'Inverter main firmware version: = %s' % msg.main_fwver 34 | print >>sys.stdout, 'Inverter slave firmware version: = %s' % msg.slave_fwver 35 | 36 | logger_socket.close() 37 | 38 | #main 39 | sys.stdout.write('This script will look for iGEN WiFi Kit loggers from SolarMAN PV\n') 40 | sys.stdout.write('List their IPs and S/Ns and connected inverters S/N\n') 41 | sys.stdout.write('These loggers are found in Omnik, Hosola, Ginlong, Kstar, Seasun, SolaX, Samil, Sofar, Trannergy\n') 42 | sys.stdout.write('and other Solar inverters\n') 43 | 44 | # Create the datagram socket 45 | sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) 46 | sock.bind((InverterLib.getNetworkIp(), 48899)) 47 | # Set a timeout so the socket does not block indefinitely when trying to receive data. 48 | sock.settimeout(6) 49 | # Set the time-to-live for messages to 1 so they do not go past the local network segment. 50 | ttl = struct.pack('b', 1) 51 | sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, ttl) 52 | sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) 53 | sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1) 54 | SendData = "WIFIKIT-214028-READ" # Lotto/TM = "AT+YZAPP=214028,READ" 55 | try: 56 | # Send data to the broadcast address 57 | sent = sock.sendto(SendData.encode('utf-8'), ('', 48899)) 58 | # Look for responses from all recipients 59 | while True: 60 | try: 61 | data, server = sock.recvfrom(1500) 62 | except socket.timeout: 63 | break 64 | else: 65 | if (data == SendData.encode('utf-8')): continue #skip sent data 66 | a = data.split(b',') 67 | logger_ip, logger_mac, logger_sn = a[0],a[1],a[2] 68 | sys.stdout.write('WiFi kit logger found, IP = %s and S/N = %s\n' % (logger_ip, logger_sn)) 69 | data = InverterLib.createV4RequestFrame(int(logger_sn)) 70 | logger_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 71 | logger_socket.settimeout(3) 72 | # Connect the socket to the port where the server is listening 73 | logger_socket.connect((logger_ip, 8899)) 74 | logger_socket.sendall(data) 75 | 76 | sys.stdout.write('Listing Inverter(s) connected to this WiFi logger\n') 77 | okflag = False 78 | while (not okflag): 79 | data = logger_socket.recv(1500) 80 | msg = InverterMsg.InverterMsg(data) 81 | 82 | if (msg.msg)[:9] == 'DATA SEND': 83 | logger_socket.close() 84 | okflag = True 85 | continue 86 | 87 | sys.stdout.write('Inverter SN = %s\n' % msg.id) 88 | sys.stdout.write('Inverter main firmware version: = %s\n') 89 | sys.stdout.write('Inverter slave firmware version: = %s\n' % msg.slave_fwver) 90 | 91 | logger_socket.close() 92 | 93 | finally: 94 | sys.stdout.write('closing socket, scanning done!\n') 95 | sock.close() 96 | sys.stdout.flush() 97 | -------------------------------------------------------------------------------- /config-org.cfg: -------------------------------------------------------------------------------- 1 | ################ 2 | ### Settings ### 3 | ################ 4 | 5 | [general] 6 | # General:enabled_plugins 7 | # Choose which outputs to use 8 | # Possible options: MysqlOutput,PostgreSQLOutput,PVoutputOutput,ConsoleOutput,CSVOutput,CSVOutput2File,DomoticzOutput,MQTTOutput 9 | enabled_plugins = ConsoleOutput 10 | 11 | # choose one of these 12 | # use temperature of inverter for output to pvoutput/mqtt 13 | use_temperature = true 14 | # do not use temperature of inverter for output to pvoutput/mqtt 15 | #use_temperature = false 16 | 17 | # Minimum Temperature for exporting. (a max. of 300 degrees is hardcoded) 18 | # Set to -32768 to always sent the temperature value. 19 | # Or set to a value so that the inverter internal temperature is only exported if equal or above this value. 20 | min_temp = 5 21 | 22 | # Minimum Voltage of any sensor for exporting. 23 | # Set to 0 to always sent the sensor's voltage value. 24 | # Or set to a value so that the sensor voltage data is only exported if equal or above this value. 25 | min_voltage = 0 26 | 27 | # Minimum grid Frequency for exporting. 28 | # Set to 0 to always sent the sensor's frequency value. 29 | # Or set to a value so that the grid Frequency is only exported if equal or above this value. 30 | min_freq = 30 31 | 32 | [server] 33 | # InverterServer parameters 34 | listen_address = 0.0.0.0 35 | listen_port = 10004 36 | 37 | [logger] 38 | # ip,sn,ip,sn,ip,sn or auto 39 | # IP address of your inverter(s) data logger and S/N of the wifi kit(s) 40 | #gateways = 192.168.1.10,602123456 41 | # Automatically detect logger(s) on the local network 42 | gateways = auto 43 | # Default for the Wifi module/logger/gateway 44 | port = 8899 45 | # time to wait for inverter logger response 46 | timeout = 3 47 | 48 | ### repeat this for every inverter ID that must be logged to pvoutput 49 | ### The apikey(s) and sysid(s) can be found at http://pvoutput.org/account.jsp 50 | [pvout] 51 | #use apikey- in the apikey name 52 | apikey-NLBN1234567A1234 = NOTAREALAPIKEY86e2258d4e29169fb79cf18b00 53 | #use sysid- in the sysid name 54 | sysid-NLBN1234567A1234 = 12345 55 | 56 | ### use domoticz- as section name 57 | ### repeat this section for every inverter ID that must be logged to domoticz 58 | ### Replace 'idx' with the Idx number of the corresponding virtual sensor device as defined in domoticz 59 | ### comment out values which can or must be skipped 60 | [domoticz-NLBN1234567A1234] 61 | host = 192.168.1.10 62 | port = 8080 63 | path = /json.htm 64 | # Replace 'idx' with the Idx number of the corresponding virtual sensor device as defined in domoticz 65 | Electric_meter_idx = idx 66 | # comment out below values which are not needed 67 | Temp_idx = idx 68 | #E_today_idx = idx 69 | #E_total_idx = idx 70 | #E_total_c_idx = idx 71 | #H_total_idx = idx 72 | ### DC input 73 | PV1_voltage_idx = idx 74 | PV1_current_idx = idx 75 | #use below when you have multiple PVs on your inverter 76 | #PV2_voltage_idx = idx 77 | #PV2_current_idx = idx 78 | #PV3_voltage_idx = idx 79 | #PV3_current_idx = idx 80 | #PV123_voltage_idx = idx 81 | #PV123_current_idx = idx 82 | ### AC output 83 | AC1_voltage_idx = idx 84 | AC1_current_idx = idx 85 | #AC1_power_idx = idx 86 | #AC1_frequency_idx = idx 87 | #use below when you have a 3-phase inverter 88 | #AC2_voltage_idx = idx 89 | #AC2_current_idx = idx 90 | #AC2_power_idx = idx 91 | #AC2_frequency_idx = idx 92 | #AC3_voltage_idx = idx 93 | #AC3_current_idx = idx 94 | #AC3_power_idx = idx 95 | #AC3_frequency_idx = idx 96 | #AC123_voltage_idx = idx 97 | #AC123_current_idx = idx 98 | #AC123_power_idx = idx 99 | 100 | [mysql] 101 | # Host where the mysql server is active 102 | host = 127.0.0.1 103 | user = 104 | pass = 105 | database = 106 | 107 | [postgresql] 108 | connstr = host=10.0.0.1 dbname=inverter user=inverter password=example 109 | 110 | [mqtt] 111 | # Host where the mqtt server is, including user/pass authentication 112 | host = 127.0.0.1 113 | port = 1883 114 | user = username 115 | pass = password 116 | topic = omnik/solar 117 | 118 | [csv] 119 | daily_file = false 120 | disable_header = false 121 | csv_file_name = filename.csv 122 | 123 | [log] 124 | # Log:Output 125 | # Possible options: none,console,file (combinations are possible) 126 | # Use none to disable logging 127 | type = console 128 | 129 | # Log:level 130 | # Possible options: critical, error, warning, info, debug, notset 131 | level = debug 132 | 133 | # Log:filename 134 | # Output file for file logger 135 | filename = inverter-export.log 136 | -------------------------------------------------------------------------------- /outputs/CSVOutput.py: -------------------------------------------------------------------------------- 1 | import PluginLoader 2 | from datetime import datetime 3 | 4 | 5 | class CSVOutput(PluginLoader.Plugin): 6 | """Outputs the data from the inverter logger 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.temp, 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_today*10)-(int(msg.e_today*10)))/10)+msg.e_total), msg.h_total)) 32 | -------------------------------------------------------------------------------- /outputs/CSVOutput2File.py: -------------------------------------------------------------------------------- 1 | import PluginLoader 2 | import os 3 | from datetime import datetime 4 | 5 | 6 | class CSVOutput(PluginLoader.Plugin): 7 | """Outputs the data from the inverter logger to stdout in csv format""" 8 | 9 | def process_message(self, msg): 10 | """Output the information from the inverter to stdout in csv format. 11 | 12 | Args: 13 | msg (InverterMsg.InverterMsg): Message to process 14 | """ 15 | if (self.config.getboolean('csv', 'daily_file')): 16 | csvfilename = datetime.now().strftime("%Y-%m-%d") + "_" + self.config.get('csv', 'csv_file_name') 17 | else: 18 | csvfilename = self.config.get('csv', 'csv_file_name') 19 | 20 | if (not os.path.exists(csvfilename)) & (not self.config.getboolean('csv', 'disable_header')): 21 | file = open(csvfilename, 'w') 22 | file.write ("DateTime,ID,Temp,VPV1,VPV2,VPV3,IPV1,IPV2,IPV3,IAC1,IAC2,IAC3," \ 23 | "VAC1,VAC2,VAC3,FAC1,PAC1,FAC2,PAC2,FAC3,PAC3," \ 24 | "ETODAY,ETOTAL,HTOTAL\n") 25 | else: 26 | file = open(csvfilename, 'a') 27 | 28 | timestamp = datetime.now().strftime('%Y-%m-%d %H:%M'); 29 | file.write (("{0},{1},{2},{3},{4},{5},{6},{7},{8},{9}," + 30 | "{10},{11},{12},{13},{14},{15},{16},{17},{18},{19}," + 31 | "{20},{21},{22},{23}\n")\ 32 | .format(timestamp, msg.id, msg.temp, 33 | msg.v_pv(1), msg.v_pv(2), msg.v_pv(3), 34 | msg.i_pv(1), msg.i_pv(2), msg.i_pv(3), 35 | msg.i_ac(1), msg.i_ac(2), msg.i_ac(3), 36 | msg.v_ac(1), msg.v_ac(2), msg.v_ac(3), 37 | msg.f_ac(1), msg.p_ac(1), 38 | msg.f_ac(2), msg.p_ac(2), 39 | msg.f_ac(3), msg.p_ac(3), 40 | msg.e_today, ((((msg.e_today*10)-(int(msg.e_today*10)))/10)+msg.e_total), msg.h_total)) 41 | -------------------------------------------------------------------------------- /outputs/ConsoleOutput.py: -------------------------------------------------------------------------------- 1 | import PluginLoader 2 | import sys 3 | 4 | class ConsoleOutput(PluginLoader.Plugin): 5 | """Outputs the data from the inverter logger 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 | sys.stdout.write('Inverter ID: {0}\n'.format(msg.id)) 14 | 15 | sys.stdout.write('E Today : {0:>5} Total: {1:<5}\n'.format(msg.e_today, ((((msg.e_today*10)-(int(msg.e_today*10)))/10)+msg.e_total))) 16 | sys.stdout.write('H Total : {0:>5} Temp : {1:<5}\n'.format(msg.h_total, msg.temp)) 17 | sys.stdout.write('errorMsg: {0:>5}\n'.format(msg.errorMsg)) 18 | 19 | sys.stdout.write('PV1 V: {0:>5} I: {1:>4}\n'.format(msg.v_pv(1), msg.i_pv(1))) 20 | sys.stdout.write('PV2 V: {0:>5} I: {1:>4}\n'.format(msg.v_pv(2), msg.i_pv(2))) 21 | sys.stdout.write('PV3 V: {0:>5} I: {1:>4}\n'.format(msg.v_pv(3), msg.i_pv(3))) 22 | 23 | sys.stdout.write('L1 P: {0:>5} V: {1:>5} I: {2:>4} F: {3:>5}\n'.format(msg.p_ac(1), msg.v_ac(1), msg.i_ac(1), msg.f_ac(1))) 24 | sys.stdout.write('L2 P: {0:>5} V: {1:>5} I: {2:>4} F: {3:>5}\n'.format(msg.p_ac(2), msg.v_ac(2), msg.i_ac(2), msg.f_ac(2))) 25 | sys.stdout.write('L3 P: {0:>5} V: {1:>5} I: {2:>4} F: {3:>5}\n'.format(msg.p_ac(3), msg.v_ac(3), msg.i_ac(3), msg.f_ac(3))) 26 | -------------------------------------------------------------------------------- /outputs/DomoticzOutput.py: -------------------------------------------------------------------------------- 1 | import PluginLoader 2 | import datetime 3 | import sys 4 | if sys.version[:1] == '2': 5 | import urllib 6 | import urllib2 7 | else: 8 | import urllib.request, urllib.parse, urllib.error 9 | 10 | class DomoticzOutput(PluginLoader.Plugin): 11 | """Sends the data from the inverter to Domoticz.""" 12 | 13 | def process_message(self, msg): 14 | """Send the information from the inverter to Domoticz. 15 | 16 | Args: 17 | msg (InverterMsg.InverterMsg): Message to process 18 | 19 | """ 20 | section_id = 'domoticz-'+msg.id 21 | if not self.config.has_section(section_id): 22 | self.logger.error('no section in configuration file for inverter with ID: {0}, skipping.'.format(msg.id)) 23 | return [] 24 | 25 | mt = int(self.config.get('general', 'min_temp'))-0.1 26 | mv = int(self.config.get('general', 'min_voltage'))-0.1 27 | mf = int(self.config.get('general', 'min_freq'))-0.1 28 | 29 | host = self.config.get(section_id, 'host') 30 | port = self.config.get(section_id, 'port') 31 | path = self.config.get(section_id, 'path') 32 | 33 | self.logger.info('Uploading data from inverter with ID: {0} to Domoticz'.format(msg.id)) 34 | 35 | #e_total is truncated to 1 digit, add 2nd digit from e_today. 36 | e_total = ((((msg.e_today*10)-(int(msg.e_today*10)))/10)+msg.e_total) 37 | 38 | # calculate total power for 3 phase inverter 39 | p_ac_t = 0 40 | if (msg.p_ac(1)<99999 and msg.p_ac(1)>0): p_ac_t = msg.p_ac(1) 41 | if (msg.p_ac(2)<99999 and msg.p_ac(2)>0): p_ac_t = p_ac_t + msg.p_ac(2) 42 | if (msg.p_ac(2)<99999 and msg.p_ac(3)>0): p_ac_t = p_ac_t + msg.p_ac(3) 43 | 44 | url = ("http://" + host + ":" + port + path) 45 | self.logger.debug('url: '+url) 46 | self.logger.debug('Temperature : '+str(msg.temp)+' degrees celcius') # err:514,7 47 | self.logger.debug('PV1 voltage : '+str(msg.v_pv(1))+' Volt') 48 | self.logger.debug('AC1 voltage : '+str(msg.v_ac(1))+' Volt') 49 | self.logger.debug('AC total power: '+str(p_ac_t)+' Watt') 50 | self.logger.debug('e_today : '+str(msg.e_today)+' kWh') 51 | self.logger.debug('msg.e_total : '+str(msg.e_total)+' kWh') 52 | self.logger.debug('e_total : '+str(e_total)+' kWh') 53 | 54 | # the inverter gives 0 for voltage and current when in sleep mode, don't send those values then to keep the graphs neat. 55 | data_idx_array = { 56 | self.config.get(section_id, 'Electric_meter_idx'): str(p_ac_t)+';'+str(e_total*1000), 57 | } 58 | # sometimes the inverter gives 514,7 as temperature, don't send temp then! 59 | if (mtmv and self.config.has_option(section_id, 'PV1_voltage_idx')): 110 | data_idx_array.update ({ 111 | self.config.get(section_id, 'PV1_voltage_idx'): msg.v_pv(1), 112 | }) 113 | else: self.logger.debug('PV1 voltage out of range, or not defined: '+str(msg.v_pv(1))+' Volts') 114 | if (msg.v_pv(2)>mv and self.config.has_option(section_id, 'PV2_voltage_idx')): 115 | data_idx_array.update ({ 116 | self.config.get(section_id, 'PV2_voltage_idx'): msg.v_pv(2), 117 | }) 118 | else: self.logger.debug('PV2 voltage out of range, or not defined: '+str(msg.v_pv(2))+' Volts') 119 | if (msg.v_pv(3)>mv and self.config.has_option(section_id, 'PV3_voltage_idx')): 120 | data_idx_array.update ({ 121 | self.config.get(section_id, 'PV3_voltage_idx'): msg.v_pv(3), 122 | }) 123 | else: self.logger.debug('PV3 voltage out of range, or not defined: '+str(msg.v_pv(3))+' Volts') 124 | if (self.config.has_option(section_id, 'PV123_voltage_idx')): 125 | data_idx_array.update ({ 126 | self.config.get(section_id, 'PV123_voltage_idx'): str(msg.v_pv(1))+';'+str(msg.v_pv(2))+';'+str(msg.v_pv(3)), 127 | }) 128 | else: self.logger.debug('PV1/2/3 voltage not defined: '+str(msg.v_pv(1))+'/'+str(msg.v_pv(2))+'/'+str(msg.v_pv(3))+' Volts') 129 | # Send i_ac(1-3) 130 | if (msg.i_ac(1)<30 and self.config.has_option(section_id, 'AC1_current_idx')): 131 | data_idx_array.update ({ 132 | self.config.get(section_id, 'AC1_current_idx'): msg.i_ac(1), 133 | }) 134 | else: self.logger.debug('AC1 current out of range, or not defined: '+str(msg.i_ac(1))+' Ampere') 135 | if (msg.i_ac(2)<30 and self.config.has_option(section_id, 'AC2_current_idx')): 136 | data_idx_array.update ({ 137 | self.config.get(section_id, 'AC2_current_idx'): msg.i_ac(2), 138 | }) 139 | else: self.logger.debug('AC2 current out of range, or not defined: '+str(msg.i_ac(2))+' Ampere') 140 | if (msg.i_ac(3)<30 and self.config.has_option(section_id, 'AC3_current_idx')): 141 | data_idx_array.update ({ 142 | self.config.get(section_id, 'AC3_current_idx'): msg.i_ac(3), 143 | }) 144 | else: self.logger.debug('AC3 current out of range, or not defined: '+str(msg.i_ac(3))+' Ampere') 145 | if (self.config.has_option(section_id, 'AC123_current_idx')): 146 | data_idx_array.update ({ 147 | self.config.get(section_id, 'AC123_current_idx'): str(msg.i_ac(1))+';'+str(msg.i_ac(2))+';'+str(msg.i_ac(3)), 148 | }) 149 | else: self.logger.debug('AC1/2/3 current not defined: '+str(msg.i_ac(1))+'/'+str(msg.i_ac(2))+'/'+str(msg.i_ac(3))+' Ampere') 150 | # Send v_ac(1-3) 151 | if (msg.v_ac(1)>mv and self.config.has_option(section_id, 'AC1_voltage_idx')): # drops to 0V when in sleep mode 152 | data_idx_array.update ({ 153 | self.config.get(section_id, 'AC1_voltage_idx'): msg.v_ac(1), 154 | }) 155 | else: self.logger.debug('AC1 voltage out of range, or not defined: '+str(msg.v_ac(1))+' Volt') 156 | if (msg.v_ac(2)>mv and self.config.has_option(section_id, 'AC2_voltage_idx')): # drops to 0V when in sleep mode 157 | data_idx_array.update ({ 158 | self.config.get(section_id, 'AC2_voltage_idx'): msg.v_ac(2), 159 | }) 160 | else: self.logger.debug('AC2 voltage out of range, or not defined: '+str(msg.v_ac(2))+' Volt') 161 | if (msg.v_ac(3)>mv and self.config.has_option(section_id, 'AC3_voltage_idx')): # drops to 0V when in sleep mode 162 | data_idx_array.update ({ 163 | self.config.get(section_id, 'AC3_voltage_idx'): msg.v_ac(3), 164 | }) 165 | else: self.logger.debug('AC3 voltage out of range, or not defined: '+str(msg.v_ac(3))+' Volt') 166 | if (self.config.has_option(section_id, 'AC123_voltage_idx')): 167 | data_idx_array.update ({ 168 | self.config.get(section_id, 'AC123_voltage_idx'): str(msg.v_ac(1))+';'+str(msg.v_ac(2))+';'+str(msg.v_ac(3)), 169 | }) 170 | else: self.logger.debug('AC1/2/3 voltage not defined: '+str(msg.v_ac(1))+'/'+str(msg.v_ac(2))+'/'+str(msg.v_ac(3))+' Volts') 171 | # Send p_ac(1-3) 172 | if (msg.p_ac(1)<99999 and self.config.has_option(section_id, 'AC1_power_idx')): 173 | data_idx_array.update ({ 174 | self.config.get(section_id, 'AC1_power_idx'): msg.p_ac(1), 175 | }) 176 | else: self.logger.debug('AC1 power out of range, or not defined: '+str(msg.p_ac(1))+' Watt') 177 | if (msg.p_ac(2)<99999 and self.config.has_option(section_id, 'AC2_power_idx')): 178 | data_idx_array.update ({ 179 | self.config.get(section_id, 'AC2_power_idx'): msg.p_ac(2), 180 | }) 181 | else: self.logger.debug('AC2 power out of range, or not defined: '+str(msg.p_ac(2))+' Watt') 182 | if (msg.p_ac(3)<99999 and self.config.has_option(section_id, 'AC3_power_idx')): 183 | data_idx_array.update ({ 184 | self.config.get(section_id, 'AC3_power_idx'): msg.p_ac(3), 185 | }) 186 | else: self.logger.debug('AC3 power out of range, or not defined: '+str(msg.p_ac(3))+' Watt') 187 | if (self.config.has_option(section_id, 'AC123_power_idx')): 188 | data_idx_array.update ({ 189 | self.config.get(section_id, 'AC123_power_idx'): p_ac_t, 190 | }) 191 | else: self.logger.debug('AC123 power not defined: '+str(p_ac_t)+' Watt') 192 | # Send f_ac(1-3) 193 | if (mf