Simplify the V1 methods by using single re-usable base methods

.github/workflows/ruff.yml

@@ -0,0 +1,11 @@
+name: Ruff
+on: 
+  - push
+  - pull_request
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3

.gitignore

@@ -26,6 +26,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+*.json
 
 # Symlink
 examples/growattServer

.ruff.toml

@@ -0,0 +1,25 @@
+# The contents of this file is based on https://github.com/home-assistant/core/blob/dev/pyproject.toml
+
+target-version = "py313"
+
+[lint]
+select = [
+    "ALL",
+]
+
+ignore = [
+    "ANN401", # Dynamically typed expressions (typing.Any) are disallowed
+    "D203", # no-blank-line-before-class (incompatible with formatter)
+    "D212", # multi-line-summary-first-line (incompatible with formatter)
+    "COM812", # incompatible with formatter
+    "ISC001", # incompatible with formatter
+]
+
+[lint.flake8-pytest-style]
+fixture-parentheses = false
+
+[lint.pyupgrade]
+keep-runtime-typing = true
+
+[lint.mccabe]
+max-complexity = 25

examples/__init__.py

@@ -0,0 +1 @@
+"""Examples package for PyPi_GrowattServer."""

examples/min_example.py

@@ -1,93 +1,102 @@
-import growattServer
-import datetime
-import json
-import requests
-
 """
-# Example script controlling a MID/TLX Growatt (MID-30KTL3-XH + APX battery) system using the public growatt API 
-# You can obtain an API token from the Growatt API documentation or developer portal.
+Example script for MIN/TLX Growatt inverters using the public API.
+
+This script demonstrates controlling a MID/TLX Growatt
+(MID-30KTL3-XH + APX battery) system.
+You can obtain an API token from the Growatt API documentation or
+developer portal.
 """
 
-# Get the API token from user input or environment variable
-# api_token = os.environ.get("GROWATT_API_TOKEN") or input("Enter your Growatt API token: ")
+import json
+from pathlib import Path
+
+import requests
+
+from . import growattServer
 
-# test token from official API docs https://www.showdoc.com.cn/262556420217021/1494053950115877
-api_token = "6eb6f069523055a339d71e5b1f6c88cc"  # gitleaks:allow
+# Test token from official API docs
+# https://www.showdoc.com.cn/262556420217021/1494053950115877
+api_token = "6eb6f069523055a339d71e5b1f6c88cc"  # noqa: S105
 
 try:
     # Initialize the API with token instead of using login
     api = growattServer.OpenApiV1(token=api_token)
 
     # Plant info
     plants = api.plant_list()
-    print(f"Plants: Found {plants['count']} plants")
-    plant_id = plants['plants'][0]['plant_id']
+    print(f"Plants: Found {plants['count']} plants")  # noqa: T201
+    plant_id = plants["plants"][0]["plant_id"]
 
     # Devices
     devices = api.device_list(plant_id)
 
-    for device in devices['devices']:
-        if device['type'] == 7:  # (MIN/TLX)
-            inverter_sn = device['device_sn']
-            print(f"Processing inverter: {inverter_sn}")
+    for device in devices["devices"]:
+        print(device)  # noqa: T201
+        if device["device_type"] == growattServer.DeviceType.MIN_TLX.value:
+            inverter_sn = device["device_sn"]
+            device_type = device["device_type"]
+            print(f"Processing {device_type.name} inverter: {inverter_sn}")  # noqa: T201
 
             # Get device details
-            inverter_data = api.min_detail(inverter_sn)
-            print("Saving inverter data to inverter_data.json")
-            with open('inverter_data.json', 'w') as f:
+            inverter_data = api.min_detail(
+                device_sn=inverter_sn,
+            )
+            print("Saving inverter data to inverter_data.json")  # noqa: T201
+            with Path("inverter_data.json").open("w") as f:
                 json.dump(inverter_data, f, indent=4, sort_keys=True)
 
             # Get energy data
