diff --git a/docs/developer/vs.md b/docs/developer/vs.md index 4fe1ba4..e3a30f9 100644 --- a/docs/developer/vs.md +++ b/docs/developer/vs.md @@ -7,7 +7,7 @@ title: Visual Studio ## Visual studio on Windows host os -Visual Studio 2019 community or newer is recommended. You need to have dotnet 5 installed. [Download .NET 5 here](https://dotnet.microsoft.com/download/dotnet/5.0) or check the minimal version of Visual Studio supported. +Visual Studio 2019 community or newer is recommended. You need to have dotnet 10 installed. [Download .NET 10 here](https://dotnet.microsoft.com/download/dotnet/10.0) or check the minimal version of Visual Studio supported. Fork and clone your net-daemon/netdaemon. diff --git a/docs/get_started.md b/docs/get_started.md index c233fec..e8464e3 100644 --- a/docs/get_started.md +++ b/docs/get_started.md @@ -11,8 +11,8 @@ Here is what you will need to start developing apps to automate your home with N - We recommend using [git](https://git-scm.com/) as a way to version control your apps. - Create an access token to use for authorization. The long lived access token is created under your profile in the Home Assistant GUI. Make sure the user account for this access token has Administrator privileges in Home Assistant - Have a .NET development environment. You can edit .cs files in any tool, but using a development environment is recommended - - [Visual Studio 2022](https://visualstudio.microsoft.com/vs/), [Visual Studio Code](https://code.visualstudio.com) or [JetBrains Rider](https://www.jetbrains.com/rider/) - - [.NET 9 SDK](https://dotnet.microsoft.com/download/dotnet/9.0) installed (if running in a VS Code Dev Container, it is pre-installed) + - [Visual Studio 2026](https://visualstudio.microsoft.com/vs/), [Visual Studio Code](https://code.visualstudio.com) or [JetBrains Rider](https://www.jetbrains.com/rider/) + - [.NET 10 SDK](https://dotnet.microsoft.com/download/dotnet/10.0) installed (if running in a VS Code Dev Container, it is pre-installed) - [Docker](https://www.docker.com/) installed if you want to use a Dev Container in VS Code (recommended) Now you have all you need to develop an app, lets just do that by moving to app development. diff --git a/docs/user/app_model/moving_from_v3.md b/docs/user/app_model/moving_from_v3.md index df2ef85..9106ac3 100644 --- a/docs/user/app_model/moving_from_v3.md +++ b/docs/user/app_model/moving_from_v3.md @@ -3,7 +3,7 @@ id: app_model_moving_from_v3 title: Moving from NetDaemon version 3 --- -This documentation how to upgrade and move to current .NET 7 based NetDaemon runtime v3.x to .NET 9 based NetDaemon runtime 5. There are some breaking issues but should be quite straight forward upgrade your applications and runtime environment. +This documentation how to upgrade and move to current .NET 7 based NetDaemon runtime v3.x to .NET 10 based NetDaemon runtime 6. There are some breaking issues but should be quite straight forward upgrade your applications and runtime environment. ### Nuget packages @@ -19,21 +19,21 @@ We try to always keep NetDaemon up-to-date with the latest versions of .NET. Sin ::: -The following changes have to be executed in order to develop your apps for NetDaemon 5 and .NET 9. +The following changes have to be executed in order to develop your apps for NetDaemon 6 and .NET 10. ## 1. Update nuget packages In this release we decided to change naming of NetDaemon nuget packages. The names are basically the same but without the `JoySoftware`. The reason is we needed to make sure we got the ownership of the NetDaemon id on our nuget packages for security reasons. 1. In all .NET project files `*.csproj`, rename all nuget references that starts with `JoySoftware.NetDaemon` to `NetDaemon`. For users that uses the source deploy option you will have to add the`NetDaemon.AppModel.SourceDeployedApps` nuget package! -2. Change the target framework to 9.0 -3. Update Microsoft .NET references in your C# files to the corresponding .NET 9 versions +2. Change the target framework to 10.0 +3. Update Microsoft .NET references in your C# files to the corresponding .NET 10 versions ### 2. Update docker containers and add-ons -The docker container, change the name from `netdaemon3` to `netdaemon5`. All other settings are the same. +The docker container, change the name from `netdaemon3` to `netdaemon6`. All other settings are the same. -If you are using the addon write down the current settings in your current 3.x based addon and install the version 5 version and update settings as needed. In version 4 the default path had changed from `config/netdaemon3` to `config/netdaemon5`. +If you are using the addon write down the current settings in your current 3.x based addon and install the version 6 version and update settings as needed. In version 4 the default path had changed from `config/netdaemon3` to `config/netdaemon6`. ### 3. Update the code generator diff --git a/docs/user/index.md b/docs/user/index.md index 3e233e9..8371e0c 100644 --- a/docs/user/index.md +++ b/docs/user/index.md @@ -3,12 +3,12 @@ id: index title: NetDaemon --- -NetDaemon provides the capability to write home automations for Home Assistant in C#. Current version of the NetDaemon runtime is 5 and use .NET 9 and C# 13. +NetDaemon provides the capability to write home automations for Home Assistant in C#. Current version of the NetDaemon runtime is 6 and use .NET 10 and C# 14. ## About NetDaemon -Runtime version 5 has NuGet version >= `24.47.0` and uses the Docker image `netdaemon/netdaemon5`. -No additional features will be added to version 4. +Runtime version 6 has NuGet version >= `24.47.0` and uses the Docker image `netdaemon/netdaemon6`. +No additional features will be added to version 5. ## Migrating from version 3 We are no longer supporting version 3 of the runtime. diff --git a/docs/user/started/development_source_deploy.md b/docs/user/started/development_source_deploy.md index eb3d844..6029cf9 100644 --- a/docs/user/started/development_source_deploy.md +++ b/docs/user/started/development_source_deploy.md @@ -32,7 +32,7 @@ dotnet new nd-src-project ### Source files and configurations **Do not copy project files. Only copy the contents under the `apps` folder!** -Copy the content from the `apps` folder to to `/config/netdaemon5` if you are using +Copy the content from the `apps` folder to to `/config/netdaemon6` if you are using add-on (note that you might have changed the destination in add-on config), or the destination folder you chose in the other hosting options. **Do not copy project files. Only copy the contents under the `apps` folder!** diff --git a/docs/user/started/development_tools.md b/docs/user/started/development_tools.md index f29ac7c..a9c6451 100644 --- a/docs/user/started/development_tools.md +++ b/docs/user/started/development_tools.md @@ -71,13 +71,13 @@ Supervisor -> Add-on Store -> Menu -> Repositories - apt-get update - apt-get install -y apt-transport-https - apt-get update - - apt-get install -y dotnet-sdk-9.0 + - apt-get install -y dotnet-sdk-10.0 - dotnet tool install -g NetDaemon.HassModel.CodeGen packages: [] log_level: info config_path: / ``` - --> The part in the `init_commands` will install .NET SDK 9.0 only in the + --> The part in the `init_commands` will install .NET SDK 10.0 only in the Studio Code Server add-on (Docker Container) 5. Now you can start the Studio Code Server add-on by going the add-on information tab and pressing `OPEN WEB UI`. diff --git a/docs/user/started/get_started.md b/docs/user/started/get_started.md index fdb06bf..6c5e4b1 100644 --- a/docs/user/started/get_started.md +++ b/docs/user/started/get_started.md @@ -10,7 +10,7 @@ building NetDaemon apps. ## Prerequisites -- Dotnet 9 SDK +- Dotnet 10 SDK - Development environment - A Home Assistant long lived authorization token - Git (optional) @@ -123,7 +123,7 @@ Use `dotnet publish -c Release -o [your output directory]` Then, copy all contents from `[your_output_directory]` to the appropriate location on your Home Assistant host: -- If using the NetDaemon add-on: `/config/netdaemon5` +- If using the NetDaemon add-on: `/config/netdaemon6` - If using another hosting option: Copy to your chosen destination folder For more details on different deployment options, see the [Installation Documentation](user/started/installation.md) diff --git a/docs/user/started/installation.md b/docs/user/started/installation.md index ad86fec..00bcf03 100644 --- a/docs/user/started/installation.md +++ b/docs/user/started/installation.md @@ -13,13 +13,13 @@ You can deploy your NetDaemon apps in several ways: ## Deploying NetDAemon using the Home Assistant add-on Once added to Home Assistant, -select one of the V5 versions. +select one of the V6 versions. 1. Create a folder structure under your Home Assistant host configuration directory to store NetDaemon apps: ```text -/config/netdaemon5 +/config/netdaemon6 ``` 2. Add the NetDaemon repository to the Home Assistant add-on store: @@ -43,7 +43,7 @@ dotnet publish -c Release -o [outputdir] ``` Copy all files and folders **within** the `[outputdir]` -to `/config/netdaemon5` on your Home Assistant host. +to `/config/netdaemon6` on your Home Assistant host. For more details how to make this step easier, see the tutorial [Publish NetDeamon apps with Powershell](user/tutorials/publish_script.md). @@ -52,7 +52,7 @@ For more details how to make this step easier, see the tutorial In the add-on configuration, set `Application assembly` setting to the path for your project's entry assembly (DLL), -relative to `/config/netdaemon5` folder. +relative to `/config/netdaemon6` folder. Optionally, specify a separate path for configurations. This is an example of how the configuration should should look like, @@ -82,7 +82,7 @@ to avoid potential breaking changes. ```bash docker run -d \ - --name netdaemon5 \ + --name netdaemon6 \ --restart=always \ -e HomeAssistant__Host=192.168.1.4 \ -e HomeAssistant__Token="eyJhbGciOiJIUz..." \ @@ -90,7 +90,7 @@ docker run -d \ -e Logging__LogLevel__Default=Information \ -e TZ=Europe/Stockholm \ -v ~/netdaemon_config:/data \ - netdaemon/netdaemon5 + netdaemon/netdaemon6 ``` ### Example using docker-compose.yaml for @@ -98,9 +98,9 @@ docker run -d \ ```yaml services: netdaemon: - image: netdaemon/netdaemon5 # use netdaemon/netdaemon5:ver + image: netdaemon/netdaemon6 # use netdaemon/netdaemon6:ver # for specific version - container_name: netdaemon5 + container_name: netdaemon6 restart: always environment: - HomeAssistant__Host=your_ip_or_hostname # use host.docker.internal if HA in container (see section below) diff --git a/docs/user/tutorials/publish_script.md b/docs/user/tutorials/publish_script.md index 49d2348..4e40838 100644 --- a/docs/user/tutorials/publish_script.md +++ b/docs/user/tutorials/publish_script.md @@ -35,7 +35,7 @@ The Home Assistant PowerShell Module uses the IP address of Home Assistant to st $settings = (Get-Content appsettings.json | ConvertFrom-Json) #CHANGE ME -$slug = 'c6a2317c_netdaemon5' # the slug can be found in the url of the browser when navigating to the NetDaemon addon +$slug = 'c6a2317c_netdaemon6' # the slug can be found in the url of the browser when navigating to the NetDaemon addon $version = $slug.Split('_')[-1] # adapt if you are not using the default foldername for the addon $json = '{"addon": "' + $slug + '"}' diff --git a/docs/user/tutorials/webhost.md b/docs/user/tutorials/webhost.md index 4952285..3c975f9 100644 --- a/docs/user/tutorials/webhost.md +++ b/docs/user/tutorials/webhost.md @@ -136,7 +136,7 @@ how easy it is to inject the ND services and use the generated HA classes. ``` Now let's deploy the whole thing. -While it is perfectly fine to copy the binaries to `/config/netdaemon5` for a _normal_ NetDaemon project, it will fail for Blazor. +While it is perfectly fine to copy the binaries to `/config/netdaemon6` for a _normal_ NetDaemon project, it will fail for Blazor. We need to Publish the WebSite in order to build the web artifacts in `wwwroot`. ![](/img/docs/tutorials/webhost_2_publish.png) diff --git a/docs/user/whats_new.md b/docs/user/whats_new.md index fc7744f..0704c86 100644 --- a/docs/user/whats_new.md +++ b/docs/user/whats_new.md @@ -1,19 +1,19 @@ --- id: whats_new_v5 -title: What's new in V5 +title: What's new in V6 --- -## Version 5 of NetDaemon +## Version 6 of NetDaemon -We are exited to introduce you to version 5 of NetDaemon! +We are exited to introduce you to version 6 of NetDaemon! -For version 4 users it is a matter of using the latest version of the nuget packages and the v5/.NET 9 version of the NetDaemon +For version 5 users it is a matter of using the latest version of the nuget packages and the v6/.NET 10 version of the NetDaemon Docker image or add-on. -If you are still using version 3 it is really time to upgrade, we do not longer support that version, +If you are still using version 3, it is really time to upgrade, we do no longer support that version, see the [upgrade path for version 3 users](user/app_model/moving_from_v3.md) -### .NET 9 and C# 13 +### .NET 10 and C# 14 NetDaemon always have been releasing new version following the Microsoft release schedule of .NET to let our users to use the latest innovations and speed of modern .NET.