Add support for new ubisys S1-R (Series 2). #7915

lgraf · 2024-08-29T17:15:01Z

Adds support for the new ubisys S1-R (Series 2). Currently a technical reference document for the device is not (yet) available. The main difference seems to be that there is no endpoint 4 in the new device and the energy related clusters are located in endpoint 1 (instead of 4 like the regular S1-R).

The device seems to be working fine:

{
    "energy": 0.01,
    "last_seen": "2024-08-29T19:51:12+02:00",
    "linkquality": 116,
    "power": 6.6,
    "state": "ON",
    "action": null
}

One thing i am unsure about is if the fingerprint is working correctly. When i test this Definition as external converter with only the fingerprint defined (no zigbeeModel attribute), the normal S1-R Definition is used. As external converter the new Definition is only picked up when i trump with the zigbeeModel attribute (S1-R (5601)). Not sure if this is normal behaviour for external converters or if there something wrong about the fingerprinting?

db entry (paired with the Definition of this PR)

{
    "id": 9,
    "type": "Router",
    "ieeeAddr": "0x001fee000000a8ea",
    "nwkAddr": 34094,
    "manufId": 4338,
    "manufName": "ubisys",
    "powerSource": "Mains (single phase)",
    "modelId": "S1-R (5601)",
    "epList": [
        1,
        2,
        3,
        232,
        242
    ],
    "endpoints": {
        "1": {
            "profId": 260,
            "epId": 1,
            "devId": 266,
            "inClusterList": [
                0,
                3,
                4,
                5,
                6,
                1794,
                2820
            ],
            "outClusterList": [],
            "clusters": {
                "genBasic": {
                    "attributes": {
                        "modelId": "S1-R (5601)",
                        "manufacturerName": "ubisys",
                        "powerSource": 1,
                        "zclVersion": 8,
                        "appVersion": 1,
                        "stackVersion": 1,
                        "hwVersion": 16,
                        "dateCode": "20240612-DE-FB1",
                        "swBuildId": "2.5.0"
                    }
                },
                "seMetering": {
                    "attributes": {
                        "multiplier": 1,
                        "divisor": 10000
                    }
                },
                "genOnOff": {
                    "attributes": {
                        "onOff": 0
                    }
                }
            },
            "binds": [
                {
                    "cluster": 1794,
                    "type": "endpoint",
                    "deviceIeeeAddress": "0x00124b002c3a8c02",
                    "endpointID": 1
                },
                {
                    "cluster": 6,
                    "type": "endpoint",
                    "deviceIeeeAddress": "0x00124b002c3a8c02",
                    "endpointID": 1
                }
            ],
            "configuredReportings": [
                {
                    "cluster": 1794,
                    "attrId": 1024,
                    "minRepIntval": 5,
                    "maxRepIntval": 3600,
                    "repChange": 1,
                    "manufacturerCode": null
                },
                {
                    "cluster": 6,
                    "attrId": 0,
                    "minRepIntval": 0,
                    "maxRepIntval": 65000,
                    "repChange": 1,
                    "manufacturerCode": null
                }
            ],
            "meta": {}
        },
        "2": {
            "profId": 260,
            "epId": 2,
            "devId": 260,
            "inClusterList": [
                0,
                3
            ],
            "outClusterList": [
                3,
                5,
                6,
                8,
                768,
                64514
            ],
            "clusters": {},
            "binds": [
                {
                    "cluster": 6,
                    "type": "endpoint",
                    "deviceIeeeAddress": "0x001fee000000a8ea",
                    "endpointID": 1
                },
                {
                    "cluster": 6,
                    "type": "endpoint",
                    "deviceIeeeAddress": "0x00124b002c3a8c02",
                    "endpointID": 1
                },
                {
                    "cluster": 8,
                    "type": "endpoint",
                    "deviceIeeeAddress": "0x00124b002c3a8c02",
                    "endpointID": 1
                },
                {
                    "cluster": 768,
                    "type": "endpoint",
                    "deviceIeeeAddress": "0x00124b002c3a8c02",
                    "endpointID": 1
                }
            ],
            "configuredReportings": [],
            "meta": {}
        },
        "3": {
            "profId": 260,
            "epId": 3,
            "devId": 260,
            "inClusterList": [
                0,
                3
            ],
            "outClusterList": [
                3,
                5,
                6,
                8,
                768,
                64514
            ],
            "clusters": {},
            "binds": [
                {
                    "cluster": 6,
                    "type": "endpoint",
                    "deviceIeeeAddress": "0x00124b002c3a8c02",
                    "endpointID": 1
                },
                {
                    "cluster": 8,
                    "type": "endpoint",
                    "deviceIeeeAddress": "0x00124b002c3a8c02",
                    "endpointID": 1
                },
                {
                    "cluster": 768,
                    "type": "endpoint",
                    "deviceIeeeAddress": "0x00124b002c3a8c02",
                    "endpointID": 1
                }
            ],
            "configuredReportings": [],
            "meta": {}
        },
        "232": {
            "profId": 260,
            "epId": 232,
            "devId": 1287,
            "inClusterList": [
                0,
                61,
                64512,
                64599
            ],
            "outClusterList": [
                3,
                25
            ],
            "clusters": {},
            "binds": [],
            "configuredReportings": [],
            "meta": {}
        },
        "242": {
            "profId": 41440,
            "epId": 242,
            "devId": 97,
            "inClusterList": [],
            "outClusterList": [
                33
            ],
            "clusters": {},
            "binds": [],
            "configuredReportings": [],
            "meta": {}
        }
    },
    "appVersion": 1,
    "stackVersion": 1,
    "hwVersion": 16,
    "dateCode": "20240612-DE-FB1",
    "swBuildId": "2.5.0",
    "zclVersion": 8,
    "interviewCompleted": true,
    "meta": {
        "configured": 332242049
    },
    "lastSeen": 1724949732485
}

