config.schema.json

{
	"pluginAlias": "MyQ2",
	"pluginType": "platform",
	"headerDisplay": "MyQ LiftMaster and Chamberlain Plugin for HomeBridge (API 2.0). <p>[homebridge-myq2](https://github.com/hjdhjd/homebridge-myq2) is a HomeBridge plugin to interact with MyQ Smart Garage door openers, made primarily by LiftMaster and Chamberlain.",
	"footerDisplay": "For help please see the [wiki](https://github.com/hjdhjd/homebridge-myq2/wiki).",
	"singular": false,
	"schema": {
		"type": "object",
		"properties": {
			"name": {
				"title": "Place Name",
                                "type": "string",
                                "required": false,
                                "placeholder": "eg. Home",
				"description": "Physical location where this MyQ Home Bridge is installed?"
                        },
			"email": {
				"title": "MyQ Username",
				"type": "string",
				"required": true,
				"placeholder": "e.g. user@example.com",
				"description": "Email address used for your MyQ account."
			},
			"password": {
				"title": "MyQ Password",
				"type": "string",
				"required": true,
				"placeholder": "e.g. mypassword",
				"description": "Password used for your MyQ account."
			},
			"verbose": {
				"title": "Debug Logging Verbosity",
				"type": "boolean",
				"required": false,
				"description": "Logging verbosity for debugging purporses. (Default = false)"
			},
			"openDuration": {
				"title": "Open Duration",
				"type": "integer",
				"required": false,
				"description": "Time in <code>seconds</code> to check that the garage door has finished opening. (Default = 15)"
			},
			"closeDuration": {
				"title": "Close Duration",
				"type": "integer",
				"required": false,
				"description": "Time in <code>seconds</code> to check that the garage door has finished closing. (Default = 25)"
			},
			"longPoll": {
				"title": "Long Poll Interval",
				"type": "integer",
				"required": false,
				"description": "Normal polling interval in <code>seconds</code>. (Default = 15)"
			},
			"shortPoll": {
				"title": "Short Poll Interval",
				"type": "integer",
				"required": false,
				"description": "Polling interval in <code>seconds</code> to use when the door state changes. (Default = 5)"
			},
			"shortPollDuration": {
				"title": "Short Poll Duration",
				"type": "integer",
				"required": false,
				"description": "Duration in <code>seconds</code> to use the <code>Short Poll Interval</code>. (Default = 600)"
			},
			"gateways": {
				"title": "Gateways",
				"type": "string",
				"required": false,
				"placeholder": "e.g. [My Home]",
				"description": "An array of gateway IDs or names to add. This is only useful or needed if you have multiple MyQ gateways. (Default = [])"
			}
		}
	},

	"form": [
		"name",
		"email",
		"password",
		{
			"type": "fieldset",
			"expandable": true,
			"title": "Advanced Configuration (Optional)",
			"description": "This step is not required. HomeBridge with API 2.0 can handle configurations in the HomeKit app.",
			"items": ["verbose", "openDuration", "closeDuration", "longPoll", "shortPoll", "shortPollDuration", "gateways"]
	}
]
}