Merge pull request #87 from Monitor-My-Solar/monitorMySolarStaging

Monitor my solar staging

Author: zakery292

.gitignore

@@ -2,7 +2,8 @@
 custom_components/monitormysolar/__pycache__
 custom_components/monitormysolar/.claude
 custom_components/monitormysolar/docs/
+custom_components/monitormysolar/registers
 ./claude
 *.claude
 claude.md
-docs/
+docs/

custom_components/monitormysolar/CHANGELOG.md

@@ -1,5 +1,88 @@
 # Changelog
 
+## Version 3.1.0 - GridBoss Enhancements & Performance Improvements
+
+### 🔄 **Important: GridBoss Upgrade Instructions**
+If you are using GridBoss functionality, please follow these steps to upgrade:
+1. **Delete the integration** from Home Assistant
+2. **Reboot** Home Assistant
+3. **Update through HACS** to get the latest version
+4. **Re-setup** the integration with your GridBoss configuration
+
+This ensures a clean upgrade and prevents any configuration conflicts with the new GridBoss features.
+- **Multi-Inverter**: Enhanced support for parallel inverter configurations with GridBoss
+
+### 🚀 Major Performance Improvements
+- **Fixed Home Assistant Slow Startup**: Implemented startup delay to prevent MQTT message processing during HA initialization
+- **Eliminated Excessive Coordinator Updates**: Reduced coordinator update frequency from every 1.5 seconds to only when needed
+- **Optimized MQTT Processing**: Deferred non-critical MQTT message processing until after HA startup completion
+- **Improved Main Thread Performance**: Prevented blocking operations during Home Assistant startup
+- **Resolved Bootstrap Timeout**: Fixed blocking `while True:` loop in SyncStatusSensor that was causing 5+ minute startup times
+- **Non-Blocking Async Scheduling**: Replaced blocking loops with proper async scheduling using `async_call_later()`
+
+### 🔧 GridBoss Configuration & Setup Fixes
+- **Enhanced Config Flow**: Added dedicated GridBoss configuration step with proper dongle selection
+- **Improved Error Handling**: Added comprehensive error handling for dongle connectivity and firmware code reception
+- **Fixed Entity Creation Logic**: Implemented strict GridBoss entity filtering to prevent creation of unnecessary standard entities
+- **Corrected Device Naming**: Fixed GridBoss device naming to display "GridBoss" instead of generic names
+
+### 📡 GridBoss MQTT & Payload Processing
+- **Fixed Nested Payload Parsing**: Implemented proper handling of GridBoss nested JSON payload structure
+- **Corrected Entity Name Mapping**: Fixed mapping between payload keys and entity unique_ids
+- **Enhanced Topic Routing**: Improved MQTT topic routing for GridBoss-specific settings
+- **Simplified Payload Processing**: Streamlined nested data processing with recursive flattening
+
+### 🛠️ Technical Improvements
+- **Removed Complex Throttling**: Simplified coordinator update mechanism for better performance
+- **Enhanced Fault/Warning Deduplication**: Prevented duplicate processing of identical fault/warning data
+- **Improved Entity Type Determination**: Optimized entity type detection for better performance
+- **Better Error Recovery**: Enhanced error handling and recovery mechanisms
+
+### 🎯 User Experience Enhancements
+- **Faster Home Assistant Startup**: Reduced startup time by deferring MQTT processing
+- **Cleaner Debug Logs**: Eliminated excessive "Manually updated MonitorySolar Coordinator data" messages
+- **More Responsive Interface**: Home Assistant becomes responsive much faster after restart
+- **Better Configuration Flow**: Improved GridBoss setup process with clear error messages
+
+### 🔄 Backward Compatibility
+- **Maintained All Existing Features**: All previous functionality preserved
+- **No Breaking Changes**: Existing configurations continue to work without modification
+- **Preserved Entity History**: All entity data and settings remain intact
+- **Seamless Upgrade Path**: No manual intervention required for existing users
+
+### 📋 Technical Details
+- **Startup Delay**: 30-second delay before MQTT message processing begins
+- **Firmware Code Processing**: Still processed immediately for proper entity creation
+- **GridBoss Entity Filtering**: Only creates entities explicitly allowed for "IAAB" firmware
+- **Payload Structure**: Supports both old and new nested payload formats
+
+### 🐛 Bug Fixes
+- Fixed `IndentationError` in sensor.py that prevented integration loading
+- Resolved `NameError: name 'data_to_process' is not defined` in coordinator
+- Fixed GridBoss entity count issues (was creating ~400 entities, now creates only relevant ones)
+- Corrected GridBoss device naming in Home Assistant interface
+- Fixed nested payload parsing for GridBoss settings updates
+- **Fixed Home Assistant startup timeout**: Replaced blocking `while True:` loop in SyncStatusSensor with non-blocking async scheduling
+- **Resolved 5+ minute startup times**: Prevented bootstrap timeout warnings and excessive coordinator updates during startup
+- **Fixed GridBoss MQTT routing issue**: GridBoss settings were incorrectly being sent to bank-specific topics instead of the standard `/update` topic, causing settings to be rejected
+- **Enhanced GridBoss conditional entity system**: Implemented hierarchical availability logic based on Port Mode → SOC/Volt mode → Enable state
+- **Added Port Mode selects**: New SmartLoad1-4 Port Mode selects with proper numeric value mapping (0=Does Not Operate, 1=Smart Load, 2=AC Coupled)
+- **Fixed switch availability logic**: Added proper availability checking to switch entities based on Port Mode, SOC/Volt mode, and SmartLoad enable state
+- **Firmware code persistence**: Firmware codes are now saved to config entry data and only requested when not already available, improving startup performance
+- **Fixed availability timing issue**: Added 0.5s delay to availability updates to prevent blocking legitimate user actions when Port Mode changes
+- **Removed availability blocking from user actions**: Availability logic now only affects UI display (grayed out entities) but no longer blocks user actions, preventing the "revert" issue
+- **Fixed select entity revert issue**: Select entities now properly store previous state before changing and revert correctly on MQTT failure, preventing the auto-revert issue with Port Mode selects
+- **Fixed coordinator override issue**: Added user-initiated change flag to prevent coordinator from overriding user selections during MQTT processing, solving the select revert problem
+- **Fixed availability delay issue**: Port Mode changes now trigger immediate availability updates, and enable switches are always available when Port Mode is set to "Smart Load" or "AC Coupled" (both SmartLoad and AC Coupled enable switches)
+- **Added SOC/Volt mode select entities**: New SmartLoad1-4 Mode selects with "Time" and "SOC/Volt" options, available when Port Mode is set to "Smart Load" or "AC Coupled"
+
+### 📝 Notes
+- **Dongle Firmware**: Requires dongle firmware 3.1.0+ for optimal GridBoss functionality
+- **Performance**: Significant improvement in Home Assistant startup time
+- **GridBoss**: Full support for GridBoss units with firmware code "IAAB"
+
+---
+
 ## Version 3.0.1 - GridBoss Support & Enhanced Multi-Inverter Features
 
 ### Minimum Requirements include the dongle Firmware 3.0.0> if your dongle is below this then a OTA update will be required. 