src/devices/ubisys.ts

Koenkk · 2024-08-30T18:01:36Z

src/devices/ubisys.ts

+            commandsColorCtrl({endpointNames: ['2', '3']}),
+        ],
+        configure: async (device, coordinatorEndpoint) => {
+            const endpoint = device.getEndpoint(1);


Everything inside here is not needed because of electricityMeter

I think its needed because configureReporting is set to false for electricityMeter. The reason is that the currentSummDelivered is not bindable for this device (as far i can tell for the most ubisys devices). As workaround only the instantaneousDemand attribute is binded manually and currentSummDelivered read in onEvent.

I see now, I think we can improve the ubisysOnEventReadCurrentSummDelivered a bit, I see 2 issues with it:

In case the Ubisys devices is sending a lot of messages, a lot of reads are done

In case no messages are send, the value becomes stale

We can solve this by polling at a certain interval, you can use the Tuya one as an example

Sounds good. I will take a closer look at the weekend when I have the device for testing at hand.

I was a bit uncertain to change this for devices i do not own myself, so i added a separate method that can be used for polling.

Koenkk · 2024-08-30T18:02:01Z

src/devices/ubisys.ts

+            await reporting.readMeteringMultiplierDivisor(endpoint);
+            await reporting.instantaneousDemand(endpoint);
+        },
+        meta: {multiEndpointSkip: ['state', 'power', 'energy']},


Use multiEndpointSkip of deviceEndpoints instead

Koenkk · 2024-08-30T18:02:27Z

src/devices/ubisys.ts

+                endpoints: [{ID: 1, profileID: 260, deviceID: 266, inputClusters: [0, 3, 4, 5, 6, 1794, 2820], outputClusters: []}],
+            },
+        ],
+        model: 'S1-R (Series 2)',


Suggested change

model: 'S1-R (Series 2)',

model: 'S1-R-2',

Can we use this here? It's a bit more friendly without the spaces

…del name.

…ndent of the actual amount of device messages.

src/devices/ubisys.ts

Co-authored-by: Koen Kanters <[email protected]>

Koenkk · 2024-09-06T19:51:20Z

Thanks!

Koenkk reviewed Aug 30, 2024

View reviewed changes

src/devices/ubisys.ts Show resolved Hide resolved

Koenkk reviewed Aug 30, 2024

View reviewed changes

lgraf added 3 commits September 6, 2024 16:54

Add support for new ubisys S1-R (Series 2).

d9b7d3b

review: set multiEndpointSkip in deviceEnpoints, use more friendly mo…

bac7c10

…del name.

use polling to read currentSumDeleviered attribute, to be more indepe…

8c4345f

…ndent of the actual amount of device messages.

lgraf force-pushed the ubisys-s1-r-series2 branch from e8b23c7 to 8c4345f Compare September 6, 2024 14:54

Koenkk reviewed Sep 6, 2024

View reviewed changes

src/devices/ubisys.ts Outdated Show resolved Hide resolved

Update src/devices/ubisys.ts

7e4fe16

Co-authored-by: Koen Kanters <[email protected]>

Koenkk merged commit 0b51cc0 into Koenkk:master Sep 6, 2024
2 checks passed

lgraf deleted the ubisys-s1-r-series2 branch September 6, 2024 20:04

lgraf mentioned this pull request Sep 8, 2024

fix: add all device endpoints to fingerprint #7959

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for new ubisys S1-R (Series 2). #7915

Add support for new ubisys S1-R (Series 2). #7915

lgraf commented Aug 29, 2024 •

edited

Loading

Koenkk Aug 30, 2024

lgraf Aug 31, 2024

Koenkk Aug 31, 2024

lgraf Sep 3, 2024

lgraf Sep 6, 2024

Koenkk Aug 30, 2024

lgraf Aug 31, 2024

Koenkk Aug 30, 2024

lgraf Aug 31, 2024

Koenkk commented Sep 6, 2024

Add support for new ubisys S1-R (Series 2). #7915

Add support for new ubisys S1-R (Series 2). #7915

Conversation

lgraf commented Aug 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Koenkk commented Sep 6, 2024

lgraf commented Aug 29, 2024 •

edited

Loading