-            energy_data = api.min_energy(device_sn=inverter_sn)
-            print("Saving energy data to energy_data.json")
-            with open('energy_data.json', 'w') as f:
+            energy_data = api.min_energy(
+                device_sn=inverter_sn,
+            )
+            print("Saving energy data to energy_data.json")  # noqa: T201
+            with Path("energy_data.json").open("w") as f:
                 json.dump(energy_data, f, indent=4, sort_keys=True)
 
             # Get energy history
-            energy_history_data = api.min_energy_history(inverter_sn)
-            print("Saving energy history data to energy_history.json")
-            with open('energy_history.json', 'w') as f:
-                json.dump(energy_history_data['datas'],
-                          f, indent=4, sort_keys=True)
+            energy_history_data = api.min_energy_history(
+                device_sn=inverter_sn,
+            )
+            print("Saving energy history data to energy_history.json")  # noqa: T201
+            with Path("energy_history.json").open("w") as f:
+                json.dump(
+                    energy_history_data.get("datas", []),
+                    f,
+                    indent=4,
+                    sort_keys=True,
+                )
 
             # Get settings
-            settings_data = api.min_settings(device_sn=inverter_sn)
-            print("Saving settings data to settings_data.json")
-            with open('settings_data.json', 'w') as f:
+            settings_data = api.min_settings(
+                device_sn=inverter_sn,
+            )
+            print("Saving settings data to settings_data.json")  # noqa: T201
+            with Path("settings_data.json").open("w") as f:
                 json.dump(settings_data, f, indent=4, sort_keys=True)
 
             # Read time segments
-            tou = api.min_read_time_segments(inverter_sn, settings_data)
-            print(json.dumps(tou, indent=4))
+            tou = api.read_time_segments(
+                device_sn=inverter_sn,
+                device_type=device_type,
+                settings_data=settings_data,
+            )
+            print("Time-of-Use Segments:")  # noqa: T201
+            with Path("tou_data.json").open("w") as f:
+                json.dump(tou, f, indent=4, sort_keys=True)
 
             # Read discharge power
-            discharge_power = api.min_read_parameter(
-                inverter_sn, 'discharge_power')
-            print("Current discharge power:", discharge_power, "%")
-
-            # Settings parameters - Uncomment to test
-
-            # Turn on AC charging
-#            api.min_write_parameter(inverter_sn, 'ac_charge', 1)
-#            print("AC charging enabled successfully")
-
-            # Enable Load First between 00:00 and 11:59 using time segment 1
-#            api.min_write_time_segment(
-#                device_sn=inverter_sn,
-#                segment_id=1,
-#                batt_mode=growattServer.BATT_MODE_BATTERY_FIRST,
-#                start_time=datetime.time(0, 0),
-#                end_time=datetime.time(00, 59),
-#                enabled=True
-#            )
-#            print("Time segment updated successfully")
-
+            discharge_power = api.common_read_parameter(
+                device_sn=inverter_sn,
+                device_type=device_type,
+                parameter_id="discharge_power",
+            )
+            print(f"Current discharge power: {discharge_power}%")  # noqa: T201
 
 except growattServer.GrowattV1ApiError as e:
-    print(f"API Error: {e} (Code: {e.error_code}, Message: {e.error_msg})")
+    print(f"API Error: {e} (Code: {e.error_code}, Message: {e.error_msg})")  # noqa: T201
 except growattServer.GrowattParameterError as e:
-    print(f"Parameter Error: {e}")
+    print(f"Parameter Error: {e}")  # noqa: T201
 except requests.exceptions.RequestException as e:
-    print(f"Network Error: {e}")
-except Exception as e:
-    print(f"Unexpected error: {e}")
+    print(f"Network Error: {e}")  # noqa: T201
+except Exception as e:  # noqa: BLE001
+    print(f"Unexpected error: {e}")  # noqa: T201