custom_components/monitormysolar/CONDITIONAL_ENTITIES.md

@@ -0,0 +1,174 @@
+# Conditional Entity System for GridBoss SmartLoad Settings
+
+## Overview
+
+This document describes the implementation of a conditional entity system that dynamically enables/disables GridBoss SmartLoad settings based on two key configurations:
+1. **SmartSOCVoltBits**: Controls SOC/Volt vs Time mode
+2. **SmartLoad Bits**: Controls which SmartLoads are enabled
+
+This solves the challenge of having dependent settings where some values can only be set when other settings have specific values.
+
+## Problem Statement
+
+In GridBoss systems, certain settings have dependencies:
+
+### SmartLoad Enable/Disable
+- **Disabled SmartLoads**: When `SmartLoadX_Enable` is `false`, all related settings should be unavailable
+- **Enabled SmartLoads**: When `SmartLoadX_Enable` is `true`, related settings become available
+
+### SOC/Volt vs Time Mode
+- **SOC/Volt Mode**: When `SmartLoadX_SOC_Volt` is `true`, only SOC and voltage-based settings are available
+- **Time Mode**: When `SmartLoadX_SOC_Volt` is `false`, only time-based settings are available
+
+### Always Available Settings
+- **Enable/Disable Switches**: Always available regardless of other settings
+
+Home Assistant doesn't provide built-in popup alerts or dynamic entity enabling/disabling, so we needed a creative solution.
+
+## Solution Architecture
+
+### 1. SmartSOCVoltBits and SmartLoad Bits Tracking
+
+The coordinator now tracks both configuration types for each dongle:
+
+```python
+self._smart_soc_volt_bits = {}  # Track SmartSOCVoltBits for each dongle
+self._smartload_bits = {}  # Track SmartLoad Bits for each dongle
+```
+
+### 2. Entity Availability System
+
+Entities use the `available` property to dynamically show/hide based on dependency settings:
+
+```python
+@property
+def available(self) -> bool:
+    """Return if entity is available."""
+    if not self.coordinator.last_update_success:
+        return False
+    
+    # Check if entity should be available based on SmartLoad SOC/Volt settings
+    return self.coordinator.is_entity_available_for_smartload(self._dongle_id, self._entity_type)
+```
+
+### 3. Validation and User Feedback
+
+When users try to set invalid values, the system:
+1. Prevents the setting from being applied
+2. Shows a persistent notification explaining why the setting is unavailable
+3. Logs a warning message
+
+## Implementation Details
+
+### Coordinator Methods
+
+#### `update_smart_soc_volt_bits(dongle_id, smart_soc_volt_bits)`
+Updates the SmartSOCVoltBits settings and triggers entity availability updates.
+
+#### `update_smartload_bits(dongle_id, smartload_bits)`
+Updates the SmartLoad Bits settings and triggers entity availability updates.
+
+#### `is_entity_available_for_smartload(dongle_id, entity_unique_id)`
+Determines if an entity should be available based on:
+- Whether it's a GridBoss dongle
+- The SmartLoad number (1-4)
+- Whether the SmartLoad is enabled
+- Whether it's a SOC/Volt or Time entity
+- The current SmartSOCVoltBits setting
+
+#### `is_smartload_enabled(dongle_id, smartload_number)`
+Checks if a specific SmartLoad is enabled.
+
+#### `is_entity_available_for_smartload_enable(dongle_id, entity_unique_id)`
+Checks availability based only on SmartLoad enable state (used for Enable/Disable switches).
+
+#### `_trigger_entity_availability_update(dongle_id)`
+Triggers async updates to entity availability when SmartSOCVoltBits change.
+
+### Entity Classification
+
+The system classifies entities into categories:
+
+**SOC/Volt Entities** (available when `SmartLoadX_SOC_Volt` is `true`):
+- `StartSOC`, `EndSOC`
+- `StartVolt`, `EndVolt`
+- `SheddingStartSOC`, `SheddingEndSOC`
+- `SheddingStartVolt`, `SheddingEndVolt`
+
+**Time Entities** (available when `SmartLoadX_SOC_Volt` is `false`):
+- `Start0`, `End0`
+- `Start1`, `End1`
+- `Start2`, `End2`
+
+### User Experience
+
+1. **Visual Feedback**: Unavailable entities appear grayed out in Home Assistant
+2. **Prevention**: Users cannot set values on unavailable entities
+3. **Notifications**: Clear explanations when users try to access unavailable settings
+4. **Dynamic Updates**: Entities become available/unavailable automatically when SmartSOCVoltBits change
+
+## Example Usage
+
+### Complete SmartLoad Configuration
+
+```json
+"SmartLoad": {
+  "Bits": {
+    "SmartLoad1_Enable": true,
+    "SmartLoad2_Enable": true,
+    "SmartLoad3_Enable": false,
+    "SmartLoad4_Enable": false
+  }
+},
+"SmartSOCVoltBits": {
+  "SmartLoad1_SOC_Volt": true,
+  "SmartLoad2_SOC_Volt": false,
+  "SmartLoad3_SOC_Volt": true,
+  "SmartLoad4_SOC_Volt": false
+}
+```
+
+**Result**:
+- **SmartLoad1**: ✅ Enabled + SOC/Volt mode → SOC/Volt entities available, Time entities unavailable
+- **SmartLoad2**: ✅ Enabled + Time mode → Time entities available, SOC/Volt entities unavailable  
+- **SmartLoad3**: ❌ Disabled → All entities unavailable (except Enable switch)
+- **SmartLoad4**: ❌ Disabled → All entities unavailable (except Enable switch)
+
+### User Interaction Examples
+
+#### Example 1: Disabled SmartLoad
+1. User tries to set `SmartLoad3StartSOC` when `SmartLoad3_Enable` is `false`
+2. System shows notification: "The setting 'SmartLoad3 Start SOC' is not available because SmartLoad3 is disabled. Please enable SmartLoad3 first."
+3. Entity remains grayed out until SmartLoad3 is enabled
+
+#### Example 2: Wrong Mode
+1. User tries to set `SmartLoad1Start0` (time entity) when `SmartLoad1_SOC_Volt` is `true`
+2. System shows notification: "The setting 'SmartLoad1 Start0' is not available because SmartLoad1 is configured for Time mode. Please change to SOC/Volt mode first."
+3. Entity remains grayed out until SmartLoad mode changes
+
+#### Example 3: Always Available
+1. User can always access `SmartLoad1_Enable` switch regardless of other settings
+2. This allows users to enable/disable SmartLoads as needed
+
+## Benefits
+
+1. **Prevents Invalid Configurations**: Users cannot set conflicting settings
+2. **Clear User Feedback**: Persistent notifications explain why settings are unavailable
+3. **Dynamic Behavior**: Entities automatically update when dependencies change
+4. **No Breaking Changes**: Existing functionality remains intact
+5. **Extensible**: System can be extended for other conditional settings
+
+## Technical Notes
+
+- The system uses Home Assistant's built-in `available` property
+- Persistent notifications provide user feedback without popups
+- Entity availability updates are triggered asynchronously
+- The system gracefully handles missing or incomplete SmartSOCVoltBits data
+- All changes are backward compatible
+
+## Future Enhancements
+
+1. **Additional Dependencies**: Extend to other conditional settings
+2. **Bulk Operations**: Handle multiple entity updates more efficiently
+3. **Configuration UI**: Add visual indicators in the configuration flow
+4. **Automation Support**: Allow automations to be aware of entity availability

