Solis development, fixes for component restarts #3179

springfall2008 · 2026-01-04T16:14:26Z

No description provided.

DB Manager crash on exit with different DB

Copilot

Pull request overview

This PR adds comprehensive Solis Cloud API integration for Predbat and fixes component restart behavior with exponential backoff. The changes introduce a new 2642-line Solis integration module, update the ComponentBase lifecycle management with backoff retry logic, add comprehensive unit tests for ComponentBase, and include defensive code improvements.

Key Changes

Added new Solis Cloud API integration with full inverter control via REST API and HMAC-SHA1 authentication
Implemented exponential backoff retry mechanism in ComponentBase for component startup failures (60s initial, max 128 minutes)
Added comprehensive unit tests for ComponentBase lifecycle and backoff behavior
Added defensive hasattr check in db_manager before calling _commit_db

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 21 comments.

Show a summary per file

File	Description
apps/predbat/solis.py	New 2642-line Solis Cloud API integration with inverter discovery, control, time window management, and HA entity publishing
apps/predbat/component_base.py	Updated start() method with exponential backoff logic for component restart resilience
apps/predbat/tests/test_component_base.py	New test suite with 5 tests covering ComponentBase lifecycle, backoff, exception handling, and stop behavior
apps/predbat/config.py	Added SolisCloud inverter type definition and 5 new config options (api_key, api_secret, inverter_sn, automatic, base_url)
apps/predbat/components.py	Registered Solis API component with event filtering and configuration mapping
apps/predbat/predbat.py	Updated PREDBAT_FILES list to include solis.py and solax.py
apps/predbat/db_manager.py	Added defensive hasattr check before calling _commit_db to prevent AttributeError
apps/predbat/unit_test.py	Registered new component_base test suite in TEST_REGISTRY

Comments suppressed due to low confidence (1)

apps/predbat/component_base.py:54

This call to ComponentBase.initialize in an initialization method is overridden by AlertFeed.initialize.
This call to ComponentBase.initialize in an initialization method is overridden by HAInterface.initialize.
This call to ComponentBase.initialize in an initialization method is overridden by OctopusAPI.initialize.
This call to ComponentBase.initialize in an initialization method is overridden by OhmeAPI.initialize.
This call to ComponentBase.initialize in an initialization method is overridden by SolaxAPI.initialize.
This call to ComponentBase.initialize in an initialization method is overridden by SolisAPI.initialize.
This call to ComponentBase.initialize in an initialization method is overridden by PredbatMCPServer.initialize.

        self.initialize(**kwargs)

Copilot · 2026-01-04T16:19:13Z

apps/predbat/components.py

+            "inverter_sn": {"required": False, "config": "solis_inverter_sn"},
+            "automatic": {"required": False, "config": "solis_automatic", "default": False},
+            "base_url": {"required": False, "config": "solis_base_url", "default": "https://www.soliscloud.com:13333"},
+            "control_enable": {"required": False, "config": "solis_control_enable", "default": True},


The config entry "solis_control_enable" is referenced in components.py (line 255) but is not defined in the CONFIG_ITEMS dictionary in config.py. This will cause the configuration validation to fail when users try to set this option. The config item should be added to CONFIG_ITEMS with proper type definition like the other solis_* entries.

Suggested change

"control_enable": {"required": False, "config": "solis_control_enable", "default": True},

Copilot · 2026-01-04T16:19:13Z

apps/predbat/solis.py

+        async def list_operation():
+            payload = {"pageSize": "100"}
+            data = await self._execute_request(SOLIS_INVERTER_LIST_ENDPOINT, payload)
+            print(data)


Debug print statement should be removed or converted to a log call. Using print() instead of self.log() bypasses the standard logging infrastructure and won't be captured properly in production environments.

Suggested change

print(data)

self.log(f"Solis API inverter list response: {data}")

Copilot · 2026-01-04T16:19:14Z

apps/predbat/solis.py

+
+            # detail contains: maxChargePowerW which can be used for battery_rate_max
+            max_charge_power_detail = detail.get("maxChargePowerW")
+            print("Max Charge Power from detail:", max_charge_power_detail)


