homebridge-philips-hue-sync-box-switches/config.schema.json

Homebridge plugin for the Philips Hue Sync Box. Adapted to be Switch accessories.

{
    "pluginAlias": "PhilipsHueSyncBoxSwitchesPlatform",
    "pluginType": "platform",
    "headerDisplay": "Homebridge plugin for the Philips Hue Sync Box. Adapted to be Switch accessories. This is useful for automation purposes",
    "footerDisplay": "For help please visit the [GitHub repository](https://github.com/T4cC0re/homebridge-philips-hue-sync-box-switches).",
    "schema": {
        "type": "object",
        "properties": {
            "syncBoxIpAddress": {
                "title": "IP Address",
                "type": "string",
                "required": true,
                "placeholder": "XXX.XXX.XXX.XXX",
                "description": "The IP address of your Philips Hue Sync Box."
            },
            "syncBoxApiAccessToken": {
                "title": "Access Token",
                "type": "string",
                "required": true,
                "description": "The access token that you get while registration."
            },
            "syncBoxNameOverride": {
                "title": "Sync Box name override",
                "type": "string",
                "required": false,
                "description": "Set a different name on this instance if you have multiple boxes."
            },
            "defaultOffMode": {
                "title": "Default OFF mode",
                "type": "string",
                "required": false,
                "placeholder": "passthrough",
                "description": "The mode that is used when switching the Sync Box off via HomeKit. Possible values are 'powersave' or 'passthrough'."
            },
            "hideBrightness": {
                "title": "Hide Brightness",
                "type": "boolean",
                "required": false,
                "placeholder": false,
                "description": "When true, no Light accessory will be presented. Instead you will see a 'Power' switch to toggle between 'Default OFF Mode' and the last sync mode. When false, you will have a Light accessory. When toggling this, you need to recreate any automations which act on the brightness of this accessory!"
            },
            "unifiedAccessory": {
                "title": "Unified Accessory",
                "type": "boolean",
                "required": false,
                "placeholder": false,
                "description": "When true, there will be only one accessory, instead of one for each mode, intensity, and input. If `hideBrightness` is true, this will be a switch, a lightbulb otherwise. When toggling this, you need to recreate ALL automations which interact with this accessory!"
            },
            "isApiEnabled": {
                "title": "Enable API",
                "type": "boolean",
                "default": false,
                "required": false,
                "description": "Enables an HTTP API for controlling the Sync Box."
            },
            "apiPort": {
                "title": "API Port",
                "type": "integer",
                "placeholder": "40220",
                "required": false,
                "description": "The port that the API (if enabled) runs on"
            },
            "apiToken": {
                "title": "API Token",
                "type": "string",
                "required": false,
                "description": " The token that has to be included in each request of the API. Is required if the API is enabled and has no default value."
            }
        }
    }
}