config.schema.json

{
  "pluginAlias": "Blinds Command",
  "pluginType": "platform",
  "headerDisplay": "homebridge-blinds-cmd creates window covering (or blind) accessories in HomeKit, providing control and status functions through the command line scripts.",
  "footerDisplay": "For additional help and documentation please see the [developer page](https://github.com/hjdhjd/homebridge-blinds-cmd).",
  "singular": true,

  "schema": {
    "type": "object",
    "properties": {

      "blinds": {
        "type": "array",
        "title": "Blinds",

        "items": {
          "type": "object",
          "title": "Blind",
          "properties": {

            "name": {
              "type": "string",
              "title": "Blind Name",
              "required": true,
              "placeholder": "e.g. Blinds",
              "description": "Name you want to give this blind accessory in HomeKit. Each blind must have a unique name."
            },

            "up": {
              "type": "string",
              "title": "Up Command Script",
              "required": true,
              "placeholder": "e.g. /path/to/your/raise-blinds-script",
              "description": "Path to the command or script to raise the blind. Default: none."
            },

            "down": {
              "type": "string",
              "title": "Down Command Script",
              "required": true,
              "placeholder": "e.g. /path/to/your/lower-blinds-script",
              "description": "Path to the command or script to lower the blind. Default: none."
            },

            "stop": {
              "type": "string",
              "title": "Stop Command Script",
              "required": false,
              "placeholder": "e.g. /path/to/your/stop-blinds-script",
              "description": "Path to the command or script to stop the blind. Default: none."
            },

            "status": {
              "type": "string",
              "title": "Status Command Script",
              "required": false,
              "placeholder": "e.g. /path/to/your/blinds-status-script",
              "description": "Path to the command or script to show the current position of the blind. Default: none."
            },

            "transitionInterval": {
              "type": "number",
              "title": "Simulated Transition Duration",
              "required": false,
              "minimum": 0,
              "maximum": 120,
              "placeholder": "e.g. 12.5",
              "description": "Duration, in seconds, of an open or close event used to simulate action progress in HomeKit. Default: 10.0."
            },

            "refreshRate": {
              "type": "number",
              "title": "Status Refresh Interval",
              "required": false,
              "minimum": 0,
              "maximum": 120,
              "placeholder": "e.g. 10",
              "description": "Interval, in seconds, to execute the status command or script in order to keep HomeKit up to date on blinds status. Default: 0 (disabled)."
            },

            "manufacturer": {
              "type": "string",
              "title": "Blind Manufacturer",
              "required": false,
              "placeholder": "e.g. SomeManufacturer",
              "description": "Manufacturer name to assign to this blind."
            },

            "model": {
              "type": "string",
              "title": "Blind Model",
              "required": false,
              "placeholder": "e.g. SomeModel",
              "description": "Model name to assign to this blind."
            },

            "serial": {
            "type": "string",
            "title": "Blind Serial",
            "required": false,
            "placeholder": "e.g. SomeSerial",
            "description": "Serial number of this blind."
            }
          }
        }
      }
    }
  },

  "layout": [
    {
      "key": "blinds",
      "type": "array",
      "name": " ",
      "description": "Provide the details of your blinds.",
      "orderable": true,
      "buttonText": "Add Blind",
      "items": [
        "blinds[].name",

        {
          "key": "blinds[]",
          "type": "section",
          "title": "Blind Commands",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "description": "Commands to control your blinds.",
              "items": [
                "blinds[].up",
                "blinds[].down",
                "blinds[].stop",
                "blinds[].status"
              ]
            }
          ]
        },

        {
          "key": "blinds[]",
          "type": "section",
          "title": "Optional Settings",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "description": "These settings are optional and provide additional customization settings.",
              "items": [
                "blinds[].transitionInterval",
                "blinds[].refreshRate"
              ]
            }
          ]
        },

        {
          "key": "blinds[]",
          "type": "section",
          "title": "Blind Information",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "description": "These settings are optional and allow you to set additional information about your blinds.",
              "items": [
                "blinds[].manufacturer",
                "blinds[].model",
                "blinds[].serial"
              ]
            }
          ]
        }
      ]
    }
  ]
}