homebridge-ambient-realtime/config.schema.json

Ambient Weather Realtime API platform plugin for [Homebridge](https://github.com/nfarina/homebridge).

{
	"pluginAlias": "ambient",
	"headerDisplay": "Homebridge plugin for Ambient Realtime",
	"pluginType": "platform",
	"singular": true,
	"strictValidation": true,
	"schema": {
		"type": "object",
		"properties": {
			"name": {
				"title": "Accessory Name",
				"type": "string",
				"required": true,
				"placeholder": "Ambient",
				"default": "Ambient"
			},
			"api_app_key": {
				"title": "App Key",
				"type": "string",
				"required": true
			},
			"api_key": {
				"title": "API Key",
				"type": "string",
				"required": true
			},
			"locationAddress": {
				"title": "Location Address",
				"type": "string",
				"required": false,
				"placeholder": "Leave blank for all locations"
			},
			"showOutdoor":{
				"title": "Show Outdoor Temperature and Humidity",
				"type": "boolean",
				"required": true,
				"default": true
			},
			"showIndoor":{
				"title": "Show Indoor Temperature and Humidity WH32B",
				"type": "boolean",
				"required": true,
				"default": true
			},
			"showAqin":{
				"title": "Show Indoor Air Quality AQIN",
				"type": "boolean",
				"required": true,
				"default": false
			},
			"showIndoorAir":{
				"title": "Show Indoor Air Quality sensor PM25IN",
				"type": "boolean",
				"required": true,
				"default": false
			},
			"showOutdoorAir":{
				"title": "Show Outdoor Air Quality sensor PM25",
				"type": "boolean",
				"required": true,
				"default": false
			},
			"showOtherTemp":{
				"title": "Show additional Temperature and Humidity sensors WH31P, WH31PF, WH31E, WH51RF",
				"type": "boolean",
				"required": true,
				"default": false
			},
			"showLeak":{
				"title": "Show Leak Sensors WH31LA",
				"type": "boolean",
				"default": false
			},
			"sensors": {
				"title": "Sensors",
				"type": "array",
				"required": true,
				"items": {
					"title": "Custom Sensor",
					"type": "object",
					"properties": {
						"name": {
							"title": "Name for this sensor",
							"type": "string",
							"minLength": 3,
							"required": true,
							"placeholder": "Wind"
						},
						"dataPoint": {
							"title": "Data point to be measured for this sensor",
							"type": "string",
							"minLength": 2,
							"required": true,
							"placeholder": "windspeedmph"
						},
						"threshold": {
							"title": "threshold exceeded to trigger detection",
							"type": "number",
							"required": true,
							"placeholder": 4
						},
						"type": {
							"title": "Show as sensor type",
							"type": "integer",
							"required": true,
							"default": 0,
							"description": "Select the controls to display in HomeKit.",
							"oneOf": [
								{
									"title": "Motion",
									"enum": [0]
								},
								{
									"title": "Occupancy",
									"enum": [1]
								}
							]
						}
					}
				}
			},
			"showSocketData":{
				"title": "Show recived outdoor temperature in debug log",
				"type": "boolean",
				"default": false
			}
		}
	},
	"layout": [
		{
			"type": "help",
			"helpvalue": "<h4><b>Required settings<b/></h4>"
		},
		{
			"type": "flex",
			"flex-flow": "row wrap",
			"items": [
				"name"
			]
		},
		{
			"type": "flex",
			"items": [
				"api_app_key",
				"api_key"
			]
		},
		{
			"type": "help",
			"helpvalue": "<p class='help-block'> Visit Ambient.net <a target='blank' href='https://ambientweather.net/account/keys'>here</a> for instruction on obtaining your Application and API keys.</p>"
		},
		{
      "type": "flex",
      "flex-flow": "row wrap",
      "items": [
        "locationAddress"
      ]
		},
		{
			"type": "help",
			"helpvalue": "<h6><b>Location Support</b></h6><p class='help-block'> If you have more than one location and want to display them in separate Homebridge/HomeKit homes you can retrive only the devices at this loction name otherwise leave blank.<br/>The location must match the location configured in the Ambient.net app, review the log file to see the adresses as configured in the Ambient app.</p>"
		},
		{
			"type": "fieldset",
			"title": "Homekit Accessories",
			"description": "Expand to expose devices to show in Homekit",
			"expandable": true,
			"items": [
				"showOutdoor",
				"showIndoor",
				"showAqin",
				"showIndoorAir",
				"showOutdoorAir",
				"showOtherTemp",
				"showLeak"
			]
		},
		{
			"type": "flex",
			"title": "Show extra information in debug log",
			"flex-flow": "row wrap",
			"items": [
				"showSocketData"
			]
		},
		{
		"type": "help",
		"helpvalue": "<h5><b>Optional</b></h5><p class='help-block'> Reference Readme file <a target='blank' href='https://github.com/valiquette/homebridge-Ambient-realtime#readme'>here</a> for more information.</p>"
 		},
	{
		"key": "sensors",
		"type": "tabarray",
		"title": "{{ value.name || 'new Sensor' }}",
		"description": "Create custom sensors to show in Homekit",
		"expandable": true,
		"items": [
			"sensors[].name",
			"sensors[].dataPoint",
			"sensors[].threshold",
			"sensors[].type"
				]
	}
	]
}