-
Notifications
You must be signed in to change notification settings - Fork 84
udp eisc #1370
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this 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.
This pull request refactors and improves the
BridgeBase.csfile 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:
Debug.LogMessagewith new extension-based logging methods such asthis.LogDebug,this.LogInformation,this.LogWarning,this.LogVerbose, andthis.LogErrorthroughout the file, improving consistency and maintainability of logging. [1] [2] [3] [4] [5] [6] [7] [8]Documentation and code clarity:
BridgeApibase class as[Obsolete("Will be removed in v3.0.0")]to indicate its planned deprecation.Device and factory enhancements:
EiscApiAdvancedFactoryto support additional device types, specifically UDP variants (eiscapiadvudp,eiscapiadvancedudp), and updated the type list and instantiation logic accordingly.Other improvements:
These changes collectively improve code readability, maintainability, and extend the capabilities of the EISC API infrastructure.