OverkizClient 1.0.1

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. .NET Framework 4.7.2 This package targets .NET Framework 4.7.2. The package is compatible with this framework or higher. 
dotnet add package OverkizClient --version 1.0.1
                    


                    

                
NuGet\Install-Package OverkizClient -Version 1.0.1
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="OverkizClient" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="OverkizClient" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="OverkizClient" />
                    


                            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 OverkizClient --version 1.0.1
                    


                    

                
#r "nuget: OverkizClient, 1.0.1"
#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 OverkizClient@1.0.1
#: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=OverkizClient&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=OverkizClient&version=1.0.1
                    


                            Install as a Cake Tool

OverkizClient

A .NET client library for the Overkiz cloud and local REST API, enabling control and monitoring of smart-home gateways and devices from Somfy, Atlantic Cozytouch, Hitachi Hi Kumo, and other Overkiz-compatible ecosystems.

NuGet License: MIT

Supported Platforms

Target Framework Supported
.NET 10 ✅
.NET Framework 4.7.2 ✅

Supported Gateways / Cloud Servers

Brand / Server Auth Method
Somfy TaHoma (Europe, America, Oceania) Somfy OAuth 2.0
Atlantic Cozytouch CozyTouch JWT
Sauter Cozytouch CozyTouch JWT
Thermor Cozytouch CozyTouch JWT
Hitachi Hi Kumo (Asia, Europe, Oceania) Username / Password
Nexity Eugénie AWS Cognito SRP
Flexom by Bouygues Username / Password
Brandt Smart Control Username / Password
Rexel Energeasy Connect Username / Password
SIMU LiveIn2 Username / Password
Hexaom HexaConnect Username / Password
Ubiwizz by Decelect Username / Password
Somfy Developer Mode (local gateway) Bearer Token

Local API (LAN) is supported for Somfy TaHoma and compatible gateways when a developer-mode bearer token is available.

Installation

dotnet add package OverkizClient

Quick Start

Cloud Connection (Somfy)

using OverKizApi;
using OverKizApi.Enums;

var client = new OverkizClient(Server.SomfyEurope);
await client.Login("your@email.com", "your-password");

var devices = await client.GetDevices();
foreach (var device in devices)
	Console.WriteLine($"{device.Label} — {device.DeviceURL}");

Local Connection (LAN)

var client = new OverkizClient("192.168.1.xxx", token: "your-local-bearer-token");
await client.Login();

var devices = await client.GetDevices();

Sending a Command

string execId = await client.ExecuteDeviceAction(
	deviceUrl: "io://xxxx-xxxx-xxxx/12345678",
	command:   new Command("open"));

Live Event Streaming

await client.RegisterEventListener();

while (true)
{
	var events = await client.FetchEvents();
	foreach (var ev in events)
		Console.WriteLine($"{ev.Name}: {ev.DeviceURL}");

	await Task.Delay(2000);
}

await client.UnregisterEventListener();

Test Console

The solution includes OverKizApi.TestConsole, an interactive command-line tool for testing API operations — device listing, command execution, and live event watching — against both cloud and local connections.

Documentation

Full API documentation is available as a PDF in the Releases section.

Acknowledgements

Protocol details and server endpoint information derived from python-overkiz-api by Mick Vleeshouwer — MIT License.

License

MIT © 2026 Neil Colvin — see LICENSE.

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. 
.NET Framework net472 is compatible.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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 0 6/1/2026
1.0.1-preview.1 0 6/1/2026 1.0.1-preview.1 is deprecated because it is no longer maintained.
1.0.0 55 5/24/2026