Debug print statement should be removed or converted to a log call. Using print() instead of self.log() bypasses the standard logging infrastructure and won't be captured properly in production environments.

Suggested change

print("Max Charge Power from detail:", max_charge_power_detail)

self.log(f"Max Charge Power from detail: {max_charge_power_detail}")

Copilot · 2026-01-04T16:19:14Z

apps/predbat/solis.py

+
+        # One-time startup configuration
+        if first:
+            # Create aiohttp session
+            timeout = aiohttp.ClientTimeout(total=SOLIS_REQUEST_TIMEOUT)
+            self.session = aiohttp.ClientSession(timeout=timeout)
+
+            # Discover inverters - always scan, filter by inverter_sn if specified
+            try:
+                self.log("Solis API: Discovering inverters...")
+                all_inverters = await self.get_inverter_list()
+
+                if all_inverters:
+                    # Filter by configured inverter_sn if specified, otherwise use all
+                    if self.inverter_sn:
+                        # inverter_sn was configured, filter to only those
+                        filtered = [inv for inv in all_inverters if inv.get("sn") in self.inverter_sn]
+                        self.log(f"Solis API: Filtered to {len(filtered)} of {len(all_inverters)} inverter(s) based on config")
+                        self.inverter_sn = [inv.get("sn") for inv in filtered if inv.get("sn")]
+                    else:
+                        # No filter configured, use all discovered inverters
+                        self.inverter_sn = [inv.get("sn") for inv in all_inverters if inv.get("sn")]
+                        self.log(f"Solis API: Using all {len(self.inverter_sn)} discovered inverter(s)")
+
+                    if not self.inverter_sn:
+                        self.log("Warn: Solis API: No inverters found after filtering")
+                else:
+                    self.log("Warn: Solis API: No inverters discovered")
+
+            except Exception as e:
+                self.log(f"Error: Solis API: Inverter discovery failed: {e}")
+
+            # Get inverter details for all inverters
+            for sn in self.inverter_sn:
+                await self.fetch_inverter_details(sn)
+                await self.poll_inverter_data(sn, [SOLIS_CID_TOU_V2_MODE])  # Get TOU V2 mode status
+                if self.is_tou_v2_mode(sn):
+                    self.log(f"Solis API: Inverter {sn} is in Time of Use V2 mode")
+                else:
+                    self.log(f"Solis API: Inverter {sn} is in standard Time of Use mode")
+
+            if self.inverter_sn:
+                self.log(f"Solis API: Managing {len(self.inverter_sn)} inverter(s): {', '.join(self.inverter_sn)}")
+                self.api_started = True
+            else:
+                self.log("Error: Solis API: No inverters to manage after discovery")
+                self.api_started = False
+                return  # Stop further processing if no inverters
+
+        # Frequent polling (every 5 minutes)
+        if first or (seconds % 300 == 0):
+            poll_success = True
+            for sn in self.inverter_sn:
+                success =  await self.fetch_inverter_details(sn) # Get inverter details for all inverters
+                if not success:
+                    poll_success = False
+
+            # Only update last_updated_time if all polls succeeded
+            if poll_success:
+                self.last_updated_time = self.base.now_utc
+
+        # Infrequent polling (every 60 minutes)
+        if first or (seconds % 3600 == 0):
+            for sn in self.inverter_sn:
+                self.log(f"Solis API: Performing infrequent data poll for inverter {sn}...")
+                await self.poll_inverter_data(sn, SOLIS_CID_INFREQUENT)
+                if self.is_tou_v2_mode(sn):
+                    success = await self.poll_inverter_data(sn, SOLIS_CID_LIST_TOU_V2)
+                    if not success:
+                        poll_success = False
+                    await self.decode_time_windows_v2(sn)
+                else:
+                    self.log("Solis API: Inverter is in standard Time of Use mode, polling standard TOU data")
+                    success =  await self.poll_inverter_data(sn, SOLIS_CID_SINGLE, batch=False)
+                    if not success:
+                        poll_success = False
+                    await self.decode_time_windows(sn)
+                # Recalculate max currents after polling infrequent data
+                self._calculate_max_currents(sn)
+
+        # Control mode
+        if first or (seconds % 60 == 0):
+            # Write to inverter using new function (handles both V1 and V2)
+            is_readonly = self.get_state_wrapper(f'switch.{self.prefix}_set_read_only', default='off') == 'on'
+            if self.control_enable and not is_readonly:
+                for sn in self.inverter_sn:
+                    await self.reset_charge_windows_if_needed(sn)
+                    await self.write_time_windows_if_changed(sn)
+            else:
+                self.log("Solis API: Control disabled, skipping writing time windows")
+
+
+        # Publish entities after polling
+        if first or (seconds % 300 == 0):
+            await self.publish_entities()
+
+        # Auto-configure Predbat if enabled
+        if first and self.automatic and self.inverter_sn:
+            await self.automatic_config()
+


