Support for OPOP: ST-581v9 Premium unit

[alevike]

Hello,
It looks promising, i have a OPOP: ST-581v9 Premium unit - it is a pellet boiler - if you're interested to implement the support for this one i will gladly support you..

LE: managed to connect/authenticate to the controller via Postman and gather some info.
LE2: identified each id with the corresponding widget. Let me know if it make sense to move forward with the investigation.
LE3: moved topic form issues to discussions.

Mapping attached:
opop_mapping.pdf

{
    "zones": {
        "transaction_time": null,
        "elements": [],
        "globalSchedules": {
            "time": null,
            "duringChange": null,
            "elements": []
        },
        "controllerParameters": {}
    },
    "tiles": [
        {
            "id": 1000,
            "parentId": 0,
            "type": 21,
            "menuId": 0,
            "orderId": 15,
            "visibility": false,
            "params": {
                "description": "Additional pump",
                "workingStatus": false,
                "pumpNumber": 0,
                "txtId": 922
            }
        },
        {
            "id": 1001,
            "parentId": 0,
            "type": 40,
            "menuId": 2011,
            "orderId": 12,
            "visibility": true,
            "params": {
                "description": "Text information",
                "statusId": 473,
                "headerId": 820,
                "iconId": 3,
                "options": []
            }
        },
        {
            "id": 1002,
            "parentId": 0,
            "type": 11,
            "menuId": 0,
            "orderId": 14,
            "visibility": true,
            "params": {
                "description": "Relay",
                "workingStatus": false,
                "txtId": 550,
                "iconId": 101
            }
        },
        {
            "id": 1003,
            "parentId": 0,
            "type": 11,
            "menuId": 0,
            "orderId": 9,
            "visibility": true,
            "params": {
                "description": "Relay",
                "workingStatus": false,
                "txtId": 1042,
                "iconId": 9
            }
        },
        {
            "id": 1004,
            "parentId": 0,
            "type": 11,
            "menuId": 0,
            "orderId": 10,
            "visibility": true,
            "params": {
                "description": "Relay",
                "workingStatus": false,
                "txtId": 571,
                "iconId": 17
            }
        },
        {
            "id": 1005,
            "parentId": 0,
            "type": 11,
            "menuId": 0,
            "orderId": 11,
            "visibility": true,
            "params": {
                "description": "Relay",
                "workingStatus": false,
                "txtId": 573,
                "iconId": 17
            }
        },
        {
            "id": 1006,
            "parentId": 0,
            "type": 6,
            "menuId": 2060,
            "orderId": 2,
            "visibility": true,
            "params": {
                "description": "Universal status with widgets",
                "statusId": 1,
                "iconId": 87,
                "widget1": {
                    "txtId": 937,
                    "value": 0,
                    "unit": 7,
                    "type": 1,
                    "params": [
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                "widget2": {
                    "txtId": 1050,
                    "value": 763,
                    "unit": 7,
                    "type": 9,
                    "params": [
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                }
            }
        },
        {
            "id": 1007,
            "parentId": 0,
            "type": 1,
            "menuId": 2061,
            "orderId": 4,
            "visibility": true,
            "params": {
                "description": "Temperature sensor",
                "workingStatus": true,
                "txtId": 1041,
                "value": 678,
                "batteryLevel": null,
                "signalStrength": null
            }
        },
        {
            "id": 1008,
            "parentId": 0,
            "type": 1,
            "menuId": 0,
            "orderId": 3,
            "visibility": true,
            "params": {
                "description": "Temperature sensor",
                "workingStatus": true,
                "txtId": 791,
                "value": 742,
                "batteryLevel": null,
                "signalStrength": null
            }
        },
        {
            "id": 1009,
            "parentId": 0,
            "type": 1,
            "menuId": 0,
            "orderId": 1,
            "visibility": true,
            "params": {
                "description": "Temperature sensor",
                "workingStatus": true,
                "txtId": 795,
                "value": 18,
                "batteryLevel": null,
                "signalStrength": null
            }
        },
        {
            "id": 1010,
            "parentId": 0,
            "type": 31,
            "menuId": 252,
            "orderId": 7,
            "visibility": true,
            "params": {
                "description": "Fuel supply",
                "percentage": 0,
                "hours": 0
            }
        },
        {
            "id": 1011,
            "parentId": 0,
            "type": 22,
            "menuId": 0,
            "orderId": 16,
            "visibility": true,
            "params": {
                "description": "Fan",
                "workingStatus": false,
                "fanNumber": 0,
                "gear": 0,
                "txtId": null
            }
        },
        {
            "id": 1012,
            "parentId": 0,
            "type": 23,
            "menuId": 2229,
            "orderId": 5,
            "visibility": true,
            "params": {
                "description": "Built-in valve",
                "workingStatus": true,
                "valveNumber": 1,
                "currentTemp": 260,
                "returnTemp": 58,
                "setTempCorrection": -40,
                "openingPercentage": 5,
                "valvePump": 1,
                "boilerProtection": 0,
                "returnProtection": 0,
                "setTemp": 60,
                "txtId": 992
            }
        },
        {
            "id": 1013,
            "parentId": 0,
            "type": 23,
            "menuId": 2329,
            "orderId": 6,
            "visibility": true,
            "params": {
                "description": "Built-in valve",
                "workingStatus": true,
                "valveNumber": 2,
                "currentTemp": 276,
                "returnTemp": 58,
                "setTempCorrection": -40,
                "openingPercentage": 5,
                "valvePump": 1,
                "boilerProtection": 1,
                "returnProtection": 0,
                "setTemp": 60,
                "txtId": 993
            }
        },
        {
            "id": 1016,
            "parentId": 0,
            "type": 2,
            "menuId": 0,
            "orderId": 8,
            "visibility": true,
            "params": {
                "description": "Fire sensor",
                "workingStatus": false,
                "value": 0
            }
        },
        {
            "id": 1020,
            "parentId": 0,
            "type": 11,
            "menuId": 0,
            "orderId": 13,
            "visibility": true,
            "params": {
                "description": "Relay",
                "workingStatus": false,
                "txtId": 553,
                "iconId": 101
            }
        },
        {
            "id": 2000,
            "parentId": 0,
            "type": 50,
            "menuId": 0,
            "orderId": null,
            "visibility": true,
            "params": {
                "description": "Controller software version",
                "version": "2.2.4",
                "txtId": 873,
                "iconId": 50,
                "companyId": 25,
                "controllerName": "ST-581v9 Premium 1.6.1 P01",
                "mainControllerId": 0
            }
        },
        {
            "id": 2040,
            "parentId": 0,
            "type": 40,
            "menuId": 0,
            "orderId": 18,
            "visibility": true,
            "params": {
                "description": "Text information",
                "statusId": 233,
                "headerId": 1039,
                "iconId": 50,
                "options": []
            }
        },
        {
            "id": 3630,
            "parentId": 0,
            "type": 32,
            "menuId": 0,
            "orderId": 17,
            "visibility": false,
            "params": {
                "description": "Disinfection",
                "txtId": 0,
                "percentage": 0
            }
        }
    ]
}

[mariusz-ostoja-swierczynski]

Hi @alevike

Thank you for this idea, and I must say, you are not the first one requesting this. I originally did not plan to add this kind of controllers, as I don't own one, and don't need it myself which makes very difficult to guess API calls and responses, but the work you did above is bit motivating. I already learned that other controllers' information is delivered via "tiles" object and what you did in the pdf is very helpful, but it's not fully correct. There is no sense to do mapping between tile id and widget, as every each user will have probably different ids for their widgets setup.

Therefore if you are willing to do some more work to support this integration, you could redo the mapping, but based on following?

• type
• description
• txtId
• iconId
• widget screenshot

I think that type and description describes main widget type, and later txtId and iconId presents subtypes, for example:

type: 11
description: Relay

can have subtype widgets described with different name (txtId) and icon (iconId), like feeder and pumps. Moreover, if you can check if iconId differ for different workingStatuses and do the mapping for those as well.

When we have such mappings this will be huge step forward. I did contact producer asking for documentation, but so far no success with that, therefore we need to do it ourselves.

Cheers, Mariusz

[alevike]

Hello Mariusz, I've tried to redo the mapping as requested. I still think that there are more than one pattern for widget type. In some cases the textId and the iconId are not present... Please find attached the updated mapping with more details Regards, Levi

…

On Tue, Jan 12, 2021 at 12:19 AM Mariusz Ostoja-Świerczyński < ***@***.***> wrote: Hi @alevike <https://github.com/alevike> Thank you for this idea, and I must say, you are not the first one requesting this. I originally did not plan to add this kind of controllers, as I don't own one, and don't need it myself which makes very difficult to guess API calls and responses, but the work you did above is bit motivating. I already learned that other controllers' information is delivered via "tiles" object and what you did in the pdf is very helpful, but it's not fully correct. There is no sense to do mapping between tile id and widget, as every each user will have probably different ids for their widgets setup. Therefore if you are willing to do some more work to support this integration, you could redo the mapping, but based on following? - type - description - txtId - iconId - widget screenshot I think that type and description describes main widget type, and later txtId and iconId presents subtypes, for example: type: 11 description: Relay can have subtype widgets described with different name (txtId) and icon (iconId), like feeder and pumps. Moreover, if you can check if iconId differ for different workingStatuses and do the mapping for those as well. When we have such mappings this will be huge step forward. I did contact producer asking for documentation, but so far no success with that, therefore we need to do it ourselves. Cheers, Mariusz — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#14 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AOQQY7HZLMNIEXNSMA4KHVLSZN2ORANCNFSM4V2KKQTQ> .

[alevike]

The attachment wasn't sent via mail. Find it attached below.

Thanks,
Levi
OPOP - tiles mapping.pdf

[mariusz-ostoja-swierczynski]

Wow, that really lost of useful info in this document you created. BIG THANKS !!! I will review it in details hopefully this week and I already did some work to introduce tiles support. See #15

[alevike]

I've just try #15. Some temp sensors and relay entities were imported successfully. I've identified some,

Till now looks very promising. Please drop me a mail at antal.levente[at]gmail[dot]com if i can contribute with anything else.

Thank you,
Levi

[alevike]

Hello Marius,

I had some issues generated by the defined refresh value for this integration. It looks like Tech has some limitations for this option. If the state is refreshed on each 30Sec, the controller is "blocked" on emodul.eu - receiving error 502, 501 after a time. Alos the controller become offline on emodul.eu. I've try to reduce the refresh rate to once/minute. Seems to resolve the problem - didn't had any issue after.

Regards,
Levi.

[jaanek]

Curious if you got it working with ST-581v9. Would be interested myself to integrate it with Home Assistant.

[ZdenekM]

I have the same boiler and it would be cool to have it integrated... May I help somehow to make that happen? :-)

EDIT: I just tried and it seems to be working!