Add packet statistic information to the ACU Console app

[bytedreamer]

Include following information

• Total number of commands sent
• Total number of replies received
• Percentage of commands sent with replies (connection health)
• Count for both clear and encrypted packets

Allow for the user to reset counts

[github-actions]

Issue Analysis: Add Packet Statistics to ACU Console

Category

Enhancement - This is a feature request to add statistics tracking and display functionality to the ACUConsole application.

Complexity Assessment

Moderate - The implementation requires changes across multiple layers but follows established patterns in the codebase.

Priority

Medium - This is a valuable quality-of-life enhancement that provides visibility into connection health and packet flow, which aids debugging and monitoring. While not critical for core functionality, it significantly improves the user experience for troubleshooting and system monitoring.

Requirements Analysis

The issue requests the following statistics in the ACU Console:

1. Total number of commands sent
2. Total number of replies received
3. Percentage of commands sent with replies (connection health indicator)
4. Separate counts for clear (unencrypted) and encrypted packets
5. Ability to reset/clear statistics

Affected Modules/Files

Core Library Changes (src/OSDP.Net):

• ControlPanel.cs - Add statistics tracking API and events
• Bus.cs - Track command/reply counts at the bus level where messages are sent/received
• DeviceProxy.cs - May need to track per-device statistics
• Messages/OutgoingMessage.cs & Messages/IncomingMessage.cs - Access to encryption status

ACUConsole Application Changes (src/ACUConsole):

• ACUConsolePresenter.cs - Add statistics management methods and expose statistics data
• ACUConsoleView.cs - Add UI panel for statistics display
• New Dialog: Dialogs/PacketStatisticsDialog.cs - Full-screen statistics display with reset capability
• Menu Integration - Add menu item to view/reset statistics

Implementation Approach

Phase 1: Core Statistics Tracking (OSDP.Net Library)

1. Create Statistics Model (src/OSDP.Net/PacketStatistics.cs):

public class PacketStatistics
{
    public long CommandsSent { get; set; }
    public long RepliesReceived { get; set; }
    public long ClearPacketsSent { get; set; }
    public long EncryptedPacketsSent { get; set; }
    public long ClearPacketsReceived { get; set; }
    public long EncryptedPacketsReceived { get; set; }
    public DateTime StartTime { get; set; }
    
    public double HealthPercentage => CommandsSent > 0 
        ? (RepliesReceived * 100.0) / CommandsSent 
        : 0.0;
    
    public void Reset() { /* Clear all counters */ }
}

2. Modify Bus.cs (src/OSDP.Net/Bus.cs:~line 200-300):

   • Add PacketStatistics field
   • Increment counters in the polling loop where messages are sent/received
   • Check SecurityBlock to determine if packet is encrypted
   • Track at both bus level and optionally per-device level

3. Extend ControlPanel.cs (src/OSDP.Net/ControlPanel.cs):

   • Add GetStatistics(Guid connectionId) method
   • Add ResetStatistics(Guid connectionId) method
   • Expose statistics through property or event

Phase 2: ACUConsole Integration

1. Update ACUConsolePresenter.cs:

   • Add method: GetPacketStatistics() - retrieves current statistics from ControlPanel
   • Add method: ResetPacketStatistics() - resets statistics counters
   • Add periodic update mechanism (optional: statistics changed event)

2. Create Statistics Panel in ACUConsoleView.cs (src/ACUConsole/ACUConsoleView.cs:~line 150-220):

   • Add a new FrameView for statistics (similar to existing Device Status panel)
   • Display real-time statistics in a compact format:

     Packet Statistics
     ────────────────────
     Commands:    1,234
     Replies:     1,198
     Health:      97.1%
     
     Clear:       234
     Encrypted:   1,000
     

   • Update display on message received events

3. Add Menu Integration (src/ACUConsole/ACUConsoleView.cs:~line 82-133):

   • Add to System menu: "View _Packet Statistics"
   • Add to System menu: "_Reset Packet Statistics"
   • Or create new "Statistics" menu bar item

4. Optional: Create Detailed Statistics Dialog (src/ACUConsole/Dialogs/PacketStatisticsDialog.cs):

   • Full-screen view following Terminal.Gui style guide
   • Show detailed breakdown with timestamps
   • Include reset button following dialog standards
   • Display per-device statistics if implemented

Phase 3: Testing & Polish

1. Verify statistics accuracy with various scenarios:

   • Clear channel communication
   • Secure channel communication (encrypted)
   • Connection interruptions (NAK responses)
   • Multiple devices

2. Ensure statistics persist across connection restarts within same session

3. Follow ReSharper code inspection requirements - Run inspection and fix all warnings/errors

Technical Considerations

1. Thread Safety: Use Interlocked.Increment() for counter updates since Bus polling occurs on background thread
2. Performance: Statistics tracking should have minimal overhead - simple counter increments
3. Encryption Detection: Check SecurityBlock.IsSecureControlBlock() or message security context to determine if packet is encrypted
4. UI Update Frequency: Update statistics display at reasonable intervals (e.g., on each message event) to avoid UI thrashing
5. Memory: Use long type for counters to avoid overflow during long-running sessions

Estimated Implementation Effort

• Core statistics tracking (Phase 1): 4-6 hours
• UI integration (Phase 2): 3-4 hours
• Testing and polish (Phase 3): 2-3 hours
• Total: ~9-13 hours for complete implementation

Success Criteria

• Statistics accurately track all commands and replies
• Clear vs encrypted packets are correctly identified and counted
• Connection health percentage is calculated and displayed
• UI displays statistics in real-time
• Reset functionality clears all counters
• No ReSharper warnings or errors
• Follows existing Terminal.Gui style guidelines
• Thread-safe implementation with no race conditions

---

Recommendation: This is a straightforward enhancement that would significantly improve the debugging and monitoring capabilities of the ACU Console. The implementation follows existing patterns in the codebase and integrates cleanly with the current architecture. Suggest implementing as three phases with core library changes first, followed by UI integration.