config.schema.json

{
    "pluginAlias": "MagicOccupancy",
    "pluginType": "accessory",
    "schema": {
        "properties": {
            "name": {
                "required": true,
                "title": "Name",
                "type": "string"
            },
            "serial": {
                "required": false,
                "description": "Serial for the occupancy sensor (changing this will break existing HomeKit automations), defaults to 'JmoMagicOccupancySwitch'.",
                "title": "Serial",
                "type": "string"
            },
            "stayOccupiedDelay": {
                "default": 60,
                "description": "How long in seconds the room should stay occupied after all switches turn off. Set 0 to shutoff as soon as not occupied.",
                "title": "Stay Occupied Delay",
                "type": "number"
            },
            "maxOccupationTimeout": {
                "description": "How long in seconds is the absolute max time a room can stay occupied for (regardless of switch activity). Set 0 or blank to run forever.",
                "title": "Absolute Max Occupation Time (auto-shutoff)",
                "type": "number"
            },
            "occupancyLogging": {
                "default": true,
                "description": "Write logs when the occupancy sensor becomes occupied or unoccupied.",
                "title": "Occupancy Logging",
                "type": "boolean"
            },
            "persistBetweenReboots": {
                "default": true,
                "description": "Whether the occupancy sensor and its switches should restore their previous states on Homebridge restart",
                "title": "Persist State Between Reboots",
                "type": "boolean"
            },
            "startOnReboot": {
                "default": false,
                "description": "Whether the occupancy sensor should always initialize as triggered (occupied) on reboot regardless of prior status.",
                "title": "Always Start as Occupied on Reboot",
                "type": "boolean"
            },
            "lightSwitchesNames": {
                "default": "",
                "description": "These switches should be directly linked to light switches (on=on, off=off) and will act like a hybrid of stateful and master shutoff switches. See Readme for more info.",
                "title": "Names of Light Switches (Separate by comma)",
                "type": "string"
            },
            "statefulSwitchesNames": {
                "default": "",
                "description": "These switches activate the occupancy sensor immediately and keep the delay timer from resetting as long as the switch is on.",
                "title": "Names of Stateful (manual) Switches (Separate by comma)",
                "type": "string"
            },
            "triggerSwitchesNames": {
                "default": "",
                "description": "These switches activate the occupancy sensor immediately and allow the delay timer to start immediately.",
                "title": "Names of Trigger Stateless Switches (Separate by comma)",
                "type": "string"
            },
            "statefulStayOnSwitchesNames": {
                "default": "",
                "description": "These switches will keep the delay timer from starting as long as the switch is on if the occupancy sensor is already on, or they will do nothing if not occupied already.",
                "title": "Names of Stateful Stay-on Switches (Separate by comma)",
                "type": "string"
            },
            "triggerStayOnSwitchesNames": {
                "default": "",
                "description": "These switches will reset the delay if the occupancy sensor is already on, or they will do nothing if not occupied already.",
                "title": "Names of Trigger Stateless Stay-on Switches (Separate by comma)",
                "type": "string"
            },
            "createMasterShutoff": {
                "required": true,
                "default": false,
                "description": "Whether or not to create a master shutoff switch. Master shutoff toggled off kills occupancy immediately when toggled on.",
                "title": "Create Master Shutoff",
                "type": "boolean"
            }
        },
        "type": "object"
    },
    "singular": false
}