DMXCore.PluginSdk 1.7.2

DMXCore.PluginSdk

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

Getting started

1. Create a .NET class library targeting net10.0 and reference this package.
2. Set <PluginId> (plus Version and friends) in the project file — the build then generates manifest.json and a PluginBuildInfo constants class, so the plugin id and version live in exactly one place.
3. Implement IPlugin in a public class with a parameterless constructor.
4. Package the build output as a .dmxplugin archive (zip with the generated manifest.json plus your assemblies) and upload it to the device from the admin UI.

<PropertyGroup>
  <PluginId>my-plugin</PluginId>
  <PluginDisplayName>My Plugin</PluginDisplayName>
  <Version>1.0.0</Version>
  <Authors>Me</Authors>
</PropertyGroup>

public class MyPlugin : IPlugin
{
    public PluginInfo Info { get; } = new()
    {
        Id = PluginBuildInfo.Id,
        Name = PluginBuildInfo.Name,
        Version = PluginBuildInfo.Version,
        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.
• host.Mdns discovers devices on the local network through the host's shared mDNS/DNS-SD browser, e.g. await host.Mdns.GetServicesAsync("_hue._tcp") — no need to bundle an mDNS stack in the plugin. Requires SDK contract 1.1; declare "minSdkVersion": "1.1" in the manifest if the plugin depends on it.
• host.Actions.RegisterProvider(...) makes the plugin an output action provider: its targets (e.g. Home Assistant scenes) become selectable on the device's Output Events page, and the resulting events can be fired from control surfaces, custom menus, input triggers, timelines and scripts. Requires SDK contract 1.7.
• The generated manifest's minSdkVersion defaults to the contract version of the SDK assembly the project compiles against (the assembly version's major.minor — not the NuGet package version, which is just a publish counter). Reference the oldest SDK package you support and the declared floor is correct by construction; set <PluginMinSdkVersion> to override.
• Plugin changes are applied by the Reload action on the device's Plugins page (or a device restart).