1 2 3 4 5 6 7 8 9 10 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 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
|
import warnings
from datetime import date, timedelta
from . import GrowattApi
import platform
from .exceptions import GrowattParameterError, GrowattV1ApiError
class OpenApiV1(GrowattApi):
"""
Extended Growatt API client with V1 API support.
This class extends the base GrowattApi class with methods for MIN inverters using
the public V1 API described here: https://www.showdoc.com.cn/262556420217021/0
"""
def _create_user_agent(self):
python_version = platform.python_version()
system = platform.system()
release = platform.release()
machine = platform.machine()
user_agent = f"Python/{python_version} ({system} {release}; {machine})"
return user_agent
def __init__(self, token):
"""
Initialize the Growatt API client with V1 API support.
Args:
token (str): API token for authentication (required for V1 API access).
"""
# Initialize the base class
super().__init__(agent_identifier=self._create_user_agent())
# Add V1 API specific properties
self.api_url = f"{self.server_url}v1/"
# Set up authentication for V1 API using the provided token
self.session.headers.update({"token": token})
def _process_response(self, response, operation_name="API operation"):
"""
Process API response and handle errors.
Args:
response (dict): The JSON response from the API
operation_name (str): Name of the operation for error messages
Returns:
dict: The 'data' field from the response
Raises:
GrowattV1ApiError: If the API returns an error response
"""
if response.get('error_code', 1) != 0:
raise GrowattV1ApiError(
f"Error during {operation_name}",
error_code=response.get('error_code'),
error_msg=response.get('error_msg', 'Unknown error')
)
return response.get('data')
def _get_url(self, page):
"""
Simple helper function to get the page URL for v1 API.
"""
return self.api_url + page
def plant_list(self):
"""
Get a list of all plants with detailed information.
Returns:
dict: A dictionary containing plants information with 'count' and 'plants' keys.
Raises:
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
# Prepare request data
request_data = {
'page': '',
'perpage': '',
'search_type': '',
'search_keyword': ''
}
# Make the request
response = self.session.get(
url=self._get_url('plant/list'),
data=request_data
)
return self._process_response(response.json(), "getting plant list")
def plant_details(self, plant_id):
"""
Get basic information about a power station.
Args:
plant_id (int): Power Station ID
Returns:
dict: A dictionary containing the plant details.
Raises:
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
response = self.session.get(
self._get_url('plant/details'),
params={'plant_id': plant_id}
)
return self._process_response(response.json(), "getting plant details")
def plant_energy_overview(self, plant_id):
"""
Get an overview of a plant's energy data.
Args:
plant_id (int): Power Station ID
Returns:
dict: A dictionary containing the plant energy overview.
Raises:
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
response = self.session.get(
self._get_url('plant/data'),
params={'plant_id': plant_id}
)
return self._process_response(response.json(), "getting plant energy overview")
def plant_power_overview(self, plant_id: int, day: str | date = None) -> dict:
"""
Obtain power data of a certain power station.
Get the frequency once every 5 minutes
Args:
plant_id (int): Power Station ID
day (date): Date - defaults to today
Returns:
dict: A dictionary containing the plants power data.
.. code-block:: python
{
'count': int, # Total number of records
'powers': list[dict], # List of power data entries
# Each entry in 'powers' is a dictionary with:
# 'time': str, # Time of the power reading
# 'power': float | None # Power value in Watts (can be None)
}
Raises:
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
API-Doc: https://www.showdoc.com.cn/262556420217021/1494062656174173
"""
if day is None:
day = date.today()
response = self.session.get(
self._get_url('plant/power'),
params={
'plant_id': plant_id,
'date': day,
}
)
return self._process_response(response.json(), "getting plant power overview")
def plant_energy_history(self, plant_id, start_date=None, end_date=None, time_unit="day", page=None, perpage=None):
"""
Retrieve plant energy data for multiple days/months/years.
Args:
plant_id (int): Power Station ID
start_date (date, optional): Start Date - defaults to today
end_date (date, optional): End Date - defaults to today
time_unit (str, optional): Time unit ('day', 'month', 'year') - defaults to 'day'
page (int, optional): Page number - defaults to 1
perpage (int, optional): Number of items per page - defaults to 20, max 100
Returns:
dict: A dictionary containing the plant energy history.
Notes:
- When time_unit is 'day', date interval cannot exceed 7 days
- When time_unit is 'month', start date must be within same or previous year
- When time_unit is 'year', date interval must not exceed 20 years
Raises:
GrowattParameterError: If date parameters are invalid.
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
if start_date is None and end_date is None:
start_date = date.today()
end_date = date.today()
elif start_date is None:
start_date = end_date
elif end_date is None:
end_date = start_date
# Validate date ranges based on time_unit
if time_unit == "day" and (end_date - start_date).days > 7:
warnings.warn(
"Date interval must not exceed 7 days in 'day' mode.", RuntimeWarning)
elif time_unit == "month" and (end_date.year - start_date.year > 1):
warnings.warn(
"Start date must be within same or previous year in 'month' mode.", RuntimeWarning)
elif time_unit == "year" and (end_date.year - start_date.year > 20):
warnings.warn(
"Date interval must not exceed 20 years in 'year' mode.", RuntimeWarning)
response = self.session.get(
self._get_url('plant/energy'),
params={
'plant_id': plant_id,
'start_date': start_date.strftime("%Y-%m-%d"),
'end_date': end_date.strftime("%Y-%m-%d"),
'time_unit': time_unit,
'page': page,
'perpage': perpage
}
)
return self._process_response(response.json(), "getting plant energy history")
def device_list(self, plant_id):
"""
Get devices associated with plant.
Note:
returned "device_type" mappings:
1: inverter (including MAX)
2: storage
3: other
4: max (single MAX)
5: sph
6: spa
7: min (including TLX)
8: pcs
9: hps
10: pbd
Args:
plant_id (int): Power Station ID
Returns:
DeviceList
e.g.
{
"data": {
"count": 3,
"devices": [
{
"device_sn": "ZT00100001",
"last_update_time": "2018-12-13 11:03:52",
"model": "A0B0D0T0PFU1M3S4",
"lost": True,
"status": 0,
"manufacturer": "Growatt",
"device_id": 116,
"datalogger_sn": "CRAZT00001",
"type": 1
},
]
},
"error_code": 0,
"error_msg": ""
}
"""
response = self.session.get(
url=self._get_url("device/list"),
params={
"plant_id": plant_id,
"page": "",
"perpage": "",
},
)
return self._process_response(response.json(), "getting device list")
def min_detail(self, device_sn):
"""
Get detailed data for a MIN inverter.
Args:
device_sn (str): The serial number of the MIN inverter.
Returns:
dict: A dictionary containing the MIN inverter details.
Raises:
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
response = self.session.get(
self._get_url('device/tlx/tlx_data_info'),
params={
'device_sn': device_sn
}
)
return self._process_response(response.json(), "getting MIN inverter details")
def min_energy(self, device_sn):
"""
Get energy data for a MIN inverter.
Args:
device_sn (str): The serial number of the MIN inverter.
Returns:
dict: A dictionary containing the MIN inverter energy data.
Raises:
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
response = self.session.post(
url=self._get_url("device/tlx/tlx_last_data"),
data={
"tlx_sn": device_sn,
},
)
return self._process_response(response.json(), "getting MIN inverter energy data")
def min_energy_history(self, device_sn, start_date=None, end_date=None, timezone=None, page=None, limit=None):
"""
Get MIN inverter data history.
Args:
device_sn (str): The ID of the MIN inverter.
start_date (date, optional): Start date. Defaults to today.
end_date (date, optional): End date. Defaults to today.
timezone (str, optional): Timezone ID.
page (int, optional): Page number.
limit (int, optional): Results per page.
Returns:
dict: A dictionary containing the MIN inverter history data.
Raises:
GrowattParameterError: If date interval is invalid (exceeds 7 days).
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
if start_date is None and end_date is None:
start_date = date.today()
end_date = date.today()
elif start_date is None:
start_date = end_date
elif end_date is None:
end_date = start_date
# check interval validity
if end_date - start_date > timedelta(days=7):
raise GrowattParameterError("date interval must not exceed 7 days")
response = self.session.post(
url=self._get_url('device/tlx/tlx_data'),
data={
"tlx_sn": device_sn,
"start_date": start_date.strftime("%Y-%m-%d"),
"end_date": end_date.strftime("%Y-%m-%d"),
"timezone_id": timezone,
"page": page,
"perpage": limit,
}
)
return self._process_response(response.json(), "getting MIN inverter energy history")
def min_settings(self, device_sn):
"""
Get settings for a MIN inverter.
Args:
device_sn (str): The serial number of the MIN inverter.
Returns:
dict: A dictionary containing the MIN inverter settings.
Raises:
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
response = self.session.get(
self._get_url('device/tlx/tlx_set_info'),
params={
'device_sn': device_sn
}
)
return self._process_response(response.json(), "getting MIN inverter settings")
def min_read_parameter(self, device_sn, parameter_id, start_address=None, end_address=None):
"""
Read setting from MIN inverter.
Args:
device_sn (str): The ID of the TLX inverter.
parameter_id (str): Parameter ID to read. Don't use start_address and end_address if this is set.
start_address (int, optional): Register start address (for set_any_reg). Don't use parameter_id if this is set.
end_address (int, optional): Register end address (for set_any_reg). Don't use parameter_id if this is set.
Returns:
dict: A dictionary containing the setting value.
Raises:
GrowattParameterError: If parameters are invalid.
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
if parameter_id is None and start_address is None:
raise GrowattParameterError(
"specify either parameter_id or start_address/end_address")
elif parameter_id is not None and start_address is not None:
raise GrowattParameterError(
"specify either parameter_id or start_address/end_address - not both."
)
elif parameter_id is not None:
# named parameter
start_address = 0
end_address = 0
else:
# using register-number mode
parameter_id = "set_any_reg"
if start_address is None:
start_address = end_address
if end_address is None:
end_address = start_address
response = self.session.post(
self._get_url('readMinParam'),
data={
"device_sn": device_sn,
"paramId": parameter_id,
"startAddr": start_address,
"endAddr": end_address,
}
)
return self._process_response(response.json(), f"reading parameter {parameter_id}")
def min_write_parameter(self, device_sn, parameter_id, parameter_values=None):
"""
Set parameters on a MIN inverter.
Args:
device_sn (str): Serial number of the inverter
parameter_id (str): Setting type to be configured
parameter_values: Parameter values to be sent to the system.
Can be a single string (for param1 only),
a list of strings (for sequential params),
or a dictionary mapping param positions to values
Returns:
dict: JSON response from the server
Raises:
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
# Initialize all parameters as empty strings
parameters = {i: "" for i in range(1, 20)}
# Process parameter values based on type
if parameter_values is not None:
if isinstance(parameter_values, (str, int, float, bool)):
# Single value goes to param1
parameters[1] = str(parameter_values)
elif isinstance(parameter_values, list):
# List of values go to sequential params
for i, value in enumerate(parameter_values, 1):
if i <= 19: # Only use up to 19 parameters
parameters[i] = str(value)
elif isinstance(parameter_values, dict):
# Dict maps param positions to values
for pos, value in parameter_values.items():
pos = int(pos) if not isinstance(pos, int) else pos
if 1 <= pos <= 19: # Validate parameter positions
parameters[pos] = str(value)
# IMPORTANT: Create a data dictionary with ALL parameters explicitly included
request_data = {
"tlx_sn": device_sn,
"type": parameter_id
}
# Add all 19 parameters to the request
for i in range(1, 20):
request_data[f"param{i}"] = str(parameters[i])
# Send the request
response = self.session.post(
self._get_url('tlxSet'),
data=request_data
)
return self._process_response(response.json(), f"writing parameter {parameter_id}")
def min_write_time_segment(self, device_sn, segment_id, batt_mode, start_time, end_time, enabled=True):
"""
Set a time segment for a MIN inverter.
Args:
device_sn (str): The serial number of the inverter.
segment_id (int): Time segment ID (1-9).
batt_mode (int): 0=load priority, 1=battery priority, 2=grid priority.
start_time (datetime.time): Start time for the segment.
end_time (datetime.time): End time for the segment.
enabled (bool): Whether this segment is enabled.
Returns:
dict: The server response.
Raises:
GrowattParameterError: If parameters are invalid.
GrowattV1ApiError: If the API returns an error response.
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
if not 1 <= segment_id <= 9:
raise GrowattParameterError("segment_id must be between 1 and 9")
if not 0 <= batt_mode <= 2:
raise GrowattParameterError("batt_mode must be between 0 and 2")
# Initialize ALL 19 parameters as empty strings, not just the ones we need
all_params = {
"tlx_sn": device_sn,
"type": f"time_segment{segment_id}"
}
# Add param1 through param19, setting the values we need
all_params["param1"] = str(batt_mode)
all_params["param2"] = str(start_time.hour)
all_params["param3"] = str(start_time.minute)
all_params["param4"] = str(end_time.hour)
all_params["param5"] = str(end_time.minute)
all_params["param6"] = "1" if enabled else "0"
# Add empty strings for all unused parameters
for i in range(7, 20):
all_params[f"param{i}"] = ""
# Send the request
response = self.session.post(
self._get_url('tlxSet'),
data=all_params
)
return self._process_response(response.json(), f"writing time segment {segment_id}")
def min_read_time_segments(self, device_sn, settings_data=None):
"""
Read Time-of-Use (TOU) settings from a Growatt MIN/TLX inverter.
Retrieves all 9 time segments from a Growatt MIN/TLX inverter and
parses them into a structured format.
Note that this function uses min_settings() internally to get the settings data,
To avoid endpoint rate limit, you can pass the settings_data parameter
with the data returned from min_settings().
Args:
device_sn (str): The device serial number of the inverter
settings_data (dict, optional): Settings data from min_settings call to avoid repeated API calls.
Can be either the complete response or just the data portion.
Returns:
list: A list of dictionaries, each containing details for one time segment:
- segment_id (int): The segment number (1-9)
- batt_mode (int): 0=Load First, 1=Battery First, 2=Grid First
- mode_name (str): String representation of the mode
- start_time (str): Start time in format "HH:MM"
- end_time (str): End time in format "HH:MM"
- enabled (bool): Whether the segment is enabled
Example:
# Option 1: Make a single call
tou_settings = api.min_read_time_segments("DEVICE_SERIAL_NUMBER")
# Option 2: Reuse existing settings data
settings_response = api.min_settings("DEVICE_SERIAL_NUMBER")
tou_settings = api.min_read_time_segments("DEVICE_SERIAL_NUMBER", settings_response)
Raises:
GrowattV1ApiError: If the API request fails
requests.exceptions.RequestException: If there is an issue with the HTTP request.
"""
# Process the settings data
if settings_data is None:
# Fetch settings if not provided
settings_data = self.min_settings(device_sn=device_sn)
# Define mode names
mode_names = {
0: "Load First",
1: "Battery First",
2: "Grid First"
}
segments = []
# Process each time segment
for i in range(1, 10): # Segments 1-9
# Get raw time values
start_time_raw = settings_data.get(f'forcedTimeStart{i}', "0:0")
end_time_raw = settings_data.get(f'forcedTimeStop{i}', "0:0")
# Handle 'null' string values
if start_time_raw == 'null' or not start_time_raw:
start_time_raw = "0:0"
if end_time_raw == 'null' or not end_time_raw:
end_time_raw = "0:0"
# Format times with leading zeros (HH:MM)
try:
start_parts = start_time_raw.split(":")
start_hour = int(start_parts[0])
start_min = int(start_parts[1])
start_time = f"{start_hour:02d}:{start_min:02d}"
except (ValueError, IndexError):
start_time = "00:00"
try:
end_parts = end_time_raw.split(":")
end_hour = int(end_parts[0])
end_min = int(end_parts[1])
end_time = f"{end_hour:02d}:{end_min:02d}"
except (ValueError, IndexError):
end_time = "00:00"
# Get the mode value safely
mode_raw = settings_data.get(f'time{i}Mode')
if mode_raw == 'null' or mode_raw is None:
batt_mode = None
else:
try:
batt_mode = int(mode_raw)
except (ValueError, TypeError):
batt_mode = None
# Get the enabled status safely
enabled_raw = settings_data.get(f'forcedStopSwitch{i}', 0)
if enabled_raw == 'null' or enabled_raw is None:
enabled = False
else:
try:
enabled = int(enabled_raw) == 1
except (ValueError, TypeError):
enabled = False
segment = {
'segment_id': i,
'batt_mode': batt_mode,
'mode_name': mode_names.get(batt_mode, "Unknown"),
'start_time': start_time,
'end_time': end_time,
'enabled': enabled
}
segments.append(segment)
return segments
|