Skip to content

v1.3.0

Choose a tag to compare

View all tags
@remmob remmob released this 26 Feb 19:40
v1.3.0
542e648
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

⚠️⚠️⚠️ BREAKING CHANGE WARNING ⚠️⚠️⚠️

This update includes the renaming of 57 entities (fixing the typo temperture → temperature).

Impact

Existing automations, dashboards, scripts, and templates using these entities may stop working until updated.

Affected Entities

All temperature-related sensors with the typo temperture in their entity ID have been renamed to temperature:

  • Example: sensor.amber_outside_temperture → sensor.amber_outside_temperature
  • Example: sensor.amber_dhw_tank_temperture → sensor.amber_dhw_tank_temperature

Migration Steps

  1. Backup your configuration before updating
  2. Update the integration
  3. Check Settings → Devices & Services → Itho Amber for entity rename notifications
  4. Update your automations, dashboards, and scripts with the new entity IDs
  5. Verify everything works as expected

Dashboard Available

A fully updated dashboard is available Here!

🚀 New Features

Connection Monitoring

  • Connection Status Sensor: New diagnostic sensor (sensor.amber_connection_status) provides real-time connection status: "OK", "Partial", "Failed", or "Connection Error". Now located in the Diagnostics section for better organization.
  • Dashboard Integration: The connection status entity can be used for custom dashboard items like status badges, conditionals, and automations
  • Example Dashboard: The example dashboard (available on GitHub) now includes an extensive Status tab featuring:
    • Real-time connection status indicator
    • Visual display of sensor availability
  • Partial Failure Detection: Automatically detects and reports when some register blocks fail to read, setting status to "Partial" while continuing with available data.

Configuration Options Flow

  • Runtime Configuration: Adjust connection settings without restarting Home Assistant:
    • IP address and port
    • Poll interval
    • All notification options - completely redesigned interface
  • Clear Structure:
    • Separate sections for alarm and connection notifications
    • Each section has its own persistent/mobile toggles
    • Separate notify service fields for maximum flexibility
  • Live Validation: IP addresses and notify service names are checked in real-time
  • Protected Name: Integration name can only be changed during initial setup, prevents accidental changes
  • Easy Access: Configure via Settings → Devices & Services → Itho Amber → Configure

Alarm Monitoring (NEW!)

  • Automatic Alarm Detection: Monitors all 57 heat pump alarm sensors (P01-P13, F01-F30, E01-E08, S01-S06)
  • Smart Delays:
    • Configurable delay for most alarms (default: 60 seconds)
    • Minimum 5-minute delay for S06/S07 (temperature warnings) to prevent false alerts
  • Auto-Cancellation: Notifications are cancelled if alarm clears before delay expires
  • Dual Notification Channels:
    • Persistent Notifications (configurable): In-app notifications in Home Assistant
    • Mobile App Notifications (optional): Send to one or more mobile devices
    • Each type can be independently enabled or disabled
  • Separate Service Configuration: Different notify services possible for alarm vs connection notifications
  • Customizable Title: Set your own notification title (default: "Warmtepomp in storing!")
  • Service Validation: Automatically validates that specified notify services exist before saving

Connection Error Notifications (NEW!)

  • Separate Configuration: Independent settings for connection notifications
  • Intelligent Threshold: Notification after 4 consecutive failed polls (default ~2 minutes)
  • Dual Channels: Choice between persistent and/or mobile notifications here too
  • Separate Notify Services: Can use different services than alarm notifications (e.g., alarms to phone, connection to tablet)

Notification Configuration Examples

# Only persistent notifications in Home Assistant
Send notifications for alarms (P/F/E/S): 
  - Persistent notifications: ✓ ON
  - Mobile app notifications: ✗ OFF
  - Notify services for alarms: (empty)

# Only mobile notifications for alarms
Send notifications for alarms (P/F/E/S):
  - Persistent notifications: ✗ OFF
  - Mobile app notifications: ✓ ON
  - Notify services for alarms: mobile_app_iphone

