DMXCore.PluginSdk 0.5.0

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package DMXCore.PluginSdk --version 0.5.0

NuGet\Install-Package DMXCore.PluginSdk -Version 0.5.0

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="DMXCore.PluginSdk" Version="0.5.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="DMXCore.PluginSdk" Version="0.5.0" />
                    

                            Directory.Packages.props

<PackageReference Include="DMXCore.PluginSdk" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add DMXCore.PluginSdk --version 0.5.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: DMXCore.PluginSdk, 0.5.0"

#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.

#:package DMXCore.PluginSdk@0.5.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=DMXCore.PluginSdk&version=0.5.0
                    

                            Install as a Cake Addin

#tool nuget:?package=DMXCore.PluginSdk&version=0.5.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

DMXCore.PluginSdk

Contract SDK for building plugins for the DMX Core 100 lighting controller.

Getting started

Create a .NET class library targeting net10.0 and reference this package.
Implement IPlugin in a public class with a parameterless constructor.
Package the build output as a .dmxplugin archive (zip with a manifest.json plus your assemblies) and upload it to the device from the admin UI.

public class MyPlugin : IPlugin
{
    public PluginInfo Info { get; } = new()
    {
        Id = "my-plugin",
        Name = "My Plugin",
        Version = "1.0.0",
        Settings =
        [
            new() { Key = "server-address", Label = "Server address", Type = PluginSettingType.String },
            new() { Key = "poll-interval", Label = "Poll interval (s)", Type = PluginSettingType.Integer, DefaultValue = "5" },
            new() { Key = "api-key", Label = "API key", Type = PluginSettingType.String, Secret = true },
        ],
    };

    public Task InitializeAsync(IPluginHost host, CancellationToken cancellationToken)
    {
        string? server = host.Settings.GetString("server-address");
        host.Logger.LogInformation("Connecting to {Server}", server);

        host.Mqtt.Subscribe("some/topic/#", async (msg, ct) =>
        {
            await host.Triggers.FireAsync("MY-TRIGGER");
        });

        return Task.CompletedTask;
    }

    public Task ShutdownAsync(CancellationToken cancellationToken)
    {
        return Task.CompletedTask;
    }
}

Notes

Plugins run with full trust inside the DMX Core 100 process and can only be installed by device administrators.
Subscriptions take async handlers and return IDisposable; handler exceptions are logged by the host and do not terminate the subscription.
Plugin changes are applied on device restart; there is no hot reload.

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.10)

NuGet packages (7)

Showing the top 5 NuGet packages that depend on DMXCore.PluginSdk:

Package	Downloads
DMXCore.PluginSdk.Testing Test host for DMX Core 100 plugins: an in-memory IPluginHost that records publishes, trigger fires, and playback calls, and lets tests and dev harnesses simulate MQTT messages, cue events, and settings changes.	2.0K
DMXCore.Plugin.HomeAssistant Home Assistant integration for the DMX Core 100 lighting controller: publishes the device (cues, presets, timelines, control values, status) to Home Assistant via MQTT Discovery, and fires Home Assistant scenes, scripts and automations from the device as output actions.	312
DMXCore.Plugin.LIFX LIFX output for the DMX Core 100 lighting controller: drives LIFX WiFi color bulbs and SuperColour / pixel fixtures from DMX channel data over the LIFX LAN protocol, no cloud account required.	304
DMXCore.Plugin.Shelly Shelly output for the DMX Core 100 lighting controller: drives Shelly Gen1 color devices (RGBW2 and similar) from DMX channel data over MQTT.	219
DMXCore.Plugin.Symetrix Symetrix DSP integration for the DMX Core 100 lighting controller: Control Values on the device read and write controller numbers on Symetrix Radius, Prism, Solus and similar DSPs over the Composer control protocol.	185

GitHub repositories

This package is not used by any popular GitHub repositories.