UXAV.AVnet.Core 2.1.0-beta-9

This is a prerelease version of UXAV.AVnet.Core.
There is a newer version of this package available.
See the version list below for details.
dotnet add package UXAV.AVnet.Core --version 2.1.0-beta-9                
NuGet\Install-Package UXAV.AVnet.Core -Version 2.1.0-beta-9                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="UXAV.AVnet.Core" Version="2.1.0-beta-9" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add UXAV.AVnet.Core --version 2.1.0-beta-9                
#r "nuget: UXAV.AVnet.Core, 2.1.0-beta-9"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install UXAV.AVnet.Core as a Cake Addin
#addin nuget:?package=UXAV.AVnet.Core&version=2.1.0-beta-9&prerelease

// Install UXAV.AVnet.Core as a Cake Tool
#tool nuget:?package=UXAV.AVnet.Core&version=2.1.0-beta-9&prerelease                

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

<h1 align="center">AVnet Core</a></h1>

<p align="center">An open-source Crestron SimplSharp Pro framework for Crestron control systems</p>

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

<p align="center"><a href="https://uxav.github.io/AVnetCore">Explore Docs</a></p>

Index

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.Core
    
  2. Import the library classes in your code file(s):

    using UXAV.AVnet.Core.Models;
    using UXAV.AVnet.Core.Models.Diagnostics;
    using UXAV.Logging;
    
  3. Create a class that inherits from SystemBase:

    public class MySystem : SystemBase
    {
       public MySystem(CrestronControlSystem controlSystem) : base(controlSystem)
       {
          // create all your instance logic here and any instances of rooms, devices or 
       }
    
       protected override void AppShouldRunUpgradeScripts()
       {
          // called when the program starts with a new version number
       }
    
       protected override void OnProgramStatusEventHandler(eProgramStatusEventType eventType)
       {
          if (eventType == eProgramStatusEventType.Stopping)
          {
             // anything you need to save, disconnect or stop... the program is stopping
          }
       }
    
       protected override IEnumerable<DiagnosticMessage> GenerateDiagnosticMessages()
       {
          return new DiagnosticMessage[]
          {
             // add any diagnostic messages here,
             // this is called for when the system needs to update the
             // status of stuff or the dashboard app requests it
          };
       }
    
       protected override void SystemShouldAddItemsToInitialize(Action<IInitializable> addItem)
       {
          addItem(myDeviceWithInitialization);
          addItem(myOtherDeviceWithInitialization);
       }
    
       protected override void WebScriptingHandlersShouldRegister()
       {
          // any web scripting handlers for API's can and should register here (see docs)
       }
    }
    
  4. Load and Initialize your main instance of system

    public class ControlSystem : CrestronControlSystem
    {
       private readonly SystemBase _mySystem;
    
       public ControlSystem()
       {
          try
          {
             // create your instance of MySystem
             _mySystem = new MySystem(this);
          }
          catch (Exception e)
          {
             Logger.Error(e);
          }
       }
    
       public override void InitializeSystem()
       {
          try
          {
             // start the initializing of MySystem
             _mySystem?.Initialize();
          }
          catch (Exception e)
          {
             Logger.Error(e);
          }
       }
    }
    

GitHub Repository: AVnetCore

NuGet Package: UXAV.AVnet.Core

Dependencies

Release Notes

v2.0.0

  • Reconfigured workspace to new style SDK format and added support for .NET 6.0
  • MidnightNotifier removed completely, use a CronJob

Documentation

Documentation can be viewed in GitHub Pages

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.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Framework net472 is compatible.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (12)

Showing the top 5 NuGet packages that depend on UXAV.AVnet.Core:

Package Downloads
UXAV.AVnet.DashboardWebApp

WebApp for AVnet Core

UXAV.AVnet.QSC

SimplSharp QSys Library

UXAV.AVnet.Cisco

Cisco Room product control library

UXAV.AVnet.Crestron.Nvx

Package Description

