guh - Developer documentation

aWATTar

This plugin allows to receive the current energy market price from the aWATTar GmbH. In order to use this plugin you need to enter the access token from your energy provider. You can find more information about you accesstoken here.

Available data

In following chart you can see an example of the market prices from -12 hours to + 12 hours from the current time (0).The green line describes the current market price, the red point line describes the average price of this interval and the red line describes the deviation. If the deviation is positiv, the current price is above the average, if the deviation is negative, the current price is below the average.

Heat pump

Information about the smart grid modes can be found here.

In order to interact with the heat pump (SG-ready), this plugin creates a CoAP connection to the server running on the 6LoWPAN bridge. The server IPv6 can be configured in the plugin configuration. Once the connection is established, the plugin searches for 6LoWPAN neighbors in the network.

Note: Currently there should be only one heat pump in the 6LoWPAN network!

Plugin properties

Following JSON file contains the definition and the description of all available DeviceClasses and Vendors of this DevicePlugin.

For more details how to read this JSON file please check out the documentation for The plugin JSON File.

{
    "name": "aWATTar",
    "idName": "Awattar",
    "id": "9c261c33-d44e-461e-8ec1-68803cb73f12",
    "paramTypes": [
        {
            "id": "cf13eebf-f188-447a-afcb-bbd330983060",
            "idName": "rpl",
            "name": "RPL address",
            "type": "QString",
            "index": 0,
            "inputType": "TextLine",
            "defaultValue": "fdaa:e9b8:d03a::ff:fe00:1"
        }
    ],
    "vendors": [
        {
            "name": "aWATTar",
            "idName": "awattar",
            "id": "acd47238-bbbc-4eaf-b484-38c52cfa4866",
            "deviceClasses": [
                {
                    "id": "29cd8265-d8bb-4cf9-9080-bfc2cf9787bc",
                    "name": "aWATTar",
                    "idName": "awattar",
                    "createMethods": ["user"],
                    "deviceIcon": "Energy",
                    "primaryStateTypeId": "eab37309-3dd8-46a0-94d4-bd05b5bb0430",
                    "criticalStateTypeId": "470b9b88-17f3-42e3-9250-cc181984eafe",
                    "basicTags": [
                        "Service",
                        "Actuator",
                        "Energy",
                        "Heating"
                    ],
                    "paramTypes": [
                        {
                            "id": "cbbf6f0a-6a91-4844-83f5-60eadb46099b",
                            "idName": "userUuid",
                            "name": "user uuid",
                            "type": "QString",
                            "index": 0,
                            "inputType": "TextLine"
                        },
                        {
                            "id": "7ab323d0-f3b5-4baa-9ff9-4843b4dd9811",
                            "idName": "token",
                            "name": "token",
                            "type": "QString",
                            "index": 1,
                            "inputType": "Password"
                        }
                    ],
                    "stateTypes": [
                        {
                            "id": "eab37309-3dd8-46a0-94d4-bd05b5bb0430",
                            "idName": "currentMarketPrice",
                            "name": "current market price",
                            "eventTypeName": "current market price changed",
                            "type": "double",
                            "index": 0,
                            "unit": "EuroCentPerKiloWattHour",
                            "graphRelevant": true,
                            "defaultValue": 0
                        },
                        {
                            "id": "38b86cee-9588-4269-a585-128907929dc2",
                            "idName": "averageDeviation",
                            "name": "average deviation",
                            "eventTypeName": "average deviation changed",
                            "index": 1,
                            "type": "int",
                            "unit": "Percentage",
                            "graphRelevant": true,
                            "defaultValue": 0
                        },
                        {
                            "id": "d5a8a176-aca0-45b1-b043-95c43750f383",
                            "idName": "validUntil",
                            "name": "valid until",
                            "eventTypeName": "valid until changed",
                            "index": 2,
                            "unit": "UnixTime",
                            "type": "int",
                            "ruleRelevant": false,
                            "eventRuleRelevant": false,
                            "defaultValue": 0
                        },
                        {
                            "id": "55d6d7a8-446f-48ae-8014-1225810d03ee",
                            "idName": "averagePrice",
                            "name": "average market price [+/- 12 h]",
                            "eventTypeName": "average market price [+/- 12 h] changed",
                            "index": 3,
                            "type": "double",
                            "unit": "EuroCentPerKiloWattHour",
                            "graphRelevant": true,
                            "defaultValue": 0
                        },
                        {
                            "id": "e7af5bdc-48d7-4e96-b877-331da4dcfae5",
                            "idName": "lowestPrice",
                            "name": "lowest market price [+/- 12 h]",
                            "eventTypeName": "lowest market price [+/- 12 h] changed",
                            "index": 4,
                            "type": "double",
                            "unit": "EuroCentPerKiloWattHour",
                            "ruleRelevant": false,
                            "eventRuleRelevant": false,
                            "defaultValue": 0
                        },
                        {
                            "id": "0c171c42-b070-453e-8a63-df9aebfa8533",
                            "idName": "highestPrice",
                            "name": "highest market price [+/- 12 h]",
                            "eventTypeName": "highest market price [+/- 12 h] changed",
                            "index": 5,
                            "type": "double",
                            "unit": "EuroCentPerKiloWattHour",
                            "ruleRelevant": false,
                            "eventRuleRelevant": false,
                            "defaultValue": 0
                        },
                        {
                            "id": "470b9b88-17f3-42e3-9250-cc181984eafe",
                            "idName": "online",
                            "index": 6,
                            "name": "online",
                            "eventTypeName": "online changed",
                            "type": "bool",
                            "defaultValue": false
                        },
                        {
                            "id": "1c9d139a-6618-4a39-bc83-37f80942017d",
                            "idName": "reachable",
                            "index": 7,
                            "name": "pump reachable",
                            "eventTypeName": "pump reachable changed",
                            "type": "bool",
                            "defaultValue": false
                        },
                        {
                            "id": "b83d3533-aeae-4a9b-95d8-28466bf6c0cf",
                            "idName": "sgMode",
                            "name": "sg-mode",
                            "eventTypeName": "sg-mode changed",
                            "index": 8,
                            "type": "QString",
                            "possibleValues": [
                                "0 - Invalid",
                                "1 - Off",
                                "2 - Normal",
                                "3 - High Temperature",
                                "4 - On"
                            ],
                            "defaultValue": "0 - Invalid"
                        },
                        {
                            "id": "4c303bcd-152d-45ad-874d-d57fc87a26bb",
                            "idName": "sgSyncMode",
                            "name": "sync mode",
                            "eventTypeName": "sync mode changed",
                            "index": 9,
                            "type": "QString",
                            "ruleRelevant": false,
                            "eventRuleRelevant": false,
                            "possibleValues": [
                                "auto",
                                "manual"
                            ],
                            "defaultValue": "auto",
                            "writable": true,
                            "actionTypeName": "Set sync mode"
                        }
                    ],
                    "actionTypes": [
                        {
                            "id": "dd82f6c7-5e92-48ca-b0bc-bdc55d3e1482",
                            "idName": "setSgMode",
                            "name": "set sg-mode",
                            "index": 0,
                            "paramTypes": [
                                {
                                    "id": "c7b13a33-1c05-457c-a087-20ecc1b8ca01",
                                    "idName": "sgMode",
                                    "name": "sg-mode",
                                    "type": "QString",
                                    "index": 0,
                                    "allowedValues": [
                                        "1 - Off",
                                        "2 - Normal",
                                        "3 - High Temperature",
                                        "4 - On"
                                    ],
                                    "defaultValue": "2 - Normal"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}