Minimal NetDaemon #1315

FrankBakkerNl · 2025-07-24T21:54:19Z

Breaking change

Proposed change

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (which adds functionality to an existing integration)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request:

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
The code compiles without warnings (code quality check)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration are added/changed:

Documentation added/updated for https://netdaemon.xyz

Copilot

Pull Request Overview

This PR introduces a "Minimal NetDaemon" implementation that allows simple console applications to connect to Home Assistant without the full NetDaemon runtime. The main addition is a new HaContextFactory that provides a simplified entry point for creating IHaContext instances.

Key changes:

Added a new HaContextFactory class with a static CreateAsync method for simple HA connections
Refactored cache initialization to accept IHomeAssistantConnection directly instead of relying on IHomeAssistantRunner
Added new overloaded connection methods in HomeAssistantClientConnector to support WebSocket URL strings
Created a debug console client project to demonstrate the minimal usage pattern

Reviewed Changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/HassModel/NetDaemon.HassModel/HaContextFactory.cs	New factory class providing simplified IHaContext creation for console apps
src/HassModel/NetDaemon.HassModel/ICacheManager.cs	Updated interface to accept IHomeAssistantConnection parameter
src/HassModel/NetDaemon.HassModel/Internal/*.cs	Refactored cache classes to use direct connection instead of runner dependency
src/Client/NetDaemon.HassClient/Common/HomeAssistantClientConnector.cs	Added overloaded methods for WebSocket URL connection
src/debug/ConsoleClient/*	New debug project demonstrating minimal NetDaemon usage
NetDaemon.sln	Added new ConsoleClient project to solution

Copilot · 2025-07-25T20:52:12Z

src/debug/ConsoleClient/Program.cs

@@ -0,0 +1,6 @@
+//#:package NetDaemon.HassModel@25.18.1
+
+var ha = await NetDaemon.HassModel.HaContextFactory.CreateAsync("ws://localhost:8123/api/websocket", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI4MDhlZjQ3NWRlOTU0YWJmYTYwNTRkZDc2YzRkZmJjNiIsImlhdCI6MTc0NjkxMTkxOSwiZXhwIjoyMDYyMjcxOTE5fQ.KSwYw1IER965EUcN2_7XPPgVikeIli-mTH8XreveWvA");


A hardcoded JWT token is exposed in the source code. This token provides access to Home Assistant and should be removed from the codebase. Consider using environment variables, configuration files, or user secrets to store sensitive tokens.

Suggested change

var ha = await NetDaemon.HassModel.HaContextFactory.CreateAsync("ws://localhost:8123/api/websocket", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI4MDhlZjQ3NWRlOTU0YWJmYTYwNTRkZDc2YzRkZmJjNiIsImlhdCI6MTc0NjkxMTkxOSwiZXhwIjoyMDYyMjcxOTE5fQ.KSwYw1IER965EUcN2_7XPPgVikeIli-mTH8XreveWvA");

var token = Environment.GetEnvironmentVariable("HOME_ASSISTANT_JWT_TOKEN");

if (string.IsNullOrEmpty(token))

{

Console.WriteLine("Error: HOME_ASSISTANT_JWT_TOKEN environment variable is not set.");

return;

}

var ha = await NetDaemon.HassModel.HaContextFactory.CreateAsync("ws://localhost:8123/api/websocket", token);

Copilot · 2025-07-25T20:52:12Z

src/HassModel/NetDaemon.HassModel/HaContextFactory.cs

+    /// </summary>
+    /// <remarks>Do not use this in NetDaemon apps. Apps should use UseNetDaemonRuntime and resolve IHaContext via dependency injection</remarks>
+    /// <param name="homeAssistantWebsocketUrl">The Websocket Url to HomeAssistant, eg: ws://localhost:8123/api/websocket</param>
+    /// <param name="token">The long lived accestoken for Home Assitant</param>


There are spelling errors in the parameter documentation: 'accestoken' should be 'access token' and 'Assitant' should be 'Assistant'.

Suggested change

/// <param name="token">The long lived accestoken for Home Assitant</param>

/// <param name="token">The long-lived access token for Home Assistant</param>

Copilot · 2025-07-25T20:52:13Z

src/HassModel/NetDaemon.HassModel/Internal/AppScopedHaContextProvider.cs

    }

    public async Task<JsonElement?> CallServiceWithResponseAsync(string domain, string service, ServiceTarget? target = null, object? data = null)
    {
        ObjectDisposedException.ThrowIf(_isDisposed, this);
-        _ = _hassRunner.CurrentConnection ?? throw new InvalidOperationException("No connection to Home Assistant");
+        _ = _homeAssistantConnection ?? throw new InvalidOperationException("No connection to Home Assistant");


The null check is redundant because _homeAssistantConnection is set in the constructor and cannot be null. This check should be removed as it's unreachable code.

Suggested change

_ = _homeAssistantConnection ?? throw new InvalidOperationException("No connection to Home Assistant");

Copilot · 2025-07-25T20:52:13Z

src/HassModel/NetDaemon.HassModel/Internal/AppScopedHaContextProvider.cs

@@ -101,7 +97,7 @@ public IObservable<StateChange> StateAllChanges()
    public void SendEvent(string eventType, object? data = null)
    {
        ObjectDisposedException.ThrowIf(_isDisposed, this);
-        _backgroundTaskTracker.TrackBackgroundTask(_apiManager.SendEventAsync(eventType, _tokenSource.Token, data), "Error in sending event");
+        _backgroundTaskTracker.TrackBackgroundTask(_homeAssistantConnection?.SendEventAsync(eventType, _tokenSource.Token, data), "Error in sending event");


The null-conditional operator (?.) is unnecessary here since _homeAssistantConnection cannot be null after constructor initialization. This could also cause a null Task to be passed to TrackBackgroundTask which may cause issues.

Suggested change

_backgroundTaskTracker.TrackBackgroundTask(_homeAssistantConnection?.SendEventAsync(eventType, _tokenSource.Token, data), "Error in sending event");

_backgroundTaskTracker.TrackBackgroundTask(_homeAssistantConnection.SendEventAsync(eventType, _tokenSource.Token, data), "Error in sending event");

Copilot · 2025-07-25T20:52:13Z

src/Client/NetDaemon.HassClient/Common/HomeAssistantClientConnector.cs

+    /// </summary>
+    public static async Task<IHomeAssistantConnection> ConnectClientAsync(Uri websocketUrl, string token, CancellationToken cancelToken)
+    {
+        return await ConnectClientAsync(websocketUrl.Host, websocketUrl.Port, websocketUrl.Scheme is "https" or "wss", token, websocketUrl.PathAndQuery, cancelToken);


The SSL detection logic is incorrect. WebSocket URLs use 'ws' and 'wss' schemes, not 'https'. The condition should only check for 'wss' to determine SSL usage.

Suggested change

return await ConnectClientAsync(websocketUrl.Host, websocketUrl.Port, websocketUrl.Scheme is "https" or "wss", token, websocketUrl.PathAndQuery, cancelToken);

return await ConnectClientAsync(websocketUrl.Host, websocketUrl.Port, websocketUrl.Scheme == "wss", token, websocketUrl.PathAndQuery, cancelToken);

helto4real · 2025-08-09T11:40:45Z

src/HassModel/NetDaemon.HassModel/Internal/AppScopedHaContextProvider.cs


-        _backgroundTaskTracker.TrackBackgroundTask(_hassRunner.CurrentConnection.CallServiceAsync(domain, service, data, target.Map(), _tokenSource.Token), "Error in sending event");
+        _backgroundTaskTracker.TrackBackgroundTask(_homeAssistantConnection.CallServiceAsync(domain, service, data, target.Map(), _tokenSource.Token), "Error in sending event");


This line will break the restart logic. The current connection is always just that. Or am I missing something?

When we reconnect, we dispose current apps and new apps get a new IHaContext with the new connection. A scenario where this would change current behavior is if somehow you still use this IHaContext after the reconnect. At that point the haContext itself is disposed, and some operations will fail anyways.

FrankBakkerNl added 4 commits July 24, 2025 23:52

working draft

33c82c8

Simplified

0dbc622

Simplified

9c5352f

Remove not-needed changes

2769ab3

FrankBakkerNl force-pushed the minimal_damon branch 2 times, most recently from 3a031c7 to 9a7487f Compare July 25, 2025 20:14

FrankBakkerNl requested a review from Copilot July 25, 2025 20:51

FrankBakkerNl added the pr: new-feature label Jul 25, 2025

Copilot AI reviewed Jul 25, 2025

View reviewed changes

FrankBakkerNl added 2 commits July 26, 2025 23:22

Simplified

67bd19f

Fix existing tests

0420fb9

FrankBakkerNl force-pushed the minimal_damon branch from 7d0b317 to 0420fb9 Compare July 26, 2025 21:39

FrankBakkerNl added 2 commits July 26, 2025 23:39

Add integration test for HaContextFactory

bafeda4

remove timeout

98f44e7

helto4real reviewed Aug 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Minimal NetDaemon #1315

Minimal NetDaemon #1315

FrankBakkerNl commented Jul 24, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

helto4real Aug 9, 2025

Uh oh!

FrankBakkerNl Aug 9, 2025

Uh oh!

Uh oh!

		@@ -0,0 +1,6 @@
		//#:package NetDaemon.HassModel@25.18.1

		var ha = await NetDaemon.HassModel.HaContextFactory.CreateAsync("ws://localhost:8123/api/websocket", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI4MDhlZjQ3NWRlOTU0YWJmYTYwNTRkZDc2YzRkZmJjNiIsImlhdCI6MTc0NjkxMTkxOSwiZXhwIjoyMDYyMjcxOTE5fQ.KSwYw1IER965EUcN2_7XPPgVikeIli-mTH8XreveWvA");

-var ha = await NetDaemon.HassModel.HaContextFactory.CreateAsync("ws://localhost:8123/api/websocket", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI4MDhlZjQ3NWRlOTU0YWJmYTYwNTRkZDc2YzRkZmJjNiIsImlhdCI6MTc0NjkxMTkxOSwiZXhwIjoyMDYyMjcxOTE5fQ.KSwYw1IER965EUcN2_7XPPgVikeIli-mTH8XreveWvA");
+var token = Environment.GetEnvironmentVariable("HOME_ASSISTANT_JWT_TOKEN");
+if (string.IsNullOrEmpty(token))
+{
+    Console.WriteLine("Error: HOME_ASSISTANT_JWT_TOKEN environment variable is not set.");
+    return;
+}
+var ha = await NetDaemon.HassModel.HaContextFactory.CreateAsync("ws://localhost:8123/api/websocket", token);

	/// <param name="token">The long lived accestoken for Home Assitant</param>
	/// <param name="token">The long-lived access token for Home Assistant</param>

	_backgroundTaskTracker.TrackBackgroundTask(_homeAssistantConnection?.SendEventAsync(eventType, _tokenSource.Token, data), "Error in sending event");
	_backgroundTaskTracker.TrackBackgroundTask(_homeAssistantConnection.SendEventAsync(eventType, _tokenSource.Token, data), "Error in sending event");

	return await ConnectClientAsync(websocketUrl.Host, websocketUrl.Port, websocketUrl.Scheme is "https" or "wss", token, websocketUrl.PathAndQuery, cancelToken);
	return await ConnectClientAsync(websocketUrl.Host, websocketUrl.Port, websocketUrl.Scheme == "wss", token, websocketUrl.PathAndQuery, cancelToken);

Uh oh!

Minimal NetDaemon #1315

Are you sure you want to change the base?

Minimal NetDaemon #1315

Conversation

FrankBakkerNl commented Jul 24, 2025

Breaking change

Proposed change

Type of change

Additional information

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

helto4real Aug 9, 2025

Choose a reason for hiding this comment

Uh oh!

FrankBakkerNl Aug 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!