[somfycul] Initial contribution #19207

Nookyx · 2025-08-20T23:18:14Z

Description

Adds a new binding to control somfy RTS rollershutters via CUL devices (e.g. nanoCUL).

This is based off the initial work done by Daniel Weisser back then with the somfycul binding (he never released it officially).

I have asked the original author (Daniel Weisser) in the community forum for permissions to further develop his addon, and he agreed to it.

The binding has been adapted to pass the build tests, be able to compile against OH5 and should also fix the gnu.io dependency issue that was still used in the original codebase.

Testing

For testing purposes, the addon can be installed manually with the latest JAR File.
I have tested it on my own setup with a nanoCUL

References

Fixes #15974

@weisserd

init codebase from @weisserd replace gnu.io dependency with serial transport, remove commons-io dependency Signed-off-by: Marc Klasser <shox06@gmx.de>

Signed-off-by: Marc Klasser <shox06@gmx.de>

Copilot

Pull Request Overview

Adds a new SomfyCUL binding to control Somfy RTS rollershutters via CUL devices (e.g. nanoCUL), based on initial work by Daniel Weisser with permission to develop officially.

Key changes:

Complete new binding implementation with CUL bridge and Somfy device support
Serial communication for CUL stick control with proper resource management
Rolling code persistence and device address management for RTS protocol

Reviewed Changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
bundles/pom.xml	Adds somfycul module to build
bundles/org.openhab.binding.somfycul/pom.xml	Maven configuration for the binding
bundles/org.openhab.binding.somfycul/src/main/java/.../*.java	Core binding classes including handlers, commands, and configuration
bundles/org.openhab.binding.somfycul/src/main/resources/OH-INF/*/.xml	Thing types and addon configuration
bundles/org.openhab.binding.somfycul/src/main/resources/OH-INF/i18n/somfycul.properties	Internationalization strings
bundles/org.openhab.binding.somfycul/README.md	Documentation and usage examples
bom/openhab-addons/pom.xml	Adds dependency to BOM
CODEOWNERS	Assigns code ownership

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

...openhab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/CULHandler.java

...ab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/SomfyCULHandler.java

...openhab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/CULHandler.java

lsiepel

Thank you for creating this contribution. I had a good look at all files except for the handlers, i scanned them quickly and once all is fixed i'll need another round to look closer.

...g.somfycul/src/main/java/org/openhab/binding/somfycul/internal/SomfyCULBindingConstants.java

bundles/org.openhab.binding.somfycul/src/main/resources/OH-INF/thing/thing-types.xml

lsiepel · 2025-08-21T09:54:00Z

...ab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/SomfyCULHandler.java

