config.schema.json

{
  "pluginAlias": "RPi",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "Homebridge plugin for Raspberry Pi",
  "footerDisplay": "",
  "schema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "platform": {},
      "name": {
        "description": "Plugin name as displayed in the Homebridge log.",
        "type": "string",
        "required": true,
        "default": "RPi"
      },
      "hosts": {
        "title": "Raspberry Pis",
        "notitle": true,
        "type": "array",
        "items": {
          "description": "<b>Raspberry Pi</b>",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "host": {
              "title": "Host",
              "description": "IP address or hostname and port of the Pi's pigpiod server.  E.g.: 'localhost:8888'.",
              "type": "string",
              "required": true
            },
            "name": {
              "title": "Name",
              "description": "The hostname of the Raspberry Pi.",
              "type": "string"
            },
            "hidden": {
              "title": "Hidden",
              "description": "Do not expose a service for the Raspberry Pi itself.",
              "type": "boolean"
            },
            "noFan": {
              "title": "No Fan",
              "description": "Do not expose a Fan service for the Raspberry Pi fan.",
              "type": "boolean"
            },
            "noPowerLed": {
              "title": "No Power LED",
              "description": "Do not expose a Lightbulb service for the Raspberry Pi power LED.",
              "type": "boolean"
            },
            "noSmokeSensor": {
              "title": "No Smoke Sensor",
              "description": "Do not expose a Smoke Sensor service for the Raspberry Pi itself.",
              "type": "boolean"
            },
            "usbPower": {
              "title": "USB Power",
              "description": "Expose an Outlet service to control power to the USB ports. Only for Raspberry Pi models with four USB 2.0 ports: B+, 2B, 3B, and 3B+.<br>You need to configure pigpiod as well, see the <a href=\"https://github.com/ebaauw/homebridge-rpi/wiki/Supported-Devices#usb-power\" target=\"_blank\">Wiki</a>.",
              "type": "boolean"
            },
            "devices": {
              "title": "Devices",
              "notitle": true,
              "type": "array",
              "items": {
                "description": "<b>Device</b>",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "device": {
                    "title": "Device",
                    "description": "The type of the device. See the <a href=\"https://github.com/ebaauw/homebridge-rpi/wiki/Supported-Devices#gpio-devices\" target=\"_blank\">Wiki</a> for details.",
                    "type": "string",
                    "required": true,
                    "oneOf": [
                      {
                        "title": "Blinkt",
                        "enum": [
                          "blinkt"
                        ]
                      },
                      {
                        "title": "Button",
                        "enum": [
                          "button"
                        ]
                      },
                      {
                        "title": "DHTxx Temperature/Humidity Sensor",
                        "enum": [
                          "dht"
                        ]
                      },
                      {
                        "title": "Carbon Monoxide Sensor",
                        "enum": [
                          "carbonmonoxide"
                        ]
                      },
                      {
                        "title": "Contact Sensor",
                        "enum": [
                          "contact"
                        ]
                      },
                      {
                        "title": "Door Bell",
                        "enum": [
                          "doorbell"
                        ]
                      },
                      {
                        "title": "Fan SHIM",
                        "enum": [
                          "fanshim"
                        ]
                      },
                      {
                        "title": "Garage Door Opener",
                        "enum": [
                          "garage"
                        ]
                      },
                      {
                        "title": "Leak Sensor",
                        "enum": [
                          "leak"
                        ]
                      },
                      {
                        "title": "Light",
                        "enum": [
                          "light"
                        ]
                      },
                      {
                        "title": "Lock",
                        "enum": [
                          "lock"
                        ]
                      },
                      {
                        "title": "Motion Sensor",
                        "enum": [
                          "motion"
                        ]
                      },
                      {
                        "title": "Chain of P9813 LED Controllers",
                        "enum": [
                          "p9813"
                        ]
                      },
                      {
                        "title": "Rocker",
                        "enum": [
                          "rocker"
                        ]
                      },
                      {
                        "title": "Servo Motor",
                        "enum": [
                          "servo"
                        ]
                      },
                      {
                        "title": "Smoke Sensor",
                        "enum": [
                          "smoke"
                        ]
                      },
                      {
                        "title": "Switch",
                        "enum": [
                          "switch"
                        ]
                      },
                      {
                        "title": "Valve",
                        "enum": [
                          "valve"
                        ]
                      }
                    ]
                  },
                  "name": {
                    "title": "Name",
                    "description": "The HomeKit name of the device.",
                    "type": "string"
                  },
                  "gpio": {
                    "title": "GPIO",
                    "description": "The BCM number of the GPIO pin.<br>For devices: Button, Carbon Monoxide Sensor, Contact Sensor, DHTxx Sensor, Door Bell, Garage Door Opener, Leak Sensor, Light, Motion Sensor, Rocker, Servo Motor, Smoke Sensor, Switch.",
                    "type": "integer",
                    "maximum": 31
                  },
                  "pull": {
                    "title": "Pull-up/pull-down resistor",
                    "description": "The configuration of the internal pull-up/pull-down resistor.<br>For input devices: Button, Carbon Monoxide Sensor, Contact Sensor, Door Bell, Leak Sensor, Motion Sensor, Rocket, Smoke Sensor.",
                    "type": "string",
                    "oneOf": [
                      {
                        "title": "Off",
                        "enum": [
                          "off"
                        ]
                      },
                      {
                        "title": "Pull-down",
                        "enum": [
                          "down"
                        ]
                      },
                      {
                        "title": "Pull-up",
                        "enum": [
                          "up"
                        ]
                      }
                    ]
                  },
                  "debounceTimeout": {
                    "title": "Debounce Timeout",
                    "description": "Time in ms to ignore state changes for debouncing. Default 20ms.<br>For input devices: Button, Carbon Monoxide Sensor, Contact Sensor, Door Bell, Leak Sensor, Motion Sensor, Rocket, Smoke Sensor.",
                    "type": "integer",
                    "minimum": 0,
                    "maxmimum": 300
                  },
                  "reversed": {
                    "title": "Reversed",
                    "description": "The device state is reversed<br>For devices: Button, Carbon Monoxide Sensor, Contact Sensor, Door Bell, Garage Door Opener, Leak Sensor, Motion Sensor, Smoke Sensor, Switch.",
                    "type": "boolean"
                  },
                  "doublePressTimeout": {
                    "title": "Double Press Timeout",
                    "description": "Time in ms to wait after a release to see if button is pressed again for Double Press. Default 500ms.  Set to 0 to disable Double Press altogether.<br>For device: Button.",
                    "type": "integer",
                    "minimum": 0,
                    "maxmimum": 100
                  },
                  "longPressTimeout": {
                    "title": "Long Press Timeout",
                    "description": "Time in ms between button press and release after which a Long Press is issued. Default: 1000ms. Set to 0 to disable Long Press.<br>For device: Button.",
                    "type": "integer",
                    "minimum": 0,
                    "maxmimum": 100
                  },
                  "pulse": {
                    "title": "Pulse",
                    "description": "Time in ms to lock the lock or turn off the switch automatically.<br>For devices: Lock, Switch.",
                    "type": "integer",
                    "minimum": 20,
                    "maximum": 5000
                  },
                  "duration": {
                    "title": "Expose Duration",
                    "description": "Expose duration characteristic on switch to turn it off automatically.<br>For device: Switch.",
                    "type": "boolean"
                  },
                  "gpioClock": {
                    "title": "GPIO Clock",
                    "description": "The BCM number of the GPIO pin for the clock signal.<br>For device: Blinkt.",
                    "type": "integer",
                    "maximum": 31
                  },
                  "gpioData": {
                    "title": "GPIO Data",
                    "description": "The BCM number of the GPIO pin for the data signal.<br>For device: Blinkt.",
                    "type": "integer",
                    "maximum": 31
                  },
                  "nLeds": {
                    "title": "# LEDs",
                    "description": "The number LEDs.<br>For device: Blinkt.",
                    "type": "integer"
                  }
                },
                "allOf": [
                  {
                    "oneOf": [
                      {
                        "properties": {
                          "device": {
                            "enum": [
                              "blinkt",
                              "fanshim",
                              "p9813"
                            ]
                          },
                          "gpio": {
                            "not": {}
                          }
                        }
                      },
                      {
                        "properties": {
                          "device": {
                            "enum": [
                              "button",
                              "carbonmonoxide",
                              "contact",
                              "dht",
                              "doorbell",
                              "garage",
                              "leak",
                              "light",
                              "lock",
                              "motion",
                              "rocker",
                              "servo",
                              "smoke",
                              "switch",
                              "valve"
                            ]
                          }
                        },
                        "required": [
                          "gpio"
                        ]
                      }
                    ]
                  },
                  {
                    "anyOf": [
                      {
                        "properties": {
                          "device": {
                              "enum": [
                                "button",
                                "carbonmonoxide",
                                "contact",
                                "doorbell",
                                "leak",
                                "motion",
                                "rocker",
                                "smoke"
                              ]
                          }
                        }
                      },
                      {
                        "properties": {
                          "pull": {
                            "not": {}
                          }
                        }
                      }
                    ]
                  },
                  {
                    "anyOf": [
                      {
                        "properties": {
                          "device": {
                            "enum": [
                              "button",
                              "carbonmonoxide",
                              "contact",
                              "doorbell",
                              "leak",
                              "motion",
                              "rocker",
                              "smoke"
                            ]
                          }
                        }
                      },
                      {
                        "properties": {
                          "debounceTimeout": {
                            "not": {}
                          }
                        }
                      }
                    ]
                  },
                  {
                    "anyOf": [
                      {
                        "properties": {
                          "device": {
                            "enum": [
                              "button",
                              "carbonmonoxide",
                              "contact",
                              "doorbell",
                              "garage",
                              "leak",
                              "light",
                              "lock",
                              "motion",
                              "smoke",
                              "switch",
                              "valve"
                            ]
                          }
                        }
                      },
                      {
                        "properties": {
                          "reversed": {
                            "not": {}
                          }
                        }
                      }
                    ]
                  },
                  {
                    "anyOf": [
                      {
                        "properties": {
                          "device": {
                            "const": "button"
                          }
                        }
                      },
                      {
                        "properties": {
                          "doublePressTimeout": {
                            "not": {}
                          }
                        }
                      }
                    ]
                  },
                  {
                    "anyOf": [
                      {
                        "properties": {
                          "device": {
                            "const": "button"
                          }
                        }
                      },
                      {
                        "properties": {
                          "longPressTimeout": {
                            "not": {}
                          }
                        }
                      }
                    ]
                  },
                  {
                    "oneOf": [
                      {
                        "properties": {
                          "device": {
                            "enum": [
                              "blinkt",
                              "p9813"
                            ]
                          }
                        }
                      },
                      {
                        "properties": {
                          "gpioClock": {
                            "not": {}
                          }
                        }
                      }
                    ]
                  },
                  {
                    "oneOf": [
                      {
                        "properties": {
                          "device": {
                            "enum": [
                              "blinkt",
                              "p9813"
                            ]
                          }
                        }
                      },
                      {
                        "properties": {
                          "gpioData": {
                            "not": {}
                          }
                        }
                      }
                    ]
                  },
                  {
                    "oneOf": [
                      {
                        "properties": {
                          "device": {
                            "enum": [
                              "blinkt",
                              "p9813"
                            ]
                          }
                        }
                      },
                      {
                        "properties": {
                          "nLeds": {
                            "not": {}
                          }
                        }
                      }
                    ]
                  },
                  {
                    "anyOf": [
                      {
                        "properties": {
                          "device": {
                            "enum": [
                              "lock",
                              "switch"
                            ]
	                      }
                        }
                      },
                      {
                        "properties": {
                          "pulse": {
                            "not": {}
                          }
                        }
                      }
                    ]
                  },
                  {
                    "anyOf": [
                      {
                        "properties": {
                          "device": {
                            "enum": [
                              "switch"
                            ]
	                      }
                        }
                      },
                      {
                        "properties": {
                          "autoOff": {
                            "not": {}
                          }
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      },
      "timeout": {
        "title": "Timeout",
        "description": "Timeout in seconds.  Default: 15.",
        "type": "integer",
        "minimum": 1,
        "maximum": 60
      }
    }
  }
}