# Both channels with multiple devices
Send notifications for alarms (P/F/E/S): 
  - Persistent notifications: ✓ ON
  - Mobile app notifications: ✓ ON
  - Notify services for alarms: mobile_app_iphone,mobile_app_tablet

# Separate services for different notification types
Alarm notifications:
  - Notify services for alarms: mobile_app_iphone,notify.pushover
Connection notifications:
  - Notify services for connection errors: mobile_app_tablet,notify.telegram

# Custom delay for sensitive sensors
Alarm delay (seconds): 300  # 5 minutes for all alarms
# S06/S07 always get minimum 5 minutes, regardless of this value

🛠️ Improvements

Entity Naming

  • Fixed Typo: Corrected temperture → temperature across 57 entities
  • Standardized Naming: All temperature-related entities now follow consistent naming convention
  • Automatic Migration: Entity ID history is preserved where possible

Enhanced Reconnect Logic

  • Reworked Modbus Hub: Completely redesigned reconnect flow for maximum stability
  • Smart Client Recreation: Fully recreates Modbus client instance on connection failures
  • More Reliable Recovery: Improved recovery from network issues with automatic retry mechanism

Retry Mechanism

  • 3 retry attempts per register block with intelligent delays
  • Maximizes data retrieval even during intermittent network issues
  • Continues operation with partial data when some blocks fail

Robust Error Handling

  • Clear differentiation between connection errors (network) and read failures (device)
  • Comprehensive logging for troubleshooting
  • User-friendly error messages in configuration interface

🐛 Bug Fixes

  • Fixed issue where connection loss did not automatically reconnect, leading to stale data
  • Resolved incomplete data reads by retrying failed blocks instead of aborting the entire update
  • Corrected 57 temperature entity names (typo fix: temperture → temperature)
  • Cleaned up unused imports for better code maintainability
  • Fixed options flow initialization issues with proper config entry handling
  • Minor internal cleanups and consistency improvements

🔄 Migration Notes

⚠️ IMPORTANT: Entity Rename Migration

Before updating:

  1. Make a backup of your Home Assistant configuration
  2. Export or screenshot your current dashboards
  3. Note which automations use temperature sensors

After updating:

  1. Check Settings → System → Repairs for entity rename notifications
  2. Update all automations using temperature sensors
  3. Update all dashboards with temperature cards
  4. Update scripts and templates referencing temperature entities
  5. Test thoroughly before relying on the integration in production

Finding affected entities:
Use Developer Tools → States and filter for amber to see all entity IDs.

Replacing Manual Automation

If you previously created a manual automation for alarm notifications, you can now:

  1. Enable "Alarm notifications" in the integration configuration
  2. Add your mobile notify services (comma-separated)
  3. Customize the notification title if desired
  4. Delete your old automation - the integration handles it automatically!

📖 Documentation

  • Full configuration guide available on GitHub Wiki Soon!
  • Automation examples for advanced use cases
  • Updated dashboard available: Here
    • New Status tab with real-time connection monitoring
    • Examples of connection status entity usage
    • Visual indicators for sensor availability
    • Ready to use as inspiration for your own dashboards

🙏 Feedback Welcome

This beta release focuses on reliability, stability, and user feedback. Please report any issues, suggestions, or feature requests on GitHub Issues! 🎉

Known Limitations

  • Alarm monitoring requires sensor entities to be available (integration must be fully loaded)
  • Mobile notifications require valid notify services to be configured in Home Assistant
  • Note: Mobile app notifications only work if the mobile app is properly configured and online
    • Always test first with Developer Tools → Services before relying on notifications
    • If you see "Internal error encountered", the issue is with the mobile app service, not this integration
  • Persistent notification history is not preserved across Home Assistant restarts
  • Entity rename may require manual updates in some advanced configurations
  • Integration name can only be changed during initial setup (protected against accidental changes)

What's Changed

New Contributors

Full Changelog: v1.2.6...v1.3.0

Contributors

remmob
Assets 2
Loading