+     */
+    public SomfyCULHandler(Thing thing) {
+        super(thing);
+        String somfyFolderName = OpenHAB.getUserDataFolder() + File.separator + "somfycul";


Two comments abou this.

Better to move this to the initialize method. As Enabling/disabling a thing does not re instantiate the handler, so changes are not picked up. Also the resources are used while the thing is not being used (when disabled)

when moved to the initliaze, reading the file should be made in a async method. You can check some other bindings who make use of this pattern for reading from the userfolder.

sounds reasonable, I'll change that, but it'll probably take a few days until I have time for it

...ab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/SomfyCULHandler.java

lsiepel · 2025-08-21T09:54:59Z

...ab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/SomfyCULHandler.java

+            if (command instanceof UpDownType) {
+                switch ((UpDownType) command) {


Use instanceof pattern matching, also on other locations

Suggested change

if (command instanceof UpDownType) {

switch ((UpDownType) command) {

if (command instanceof UpDownType upDownCommand) {

switch (upDownCommand) {

...ab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/SomfyCULHandler.java

…/binding/somfycul/internal/SomfyCULHandler.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

…/binding/somfycul/internal/CULHandler.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

…/binding/somfycul/internal/SomfyCULHandler.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

…/binding/somfycul/internal/CULHandler.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Signed-off-by: Marc Klasser <shox06@gmx.de>

…/binding/somfycul/internal/CULHandler.java Co-authored-by: lsiepel <leosiepel@gmail.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

…/thing/thing-types.xml Co-authored-by: lsiepel <leosiepel@gmail.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Signed-off-by: Marc Klasser <shox06@gmx.de>

…/binding/somfycul/internal/SomfyCULHandlerFactory.java Co-authored-by: lsiepel <leosiepel@gmail.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Signed-off-by: Marc Klasser <shox06@gmx.de>

…/binding/somfycul/internal/SomfyCULHandler.java Co-authored-by: lsiepel <leosiepel@gmail.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

…addons into binding-somfycul

Signed-off-by: Marc Klasser <shox06@gmx.de>

Nookyx · 2025-08-21T23:11:34Z

Thank you @lsiepel for your extensive review so far!
I think I've fixed everything so far apart from this and I'll do that as well, as soon as I have the time for it.

I'm unsure how you handle resolving discussion in this project. I usually leave it up to the person who created the discussion to decide if it is resolved or not, instead of assuming I've resolved it just because I pushed a commit that may or may not resolve the discussed issue - so unless you tell me otherwise, I'll refrain from resolving them on my end, apart from applied suggestions, because github automatically resolves the discussion in that case.

lsiepel · 2025-08-22T06:11:09Z

Take your time, we are still early in the 5.1.0 development. There is one more comments a bit buried #19207 (comment) , just mention it so they won’t be overlooked.
I prefer the same review proces, perfect!

lsiepel

Some more comments, Only the handler is left.

lsiepel · 2025-08-30T09:23:04Z

bundles/org.openhab.binding.somfycul/README.md

+| Name            | Type    | Description                           | Default | Required | Advanced |
+|-----------------|---------|---------------------------------------|---------|----------|----------|
+| Serial Port (port)     | String  | The serial port (COM1, /dev/ttyS0, ...) your CUL stick is attached to  | /dev/ttyUSB0     | yes      | no       |
+| Baud Rate (baudrate)       | int    | The serial port baud rate   | 38400     | yes      | no       |


Please align with your favorite markdown tool. It makes it easier for future reviews.
Same for the other table in this file

lsiepel · 2025-08-30T09:24:59Z

bundles/org.openhab.binding.somfycul/README.md

+```
+
+
+### Copy an existing Somfy RTS remote to your `somfy-device`


Suggested change

### Copy an existing Somfy RTS remote to your `somfy-device`

### Clone Somfy RTS Rmote to `somfy-device`

lsiepel

Last set of comments. All files have now been reviewed, some open comments and these new ones to fix.

lsiepel · 2025-09-15T18:48:11Z

...openhab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/CULHandler.java

+    @Nullable
+    private SerialPortIdentifier portId;
+    @Nullable
+    private SerialPort serialPort;
+    private final SerialPortManager serialPortManager;
+    @Nullable
+    private OutputStream outputStream;
+    @Nullable
+    private InputStream inputStream;


Suggested change

@Nullable

private SerialPortIdentifier portId;

@Nullable

private SerialPort serialPort;

private final SerialPortManager serialPortManager;

@Nullable

private OutputStream outputStream;

@Nullable

private InputStream inputStream;

private final SerialPortManager serialPortManager;

private @Nullable SerialPortIdentifier portId;

private @Nullable SerialPort serialPort;

private @Nullable OutputStream outputStream;

private @Nullable InputStream inputStream;

lsiepel · 2025-09-15T18:49:18Z

...openhab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/CULHandler.java

+     * @return true if the command was successfully transmitted to the CUL device, false otherwise
+     */
+    public boolean executeCULCommand(Thing somfyDevice, SomfyCommand somfyCommand, String rollingCode, String address) {
+        String culCommand = "Ys" + "A1" + somfyCommand.getActionKey() + "0" + rollingCode + address;


An inline comment on the meaning of these magic strings would be appreciated.

Suggested change

String culCommand = "Ys" + "A1" + somfyCommand.getActionKey() + "0" + rollingCode + address;

String culCommand = "YsA1" + somfyCommand.getActionKey() + "0" + rollingCode + address;

lsiepel · 2025-09-15T18:49:46Z

...openhab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/CULHandler.java

+     * @param msg
+     *            the string to send


Suggested change

* @param msg

* the string to send

* @param msg the string to send

lsiepel · 2025-09-15T18:50:36Z

...openhab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/CULHandler.java

+            lastCommandTime = System.currentTimeMillis();
+            return true;
+        } catch (IOException e) {
+            logger.error("Error writing '{}' to serial port {}: {}", msg, localPortId.getName(), e.getMessage());


Suggested change

logger.error("Error writing '{}' to serial port {}: {}", msg, localPortId.getName(), e.getMessage());

logger.warn("Error writing '{}' to serial port {}: {}", msg, localPortId.getName(), e.getMessage());

lsiepel · 2025-09-15T18:50:52Z

...openhab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/CULHandler.java

+
+    @Override
+    public void initialize() {
+        logger.debug("Start initializing!");


Suggested change

logger.debug("Start initializing!");

lsiepel · 2025-09-15T18:51:28Z

...openhab.binding.somfycul/src/main/java/org/openhab/binding/somfycul/internal/CULHandler.java

+            updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
+                    "somfycul configuration missing or invalid");


Please make user if i18n custom keys for updateStatus so translations can be created (applies to all occurences)

Nookyx added 2 commits August 19, 2025 02:02

initial somfycul binding creation (openhab#15974)

fdd9080

init codebase from @weisserd replace gnu.io dependency with serial transport, remove commons-io dependency Signed-off-by: Marc Klasser <shox06@gmx.de>

fix some NPE warnings

d698d6e

Signed-off-by: Marc Klasser <shox06@gmx.de>

Nookyx requested a review from a team as a code owner August 20, 2025 23:18

wborn added the new binding If someone has started to work on a binding. For a new binding PR. label Aug 20, 2025

wborn requested a review from Copilot August 20, 2025 23:23

Copilot AI reviewed Aug 20, 2025

View reviewed changes

lsiepel requested changes Aug 21, 2025

View reviewed changes

Nookyx and others added 6 commits August 21, 2025 22:06

Update bundles/org.openhab.binding.somfycul/src/main/java/org/openhab…

b7e7792

…/binding/somfycul/internal/SomfyCULHandler.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Update bundles/org.openhab.binding.somfycul/src/main/java/org/openhab…

58b41e7

…/binding/somfycul/internal/CULHandler.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Update bundles/org.openhab.binding.somfycul/src/main/java/org/openhab…

c93cb77

…/binding/somfycul/internal/SomfyCULHandler.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Update bundles/org.openhab.binding.somfycul/src/main/java/org/openhab…

dcd976d

…/binding/somfycul/internal/SomfyCULHandler.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Update bundles/org.openhab.binding.somfycul/src/main/java/org/openhab…

c2fc659

…/binding/somfycul/internal/CULHandler.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

fixup copilot mistakes, change most logging to debug level, minor fixes

91f2501

Signed-off-by: Marc Klasser <shox06@gmx.de>

Nookyx force-pushed the binding-somfycul branch from 3aa9016 to 91f2501 Compare August 21, 2025 20:50

Nookyx and others added 14 commits August 21, 2025 22:51

Update bundles/org.openhab.binding.somfycul/src/main/java/org/openhab…

5b4aef8

…/binding/somfycul/internal/CULHandler.java Co-authored-by: lsiepel <leosiepel@gmail.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Update bundles/org.openhab.binding.somfycul/src/main/resources/OH-INF…

1c3af7b

…/thing/thing-types.xml Co-authored-by: lsiepel <leosiepel@gmail.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Update bundles/org.openhab.binding.somfycul/src/main/resources/OH-INF…

c812b00

…/thing/thing-types.xml Co-authored-by: lsiepel <leosiepel@gmail.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

dropped unused variable

8779517

Signed-off-by: Marc Klasser <shox06@gmx.de>

fix naming conventions

397a0ac

Signed-off-by: Marc Klasser <shox06@gmx.de>

fixup thing-type part 1

cad4e0c

Signed-off-by: Marc Klasser <shox06@gmx.de>

fixup thing-type part 2, add connection tag to addon.xml

7bc20ec

Signed-off-by: Marc Klasser <shox06@gmx.de>

Update bundles/org.openhab.binding.somfycul/src/main/java/org/openhab…

8e1a10f

…/binding/somfycul/internal/SomfyCULHandlerFactory.java Co-authored-by: lsiepel <leosiepel@gmail.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Update bundles/org.openhab.binding.somfycul/src/main/java/org/openhab…

3c25661

…/binding/somfycul/internal/SomfyCULHandlerFactory.java Co-authored-by: lsiepel <leosiepel@gmail.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

fix antipatterns

a418db6

Signed-off-by: Marc Klasser <shox06@gmx.de>

Update bundles/org.openhab.binding.somfycul/src/main/java/org/openhab…

cedeccb

…/binding/somfycul/internal/SomfyCULHandler.java Co-authored-by: lsiepel <leosiepel@gmail.com> Signed-off-by: Nookyx <62805370+Nookyx@users.noreply.github.com>

Merge branch 'binding-somfycul' of https://github.com/Nookyx/openhab-…

534c528

…addons into binding-somfycul

use instanceof pattern matching

469a54e

Signed-off-by: Marc Klasser <shox06@gmx.de>

formatting errors, add proper thing description for the somfy-device

25ed987

Signed-off-by: Marc Klasser <shox06@gmx.de>

Nookyx force-pushed the binding-somfycul branch from 623672a to 25ed987 Compare August 21, 2025 23:07

lsiepel requested changes Aug 30, 2025

View reviewed changes

lsiepel requested changes Sep 15, 2025

View reviewed changes

		if (command instanceof UpDownType) {
		switch ((UpDownType) command) {

		```


		### Copy an existing Somfy RTS remote to your `somfy-device`

	### Copy an existing Somfy RTS remote to your `somfy-device`
	### Clone Somfy RTS Rmote to `somfy-device`

	String culCommand = "Ys" + "A1" + somfyCommand.getActionKey() + "0" + rollingCode + address;
	String culCommand = "YsA1" + somfyCommand.getActionKey() + "0" + rollingCode + address;

	* @param msg
	* the string to send
	* @param msg the string to send

	logger.error("Error writing '{}' to serial port {}: {}", msg, localPortId.getName(), e.getMessage());
	logger.warn("Error writing '{}' to serial port {}: {}", msg, localPortId.getName(), e.getMessage());

		updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
		"somfycul configuration missing or invalid");

Uh oh!

[somfycul] Initial contribution #19207

Are you sure you want to change the base?

[somfycul] Initial contribution #19207

Uh oh!

Conversation

Nookyx commented Aug 20, 2025

Description

Testing

References

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lsiepel left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Nookyx commented Aug 21, 2025

Uh oh!

lsiepel commented Aug 22, 2025

Uh oh!

lsiepel left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lsiepel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lsiepel left a comment •

edited

Loading

lsiepel left a comment •

edited

Loading