The run() method in solis.py doesn't return a boolean value to indicate success/failure, but the ComponentBase.start() method expects this. When run() fails during first-time setup (e.g., when no inverters are found), it should return False to trigger the backoff mechanism. Currently, when inverter_sn is empty after discovery (line 2492), the method returns without a value (implicit None), which will be treated as False by the ComponentBase. However, when setup succeeds, there's no explicit return True statement, meaning successful runs will also return None/False, potentially triggering unnecessary backoff.

Copilot · 2026-01-04T16:19:14Z

apps/predbat/component_base.py

+        next_retry = 0  # When to next attempt self.run() during startup backoff
+        backoff_interval = 60  # Start with 60 seconds between attempts
+        max_backoff = 128 * 60  # Maximum 128 minutes between attempts
        while not self.api_stop and not self.fatal_error:
            try:
-                if first or seconds % 60 == 0:
+                # Check if it's time to run
+                should_run = False
+                if first:
+                    # During startup, only run when we've reached the next retry time
+                    if seconds >= next_retry:
+                        should_run = True
+                        backoff_interval = min(backoff_interval * 2, max_backoff)
+                        next_retry = seconds + backoff_interval
+                else:
+                    # After startup, run every 60 seconds
+                    if seconds % 60 == 0:
+                        should_run = True
+
+                if should_run:
                    if await self.run(seconds, first):
                        if not self.api_started:
                            self.api_started = True
                            self.log(f"{self.__class__.__name__}: Started")
+                            first = False  # Clear first flag once started
                    else:
                        self.count_errors += 1
                        self.non_fatal_error_occurred()
-                first = False
+                        self.log("Warn: " + f"{self.__class__.__name__}: run() returned False")


The backoff logic has a subtle bug: backoff_interval is calculated BEFORE checking if run() succeeded. This means on the first run (when seconds=0 and next_retry=0), it will run, then immediately double the backoff_interval to 120 regardless of success. If the first run succeeds, the backoff_interval should not be increased. The interval should only be increased when run() returns False. The correct logic should be: run the method, check the result, and only if it fails, increase the backoff and set next_retry.

Copilot · 2026-01-04T16:19:18Z

apps/predbat/solis.py

+                        except (ValueError, TypeError):
+                            pass


'except' clause does nothing but pass and there is no explanatory comment.

Suggested change

except (ValueError, TypeError):

pass

except (ValueError, TypeError) as exc:

# Invalid or non-numeric current value; leave as None so UI shows unknown

self.log("Warn: Failed to convert Solis discharge_current %r for inverter %s: %s" % (current_value_amps, inverter_sn, exc))

current_value_watts = None

Copilot · 2026-01-04T16:19:18Z

apps/predbat/solis.py

+                try:
+                    storage_mode_int = int(mode_value)
+                except (ValueError, TypeError):
+                    pass


'except' clause does nothing but pass and there is no explanatory comment.

Suggested change

pass

# Invalid storage mode value from Solis; ignore and fall back to no mode

storage_mode_int = None

self.log("Warn: Invalid storage mode value {} for inverter {}".format(mode_value, inverter_sn))

Copilot · 2026-01-04T16:19:19Z

apps/predbat/solis.py

+                except (ValueError, TypeError):
+                    pass


'except' clause does nothing but pass and there is no explanatory comment.

Suggested change

except (ValueError, TypeError):

pass

except (ValueError, TypeError) as exc:

