Introducing a New Add-on Feature using the SwitchBot API for MQTT Integration

Robobo1111 · December 15, 2024, 6:29pm

Hello — pleased to come across this add-on. I have what is likely going to be a very novice question. The documentation provides quite a bit of YAML, but doesn’t specify where it goes. Is it intended to go in to configuration.yaml?

For instance, the docs provide the following:

SwitchBot:
  ApiKey: >-
    aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
  ApiSecret: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb

and

WebhookService:
  UseWebhook: true
  UseNgrok: true
  NgrokAuthToken: _________________ngrokauthtoken__________________
  HostUrl: <Configuration required only when using Webhook without ngrok>

Specifically where should I place that code?

Thank you!

hsakoh · December 15, 2024, 10:10pm

It is not for configuration.yaml. You need to input it on the add-on configuration screen.
If you installed the add-on on HA-OS, it can be accessed via the following url:
http://homeassistant.local:8123/hassio/addon/cafb8c58_switchbot_mqtt/config

If you installed Home Assistant as a Container or Core, you should configure it as /data/Options.json, since you are likely running a Docker image.
(Details are mentioned in the Wiki.)

Robobo1111 · December 15, 2024, 11:22pm

Thank you very much! Appreciate it.

Robobo1111 · December 17, 2024, 3:12am

I now have this working. I have sensors for both the Evaporative Humidifier and the Meter Pro CO2 and can also control the Evaporative Humidifier.

However — the Meter Pro CO2 reports “0” or unknown for all sensors while the Evaporative Humidifier seems to be fully functional. The temp reports 32 degrees F.

Pressing “Polling” does not update values.

The Device ID shown is correct.

Has anyone encountered this before? Are there troubleshooting steps I should try?

Thank you!

Robobo1111 · December 20, 2024, 5:11am

Might you have any ideas on why the Meter Pro CO2 is not returning correct data, @hsakoh ?

hsakoh · December 20, 2024, 5:36am

It seems that there was an outage causing the API service to stop during the following period. Did it have any impact on you? From 2024/12/16 06:47:03 (UTC) for about one day.

github.com/OpenWonderLabs/SwitchBotAPI

API Returning 403 Error Despite Previously Working Integration

opened 08:03AM - 16 Dec 24 UTC

closed 08:54PM - 17 Dec 24 UTC

apphancer

question

### Current Situation The API started returning a **403 Forbidden** response …despite the integration working perfectly until last night. - **No changes have been made to the integration.** - I've double-checked the API token and secret; they still match the values in your application. - Attempted to reset API credentials and reconfigure them in the app, but the issue persists. - To rule out any changes in how your API validates requests, I copied the **exact PHP example provided in your README.md file** and tested it separately. Unfortunately, even this sample code results in the same 403 error. It seems like something has changed on the API side, but no details are being provided in the error message or response. ### Logs ```markdown Response body: `{"message":"Forbidden"}` Headers: HTTP/2 403 content-type: application/json date: Thu, 26 Oct 2023 11:00:00 GMT ``` ### Configuration **Integration**: Symfony PHP application which has been making successful requests to the API for months. **Code for Reproduction**: Tested with the **exact PHP code from your README.md file** to eliminate any discrepancies. ### Environment - OS: macOS or Ubuntu - PHP 8.2 and 8.3 ### Additional Context - This integration has been working for months without issues. - It stopped working last night or early hours of this morning without any changes on my side. - The timestamp value and nonce were updated and correspond to valid requests. - Could this be related to recent API changes, or is there any possible validation update that’s not reflected in your examples or documentation? - API status on your status page indicates everything is operational https://status.switch-bot.com/ Please let me know if additional details are required for investigation.

It should have recovered naturally, but if it is still ongoing, please first check the add-on logs. Set the log level to trace and obtain the response JSON when you press the Polling button. (I also have a MeterProCO2 monitor, and I am able to obtain values without any issues.)

32 degrees F. is zero in Celsius degrees, which may indicate that no MeterPro values were taken (they are all initial values).

hsakoh · December 20, 2024, 5:45am

Ah, I might have figured it out. The Evaporative Humidifier is WiFi-enabled, so it sends data to SwitchBot on its own. The MeterPro only has Bluetooth, so it won’t send data to SwitchBot unless it’s connected to the Hub. (To obtain values from the API, it needs to be connected to the internet via the Hub.)

Robobo1111 · December 21, 2024, 3:10am

This makes complete sense. I am trying to get around having to install yet another hub.

Thank you @hsakoh! Appreciate it.

hsakoh · December 21, 2024, 6:55am

@Robobo1111
If you want to integrate the Meter Pro CO2 into HomeAssistant without adding a hub, you should use Bluetooth integration.

I’m not sure if the evaporative humidifier is supported, but the Meter Pro CO2 is supported.
The Humidifier (WoHumi) listed in the supported devices is likely the ultrasonic humidifier that was sold in the past (or in Japan).