UXAV.AVnet.Core
2.2.0
See the version list below for details.
dotnet add package UXAV.AVnet.Core --version 2.2.0
NuGet\Install-Package UXAV.AVnet.Core -Version 2.2.0
<PackageReference Include="UXAV.AVnet.Core" Version="2.2.0" />
paket add UXAV.AVnet.Core --version 2.2.0
#r "nuget: UXAV.AVnet.Core, 2.2.0"
// Install UXAV.AVnet.Core as a Cake Addin #addin nuget:?package=UXAV.AVnet.Core&version=2.2.0 // Install UXAV.AVnet.Core as a Cake Tool #tool nuget:?package=UXAV.AVnet.Core&version=2.2.0
<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:
Install the package via NuGet. You can use the following command in the Package Manager Console:
dotnet add [<PROJECT>] package UXAV.AVnet.Core
Import the library classes in your code file(s):
using UXAV.AVnet.Core.Models; using UXAV.AVnet.Core.Models.Diagnostics; using UXAV.Logging;
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) } }
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); } } }
Links
GitHub Repository: AVnetCore
NuGet Package: UXAV.AVnet.Core
Dependencies
- UXAV.Logging
- Crestron.SimpleSharp.SDK.ProgramLibrary
- Crestron.SimplSharp.SDK.ProgramLibrary
- Cronos
- CsvHelper
- Figgle
- Microsoft.AspNet.WebApi.Client
- Microsoft.CSharp
- MimeTypes
- Newtonsoft.Json
- Newtonsoft.Json.Schema
- System.IO.Compression
- System.Net.Http
- System.Reflection.MetadataLoadContext
- System.Runtime.Serialization.Json
- UXAV.Logging
- WebSocketSharp-netstandard
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:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push your changes to your forked repository.
- 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 | Versions 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. |
-
.NETFramework 4.7.2
- Crestron.SimplSharp.SDK.ProgramLibrary (>= 2.20.52)
- Cronos (>= 0.8.4)
- CsvHelper (>= 31.0.2)
- Figgle (>= 0.5.1)
- Microsoft.AspNet.WebApi.Client (>= 6.0.0)
- Microsoft.CSharp (>= 4.7.0)
- MimeTypes (>= 2.4.1)
- Newtonsoft.Json (>= 13.0.3)
- Newtonsoft.Json.Schema (>= 3.0.15)
- System.IO.Compression (>= 4.3.0)
- System.Net.Http (>= 4.3.4)
- System.Reflection.MetadataLoadContext (>= 8.0.0)
- System.Runtime.Serialization.Json (>= 4.3.0)
- UXAV.Logging (>= 2.0.0)
- WebSocketSharp-netstandard (>= 1.0.1)
-
net6.0
- Crestron.SimplSharp.SDK.ProgramLibrary (>= 2.20.52)
- Cronos (>= 0.8.4)
- CsvHelper (>= 31.0.2)
- Figgle (>= 0.5.1)
- Microsoft.AspNet.WebApi.Client (>= 6.0.0)
- Microsoft.CSharp (>= 4.7.0)
- MimeTypes (>= 2.4.1)
- Newtonsoft.Json (>= 13.0.3)
- Newtonsoft.Json.Schema (>= 3.0.15)
- System.IO.Compression (>= 4.3.0)
- System.Net.Http (>= 4.3.4)
- System.Reflection.MetadataLoadContext (>= 8.0.0)
- System.Runtime.Serialization.Json (>= 4.3.0)
- UXAV.Logging (>= 2.0.0)
- WebSocketSharp-netstandard (>= 1.0.1)
-
net8.0
- Crestron.SimplSharp.SDK.ProgramLibrary (>= 2.20.52)
- Cronos (>= 0.8.4)
- CsvHelper (>= 31.0.2)
- Figgle (>= 0.5.1)
- Microsoft.AspNet.WebApi.Client (>= 6.0.0)
- Microsoft.CSharp (>= 4.7.0)
- MimeTypes (>= 2.4.1)
- Newtonsoft.Json (>= 13.0.3)
- Newtonsoft.Json.Schema (>= 3.0.15)
- System.IO.Compression (>= 4.3.0)
- System.Net.Http (>= 4.3.4)
- System.Reflection.MetadataLoadContext (>= 8.0.0)
- System.Runtime.Serialization.Json (>= 4.3.0)
- UXAV.Logging (>= 2.0.0)
- WebSocketSharp-netstandard (>= 1.0.1)
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 |
---|---|---|
3.0.1-beta-07 | 26 | 11/12/2024 |
3.0.1-beta-06 | 49 | 11/11/2024 |
3.0.1-beta-05 | 37 | 11/10/2024 |
3.0.1-beta-04 | 35 | 11/10/2024 |
3.0.1-beta-03 | 34 | 11/8/2024 |
3.0.1-beta-02 | 36 | 11/8/2024 |
3.0.1-beta-01 | 34 | 11/8/2024 |
3.0.0-beta-17 | 30 | 11/8/2024 |
3.0.0-beta-16 | 31 | 11/8/2024 |
3.0.0-beta-15 | 34 | 11/8/2024 |
3.0.0-beta-14 | 34 | 11/7/2024 |
3.0.0-beta-13 | 27 | 11/7/2024 |
3.0.0-beta-12 | 47 | 11/6/2024 |
3.0.0-beta-11 | 83 | 11/5/2024 |
3.0.0-beta-10 | 62 | 11/5/2024 |
3.0.0-beta-1 | 61 | 10/31/2024 |
2.2.0 | 123 | 10/22/2024 |
2.2.0-rc-1 | 64 | 10/21/2024 |
2.1.0 | 169 | 6/28/2024 |
2.1.0-rc-4 | 101 | 6/28/2024 |
2.1.0-rc-3 | 92 | 6/28/2024 |
2.1.0-rc-2 | 88 | 6/28/2024 |
2.1.0-rc-1 | 92 | 6/21/2024 |
2.1.0-beta-9 | 118 | 6/5/2024 |
2.1.0-beta-8 | 118 | 5/15/2024 |
2.1.0-beta-7 | 97 | 5/14/2024 |
2.1.0-beta-6 | 85 | 5/14/2024 |
2.1.0-beta-5 | 97 | 5/13/2024 |
2.1.0-beta-4 | 107 | 5/9/2024 |
2.1.0-beta-3 | 66 | 5/2/2024 |
2.1.0-beta-2 | 85 | 5/1/2024 |
2.1.0-beta-1 | 106 | 4/30/2024 |
2.0.1 | 141 | 4/19/2024 |
2.0.1-rc-7 | 102 | 4/19/2024 |
2.0.1-rc-6 | 130 | 4/4/2024 |
2.0.1-rc-5 | 83 | 4/3/2024 |
2.0.1-rc-4 | 89 | 4/3/2024 |
2.0.1-rc-3 | 84 | 4/2/2024 |
2.0.1-rc-2 | 65 | 4/2/2024 |
2.0.1-rc-1 | 175 | 3/19/2024 |
2.0.0 | 267 | 3/17/2024 |
2.0.0-rc-3 | 94 | 3/17/2024 |
2.0.0-rc-2 | 98 | 3/17/2024 |
2.0.0-rc-1 | 100 | 3/16/2024 |
2.0.0-beta-9 | 111 | 3/15/2024 |
2.0.0-beta-8 | 97 | 3/15/2024 |
2.0.0-beta-7 | 103 | 3/15/2024 |
2.0.0-beta-6 | 94 | 3/14/2024 |
2.0.0-beta-5 | 297 | 3/14/2024 |
2.0.0-beta-4 | 83 | 3/14/2024 |
2.0.0-beta-3 | 81 | 3/14/2024 |
2.0.0-beta-2 | 106 | 3/13/2024 |
2.0.0-beta-1 | 140 | 3/12/2024 |
1.13.0 | 116 | 3/15/2024 |
1.13.0-beta-05 | 104 | 3/15/2024 |
1.13.0-beta-04 | 85 | 3/8/2024 |
1.13.0-beta-03 | 91 | 3/8/2024 |
1.13.0-beta-02 | 88 | 3/8/2024 |
1.13.0-beta-01 | 81 | 3/8/2024 |
1.12.3 | 273 | 2/16/2024 |
1.12.2 | 168 | 2/16/2024 |
1.12.1 | 965 | 2/8/2024 |
1.12.0 | 865 | 2/8/2024 |
1.11.2 | 311 | 1/8/2024 |
1.11.1 | 319 | 12/13/2023 |
1.11.0 | 384 | 11/3/2023 |
1.10.3 | 452 | 10/13/2023 |
1.10.2 | 398 | 10/11/2023 |
1.10.1 | 435 | 10/3/2023 |
1.10.0 | 420 | 10/2/2023 |
1.9.3 | 410 | 9/22/2023 |
1.9.2 | 428 | 9/11/2023 |
1.9.1 | 405 | 9/10/2023 |
1.9.0 | 513 | 8/28/2023 |
1.8.2 | 578 | 6/12/2023 |
1.8.1 | 679 | 3/22/2023 |
1.8.0 | 698 | 2/8/2023 |
1.7.0 | 9,971 | 12/8/2022 |
1.6.1 | 679 | 12/6/2022 |
1.6.0 | 681 | 12/6/2022 |
1.5.0 | 893 | 7/5/2022 |
1.4.2 | 852 | 6/28/2022 |
1.4.1 | 802 | 6/17/2022 |
1.4.0 | 8,865 | 6/5/2022 |
1.3.0 | 826 | 5/25/2022 |
1.2.4 | 930 | 5/6/2022 |
1.2.4-beta-03 | 574 | 5/6/2022 |
1.2.4-beta-02 | 560 | 4/27/2022 |
1.2.4-beta-01 | 556 | 4/20/2022 |
1.2.3-beta-03 | 562 | 4/6/2022 |
1.2.3-beta-02 | 558 | 4/6/2022 |
1.2.3-beta-01 | 549 | 4/4/2022 |
1.2.2 | 5,539 | 3/8/2022 |
1.2.2-beta-04 | 512 | 3/6/2022 |
1.2.2-beta-03 | 538 | 3/4/2022 |
1.2.2-beta-02 | 573 | 2/24/2022 |
1.2.2-beta-01 | 568 | 2/18/2022 |
1.2.1-beta-02 | 3,211 | 11/25/2021 |
1.2.1-beta-01 | 609 | 11/15/2021 |
1.2.0-beta-02 | 562 | 11/3/2021 |
1.2.0-beta-01 | 556 | 11/3/2021 |
1.1.0-beta-02 | 587 | 10/5/2021 |
1.1.0-beta-01 | 1,858 | 9/27/2021 |
1.0.12 | 803 | 9/14/2021 |
1.0.12-beta-02 | 595 | 9/14/2021 |
1.0.12-beta-01 | 611 | 9/14/2021 |
1.0.11-beta-01 | 640 | 8/25/2021 |
1.0.10 | 2,372 | 8/18/2021 |
1.0.10-beta-06 | 568 | 8/16/2021 |
1.0.10-beta-05 | 596 | 8/16/2021 |
1.0.10-beta-04 | 621 | 8/4/2021 |
1.0.10-beta-03 | 591 | 8/4/2021 |
1.0.10-beta-02 | 601 | 8/4/2021 |
1.0.10-beta-01 | 600 | 8/4/2021 |
1.0.5-beta-02 | 3,987 | 7/29/2021 |
1.0.5-beta-01 | 1,885 | 7/28/2021 |
1.0.4-beta-03 | 687 | 7/27/2021 |
1.0.4-beta-02 | 570 | 7/21/2021 |
1.0.4-beta-01 | 597 | 7/20/2021 |
1.0.3-beta-02 | 604 | 7/6/2021 |
1.0.3-beta-01 | 604 | 7/5/2021 |
1.0.2 | 817 | 6/28/2021 |
1.0.2-beta-02 | 647 | 6/21/2021 |
1.0.2-beta-01 | 603 | 6/16/2021 |
1.0.1 | 773 | 6/15/2021 |
1.0.1-beta-02 | 640 | 6/15/2021 |
1.0.1-beta-01 | 601 | 6/15/2021 |
1.0.0 | 3,723 | 6/4/2021 |
1.0.0-beta-29 | 587 | 6/4/2021 |
1.0.0-beta-28 | 602 | 6/4/2021 |
1.0.0-beta-27 | 637 | 5/25/2021 |
1.0.0-beta-26 | 601 | 5/24/2021 |
1.0.0-beta-25 | 625 | 5/24/2021 |
1.0.0-beta-24 | 1,338 | 5/19/2021 |