# Invalid or non-numeric current value from Solis API; leave power as None but log for diagnostics

self.log("Warn: Failed to convert Solis max charge current '{}' to watts: {}".format(max_charge_current_amps, exc))

Copilot · 2026-01-04T16:19:19Z

apps/predbat/solis.py

+            if max_discharge_current_amps is not None:
+                try:
+                    max_discharge_power_watts = int(float(max_discharge_current_amps) * self.nominal_voltage)
+                except (ValueError, TypeError):


'except' clause does nothing but pass and there is no explanatory comment.

Copilot · 2026-01-04T16:19:19Z

apps/predbat/solis.py

+                except (ValueError, TypeError):
+                    pass


'except' clause does nothing but pass and there is no explanatory comment.

Suggested change

except (ValueError, TypeError):

pass

except (ValueError, TypeError) as e:

self.log(

"Warn: Solis invalid battery capacity '%s' for inverter %s (%s): %s"

% (battery_capacity_ah, inverter_sn, inverter_name, e)

)

springfall2008 added 8 commits January 3, 2026 14:02

Started on Solis Cloud integration

7630e8f

In dev

6e03805

Solis work in progress

b3d2621

FIxes

1ceb4e0

Solis fixes

bc2f496

DB Manager crash on exit with different DB

Fix issue where if component fails to start it never tries again

83de294

Solis dev

17d25f4

Solis so far

7eca0ab

Copilot AI review requested due to automatic review settings January 4, 2026 16:14

Copilot started reviewing on behalf of springfall2008 January 4, 2026 16:14 View session

pre-commit-ci-lite bot and others added 3 commits January 4, 2026 16:16

[pre-commit.ci lite] apply automatic fixes

655a9da

FIxes

059fd25

Merge branch 'solis' of github.com:springfall2008/batpred into solis

c421934

Copilot AI reviewed Jan 4, 2026

View reviewed changes

springfall2008 and others added 4 commits January 4, 2026 20:03

Solis cloud docs

b6ac8fa

Cleanup debug

a421232

Lint

79f9b19

Bump version from v8.31.8 to v8.31.9

4ac9363

springfall2008 merged commit c37d2f7 into main Jan 4, 2026
1 check passed

springfall2008 deleted the solis branch January 4, 2026 20:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Solis development, fixes for component restarts #3179

Solis development, fixes for component restarts #3179

springfall2008 commented Jan 4, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 4, 2026

Uh oh!

Copilot AI Jan 4, 2026

Uh oh!

Copilot AI Jan 4, 2026

Uh oh!

Copilot AI Jan 4, 2026

Uh oh!

Copilot AI Jan 4, 2026

Uh oh!

Copilot AI Jan 4, 2026

Uh oh!

Copilot AI Jan 4, 2026

Uh oh!

Copilot AI Jan 4, 2026

Uh oh!

Copilot AI Jan 4, 2026

Uh oh!

Copilot AI Jan 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	print(data)
	self.log(f"Solis API inverter list response: {data}")

	print("Max Charge Power from detail:", max_charge_power_detail)
	self.log(f"Max Charge Power from detail: {max_charge_power_detail}")

-                        except (ValueError, TypeError):
-                            pass
+                        except (ValueError, TypeError) as exc:
+                            # Invalid or non-numeric current value; leave as None so UI shows unknown
+                            self.log("Warn: Failed to convert Solis discharge_current %r for inverter %s: %s" % (current_value_amps, inverter_sn, exc))
+                            current_value_watts = None

-                    pass
+                    # Invalid storage mode value from Solis; ignore and fall back to no mode
+                    storage_mode_int = None
+                    self.log("Warn: Invalid storage mode value {} for inverter {}".format(mode_value, inverter_sn))

-                except (ValueError, TypeError):
-                    pass
+                except (ValueError, TypeError) as e:
+                    self.log(
+                        "Warn: Solis invalid battery capacity '%s' for inverter %s (%s): %s"
+                        % (battery_capacity_ah, inverter_sn, inverter_name, e)
+                    )

Uh oh!

Solis development, fixes for component restarts #3179

Solis development, fixes for component restarts #3179

Conversation

springfall2008 commented Jan 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Copilot AI Jan 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants