config.schema.json

{
  "pluginAlias": "Homebridge Virtual Device",
  "pluginType": "platform",
  "singular": true,
  "author": "mkz212",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "description": "Plugin name",
        "type": "string",
        "required": true,
        "default": "Virtual Device"
      },
      "devices": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "title": "Name",
              "description": "Name of device, as it will be show in HomeKit.",
              "type": "string",
              "required": true
            },
            "type": {
              "title": "Type",
              "description": "Type of the device: switch, dimmer, blind, lock, security, thermostat, etc.",
              "type": "string",
              "default": "switch",
              "required": true,
              "oneOf": [
                {
                  "title": "Switch",
                  "enum": [
                    "switch"
                  ]
                },
                {
                  "title": "Dimmer",
                  "enum": [
                    "dimmer"
                  ]
                },
                {
                  "title": "Blind / roller shutter",
                  "enum": [
                    "blind"
                  ]
                },
                {
                  "title": "Motion",
                  "enum": [
                    "motion"
                  ]
                },
                {
                  "title": "Lock",
                  "enum": [
                    "lock"
                  ]
                },
                {
                  "title": "Garage door",
                  "enum": [
                    "garage"
                  ]
                },
                {
                  "title": "Security",
                  "enum": [
                    "security"
                  ]
                },
                {
                  "title": "Thermostat",
                  "enum": [
                    "thermostat"
                  ]
                },
                {
                  "title": "Heater Cooler",
                  "enum": [
                    "heatercooler"
                  ]
                }
              ]
            },
            "startupValue": {
              "title": "Startup value",
              "description": "Select device state after startup / restart.",
              "type": "string",
              "default": "off",
              "required": true,
              "oneOf": [
                {
                  "title": "Set Off",
                  "enum": [
                    "off"
                  ]
                },
                {
                  "title": "Set On",
                  "enum": [
                    "on"
                  ]
                }
              ]
            },
            "timerType": {
              "title": "Timer type",
              "description": "Timer type: disabled, activated when device is on, activated when device is off.",
              "type": "string",
              "default": "disabled",
              "required": true,
              "oneOf": [
                {
                  "title": "Disabled",
                  "enum": [
                    "disabled"
                  ]
                },
                {
                  "title": "When On -> set Off",
                  "enum": [
                    "whenOn"
                  ]
                },
                {
                  "title": "When Off -> set On",
                  "enum": [
                    "whenOff"
                  ]
                }
              ]
            },
            "timerTime": {
              "title": "Timer time",
              "description": "Set time for timer.",
              "type": "integer",
              "required": false,
              "condition": {
                "functionBody": "return model.devices[arrayIndices].timerType !== 'disabled';"
              }
            },
            "timerUnit": {
              "title": "Timer Unit",
              "description": "Timer unit: miliseconds, seconds, minutes, hours, days.",
              "type": "string",
              "default": "seconds",
              "required": true,
              "oneOf": [
                {
                  "title": "Miliseconds",
                  "enum": [
                    "miliseconds"
                  ]
                },
                {
                  "title": "Seconds",
                  "enum": [
                    "seconds"
                  ]
                },
                {
                  "title": "Minutes",
                  "enum": [
                    "minutes"
                  ]
                },
                {
                  "title": "Hours",
                  "enum": [
                    "hours"
                  ]
                },
                {
                  "title": "Days",
                  "enum": [
                    "days"
                  ]
                }
              ],
              "condition": {
                "functionBody": "return model.devices[arrayIndices].timerType !== 'disabled';"
              }
            },
            "timerReset": {
              "title": "Reset timer",
              "type": "boolean",
              "default": true,
              "description": "Reset timer on each activity. When this option is enabled, each activity of the device will reset the timer (e.g. re-enabling the device even though it is already turned on).",
              "condition": {
                "functionBody": "return model.devices[arrayIndices].timerType !== 'disabled';"
              }
            },
            "timerDynamic": {
              "title": "Dynamic timer",
              "type": "boolean",
              "default": false,
              "description": "Only for dimmer and blind. When this option is enabled, time depends of value setted in HomeKit device - timer will change the device value by 1, up to 0 or 100 (depending on the option selected in Timer). Example: if you set 5 minutes in Timer Time and the device is set to 3, then total timer time will be 15 minutes.",
              "condition": {
                "functionBody": "return model.devices[arrayIndices].timerType !== 'disabled' && (model.devices[arrayIndices].type === 'dimmer' || model.devices[arrayIndices].type === 'blind');"
              }
            },
            "timerStartup": {
              "title": "Timer startup",
              "description": "Set different time for timer on startup.",
              "type": "integer",
              "required": false,
              "condition": {
                "functionBody": "return model.devices[arrayIndices].timerType !== 'disabled';"
              }
            },
            "sensor": {
              "title": "Sensor",
              "description": "Add additional sensor to device. It will actvate for 3 seconds. This is useful for automations.",
              "type": "string",
              "default": "disabled",
              "required": true,
              "oneOf": [
                {
                  "title": "Disabled",
                  "enum": [
                    "disabled"
                  ]
                },
                {
                  "title": "Activate when device set on",
                  "enum": [
                    "whenOn"
                  ]
                },
                {
                  "title": "Activate when device set off",
                  "enum": [
                    "whenOff"
                  ]
                }
              ]
            },
            "sensorType": {
              "title": "Sensor type",
              "description": "Sensor type: motion, contact, occupancy, leak.",
              "type": "string",
              "required": true,
              "default": "motion",
              "oneOf": [
                {
                  "title": "Motion",
                  "enum": [
                    "motion"
                  ]
                },
                {
                  "title": "Contact",
                  "enum": [
                    "contact"
                  ]
                },
                {
                  "title": "Occupancy",
                  "enum": [
                    "occupancy"
                  ]
                },
                {
                  "title": "Leak",
                  "enum": [
                    "leak"
                  ]
                }
              ],
              "condition": {
                "functionBody": "return model.devices[arrayIndices].sensor !== 'disabled';"
              }
            }
          }
        }
      }
    }
  },
  "layout": [
    {
      "type": "array",
      "key": "devices",
      "title": "Devices",
      "description": "",
      "buttonText": "Add",
      "expandable": false,
      "expanded": true,
      "items": [
        {
          "type": "fieldset",
          "items": [
            {
              "type": "fieldset",
              "title": "General",
              "expandable": true,
              "expanded": true,
              "items": [
                "devices[].name",
                "devices[].type"
              ]
            },
            {
              "type": "fieldset",
              "title": "After start",
              "expandable": true,
              "expanded": false,
              "items": [
                "devices[].startupValue"
              ]
            },
            {
              "type": "fieldset",
              "title": "Timer",
              "expandable": true,
              "expanded": false,
              "items": [
                "devices[].timerType",
                "devices[].timerTime",
                "devices[].timerUnit",
                "devices[].timerReset",
                "devices[].timerDynamic",
                "devices[].timerStartup"
              ]
            },
            {
              "type": "fieldset",
              "title": "Additional sensor",
              "expandable": true,
              "expanded": false,
              "items": [
                "devices[].sensor",
                "devices[].sensorType"
              ]
            }
          ]
        }
      ]
    }
  ]
}