Skip to content

Conversation

@andrew-welker
Copy link
Contributor

@andrew-welker andrew-welker commented Dec 23, 2025

This pull request refactors and improves the BridgeBase.cs file in several ways, focusing on modernizing logging practices, enhancing documentation, and expanding device support. The most significant changes are the replacement of the old logging system with extension-based logging methods, improved XML documentation for better code clarity, and support for new device types in the EISC API factory.

Logging modernization and error handling:

  • Replaced all usages of the legacy Debug.LogMessage with new extension-based logging methods such as this.LogDebug, this.LogInformation, this.LogWarning, this.LogVerbose, and this.LogError throughout the file, improving consistency and maintainability of logging. [1] [2] [3] [4] [5] [6] [7] [8]
  • Enhanced error handling in exception blocks by logging both error messages and stack traces for easier debugging. [1] [2]

Documentation and code clarity:

  • Added or improved XML documentation comments for constructors, methods, and parameters across the file, making the codebase easier to understand and maintain. [1] [2] [3]
  • Marked the BridgeApi base class as [Obsolete("Will be removed in v3.0.0")] to indicate its planned deprecation.
  • Updated summary comments for classes and methods to better describe their purpose and usage. [1] [2] [3]

Device and factory enhancements:

  • Expanded the EiscApiAdvancedFactory to support additional device types, specifically UDP variants (eiscapiadvudp, eiscapiadvancedudp), and updated the type list and instantiation logic accordingly.
  • Improved the summary and remarks for the factory class to document all supported device types.

Other improvements:

  • Refactored some method implementations for clarity and conciseness, such as simplifying type checks and removing redundant code.
  • Removed commented or obsolete code to clean up the file. [1] [2] [3]

These changes collectively improve code readability, maintainability, and extend the capabilities of the EISC API infrastructure.

  • fix: support for legacy UDP EISC
  • chore: update comments, debug methods, and mark some things obsolete

Copilot AI review requested due to automatic review settings December 23, 2025 16:57
ndorin
ndorin previously approved these changes Dec 23, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds support for legacy UDP EISC communication, updates logging methods to use modern extension-based patterns with structured logging, adds documentation comments, and marks the BridgeApi base class as obsolete for future removal.

Key Changes:

  • Added UDP EISC support with new device types "eiscapiadvudp" and "eiscapiadvancedudp"
  • Migrated from Debug.LogMessage static calls to extension method logging (this.LogDebug, this.LogWarning, etc.) with structured logging placeholders
  • Enhanced XML documentation for classes, methods, and parameters throughout the file

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ndorin ndorin merged commit 39c1f60 into main Dec 23, 2025
2 checks passed
@ndorin ndorin deleted the udp-eisc branch December 23, 2025 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants