UXAV.AVnet.QSys 2.0.0-rc-01

<p align="center"> <img src="avnet_logo.svg"> </p>

<h1 align="center">AVnet QSys Library</a></h1>

<p align="center">An open-source QSys Library for use in AVnet Framework</p>

<p align="center"> <img alt="Status" src="https://img.shields.io/github/actions/workflow/status/uxav/UXAV.AVnet.QSys/test.yml?branch=main&style=flat&logo=github&label=status"> <img alt="NuGet Version" src="https://img.shields.io/nuget/v/UXAV.AVnet.QSys?style=flat&logo=nuget"> <img alt="Downloads" src="https://img.shields.io/nuget/dt/UXAV.AVnet.QSys?style=flat&logo=nuget"> <img alt="Issues" src="https://img.shields.io/github/issues/uxav/UXAV.AVnet.QSys?style=flat&logo=github"> <img alt="Pull Requests" src="https://img.shields.io/github/issues-pr/uxav/UXAV.AVnet.QSys?style=flat&logo=github"> <img alt="Licnse" src="https://img.shields.io/github/license/uxav/UXAV.AVnet.QSys?style=flat"> </p>

Index

• Quick start
• Links
• Dependencies
• Release Notes
• Contributing
• License

Quick Start

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.AVnet.QSys
   

2. Import the library classes in your code file(s):

   // Import QSys from AVnet
   using UXAV.AVnet.QSys;
   using UXAV.AVnet.QSys.Components;
   

3. Use the following to control a core:

   // create an instance of a core
   _dsp = new QSysCore("My Core", "192.168.10.10");
   
   // listen for the HasInitialized event trigger
   _dsp.HasInitialized += (sender, args) =>
   {
      // core instance should now have all components listed with external script access
      // get a component such as a gain block
      _myGain = _dsp.GetComponent<GainComponent>("Test.Gain");
      // listen for changes on the gain block
      _myGain.Change += (o, eventArgs) =>
      {
         Logger.Log($"Gain changed to {_myGain.Gain.String}");
      };
      // in order for the core to emit changes you need to call auto poll on a change group
      // the default internal group contains all components or just create your own change group
      _dsp.ChangeGroups.Default.AutoPoll(0.5);
   };
   

Links

GitHub Repository: UXAV.AVnet.QSys

NuGet Package: UXAV.AVnet.QSys

Dependencies

• Crestron.SimplSharp.SDK.ProgramLibrary
• UXAV.AVnet.Core

Release Notes

v2.0.0

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

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.