+
+
+
# HASS.Agent
-HASS.Agent is a Windows-based client (*companion*) application for [Home Assistant](https://www.home-assistant.io), developed in .NET 6.
+HASS.Agent is a Windows-based client (*companion*) application for [Home Assistant](https://www.home-assistant.io), developed in .NET 8.
Click [here](https://github.com/hass-agent/HASS.Agent/releases/latest/download/HASS.Agent.Installer.exe) to download the latest installer.
@@ -52,6 +53,14 @@ The original HASS.Agent has been created by [Sam](https://github.com/LAB02-Admin
Unfortunately due to some time constraints, they're not able to provide the constant support and feature updates. That's where we step in - trying to keep HASS.Agent bug free (dreams need to be big right?) and to introduce new features here and there!
+#### Note on the organization and project name
+*"Why this project is named the same as original HASS.Agent, it's confusing"*
+
+Yes, I agree, you're right. The initial idea after Sam's disappearance was to continue the work and offer it to Sam once they're back.
+Well, now that's more than unlikely since it's been quite a long time we last spoke with Sam.
+
+Knowing what we do now, we've probably made a different decision but doing it now it'll only create more confusion. We have a full rewrite project going and it has been already decided the name is going to be altered.
+
----
### Functionality
@@ -72,7 +81,7 @@ Summary of the core functions:
* **WebView**: quickly show any website, anywhere - no browser required, for instance a HA dashboard.
-* **Satellite Service**: use the service to collect sensordata and execute commands, even when you're not logged in (**not all commands/sensors are available for Satellite Service**)
+* **Satellite Service**: use the service to collect sensor data and execute commands, even when you're not logged in (**not all commands/sensors are available for Satellite Service**)
* All entities are dynamically acquired from your Home Assistant instance.
@@ -88,8 +97,8 @@ Notification examples:

-

+
WebView example, showing a dashboard when right-clicking the tray icon:
@@ -124,11 +133,11 @@ You'll be guided through the configuration options during onboarding:
### Installation
-Installing HASS.Agent is easy; just [download the latest installer](https://github.com/hass-agent/HASS.Agent/releases/latest/download/HASS.Agent.Installer.exe), run it and you're done! The installer is signed by us and won't download or do weird stuff - it just places everything where it should, and launches with the right parameter. (optionally installing .NET6)
+Installing HASS.Agent is easy; just [download the latest installer](https://github.com/hass-agent/HASS.Agent/releases/latest/download/HASS.Agent.Installer.exe), run it and you're done! The installer is signed by us and won't download or do weird stuff - it just places everything where it should, and launches with the right parameter. (optionally installing .NET8)
After installing, the onboarding process will help you get everything configured, step by step. If you want an introduction into HASS.Agent, be sure to read the [introduction docs](https://www.hass-agent.io/latest/getting-started/).
-Original HASS.Agent documentation is available [here](https://hassagent.readthedocs.io/en/latest/introduction/) - please bear in mind however that it may not represent state of things present in this version.
+Original HASS.Agent documentation is available [here](https://www.hass-agent.io/latest/getting-started/#introduction) - please bear in mind however that it may not represent state of things present in this version.
[Click here to download the latest installer](https://github.com/hass-agent/HASS.Agent/releases/latest/download/HASS.Agent.Installer.exe)
@@ -158,7 +167,7 @@ If you want to help with the development of HASS.Agent, check out the [Helping O
### Articles
-### Original HASS.Agent
+### Original HASS.Agent by Sam/LAB02 Research
Liam Alexander Colman from [Home Assistant Guide](https://home-assistant-guide.com) was kind enough to write an article about HASS.Agent: [Integrate Home Assistant with Windows using HASS.Agent](https://home-assistant-guide.com/2022/04/20/integrate-home-assistant-with-windows-using-hass-agent/). The website's full of useful articles, worth having a look :)
@@ -166,11 +175,15 @@ Liam Alexander Colman from [Home Assistant Guide](https://home-assistant-guide.c
### What it's not
-A Linux/macOS client!
+A Linux/macOS client (at least yet)!
+
+Without getting into much of the details, it's not as easy as you think.
+
+With HASS.Agent "2.X" version it's basically impossible. We are thinking about cross-platform support for the "v3 rewrite" but as of now it's only a hopeful wish.
-This question comes up a lot, understandably. However it's currently focussed on being a Windows-based client. Even though .NET 6 allows for Linux/macOS development, it's not as easy as pressing a button. The interface would have to be redesigned from the ground up, sensors and commands would need multiple codebases for each OS, testing would take way more time, every OS handles notifications differently, etc.
+You can try the [official companion app](https://apps.apple.com/us/app/home-assistant/id1099568401) for macOS, or [IoPC](https://github.com/maksimkurb/IoPC) which runs on Linux.
-You can use the [official companion app](https://apps.apple.com/us/app/home-assistant/id1099568401) for macOS, or [IoPC](https://github.com/maksimkurb/IoPC) which runs on Linux. Note: We haven't tested either.
+#### Note: We haven't tested either and we do not track the development efforts.
----
@@ -180,6 +193,21 @@ The best way to help out is to test as much as you can (or even join the beta pr
Same goes for sharing ideas for new (or improved) functionality! If you want, you can [join on Discord](https://discord.com/invite/JfZj98xqJr) to discuss your ideas.
+#### Feature PR Submissions
+
+While all feature PR submissions are welcome, please note that their merging is at ***sole discretion*** of the main developers.
+
+When designing the new feature please take into account:
+- **how they fit with the codebase/codestyle** (yes, we are aware the codebase has it's flaws - hence the rewrite efforts)
+- **is the feature agnostic enough and will benefit all users**
+- **the smaller the PR the better the chance of it being merged**
+
+#### AI Usage
+
+Fully "vibe-coded" submissions will most likely be rejected.
+
+While personal opinions on AI usage and it's impact can vary person-to-person, we'd rather put the effort writing code than reviewing fully AI generated and copy-pasted code.
+
----
### Credits and Licensing
@@ -208,12 +236,14 @@ Everything on the HASS.Agent platform is released under the [MIT license](https:
### Legacy
-HASS.Agent is a .NET 6 application. If for some reason you can't install .NET 6, you can use the last .NET Framework 4.8 version:
+HASS.Agent is a .NET 8 application. If for some reason you can't install .NET 8, you can use the last .NET Framework 4.8 version also developed by Sam:
[v2022.3.8](https://github.com/LAB02-Research/HASS.Agent/releases/tag/v2022.3.8)
-It's pretty feature complete if you just want commands, sensors, quickactions and notifications.
+Per it's release time it was pretty feature complete if you just want commands, sensors, quickactions and notifications.
You'll need to have .NET Framework 4.8 installed on your PC, which you can [download here](https://dotnet.microsoft.com/en-us/download/dotnet-framework/thank-you/net48-web-installer).
-If you find any bugs, feel free to [create a ticket](https://github.com/LAB02-Research/HASS.Agent/issues) and I'll try to patch it.
+#### Please note
+- .NET Framework version is considered legacy and unsupported
+- All issues/requests regarding the .NET Framework version of HASS.Agent will be closed
\ No newline at end of file
diff --git a/assets/logo_128.png b/assets/logo_128.png
new file mode 100644
index 0000000000000000000000000000000000000000..37e6f8398d1174b04bb39969b497ded5c5b5536a
GIT binary patch
literal 3394
zcmaJ^c{tQx7yn|ypvKTxvW;ylKe7vHkP%}kq!&|`A=wfWvNSRw#@Moi$evyDid=uC%Y(Ch~Q`n)-Y%Gzv)RIZK_pDlwtqH~M2&3GEp(
zr*}YEYdkpW@Q}N(Op}RFE$4?*K;WHSjTli_1r_4wQhKY61g0>9uKrbVB0gDpj0jos
zzoRt6xJmKsp5Ppnu#lt&m*f8`j`*{&5iJFkB0q=itj}IwcStfBCqe$wQSJJ6@Os2i
zz+Q}CDGA%mcP2sHBEt>;__^$Eis`mcr`IJzqc==1$|xhK-f15Cn;Si5y|=s~GNyo5
z);4M9pq_{(${?e51GnXhe9N|q<>$S(v0EC # vfel(`$>Wo3m!(!z Vi4rHiGfeKDp|Cxo}Y6}xIaB-!Njq1bScY!8$CO)xz^ESnqF@z`)Q
zuT{NOwr^_`O3h2!a7^rRZ=2$xw&fN5R;tzyVQGrc5nKC!)mqs+>gNVl21?(%;yuEl
zt_SxyO#k`>r04a<0;IS5OD#p78@V^9KILU&wnkpUKrLUNAk?HBAxA^HHT`8QD79tc^i@P(cDa15M)XA}uLWh{NFqHN!;LtRN
zu-;4W{+G2lbgluE5>-7@;y)x&%6H{|Es%4A(9*mLE5&q%FQd@
zX7j)jFKuca|F{-+Fc|1|A+Fbz3e>q+vch*oEE6#(&?!{~sOC^Dv|MF4cu93Glj@5P
ziByQXcKkH=_vGGvww!bLvM6HPXO#klirK%OdB>Y(r0{$DAevqfGU*%?WRV?MDzHz+
zIcz}qorv3w{OCgEPk&v%P>Z`Pae!u?)Yap3`xHB1_Sq|k-s@$~AVdj{Jk&TFKjDYt
zldsvq%Y*A0F5AHo%%gG3UBfT-C!aMxn0adZZ;o
$rub&I_lPJ@AMjTwA5Q
zmv877{z$VdJ(zDmZCQ*U{atT$1r+jsjwU;qha_E
w3ZEHq#|P4rBn45es?j9)6w^Oj;p45xeZ^CmF)Yz+UlIzUBYWa2
zAWH?s$SLHkMP4PcN;jA-O??If2(}V(HE%Zda~$(MQGdh@vmD5~OZ>H6Q6V6)?Og@k
zw@|9QIpUeLk5qLwkb><3hEaD8dCCE`gcb+J=Gh%SQO4aIBqXa$`14K6zVifHE@1g&u6Hr
z_zmOCZXH$(&t&0n7p6V&9K*DwYS6cqkI=>4{DZ;G38VGOlIuT9Gejg{ltE;1W}f)g
z1Zc6Tf8^mQc=nxwf#doUR~;SF#LfaDN>lAg-F8VGVJsOZh=VE}lLGI`?FDp|cihV}
z5yNKx+DyKgS54!whRv9D6Nd%SIIAg*T-ogU3v!r4E%Z{Lv5?PY2s|f)<4J*RxQPr<
za4t=>Ws2#&1RCC$CNHqr`t4RYY1x8L>~mtq_maeUrz2CGK3h&lH~^FQVV950yds?=
z*C(=6Uo9mh0}Rmdtdy3XwTCo}nU~V7^Rfkc*{o)(sq%eyUh}qV=2^C(4a0~Ak$;W&
zq*l9zmh$Wiun>x#w5|xyTI69W&}UHUFYmvlt#aep21pA>rh<$V0|?!R|MM};b`9^}
zba9bHCPqzK2t6HS_%irtJ8AHs$8O>X3Q}JI%}!N!Xs0uvjZkCiq9f%xb1xTku}
z_dlC9Jm2Rr-vP|Hs#HZr|92CwalG3{wz}cO8Gwlb)Jc9A;X~{}qdx_^7lYWQo`Y+q
z?HchNR*?X84s-4ib)~l+4{Y#Ki(JXmcIcp&_FM-HcPkh=U;VGDiV;E2C9O#&{F!sN
zLedx>X1S8wrS=SHwUXBHsWkJ#j1N%0Qtn6vUX;5K4(+<*6>Kz7?F8(uz+RvwE#?rg
z8iC9U|HRuP|8fn$xvc}Xzayl62k*en+)W3*Im+-q2>gAA
>cjjOvWYmzz~u-ri6*7537`#AJ)*wnV(|so;&V7TwkFgzrHrRZ}|K_pc%6&k2cC_
zIw>_WL%d8;3zR?^sow4jchS4pg8M_1D%@OKWvo#ME0{C8t-d&XBQ5d;FFlU*N%!xl
z{NnzyFXM^2QAF1=(4Bf?hmS#m4yp~^*+H}6)G+*^e-L#Z--nxM-+h>jQyPY4q~9o&
z`Azxw_plIXm1fY#dk;Kw@{@Gc;Y%)ws3>?iL_FrG_#QpGP-5p>4ejHROaL6u~
zBc)`GLfUJydB;dc8?y14cEzteyB&uX@f?v$J!X`yYZ!)~O5O_@N2%8#jVdmA?Flid;`jC0>|9M`Agu1%9HDVqDEP@Bfe#Z+g45(zQhzq!(iO%~%JrzUuKz
z00s%tK
t!