0.2.7: Status interval retrieved via PVOutput API

SunGather/config-example.yaml

@@ -117,8 +117,8 @@ exports:
     enabled: False                          # [Optional] Default is False
     api: "xxxxx"                            # [Required] API Key, Settings > API Key
     sid: "xxxxx"                            # [Optional] System ID, Settings > Registered Systems > System ID
+    # join_team: False                      # [Optional] Default True, This will join the SunGather team in PVOutput, Setting to False will leave the team if previously joined
     rate_limit: 60                          # [Optional] Default 60, 60 for regular accounts, 300 for donation accounts
-    status_interval: 5                      # [Optional] Default 5, In minutes, options are 5 ,10,15 minute intervals: https://pvoutput.org/help/live_data.html
     batch_points: 1                         # [Optional] Default 1, how many data points to batch upload, 
                                             # Time between uploads will be status_interval * batch_points. e.g. status_invterval of 5min, and batch_points of 12 will upload to PVOutput Hourly (5 * 12 = 60 mins)
     parameters:                             # [Required] v1 & v3 or v2 & v4 minimum. See: https://pvoutput.org/help/api_specification.html#power-and-energy-calculation

SunGather/exports/pvoutput.py

@@ -1,16 +1,23 @@
 import logging
 import requests
 import datetime
+import json
 
 # Configure PVOutput
 class export_pvoutput(object):
     def __init__(self):
+        self._isConfigured = False
         self.api_key = None
         self.system_id = None
-        self.statusbatch_url = "https://pvoutput.org/service/r2/addbatchstatus.jsp"
+        self.url_base = "https://pvoutput.org/service/r2/"
+        self.url_addbatchstatus = self.url_base + "addbatchstatus.jsp"
+        self.url_jointeam = self.url_base + "jointeam.jsp"
+        self.url_leaveteam = self.url_base + "leaveteam.jsp"
+        self.url_getsystem = self.url_base + "getsystem.jsp"
         self.rate_limit = None
         self.parameters = []
         self.latest_run = None
+        self.tid = '1618'
 
     @property
     def headers(self):
@@ -33,13 +40,49 @@ class export_pvoutput(object):
 
         for parameter in config.get('parameters'):
             self.parameters.append(parameter)
+        try:
+            logging.debug(f"PVOutput: Get System ; {self.url_getsystem}, {str(self.headers)}, 'teams': '1'")
+            response = requests.post(url=self.url_getsystem,headers=self.headers, params={'teams': '1'})
+            logging.debug(f"PVOutput: Response; {str(response.status_code)} Message; {str(response.content)}")
 
-        if not (self.status_interval == 5 or self.status_interval == 10 or self.status_interval == 15):
-            logging.warning("Status Invterval is invalid, valid options are 5, 10 and 15 minutes")
+            if response.status_code == 200:            
+                retload = response.content.decode()
+                system = retload.split(';')[0]
+                teams = retload.split(';')[2]
+
+                invertername = system.split(',')[0]
+                self.status_interval = int(system.split(',')[15])
+
+                team_member = False
+                for team in teams.split(','):
+                    if team == self.tid:
+                        team_member = True
+            else:
+                logging.error(f"PVOutput: System Status Failed; {str(response.status_code)} Message; {str(response.content)}")
+        
+        except Exception as err:
+            logging.error(f"PVOutput: Failed to configure with error: {err}")
             return False
 
-        logging.info("PVOutput: Configured")
-        return True
+        join_team = config.get('join_team',True)
+        try:
+            if not team_member and join_team:
+                logging.debug(f"PVOutput: Join Team; {self.url_jointeam}, {str(self.headers)}, 'tid': '{self.tid}'")
+                response = requests.post(url=self.url_jointeam,headers=self.headers, params={'tid': self.tid})
+                logging.debug(f"PVOutput: Response; {str(response.status_code)} Message; {str(response.content)}")
+            elif team_member and not join_team:
+                logging.debug(f"PVOutput: Leave Team; {self.url_leaveteam}, {str(self.headers)}, 'tid': '{self.tid}'")
+                response = requests.post(url=self.url_leaveteam,headers=self.headers, params={'tid': self.tid})
+                logging.debug(f"PVOutput: Response; {str(response.status_code)} Message; {str(response.content)}")  
+        except Exception as err:
+            logging.error(f"PVOutput: Team Membership update failed: {err}")
+        
+        if not response.status_code == 200:
+            logging.error(f"PVOutput: Team update Failed; {str(response.status_code)} Message; {str(response.content)}")
+
+        logging.info(f"PVOutput: Configured export to {invertername} every {self.status_interval} minutes")
+        self._isConfigured = True
+        return self._isConfigured
 
     def publish(self, inverter):
         """
@@ -137,9 +180,9 @@ class export_pvoutput(object):
                 if 'cumulative_energy' in locals():
                     payload['c1'] = cumulative_energy
 
-                logging.debug("PVOutput: Request; " + self.statusbatch_url + ", " + str(self.headers) + " : " + str(payload))
+                logging.debug("PVOutput: Request; " + self.url_addbatchstatus + ", " + str(self.headers) + " : " + str(payload))
 
-                response = requests.post(url=self.statusbatch_url, headers=self.headers, params=payload)
+                response = requests.post(url=self.url_addbatchstatus, headers=self.headers, params=payload)
                 self.batch_count = 0
 
                 if response.status_code != requests.codes.ok:
@@ -150,6 +193,4 @@ class export_pvoutput(object):
             else:
                 logging.info("PVOutput: Data added to next batch upload")
 
-        self.latest_run = now
-
-
+        self.latest_run = now

SunGather/version.py

@@ -1 +1 @@
-__version__ = '0.2.6'
+__version__ = '0.2.7'