config.schema.json

{
    "pluginAlias": "TedeePlatform",
    "pluginType": "platform",
    "headerDisplay": "This project is a homebridge plugin for Tedee smart locks.",
    "footerDisplay": "The Tedee bridge is required for this plugin to work.",
    "schema": {
        "type": "object",
        "properties": {
            "emailAddress": {
                "title": "Email address",
                "type": "string",
                "required": true,
                "placeholder": "Your email address",
                "format": "email",
                "description": "The email address of your Tedee account."
            },
            "password": {
                "title": "Password",
                "type": "string",
                "placeholder": "Your password",
                "required": true,
                "description": "The password of your Tedee account."
            },
            "devices": {
                "type": "array",
                "title": "Devices",
                "items": {
                    "type": "object",
                    "properties": {
                        "name": {
                            "title": "Device name",
                            "type": "string",
                            "required": true,
                            "placeholder": "Device name from the app",
                            "description": "The name of the lock. This name has to match the name that is configured in the Tedee app."
                        },
                        "unlatchFromUnlockedToUnlocked": {
                            "title": "Unlatch (unlocked to unlocked)",
                            "type": "boolean",
                            "default": false,
                            "required": true,
                            "description": "If enabled, the door is unlatched when you switch from 'unlocked' to 'unlocked' in the Home app (this move is valid and works in the Home app, just hold down the switch, swipe it to 'locked' and then 'unlocked' without releasing your finger - do not release the finger until you reached the 'unlocked' position again). If disabled, nothing is done when you switch from 'unlocked' to 'unlocked' in the Home app. Only works if the latch is enabled ('pull spring' in the app)."
                        },
                        "unlatchLock": {
                            "title": "Unlatch lock",
                            "type": "boolean",
                            "default": false,
                            "required": true,
                            "description": "If enabled, a second lock switch is exposed for unlatching the smart lock. Only works if the latch is enabled ('pull spring' in the app)."
                        },
                        "disableUnlock": {
                            "title": "Disable unlock",
                            "type": "boolean",
                            "default": false,
                            "required": false,
                            "description": "If enabled, you cannot unlock via HomeKit, only lock actions are executed."
                        },
                        "defaultLockName": {
                            "title": "Default lock name",
                            "type": "string",
                            "default": "Lock",
                            "placeholder": "Lock",
                            "description": "Lets you customize the name of the lock mechanism. Useful for the Alexa plugin, which does not detect changes of service names in HomeKit."
                        },
                        "defaultLatchName": {
                            "title": "Default latch name",
                            "type": "string",
                            "default": "Latch",
                            "placeholder": "Latch",
                            "description": "Lets you customize the name of the unlatch mechanism. Useful for the Alexa plugin, which does not detect changes of service names in HomeKit."
                        }
                    }
                }
            },
            "updateInterval": {
                "title": "Update Interval",
                "type": "integer",
                "default": 15,
                "placeholder": "15",
                "description": "The interval in seconds at which the lock state is updated from the API."
            },
            "maximumApiRetry": {
                "title": "Maximum amount of retries",
                "type": "integer",
                "default": 3,
                "placeholder": 3,
                "description": "The amount of attempts to call the Tedee API. Useful if you do not want to repeat failed lock/unlock/unlatch attempts after a long timeout delay."
            }
        }
    }
}