UXAV.AVnet.Biamp

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.0 87 6/28/2024
2.1.0-rc-4 76 6/28/2024
2.1.0-rc-3 70 6/28/2024
2.1.0-rc-2 67 6/28/2024
2.1.0-rc-1 67 6/21/2024
2.1.0-beta-9 87 6/5/2024
2.1.0-beta-8 101 5/15/2024
2.1.0-beta-7 80 5/14/2024
2.1.0-beta-6 67 5/14/2024
2.1.0-beta-5 77 5/13/2024
2.1.0-beta-4 82 5/9/2024
2.1.0-beta-3 49 5/2/2024
2.1.0-beta-2 64 5/1/2024
2.1.0-beta-1 83 4/30/2024
2.0.1 108 4/19/2024
2.0.1-rc-7 81 4/19/2024
2.0.1-rc-6 109 4/4/2024
2.0.1-rc-5 62 4/3/2024
2.0.1-rc-4 63 4/3/2024
2.0.1-rc-3 64 4/2/2024
2.0.1-rc-2 46 4/2/2024
2.0.1-rc-1 156 3/19/2024
2.0.0 198 3/17/2024
2.0.0-rc-3 74 3/17/2024
2.0.0-rc-2 73 3/17/2024
2.0.0-rc-1 76 3/16/2024
2.0.0-beta-9 93 3/15/2024
2.0.0-beta-8 72 3/15/2024
2.0.0-beta-7 84 3/15/2024
2.0.0-beta-6 76 3/14/2024
2.0.0-beta-5 164 3/14/2024
2.0.0-beta-4 49 3/14/2024
2.0.0-beta-3 62 3/14/2024
2.0.0-beta-2 87 3/13/2024
2.0.0-beta-1 115 3/12/2024
1.13.0 97 3/15/2024
1.13.0-beta-05 78 3/15/2024
1.13.0-beta-04 61 3/8/2024
1.13.0-beta-03 59 3/8/2024
1.13.0-beta-02 71 3/8/2024
1.13.0-beta-01 75 3/8/2024
1.12.3 257 2/16/2024
1.12.2 145 2/16/2024
1.12.1 928 2/8/2024
1.12.0 828 2/8/2024
1.11.2 305 1/8/2024
1.11.1 295 12/13/2023
1.11.0 359 11/3/2023
1.10.3 419 10/13/2023
1.10.2 371 10/11/2023
1.10.1 410 10/3/2023
1.10.0 399 10/2/2023
1.9.3 378 9/22/2023
1.9.2 407 9/11/2023
1.9.1 384 9/10/2023
1.9.0 490 8/28/2023
1.8.2 548 6/12/2023
1.8.1 652 3/22/2023
1.8.0 674 2/8/2023
1.7.0 9,847 12/8/2022
1.6.1 647 12/6/2022
1.6.0 656 12/6/2022
1.5.0 864 7/5/2022
1.4.2 828 6/28/2022
1.4.1 778 6/17/2022
1.4.0 8,768 6/5/2022
1.3.0 798 5/25/2022
1.2.4 889 5/6/2022
1.2.4-beta-03 554 5/6/2022
1.2.4-beta-02 535 4/27/2022
1.2.4-beta-01 529 4/20/2022
1.2.3-beta-03 535 4/6/2022
1.2.3-beta-02 535 4/6/2022
1.2.3-beta-01 528 4/4/2022
1.2.2 5,463 3/8/2022
1.2.2-beta-04 484 3/6/2022
1.2.2-beta-03 516 3/4/2022
1.2.2-beta-02 552 2/24/2022
1.2.2-beta-01 541 2/18/2022
1.2.1-beta-02 3,194 11/25/2021
1.2.1-beta-01 576 11/15/2021
1.2.0-beta-02 539 11/3/2021
1.2.0-beta-01 536 11/3/2021
1.1.0-beta-02 561 10/5/2021
1.1.0-beta-01 1,823 9/27/2021
1.0.12 778 9/14/2021
1.0.12-beta-02 569 9/14/2021
1.0.12-beta-01 586 9/14/2021
1.0.11-beta-01 614 8/25/2021
1.0.10 2,281 8/18/2021
1.0.10-beta-06 540 8/16/2021
1.0.10-beta-05 576 8/16/2021
1.0.10-beta-04 599 8/4/2021
1.0.10-beta-03 563 8/4/2021
1.0.10-beta-02 580 8/4/2021
1.0.10-beta-01 573 8/4/2021
1.0.5-beta-02 3,922 7/29/2021
1.0.5-beta-01 1,850 7/28/2021
1.0.4-beta-03 666 7/27/2021
1.0.4-beta-02 551 7/21/2021
1.0.4-beta-01 577 7/20/2021
1.0.3-beta-02 583 7/6/2021
1.0.3-beta-01 577 7/5/2021
1.0.2 792 6/28/2021
1.0.2-beta-02 623 6/21/2021
1.0.2-beta-01 574 6/16/2021
1.0.1 751 6/15/2021
1.0.1-beta-02 620 6/15/2021
1.0.1-beta-01 584 6/15/2021
1.0.0 3,410 6/4/2021
1.0.0-beta-29 563 6/4/2021
1.0.0-beta-28 583 6/4/2021
1.0.0-beta-27 619 5/25/2021
1.0.0-beta-26 585 5/24/2021
1.0.0-beta-25 598 5/24/2021
1.0.0-beta-24 1,144 5/19/2021