homebridge-aeg-robot/config.schema.json

AEG RX9 / Electrolux Pure i9 robot vacuum plugin for Homebridge

{
    "pluginAlias": "Homebridge AEG Robot Vacuum",
    "pluginType": "platform",
    "singular": true,
    "headerDisplay": "For help please refer to the [README](https://github.com/thoukydides/homebridge-aeg-robot/blob/master/README.md).",
    "footerDisplay": "© 2022-2024 [Alexander Thoukydides](https://www.thouky.co.uk/)",
    "schema": {
        "type": "object",
        "properties": {
            "apiKey": {
                "type": "string",
                "required": true
            },
            "accessToken": {
                "type": "string",
                "required": true
            },
            "refreshToken": {
                "type": "string",
                "required": true
            },
            "pollIntervals": {
                "type": "object",
                "properties": {
                    "statusSeconds": {
                        "type": "integer",
                        "placeholder": 30,
                        "minimum": 20,
                        "maximum": 600
                    }
                }
            },
            "hideServices": {
                "type": "array",
                "uniqueItems": true,
                "items": {
                    "type": "string",
                    "enum": [
                        "Battery",
                        "Contact Sensor",
                        "Fan",
                        "Filter Maintenance",
                        "Occupancy Sensor",
                        "Switch Clean",
                        "Switch Home"
                    ]
                }
            },
            "debug": {
                "type": "array",
                "uniqueItems": true,
                "items": {
                    "type": "string",
                    "enum": [
                        "Run API Tests",
                        "Run Unsafe API Tests",
                        "Log API Headers",
                        "Log API Bodies",
                        "Log Appliance IDs",
                        "Log Debug as Info"
                    ]
                }
            }
        }
    },
    "form": [{
        "type": "fieldset",
        "title": "Electrolux Group API Credentials",
        "expandable": false,
        "items": [{
            "type": "help",
            "helpvalue": "<div class='help-block'>Create an API Key and Authorization tokens via the <a href='https://developer.electrolux.one/dashboard'>Electrolux Group Developer Portal Dashboard</a>.</div>"
        },{
            "key": "apiKey",
            "title": "API Key",
            "placeholder": "API Key"
        },{
            "key": "accessToken",
            "title": "Authorization Access Token",
            "placeholder": "Access Token"
        },{
            "key": "refreshToken",
            "title": "Authorization Refresh Token",
            "placeholder": "Refresh Token"
        }]
    },{
        "type": "fieldset",
        "title": "Disable Unwanted Features",
        "expandable": false,
        "expanded": true,
        "items": [{
            "key": "hideServices",
            "notitle": true,
            "description": "Checking an option <b>disables</b> the corresponding HomeKit Service"
        }]
    },{
        "type": "fieldset",
        "title": "Advanced Settings",
        "expandable": true,
        "expanded": false,
        "items": [{
            "key": "pollIntervals.statusSeconds",
            "title": "Interval between polling each appliance for status updates",
            "type": "number",
            "minimum": 20,
            "maximum": 600,
            "fieldAddonRight": "&nbsp;seconds"
        },{
            "type": "help",
            "helpvalue": "<div class='help-block'>If you have multiple robot vacuum cleaner appliances in your account (or use the same API Key for other purposes) increase the poll interval to avoid exceeding the API <a href='https://developer.electrolux.one/documentation/quotasAndRateLimits'>rate limits</a>, e.g. 30 seconds for one, 60 seconds for two, or 90 seconds for three.</div>"
        }]
    },{
        "type": "fieldset",
        "title": "Debug Options",
        "expandable": true,
        "expanded": false,
        "items": [{
            "key": "debug",
            "notitle": true,
            "description": "Leave all options unchecked unless debugging a problem"
        }]
    }],
    "display": null
}