DeckX.Core 1.0.0

DeckX.Core SDK

DeckX.Core is the official .NET 8 SDK for building custom button plugins and full-screen interactive canvas dashboards for the DeckX Stream Deck hardware and DeckX Control Studio.

Features

• Hardware Button Plugins (IDeckXPlugin): Create custom action packs, toggles, macros, and 1-second live telemetry LCD tickers.
• Full-Screen Canvas Plugins (IDeckXCanvasPlugin): Render full-screen 480x272 SkiaSharp dashboards, custom gauges, media players, and process raw capacitive touch coordinates.
• USB Serial Protocol Contracts: Standardized data models for high-performance communication with the ESP32-S3 hardware controller.

Installation

Install via NuGet Package Manager or .NET CLI:

dotnet add package DeckX.Core

Or via Package Manager Console:

Install-Package DeckX.Core

Quick Start: Creating a Button Plugin

using DeckX.Core.Models;
using DeckX.Core.Plugins;

public class MyCustomPlugin : IDeckXPlugin
{
    public string Id => "com.example.myplugin";
    public string Name => "My Custom Plugin";
    public string Version => "1.0.0";
    public string Author => "Developer";
    public string Description => "Custom DeckX Stream Deck actions";
    public string Category => "Utilities";
    public string CategoryIconGeometry => "M12 2L2 7l10 5 10-5-10-5z...";
    public string? IconGeometry => CategoryIconGeometry;

    public void OnInitialize(IDeckXPluginContext context)
    {
        // Register key action tickers
    }

    public void OnShutdown() { }

    public IEnumerable<ActionItemModel> GetActions() => new[]
    {
        new ActionItemModel
        {
            Id = "my_action",
            Title = "My Action",
            Description = "Executes custom action",
            PluginId = Id
        }
    };

    public Task OnActionTriggeredAsync(string actionId, DeckKeyActionContext context)
    {
        // Handle key press
        return Task.CompletedTask;
    }
}

Quick Start: Creating a Canvas Dashboard Plugin

using DeckX.Core.Models;
using DeckX.Core.Plugins;
using SkiaSharp;

public class MyCanvasDashboard : IDeckXCanvasPlugin
{
    public string Id => "com.example.mycanvas";
    public string Name => "Interactive Dashboard";
    public string Version => "1.0.0";
    public string Author => "Developer";
    public string Description => "480x272 Interactive Touch Dashboard";
    public string Category => "Dashboards";
    public string CategoryIconGeometry => "M3 3h18v18H3V3z...";

    public int TargetFps => 1;
    public bool NeedsContinuousStream => false;
    public event Action? RequestRedraw;

    public void RenderCanvas(SKCanvas canvas, int width, int height)
    {
        canvas.Clear(new SKColor(15, 17, 23));
        using var paint = new SKPaint { Color = SKColors.White, TextSize = 20, IsAntialias = true };
        canvas.DrawText("DeckX Virtual Canvas", 40, 50, paint);
    }

    public Task OnCanvasTouchAsync(CanvasTouchEventArgs e)
    {
        // Handle touch at (e.X, e.Y)
        RequestRedraw?.Invoke();
        return Task.CompletedTask;
    }

    public void OnInitialize(IDeckXPluginContext context) { }
    public void OnShutdown() { }
    public IEnumerable<ActionItemModel> GetActions() => Array.Empty<ActionItemModel>();
    public Task OnActionTriggeredAsync(string actionId, DeckKeyActionContext context) => Task.CompletedTask;
}

License

This project is licensed under the MIT License.