UXAV.Logging

A Crestron logging solution with built-in console server and custom actions 🙂

Links

GitHub Repository: UXAV.Logging

NuGet Package: UXAV.Logging

Usage

To use this test library in your project, follow these steps:

1. Install the package via NuGet. You can use the following command in the Package Manager Console:

    dotnet add [<PROJECT>] package UXAV.Logging
   

2. Import the library in your code file:

   using UXAV.Logging;

3. Start using the library's features in your code:

   public ControlSystem()
   {
      // set this true if running a debug build
      if(debug)
      {
         // Set the logger level to log everything!
         Logger.Level = Logger.LoggerLevel.Debug;
   
         // Stream everything on the console output
         Logger.DefaultLogStreamLevel = Logger.LoggerLevel.Debug;
      }
      else
      {
         // Set the logger to ignore debug calls
         Logger.Level = Logger.LoggerLevel.Info;
   
         // Only output warnings and above on the console
         Logger.DefaultLogStreamLevel = Logger.LoggerLevel.Warning;
      }
   
      // Start the console server on port 9091 (if loaded in slot 1)
      Logger.StartConsole((int)(9000 + InitialParametersClass.ApplicationNumber));
   
      // Log some stuff
      Logger.Log("Hello, world!");
   }

Release Notes

v2.0.0

• Reconfigured workspace to new style SDK format and added support for .NET 6.0

Documentation

TBC

Contributing

Contributions are welcome! If you would like to contribute to this project, please follow these guidelines:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your forked repository.
5. Submit a pull request to the main repository.

Please ensure that your code follows the project's coding conventions and includes appropriate tests.

• For feature branches use the name feature/feature-name
• Version numbers are checked against existing tags and fail CI on match

Thank you for your interest in contributing to this project!

License

This project is licensed under the MIT License.