SmartHome.SDK.Fibaro 0.3.1

SmartHome.SDK.Fibaro

A lightweight .NET client SDK for Fibaro/Home Center REST API.

Install

NuGet package name: SmartHome.SDK.Fibaro

Install-Package SmartHome.SDK.Fibaro

Quickstart

using Microsoft.Extensions.DependencyInjection;
using SmartHome.SDK.Fibaro.Interfaces;
using SmartHome.SDK.Fibaro.Services;

var services = new ServiceCollection();

// Basic auth (recommended for Fibaro/Home Center)
services.AddFibaroClient(o =>
{
    o.BaseAddress = new Uri("https://your-home-center/api/");
    o.Username = "apiuser";
    o.Password = "apipass";
});

var provider = services.BuildServiceProvider();
var client = provider.GetRequiredService<IFibaroClient>();

var devices = await client.GetDevicesAsync();
await client.ExecuteActionAsync(123, "turnOn");

Device actions (Basic auth)

• Execute an action from code (turnOn, setValue): see docs/usage-examples.md.
• Run an action from the console example using env vars: see docs/try-it.md.

Safer ExecuteAction

Use the overload that maps directly to the Fibaro payload (DeviceActionArgumentsDto):

// { args: [50], integrationPin?: string, delay?: number }
await client.ExecuteActionAsync(123, "setValue", new object?[] { 50 });
// With PIN and delay:
await client.ExecuteActionAsync(123, "setValue", new object?[] { 50 }, integrationPin: "1234", delaySeconds: 30);

Details: see docs/usage-examples.md and docs/endpoints.md notes.

Features

• HttpClient-based, DI-friendly typed client
• Authentication: Bearer token or Basic
• Error handling with FibaroApiException (status code + payload)
• Models mapped with System.Text.Json

API Surface

• Task<IReadOnlyList<Device>> GetDevicesAsync(CancellationToken ct = default)
• Task<Device?> GetDeviceAsync(int deviceId, CancellationToken ct = default)
• Task ExecuteActionAsync(int deviceId, string action, object? parameters = null, CancellationToken ct = default)
• Task DeleteDeviceAsync(int deviceId, CancellationToken ct = default)
• Task<IReadOnlyList<Device>> FilterDevicesAsync(DeviceListFiltersDto filters, CancellationToken ct = default)
• Task<Device> UpdateDeviceAsync(int deviceId, Device device, CancellationToken ct = default)
• Task ExecuteGroupActionAsync(string actionName, GroupActionArguments args, CancellationToken ct = default)
• Task AddInterfacesToDevicesAsync(DevicesInterfacesDto request, CancellationToken ct = default)
• Task DeleteInterfacesFromDevicesAsync(DevicesInterfacesDto request, CancellationToken ct = default)
• Task<Device> AddPollingInterfaceAsync(int deviceId, CancellationToken ct = default)
• Task<Device> DeletePollingInterfaceAsync(int deviceId, CancellationToken ct = default)
• Task DeleteDelayedActionAsync(long timestamp, int id, CancellationToken ct = default)
• Task ExecuteActionOnSlaveAsync(string slaveUuid, int deviceId, string action, object? parameters = null, CancellationToken ct = default)
• Task DeleteDeviceOnSlaveAsync(string slaveUuid, int deviceId, CancellationToken ct = default)
• Task<DeviceTypeHierarchy> GetDevicesHierarchyAsync(CancellationToken ct = default)
• Task<IReadOnlyList<DeviceInfoDto>> GetUiDeviceInfoAsync(UiDeviceInfoQuery? query = null, CancellationToken ct = default)

Scenes:

• Task<IReadOnlyList<SceneDto>> GetScenesAsync(bool? alexaProhibited = null, CancellationToken ct = default)
• Task<SceneDto?> GetSceneAsync(int sceneId, bool? alexaProhibited = null, CancellationToken ct = default)
• Task<CreateSceneResponse> CreateSceneAsync(CreateSceneRequest request, CancellationToken ct = default)
• Task UpdateSceneAsync(int sceneId, UpdateSceneRequest request, CancellationToken ct = default)
• Task DeleteSceneAsync(int sceneId, CancellationToken ct = default)
• Task ExecuteSceneAsync(int sceneId, ExecuteSceneRequest? request = null, string? pin = null, CancellationToken ct = default)
• Task ExecuteSceneSyncAsync(int sceneId, ExecuteSceneRequest? request = null, string? pin = null, CancellationToken ct = default)
• Task<SceneDto> ConvertSceneAsync(int sceneId, CancellationToken ct = default)
• Task<SceneDto> CopySceneAsync(int sceneId, CancellationToken ct = default)
• Task<SceneDto> CopyAndConvertSceneAsync(int sceneId, CancellationToken ct = default)
• Task KillSceneAsync(int sceneId, string? pin = null, CancellationToken ct = default)
• Task<IReadOnlyList<SceneDto>> FilterScenesByTriggersAsync(FilterSceneRequest filters, CancellationToken ct = default)

History Events:

• Task<IReadOnlyList<HistoryEventDto>> GetHistoryEventsAsync(HistoryEventsQuery? query = null, CancellationToken ct = default)
• Task DeleteHistoryEventsAsync(DeleteHistoryQuery? query = null, CancellationToken ct = default)

Testing

Project includes xUnit + Moq tests. To run:

# From repo root
Dotnet restore
Dotnet build -c Release
Dotnet test .\tests\SmartHome.SDK.Fibaro.Tests\SmartHome.SDK.Fibaro.Tests.csproj -c Release

Packaging

Pack the library (README and XML docs included):

Dotnet pack .\SmartHome.SDK.Fibaro.csproj -c Release

CI/CD

This repo includes a GitHub Actions workflow to build/test on push and publish on version tags. Configure the secret NUGET_API_KEY in your repository settings.

Documentation

See the docs/ folder:

• docs/getting-started.md – install and first request
• docs/authentication.md – Basic and Bearer setup
• docs/endpoints.md – full API surface
• docs/scenes.md – guide for Scenes
• docs/usage-examples.md – cookbook
• docs/error-handling.md – FibaroApiException and patterns
• docs/testing-and-ci.md – tests and CI
• docs/troubleshooting.md – common issues
• docs/versioning.md – release process
• docs/try-it.md – quick run example

License

MIT