Somfy Protect smart home integration, free and open source
Arm your Somfy Protect alarm and follow its sensors, cameras and alerts in Gladys.
Published by prohand
- Devices
- Version 1.0.1
- Requires Gladys >=5.1.0
- ★ 0
Control your Somfy Protect alarm from Gladys: arm and disarm it, see what its sensors and cameras report, and react to alarms in your scenes.
Somfy Protect is a cloud service: the integration talks to the Somfy servers, exactly like the Somfy Protect app. An Internet connection is needed, and Somfy offers no local access.
What you get
| In Somfy Protect | In Gladys |
|---|---|
| Each site (alarm system) | A device "Somfy Protect site": security level + alarm ringing |
| Motion sensor | Motion (1 for 30 s at each detection), battery, temperature |
| IntelliTag | Detection (1 for 30 s), battery, temperature |
| Key fob | Presence (1 = at home), battery |
| Smoke detector | Smoke, battery |
| Indoor camera, Somfy One | Camera image, "Camera active" switch (privacy shutter) |
| Door lock | Lock (1 = locked) |
| Video doorbell | Doorbell ring |
| Siren, Link, extender | Battery, temperature, tamper, when the device reports them |
The security level is a list with three choices: Disarmed, Partial and Armed. Changing it in Gladys changes it in Somfy Protect.
Each device carries a Cloud badge. It turns to Unreachable when the Somfy cloud does not answer, or when the Link lost contact with the device. The badge of the site gets an orange dot when real-time events are down.
Setup
- In Gladys, open Integrations, find Somfy Protect and install it.
- In the Configuration screen, type the email and the password of your Somfy Protect account, then save.
- Press Test the connection: it lists your sites and devices.
- Open the Discovery tab and create the devices you want.
Tip: create a dedicated user in the Somfy Protect app (Settings, Users) for Gladys. You keep your own account private, and you can remove that user at any time.
Settings
| Setting | Default | What it does |
|---|---|---|
| Refresh interval (s) | 120 | How often batteries, temperatures and states are read (60 to 3600) |
| Real-time events | on | Alarms, level changes and detections arrive within a second. Needed by the triggers |
| Camera snapshot interval (s) | 0 | Push a camera image every N seconds. 0 = only when asked |
| Detailed logs (debug) | off | Log every request and event, to diagnose a problem |
Scenes
Triggers
- Somfy Protect alarm triggered: an intrusion, a panic or a fire alarm. Filter on the site and the kind. Variables: site name, kind, name of the device that detected it.
- Somfy Protect alarm ended: the alarm stopped.
- Somfy Protect security level changed: filter on the new level.
The device states (motion, presence, smoke, security level...) also work with the standard Device state trigger.
Actions
- Set the Somfy Protect security level
- Stop the Somfy Protect alarm
- Open or close a camera's privacy shutter
- Take a Somfy Protect camera snapshot: put it before the core action Send camera image to receive a fresh picture.
Example: "when the alarm is triggered, take a snapshot of the living room camera, then send it to me".
Dashboard widget
Add the Somfy Protect alarm widget to a dashboard. It shows the security level, the alarm, the devices that are unreachable or low on battery, and buttons to arm the site.
The Disarm and Stop alarm buttons only appear when the widget setting Allow disarming is ticked. Leave it off on a dashboard anyone can reach (a tablet in the hall, for example). Every button asks for a confirmation.
Troubleshooting
- "Somfy Protect refused the account": check the email and the password in the Somfy Protect app first.
- "Somfy Protect limits the requests": Somfy blocks accounts that log in too often. Wait the number of seconds shown; the integration retries alone. Avoid saving the configuration many times in a row.
- No real-time events: check that the container can reach
websocket.myfox.ioon port 443. The states still refresh at the refresh interval. - No camera image: the privacy shutter of the camera is closed, or the camera is offline.
- Turn on Detailed logs, reproduce the problem, then read the logs of the integration. Passwords and tokens are never written in them.
Privacy and security
- Your password is only sent to Somfy. It is stored by Gladys as a secret.
- The integration keeps a Somfy refresh token in its private
/datavolume, so a restart does not log in again. - This integration is not made nor supported by Somfy. It uses the same servers as the Somfy Protect app.
Configuration settings
These are the settings Somfy Protect asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| Getting started | section | No | Somfy Protect is a cloud service: the integration signs in with the email and the password of your Somfy Protect app account, then reads your alarm, its sensors and cameras. Create a dedicated user in the app (Settings, Users) if you prefer not to share your own account. |
| Somfy Protect email | string | Yes | The email you sign in to the Somfy Protect app with. |
| Password | secret | Yes | The password of that account. It is only sent to Somfy, never logged. |
| Refresh interval (s) | number | No | How often the Somfy cloud is read for battery levels, temperatures and states, in seconds. Alarms and detections arrive in real time, whatever this value. |
| Real-time events | boolean | No | Receive alarms, level changes and detections within a second, as the Somfy Protect app does. Needed by the scene triggers. |
| Camera snapshot interval (s) | number | No | Push a camera image to the dashboard every N seconds (60 minimum). 0 takes images only when they are asked for: dashboard live view, scene action. |
| Detailed logs (debug) | boolean | No | Log every request and every event of the Somfy cloud. Turn it on to diagnose a problem, then off again: it is verbose. Passwords and tokens are never logged. |
How to install Somfy Protect in Gladys
- In Gladys, open Integrations: Somfy Protect appears in the catalog, next to the native integrations, with a community badge.
- Click Install. Gladys pulls the Docker image (
ghcr.io/prohand/gladys-somfyprotect:1.0.1), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration). - Open the Configuration screen of the integration, fill in the settings, and save.
- You can also install it directly from its repository URL: https://github.com/prohand/gladys-somfyprotect.
Somfy Protect requires Gladys >=5.1.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.
Not running Gladys yet? It is free and open source: follow the installation guide to get started.
About external integrations
Somfy Protect is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by prohand, not by the Gladys core team.
- Browse all integrations, native and community
- Build and publish your own external integration
- Source code on GitHub — source of this documentation