custom_components/monitormysolar/binary_sensor.py

@@ -32,9 +32,26 @@ async def async_setup_entry(
     for dongle_id in dongle_ids:
         firmware_code = coordinator.get_firmware_code(dongle_id)
 
+        # Only create entities if we have a firmware code
+        if not firmware_code:
+            LOGGER.debug(f"Skipping entity creation for {dongle_id} - no firmware code available yet")
+            continue
+        
         # Loop through the sensors in the configuration for this dongle
         for bank_name, sensors in sensors_config.items():
             for sensor in sensors:
+                allowed_firmware_codes = sensor.get("allowed_firmware_codes", [])
+                # For GridBoss dongles (IAAB), only create entities that explicitly allow this firmware code
+                if coordinator.is_gridboss_dongle(dongle_id):
+                    if not allowed_firmware_codes or firmware_code not in allowed_firmware_codes:
+                        continue
+                else:
+                    # For regular dongles, use the original logic
+                    if not allowed_firmware_codes or firmware_code in allowed_firmware_codes:
+                        pass  # Continue to entity creation
+                    else:
+                        continue  # Skip this entity
+                
                 if bank_name == "battery":
                     entities.append(
                         BatteryStatusBinarySensor(sensor, hass, entry, dongle_id)

custom_components/monitormysolar/button.py

@@ -24,9 +24,26 @@ async def async_setup_entry(hass, entry: MonitorMySolarEntry, async_add_entities
         firmware_code = coordinator.get_firmware_code(dongle_id)
         device_type = FIRMWARE_CODES.get(firmware_code, {}).get("Device_Type", "")
 
+        # Only create entities if we have a firmware code
+        if not firmware_code:
+            LOGGER.debug(f"Skipping entity creation for {dongle_id} - no firmware code available yet")
+            continue
+        
         # Process buttons for this dongle
         for bank_name, buttons in buttons_config.items():
             for button in buttons:
+                allowed_firmware_codes = button.get("allowed_firmware_codes", [])
+                # For GridBoss dongles (IAAB), only create entities that explicitly allow this firmware code
+                if coordinator.is_gridboss_dongle(dongle_id):
+                    if not allowed_firmware_codes or firmware_code not in allowed_firmware_codes:
+                        continue
+                else:
+                    # For regular dongles, use the original logic
+                    if not allowed_firmware_codes or firmware_code in allowed_firmware_codes:
+                        pass  # Continue to entity creation
+                    else:
+                        continue  # Skip this entity
+                
                 try:
                     if bank_name == "inputbank1": 
                         entities.append(