MichelMichels.DobissSharp.Api
1.0.0
dotnet add package MichelMichels.DobissSharp.Api --version 1.0.0
NuGet\Install-Package MichelMichels.DobissSharp.Api -Version 1.0.0
<PackageReference Include="MichelMichels.DobissSharp.Api" Version="1.0.0" />
paket add MichelMichels.DobissSharp.Api --version 1.0.0
#r "nuget: MichelMichels.DobissSharp.Api, 1.0.0"
// Install MichelMichels.DobissSharp.Api as a Cake Addin #addin nuget:?package=MichelMichels.DobissSharp.Api&version=1.0.0 // Install MichelMichels.DobissSharp.Api as a Cake Tool #tool nuget:?package=MichelMichels.DobissSharp.Api&version=1.0.0
DobissSharp 📦
DobissSharp is a C# .NET wrapper for the domotics system Dobiss NXT. It contains a REST api wrapper (MichelMichels.DobissSharp.Api
) and an opiniated C# library which consumes previous wrapper (MichelMichels.DobissSharp
).
<details> <summary>Table of Contents</summary>
</details>
Prerequisites
- .NET 8.0
- A Dobiss NXT system
Installation
[!WARNING] Package
MichelMichels.DobissSharp
is in development and is subject to breaking changes. Use this at own risk.
Package name | Version | Description |
---|---|---|
MichelMichels.DobissSharp.Api |
Reference implementation of the REST API | |
MichelMichels.DobissSharp |
Opiniated C# class library |
Get the NuGet packages from nuget.org or search for MichelMichels.DobissSharp
in the GUI package manager in Visual Studio.
You can also use the cli of the package manager with following command:
Install-Package MichelMichels.DobissSharp.Api
Install-Package MichelMichels.DobissSharp
Usage
MichelMichels.DobissSharp.Api
Creating the API client:
DobissClientOptions options = new()
{
BaseUrl = @"http://dobiss.local/",
SecretKey = "your-secret-api-key",
};
DobissClient apiClient = new(options);
Calls:
// Discover
DiscoverResponse response = await apiClient.Discover();
// Status
StatusResponse response = await apiClient.Status();
// Action
ActionRequest body = new()
{
AddressId = 0,
ChannelId = 12,
ActionId = ActionId.Toggle,
};
ActionResponse response = await apiClient.Action(body);
MichelMichels.DobissSharp
Creating the service:
// See previous code example for creating the API client
DobissService dobiss = new(apiClient);
See the interface IDobissService
for more information. This is still in development and subject to breaking changes.
Documentation
Visit the API documentation page of Dobiss NXT for more in-depth information about the API.
Credits
- Created by Michel Michels.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- JWT (>= 10.1.1)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on MichelMichels.DobissSharp.Api:
Package | Downloads |
---|---|
MichelMichels.DobissSharp
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.0 | 70 | 5/2/2024 |
- Release 1.0.0
- REST API fully implemented