Skip to content

v1.0.1

Latest
Compare
Choose a tag to compare
@ljgonzalez1 ljgonzalez1 released this 14 Jan 17:57

Release Notes for v1.0.1


What's New in v1.0.1

Bug Fixes and Patches

  • Improved Network Management

    • Reduced the minimum number of readings required to trigger the action from 3 to 1, improving responsiveness (f81fd66).
    • Implemented lower debounce time for more accurate signal detection (c177753).
    • Added retry mechanisms for providers to enhance reliability during network interruptions (46f11bb).
  • Fixes for Notification Mechanisms

    • Reverted the "Super-attempts" feature in network_manager.py to address unintended behavior and improve reliability (03e714d).
    • Resolved issues with loop stalling by ensuring non-blocking operations (d634445).
    • Adjusted main coroutine and loop to enhance stability (476d86a, dd3c03c).
  • Temporary Fix Removal

    • Removed a temporary fix in the codebase to clean up unused or redundant logic (ee108b1).
  • Enhanced Logging and Message Clarity

    • Updated messages for better clarity during debugging and user interactions (327d905).

Notable Changes by Module

src/core

  • doorbell.py

    • Lowered debounce time for better detection sensitivity.
  • network_manager.py

    • Enhanced retry logic for connection attempts and removed "Super-attempts" logic.

src/notifications

  • notifier.py
    • Introduced a retry mechanism for sending notifications with configurable delays and maximum attempts.

src/utils

  • logging.py
    • Updated to reflect message changes and better handle debug outputs during retries.

Installation and Setup

  1. Clone the Repository
    Copy the updated files into your environment or directly onto the Raspberry Pi Pico’s filesystem.

  2. Update Configuration

    • Verify and adjust settings in src/config/settings.py as needed for your environment.
    • Confirm retry mechanism parameters in src/notifications/notifier.py for your desired behavior.
  3. Deploy and Run

    • Upload the files to the device and execute main.py.
    • Ensure required dependencies are installed.

Known Issues and Limitations

  • Network Reconnection Overhead
    Network reconnections are still required for each notification, which might introduce delays if multiple providers are enabled.

  • Provider Retry Behavior
    Retry mechanisms might cause slight delays during network outages when attempting to send notifications.


Future Enhancements

  • Optimized Retry Mechanisms
    Implement smarter retry logic to reduce delays and optimize network usage.

  • Provider-Specific Improvements
    Enhance individual provider configurations for more robust notification handling.

  • Centralized Loop Management
    Explore further optimizations to avoid halts or blocking issues in the main loop.


License

This project is licensed under the MIT License. See license for full details.


Full Changelog: v1.0.0...v1.0.1