Installation support for step 2 & 3

[FlexxFR]

First of all thanks, very interesting. However, I really need some support here.
Step 1 is pretty easy, add-on is installed.

But what/why/where to do step 2 & 3 is very unlcear to me.
IS there a more step-by-step approach somewhere?

Do I need to download something first on a windows PC?

[FlexxFR]

If found this help.... #2

However, on a Windows machine
The cp ./_build_on_haos/Dockerfile ./ is not working? What is the purpose here?

And are these the correct steps to run this as a HA addon, or is this for a seperate docker?

[hsakoh]

There are three installation methods listed.

1. running as an HA-OS add-on
2. running in a separate Docker container
3. running as a simple WebApp.
   Executing any one of these is sufficient, and typically, just installing it as a Home Assistant add-on is enough.

Even within the add-on installation, there are three options:

1. Using a pre-built image
2. Building the image yourself
3. Building the image on HA-OS

Usually, after installing the add-on from "ADD ADD-ON REPOSITORY TO," proceed to configure the add-on.

Is this expression a bit unclear?

[FlexxFR]

Do I only need the HA- addon then?
I'm struggling with step 2 > pre-compile the .NET app and step 3 compile the .NET app.

What I managed to do so far:
Step 2 (on a Windows system):
1> git clone https://github.com/hsakoh/switchbot-mqtt.git
2> run ./_compile_self/dotnet_publish.ps1
> first open powershell as administrator
> Set-ExecutionPolicy Unrestricted
3 > scripts "crashes"--> probably because I dont have the SDK installed.

I'm I on the right track? Or are these steps not required for the HA-addon?

[hsakoh]

You only need to perform one of the red blocks shown in the diagram.
Typically, the topmost installation is sufficient.

For the second red block, "2. Pre-Compiling and Publishing the .NET App, then Building the Docker Image on HA-OS," if you want to set up the add-on using this method, you need to have the .NET 6 SDK and Docker installed on your Windows PC.

[FlexxFR]

:)
I'm making this too complicated. I was confused by the header "Add-on installation On Home Assistant OS"
I assumed all steps 1 to 3 where required.
I now understand they are 3 different options to install, right?

Started the add-on, and it's running.
Upto the next steps to configure it

[FlexxFR]

Oh, man no problem.
Describing something for someone else (to be "noob"-proof) is difficult when you created it yourself and are all into it.

I will try to make a nice description.

next issue: apikey & token. The link point to various scripts. However, it is just a easy to get these keys from the mobile app.

However, I still hit some issues:

• Either: missing the NGrok stuff (not sure ifs optional or not)

• > Do I need a ngrok (free) account for this or is a paid version required?
  

• From the scripts it appears the key must be converted to upper-case. Is that requierd? Keys'read from the mobile app are lower case.

[hsakoh]

Ah, the link is slightly off...
It’s enough to extract the key and secret from the app and configure them in the add-on.
(Signing and such are done within the add-on.)

A free Ngrok account is sufficient.

If you don't need to receive webhooks or if you can open ports on HA-OS to receive webhooks directly with the add-on, you don't need to configure the Ngrok key.

[FlexxFR]

ah... :) okay. It's indeed working with just hey API key info as retrieved via the app.
K10+ enforced as S1 is also working.

Final question about why webhooks are needed? For my understanding, are those values updated "on-change" compared to only update after static polling?

Slowly getting there.

[hsakoh]

If you want to immediately receive updates on state changes, you'll need to use webhooks. Additionally, although it's rare, there are some values that can only be obtained via webhooks for certain devices.

Even without webhooks, you could achieve this by increasing the polling frequency. However, since there's a limit on the number of API calls per day per account, using webhooks is more advantageous if they're available.

For S1, there doesn't seem to be a big difference, though.
DeviceStatusAPI
https://github.com/OpenWonderLabs/SwitchBotAPI?tab=readme-ov-file#robot-vacuum-cleaner-s1-1
Webhook
https://github.com/OpenWonderLabs/SwitchBotAPI?tab=readme-ov-file#robot-vacuum-cleaner-s1-3

FieldMapping
https://github.com/hsakoh/switchbot-mqtt/blob/main/src/SwitchBotMqttApp/MasterData/FieldDefinition.csv

