Merge branch 'master' into master

Author: GraemeDBlue

docs/shinephone.md

@@ -63,6 +63,7 @@ Any methods that may be useful.
 | `api.update_mix_inverter_setting(serial_number, setting_type, parameters)` | serial_number: String, setting_type: String, parameters: Dict/Array | Apply the provided parameters for the specified setting on the specified Mix inverter. see: [details](./shinephone/inverter_settings.md) |
 | `api.update_ac_inverter_setting(serial_number, setting_type, parameters)` | serial_number: String, setting_type: String, parameters: Dict/Array | Apply the provided parameters for the specified setting on the specified AC-coupled inverter. see: [details](./shinephone/inverter_settings.md) |
 | `api.update_noah_settings(serial_number, setting_type, parameters)` | serial_number: String, setting_type: String, parameters: Dict/Array | Apply the provided parameters for the specified setting on the specified Noah device. see: [details](./shinephone/noah_settings.md) |
+| `api.update_classic_inverter_setting(default_parameters, parameters)` | default_parameters: Dict, parameters: Dict/Array | Applies settings for specified system based on serial number. This function is only going to work for classic inverters. |
 
 ### Variables
 

docs/shinephone/inverter_settings.md

@@ -78,7 +78,16 @@ Known working settings & parameters are as follows (all parameter values are str
    *   start_time: timedate object with start time of segment with format HH:MM
    *   end_time: timedate object with end time of segment with format HH:MM
    *   enabled: time segment enabled, boolean: True (Enabled), False (Disabled)
+* **Classic inverter settings**
+  * function: `api.update_classic_inverter_setting`
+  * description: Applies settings for specified system based on serial number. This function is only going to work for classic inverters.
+  * params:
+    * `param1`: First parameter (specific to the setting type)
+    * `param2`: Second parameter (specific to the setting type)
+    * Additional parameters can be passed as needed.
 
 The four functions `update_tlx_inverter_setting`, `update_mix_inverter_setting`, `update_ac_inverter_setting`, and `update_inverter_setting` take either a dictionary or an array. If an array is passed it will automatically generate the `paramN` key based on array index since all params for settings seem to used the same numbering scheme.
 
-Only the settings described above have been tested with `update_tlx_inverter_setting` and they all take only one single parameter. It is very likely that the function works with all settings returned by `tlx_get_enabled_settings`, but this has not been tested. A helper function `update_tlx_inverter_time_segment` is provided for the settings that require more than one parameter.
+Only the settings described above have been tested with `update_tlx_inverter_setting` and they all take only one single parameter. It is very likely that the function works with all settings returned by `tlx_get_enabled_settings`, but this has not been tested. A helper function `update_tlx_inverter_time_segment` is provided for the settings that require more than one parameter.
+
+The `api.get_mix_inverter_settings` method can be used to get the current inverter settings for the specified serial number including charge/discharge schedule for hybrid systems.

examples/settings_example.py

@@ -52,8 +52,11 @@
 # Get plant settings - This is performed for us inside
 # 'update_plant_settings' but you can get ALL of the settings using this
 current_settings = api.get_plant_settings(plant_id)
-# pp.pprint(current_settings)  # noqa: ERA001
+#pp.pprint(current_settings)
 
+#Get mix inverter settings
+inverter_settings = api.get_mix_inverter_settings(device_sn)
+pp.pprint(inverter_settings)
 
 # Change the timezone of the plant
 plant_settings_changes = {"plantTimezone": "0"}

examples/settings_example_classic.py

@@ -0,0 +1,49 @@
+import growattServer
+import getpass
+import pprint
+
+"""
+This script demonstrates how to interface with the configuration settings of a plant and its classic inverters.
+It uses the `update_classic_inverter_setting` function to apply settings to a classic inverter.
+"""
+pp = pprint.PrettyPrinter(indent=4)
+
+# Prompt user for username
+username = input("Enter username:")
+
+# Prompt user to input password
+user_pass = getpass.getpass("Enter password:")
+
+api = growattServer.GrowattApi(True, username)
+login_response = api.login(username, user_pass)
+
+plant_list = api.plant_list(login_response['user']['id'])
+
+# Simple logic to just get the first inverter from the first plant
+# Expand this using a for-loop to perform for more systems
+plant = plant_list['data'][0]  # This is an array - we just take the first - would need a for-loop for more systems
+plant_id = plant['plantId']
+plant_name = plant['plantName']
+plant_info = api.plant_info(plant_id)
+
+devices = api.device_list(plant_id)
+device = devices[0]  # This is an array - we just take the first - would need a for-loop for more systems
+device_sn = device['deviceSn']
+device_type = device['deviceType']
+
+# Turn inverter on
+print("Turning on inverter: %s" % (device_sn))
+
+# Set up the default parameters
+default_parameters = {
+    "action": "inverterSet",
+    "serialNum": device_sn,
+}
+
+parameters = {
+    "paramId": "pv_on_off",
+    "command_1": "0001", # 0001 to turn on, 0000 to turn off
+    "command_2": "",  # Empty string for command_2 as not used
+}
+response = api.update_classic_inverter_setting(default_parameters, parameters)
+print(response)

growattServer/base_api.py

@@ -761,16 +761,41 @@ def mix_detail(  # noqa: D417
         """
         date_str = self.__get_date_string(timespan, date)
 
-        response = self.session.post(
-            self.get_url("newMixApi.do"),
-            params={
-                "op": "getEnergyProdAndCons_KW",
-                "plantId": plant_id,
-                "mixId": mix_id,
-                "type": timespan.value,
-                "date": date_str,
-            },
-        )
+        response = self.session.post(self.get_url('newMixApi.do'), params={
+            'op': 'getEnergyProdAndCons_KW',
+            'plantId': plant_id,
+            'mixId': mix_id,
+            'type': timespan.value,
+            'date': date_str
+        })
+
+        return response.json().get('obj', {})
+
+    def get_mix_inverter_settings(self, serial_number):
+        """
+        Gets the inverter settings related to battery modes
+        Keyword arguments:
+        serial_number -- The serial number (device_sn) of the inverter
+        Returns:
+        A dictionary of settings
+        """
+
+        default_params = {
+            'op': 'getMixSetParams',
+            'serialNum': serial_number,
+            'kind': 0
+        }
+        response = self.session.get(self.get_url('newMixApi.do'), params=default_params)
+        data = json.loads(response.content.decode('utf-8'))
+        return data
+
+    def dashboard_data(self, plant_id, timespan=Timespan.hour, date=None):
+        """
+        Get 'dashboard' data for specified timespan
+        NOTE - All numerical values returned by this api call include units e.g. kWh or %
+             - Many of the 'total' values that are returned for a Mix system are inaccurate on the system this was tested against.
+               However, the statistics that are correct are not available on any other interface, plus these values may be accurate for
+               non-mix types of system. Where the values have been proven to be inaccurate they are commented below.
 
         return response.json().get("obj", {})
 
@@ -1369,3 +1394,31 @@ def update_noah_settings(  # noqa: D417
         )
 
         return response.json()
+
+    def update_classic_inverter_setting(self, default_parameters, parameters):
+        """
+        Applies settings for specified system based on serial number
+        See README for known working settings
+
+        Arguments:
+        default_params -- Default set of parameters for the setting call (dict)
+        parameters -- Parameters to be sent to the system (dict or list of str)
+                (array which will be converted to a dictionary)
+
+        Returns:
+        JSON response from the server whether the configuration was successful
+        """
+        settings_parameters = parameters
+
+        # If we've been passed an array then convert it into a dictionary
+        if isinstance(parameters, list):
+            settings_parameters = {}
+            for index, param in enumerate(parameters, start=1):
+                settings_parameters['param' + str(index)] = param
+
+        settings_parameters = {**default_parameters, **settings_parameters}
+
+        response = self.session.post(self.get_url('tcpSet.do'),
+                                     params=settings_parameters)
+
+        return response.json()