AlienFx.Api
1.0.1
dotnet add package AlienFx.Api --version 1.0.1
NuGet\Install-Package AlienFx.Api -Version 1.0.1
<PackageReference Include="AlienFx.Api" Version="1.0.1" />
<PackageVersion Include="AlienFx.Api" Version="1.0.1" />
<PackageReference Include="AlienFx.Api" />
paket add AlienFx.Api --version 1.0.1
#r "nuget: AlienFx.Api, 1.0.1"
#:package AlienFx.Api@1.0.1
#addin nuget:?package=AlienFx.Api&version=1.0.1
#tool nuget:?package=AlienFx.Api&version=1.0.1
AlienFx.Api NuGet package
A .NET 10 API client for controlling AlienFX lighting zones on Alienware systems.
Status
This package provides:
- A production-ready
AlienFxClientAPI surface. - Built-in profiles including
AllWhiteandPanoramicTeal. - HID transport using
HidSharpand AlienFX protocol command packets. - Unit tests for profile behavior and protocol packet generation.
Current limitation:
GetProfileAsyncreturns the current profile tracked by this client instance. Reading the active hardware profile from AWCC storage is planned and tracked inPLAN.md.
Installation
Install-Package AlienFx.Api
Requirements
- .NET 10 SDK/runtime.
- Windows.
- AlienFX-capable device.
Quick Start
using AlienFx.Api;
var client = new AlienFxClient();
await client.SetProfileAsync(AlienFxProfiles.AllWhite, CancellationToken.None);
Main API
Required methods:
public async Task<AlienFxProfile> GetProfileAsync(CancellationToken)
public async Task SetProfileAsync(AlienFxProfile, CancellationToken)
Additional convenience method:
public async Task SetProfileAsync(string builtInProfileName, CancellationToken)
Built-in Profiles
The package currently includes:
AllWhite.PanoramicTeal.
You can also create your own:
var profile = AlienFxProfiles.AllZonesSolid(AlienFxColor.FromHex("#FF6A00"), "WarmOrange");
await client.SetProfileAsync(profile, cancellationToken);
Custom Profiles
var custom = new AlienFxProfile(
"KeyboardAndLogo",
new Dictionary<AlienFxZone, AlienFxColor>
{
[AlienFxZone.LeftZone] = AlienFxColor.FromHex("#00FFFF"),
[AlienFxZone.RightZone] = AlienFxColor.FromHex("#00FFFF"),
[AlienFxZone.AlienFrontLogo] = AlienFxColor.FromHex("#FF00FF"),
});
await client.SetProfileAsync(custom, cancellationToken);
Device Notes
- AlienFX hardware differs by model and firmware.
- The protocol zone model is based on known reverse-engineered command formats and AWCC metadata.
- Unknown or unavailable zones may be ignored by hardware.
If Keys Do Not Change
If no key colors change, try these steps in order:
- Use explicit AWCC Advanced Keyboard IDs:
var options = new AlienFxClientOptions
{
VendorId = 0x0D62,
ProductId = 0xD2B0,
};
await using var client = new AlienFxClient(options);
await client.SetProfileAsync(AlienFxProfiles.AllWhite, CancellationToken.None);
- Fully close Alienware Command Center before running your app.
- Run your process elevated once to rule out permission/handle issues.
- Start with a full-device profile (
AllWhite) before testing per-zone color maps.
The transport now attempts both common AlienFX vendor IDs (0x187C and 0x0D62) automatically when using defaults.
Error Handling
Typical failures:
- Device not found for the configured Vendor ID / Product ID.
- Device opened but not writable (permissions / exclusive use).
- Unsupported platform (non-Windows).
Development
Build and test:
dotnet restore
dotnet build -c Release
dotnet test -c Release
Package output goes to artifacts/.
Design and Roadmap
- Architecture and design principles:
DESIGN.md - Delivery plan to full coverage and Codacy A:
PLAN.md - Current machine/profile posterity snapshot:
CURRENT-STATE.md
License
MIT
| Product | Versions 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. |
-
net10.0
- HidSharp (>= 2.1.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 1.0.1 | 118 | 10/3/2026 |
See PLAN.md and repository history for current release scope.