Skip to content

Goodwe Connector

GoodweApi

Bases: GoodweApiAuth

summary

Source code in goodwe_connector/goodwe_api.py
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
class GoodweApi(GoodweApiAuth):
    """_summary_
    """

    def __init__(self,
                 system_id:str, 
                 account:str, 
                 password:str, 
                 logging=False,
                 http_client=None) -> None:

        self.__n_max_request_retry = 5

        super().__init__(system_id, account, password, logging, http_client=http_client)

    def __call(self, url, payload) -> dict:

        try:

            if not self._authorization():
                return None

            headers = {
                'User-Agent': 'SEMS Portal/3.1 (iPhone; iOS 13.5.1; Scale/2.00)',
                'Token': self._credentials,
            }

            request = self._http_client.post(
                self.base_url + url,
                payload=payload,
                headers=headers,
                timeout=10)

            request.raise_for_status()

            self._logger.info(f'Method request elapsed seconds: {request.elapsed}')

            data = request.json()
            request.close()

            return data['data']

        except JSONDecodeError as json_decoder_error:
            self._logger.warning(f'{json_decoder_error}')
            return None

        except RequestException as e:
            self._logger.warning(f'{e}')
            return None

    def _request_daily_generation(self, payload: dict) -> dict:
        count_request = 0
        data = {}

        while(not data and count_request < self.__n_max_request_retry):
            count_request += 1
            method = GetPowerStationPowerAndIncomeByDay
            data = self.__call(method, payload)

            if not data:
                self._logger.warning(f'Request count={count_request}, Method: {method}, missing data.')

        return data

    # TODO: Pending to move this logic to power_generation_per_day.py
    def get_power_generation_per_day(self, date:datetime) -> dict:
        """_summary_

        Args:
            date (datetime): _description_

        Returns:
            float: _description_
        """

        payload = {
            'powerstation_id' : self.system_id,
            'date' : date.strftime('%Y-%m-%d'),
            'count': 1,
        }

        data = self._request_daily_generation(payload)

        return parse_daily_generation(data, date)

    # TODO: Pending to move this logic to power_generation_between_dates_to_csv.py
    def get_power_generation_between_dates_to_csv(self, 
                                           start_date:datetime, 
                                           end_date:datetime,
                                           file_name:str,
                                           show_info:bool = True) -> None:
        generation = {}
        total_days = (end_date - start_date).days + 1

        if total_days <= 0:
            write_generation_to_csv(generation, file_name)
            if show_info:
                print(format_generation_summary(generation))
            return

        payload = {
            'powerstation_id' : self.system_id,
            'date' : end_date.strftime('%Y-%m-%d'),
            'count': total_days,
        }

        data = self._request_daily_generation(payload)
        generation = parse_generation_series(data, start_date, end_date)

        write_generation_to_csv(generation, file_name)

        if show_info:
            print(format_generation_summary(generation))

    # TODO: Pending to move this logic to power_generation_between_dates.py
    def get_power_generation_between_dates(self, 
                                           start_date:datetime, 
                                           end_date:datetime) -> dict:
        total_days = (end_date - start_date).days + 1
        generation = {}

        if total_days <= 0:
            print(format_generation_summary(generation))
            return generation

        payload = {
            'powerstation_id' : self.system_id,
            'date' : end_date.strftime('%Y-%m-%d'),
            'count': total_days,
        }

        data = self._request_daily_generation(payload)
        generation = parse_generation_series(data, start_date, end_date)

        print(format_generation_summary(generation))

        return generation

    def get_power_station_generated_every_five_minutes_per_day(self, date:datetime) -> dict:

        day_powers = {} 

        day = date.strftime('%Y-%m-%d')

        payload = {
            'id' : self.system_id,
            'date' : day
        }

        count_request = 0
        data = {}

        while(not data and count_request < self.__n_max_request_retry):

            count_request += 1
            method = GetPowerStationPacByDayForApp
            data = self.__call(method, payload)

            if not data:
                self._logger.warning(f'Request count={count_request}, Method: {method}, missing data.')

        if (not data or "pacs" not in data or not data['pacs']):

            day_powers['NO_DATA'] = 0

            return day_powers

        for item in data['pacs']:

            aux_date = date.strptime(item['date'], '%m/%d/%Y %H:%M:%S')
            key_day = aux_date.strftime('%Y-%m-%d %H:%M:%S')

            day_powers[key_day] = int(item['pac'])

        return day_powers

    def get_power_station_monitor_detail(self, year:int, month:int) -> dict:

        data_returned = {} 

        if year < 0 or month < 1 or month > 12:
            print(f'Error! Month: {month}. Year: {year}')
            return data_returned

        print(f'Month : {month} | Year: {year}')

        date = datetime(year=year, month=month, day=1)
        date_str = date.strftime("%Y-%m-%d")

        payload = {
            # "date": "2023-04-1",
            'date' : date_str,
            "is_report": 2,
            "page_index": 1,
            "page_size": 5
        }

        count_request = 0
        data = {}

        while(not data and count_request < self.__n_max_request_retry):

            count_request += 1
            method = ReportDataV1GetPowerStationPowerReportDetialByMonth
            data = self.__call(method, payload)

            if not data:
                self._logger.warning(f'Request count={count_request}, Method: {method}, missing data.')

        if (not data):

            data_returned['NO_DATA'] = 0

            return data_returned

        power_stations_info = []

        # print(json.dumps(data, indent=2))

        for item in data['list']:
            power_stations_info.append({
                'PowerStationId': item['pw_id'],
                'PowerStationOwnerId': item['owner_id'],
                'PowerStationInformation' :  item['pw_name'],
                'PowerStationAddress' :  item['address'],
                'PowerStationKwCapacity' :  item['capacity'],
                'PowerStationMonthPower' :  item['month_power'],
                'PowerStationTotalPower' :  item['total_power'],
                'ContactEmail' :  item['email'],
            })

        return power_stations_info

get_power_generation_per_day(date)

summary

Parameters:

Name Type Description Default
date datetime

description

required

Returns:

Name Type Description
float dict

description

Source code in goodwe_connector/goodwe_api.py
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def get_power_generation_per_day(self, date:datetime) -> dict:
    """_summary_

    Args:
        date (datetime): _description_

    Returns:
        float: _description_
    """

    payload = {
        'powerstation_id' : self.system_id,
        'date' : date.strftime('%Y-%m-%d'),
        'count': 1,
    }

    data = self._request_daily_generation(payload)

    return parse_daily_generation(data, date)