[FlexxFR]

I see, only the "timeOfSample" is webhook-only, and actually the only usefull value to be updates a bit faster is the workingstatus. But I already see the option to "manually" poll via Home Assistant. So, without webhooks it will also work fine. Maybe do some 1 minute polling during a cleaning cycle using an HA automation?

But ok, webhook would still be nice get quick update in HA when the clean job is started via the APP.

[FlexxFR]

One more :)

ERROR: authentication failed: The authtoken you specified is properly formed, but it is invalid.
ERROR: Your authtoken: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
ERROR: This usually happens when:
ERROR: - You reset your authtoken
ERROR: - Your authtoken was for a team account that you were removed from
ERROR: - You are using ngrok link and this credential was explicitly revoked
ERROR: Go to your ngrok dashboard and double check that your authtoken is correct:
ERROR: https://dashboard.ngrok.com/get-started/your-authtoken
ERROR:
ERROR: ERR_NGROK_107
ERROR:

[hsakoh]

This is an error I've never encountered before.

Is the AuthToken entered correctly (without changing uppercase/lowercase letters or symbols)?
What happens if you regenerate and update the AuthToken...
There's also the possibility of a temporary service issue.

[FlexxFR]

I just copy/paste the key.

Steps:
Login NGROK
goto API
Add API key
Description / owner (my email address)
Save your new token box --> copy & close
paste in the config.

I tried a couple of time. Do I need to configure / enable something in NGROK ? I'm I missing some steps?
Maybe make a BOT user?

[hsakoh]

It seems like the place to retrieve it is incorrect. Regarding Ngrok, it's not the API key but the AuthToken that you need.

[FlexxFR]

Yes, that's it.
Seems to work now :)

[FlexxFR]

Although.....it starts without error. However, when I start vacuuming, the status is not updated in HA.
I turned en webhooks and restarted the add-on.

From the logs, I do see an event directly after starting a cleaning job.

17:16:11 info: SwitchBotMqttApp.Controllers.WebhookController[0] {"eventType":"changeReport","eventVersion":"1","context":{"deviceType":"WoSweeperMini","deviceMac":"XXXXXXXXXX","workingStatus":"Clearing","onlineStatus":"online","battery":99,"timeOfSample":1717946170804}}
17:16:11 fail: SwitchBotMqttApp.Controllers.WebhookController[0] webhook action {"eventType":"changeReport","eventVersion":"1","context":{"deviceType":"WoSweeperMini","deviceMac":"XXXXXXXXXX","workingStatus":"Clearing","onlineStatus":"online","battery":99,"timeOfSample":1717946170804}} System.InvalidOperationException: Sequence contains no matching element at System.Linq.ThrowHelper.ThrowNoMatchException() at SwitchBotMqttApp.Services.MqttCoreService.PublishWebhookAsync(JsonNode webhookContent) in C:\github\hsakoh\switchbot-mqtt\src\SwitchBotMqttApp\Services\MqttCoreService.cs:line 456 at SwitchBotMqttApp.Controllers.WebhookController.WebhookAsync() in C:\github\hsakoh\switchbot-mqtt\src\SwitchBotMqttApp\Controllers\WebhookController.cs:line 31

It appears to error on something.
I also notices a typo: As its now "clearing" iso "cleaning". Or is this in the Switchbot API?

[hsakoh]

There are some issues with processing Webhooks when EnforceDeviceTypes is specified.
Specifically, it fails to retrieve the device master data because the DeviceType in the Webhook is unknown.
(Seems like nobody has tried that before.)

I've made some fixes in the implementation. Please check it out with v1.0.17.

Regarding the TYPO, it's an issue on the SwitchBot side .
OpenWonderLabs/SwitchBotAPI#282

[FlexxFR]

Wow! Great work man!
Installed it, (very easy update via HA) and it appears to work.
No errors in the log, webhook lastupdates shows a value and status updates are almost real time.

I noticed something that has probably something to do with the enforce device.
Device type is now displayed as the "enforced type "Robot Vacuum Cleaner S1", previous is was somewhat recognized as a K10.
No problem ofcourse. As long as it works.