Overkiz integration - Local API [Development / Testers topic]

Yes this works all locally. I have RS100 io cover motors and they work perfectly local with the tahoma switch.

Hey guys,

I have the following problem with the local API to control my Tahoma Switch.

I used the cloud API for a while and wanted to switch to the (now a core feature) local API.
I got the PIN-Code, Tahome Switch is in Dev Mode, credentials are correct (tested on somfy webpage). But is neither working for the .local nor the IP (with SSL off) way?!
For each scenario a get a “Connection failed” message without any further information.

What am I missing? I really appreciate your work and help here!!!

1 Like

Update:

This is now resolved for unknown reason. Altough, I had issues with my garage door as well when using a Somfy KeyGo IO. Opening the door would change the state correctly to open(ing) but after it was open and I used my KeyGo again, the door is closing but the state kept for ~1 hour on open, which as of cource incorrect. I fixed this by using an Ikea Parasoll. When the state of the parasoll changed from open to closed, I’m calling my local Somfy API to close the door so it changes the state to closed.

I’m using The Overkiz integration for my garage door and Awning cover. I’m also using the Homekit bridge function so I see these devices in my Apple Home. For some reason, the Awning cover is seen as ‘open’ , but it’s closed. My garage door has the correct status , closed if it’s closed.

Does anyone know if this is a issue with the overkiz implementation, or the homekit bridge integration?

seeing that on a regular base with my garage door, (open while being closed) and only happening after it actually has been open.

closing it (even though closed in real life already) fixed the state in that case immediately

btw this is with the core integration, not any experimental.

The same issue here

Hi, how can I change the address of the used hub? I would like to change it from name to IP.

Did you get a fix for this? I have the exact same issue and it happens almost daily.

Hi, is it possible to switch from Cloud API to Local API ? Thank you.

No it happens only a few times by me.

I have changed nothing (yes my network was completely changed by tp-link
Omada but it have even with this new hardware one time the problem)

Hi, I switched to local access and it works but is there a way to completely disable or remove Somfy cloud access?
When I use the official app (TaHoma) and when I’m not connected with my wifi network it’s still functioning like before. Yes I could remove the app, but the somfy box/hub still doing something with the cloud I guess (updates?)

To use ‘local’ you still need an access token that is being checked with Somfy servers first. So, basically the Tahoma will always first communicate with Somfy services. And yes, it needs the (firmware) updates as well.

In the cloud API we have the battery level of the sun


but the battery level isn’t available in the local API

Should it be possible to have this data for the diagnostic of the batteries?

Thank you for your work on the integration!
I recently bought the Tahoma switch, installed the app and managed to get my sunscreen and two rolling shutters connected.
I followed the steps in the link provided when switching on the developer mode and made the connection in HA with the Overkiz integration on local API.
I had to change the IP and restart the Tahoma switch (replaced my router), but it never came up again.
When I try to make the connection again, I get a message “Failed to connect”.

The switch is working and pingable, DNS records are correct, I can connect it via cloud api so the switch is working and connected. Alse my Somfy login is working, so the credentials are ok.
I can’t find any attempt to connect in de HA logging.

Does anyone have any idea where to look? It’s all working with the cloud api, so I can rule out most of the components.
Does anyone know why I have to go through the steps with REST api to generate a token when I don’t seem to need any when connecting with the Overkiz integration?

Thanks in advance!

Can you still access port 8443? You should be able to access https://[ip adress]:8443/enduser-mobile-web/1/enduserAPI/apiVersion if the port is still open. In my situation, this one is often closed and the local API is not responding (where cloud API does work).

See:
Port 8443 closed after reboot · Issue #139 · Somfy-Developer/Somfy-TaHoma-Developer-Mode (github.com)
Local access stops randomly working · Issue #131 · Somfy-Developer/Somfy-TaHoma-Developer-Mode (github.com)

You can actually disable network access and the local API will still work. For the first time you will need to create a token via the Somfy API, but afterwards it won’t communicate with the Somfy server anymore.

I have been using the Overkiz integration for a long time.
This morning it asks me to reconfigure. It says I have to enable developer mode.
I enable developer mode on the somfy web page, but I can’t configure the integration because I have errors.
The host was set to gateway-xxxxxxxxx.local:8443, is that correct?
Do I have to put something in place of the x’s? I tried to put the gateway IP but it doesn’t work
I know the username and password, but when I try to connect it gives me a connection error.
What parameters do I have to put to configure the integration? I couldn’t figure it out by reading here and there.

UPDATE: After I did a reboot everything started working again, sorry

Hello, I have the same problem, I try to reconfigure Overkiz but it asks me to activate developer mode and I can’t find the option in the Somfy menu. This has happened after an update of the Somfy Tahoma. I have tried restarting HA but it still doesn’t work

Update:
problem solved, selecting cloud api (before I tried local api), it asks for username/password and it works

How to enable Developer Mode in Somfy’s Tahoma Web UI

If anyone wants to set up Local API (so your blinds etc keep working even when your internet or Somfy cloud is offline), the option to “Enable Developer Mode” is in web interface specific to your country (I was not able to find it in phone app, hopefully this saves others time):

  1. Go to https://somfy.com ans select your Continent and Country
  2. Then log-in to Somfy Cloud with your credentials
  3. Find your controller and open its details (below is screenshot from Polish version I used, sadly no way to switch to English)

  4. Details of your device will have a button that allows you to toggle Developer Mode (1) below (you can also write down the PIN code):

Once the Developer Mode is enabled, you can set up Local API in HA.

How to fix if gateway-xxxx-xxxx-xxxx.local:8443 is not working

I think that may be PIN? It did not work for me because I have custom DNS setup that breaks / disables .local names.

In networks where *.local:8443 name does not work, Local API can be set up by using the IP of your Somfy box instead (e.g. 192.168.X.Y:8443) + disable TLS verification.

NOTE: If you set Host to a raw IP you need to remember to do two things:

  1. Assign static IP to your Somfy box (configure DHCP at your Router to always give the box the same IP, and use the static IP instead of dynamic one as Host). If you don’t do this, things may break in a few days, weeks, months because eventually the IP will change.
  2. Skip TLS verification (i am guessing it only works with .local common names and may cause connectivity error with raw IP, likely why it did not work for you).
1 Like

Hello

After a issue with the connexion, I have tested the local api connection. Unfortunately I have encountered disconnection which avoid to get a normal and stable usage.
It seems that there is not real solution for this point (actually I did not read a clear solution).

How to switch back to the cloud api without losing with current entity names.
Is there a way to delete the token in order to display the “configuration” button?

Thank for your help

Hello
No idea ? I have checked files butI don’t find where it could be located…
Please help : my climates, covers can not be managed anymore