config.schema.json

{
	"pluginAlias": "AwairLocal",
	"pluginType": "accessory",
	"singular": false,
	"headerDisplay": "Awair plug-in for [Homebridge](https://github.com/nfarina/homebridge) using the native Awair API. Reference [Installation Instructions](https://github.com/deanlyoung/homebridge-awair-local#readme) for details on determining 'Developer Token' and 'Device ID'.",
	"footerDisplay": "If you have multiple Awair devices, use those IDs to create individual accessories. Be sure to uniquely 'name' each device.",
	"schema": {
		"type": "object",
		"properties": {
			"name": {
				"title": "Accessory Name (REQUIRED)",
				"type": "string",
				"default": "Awair",
				"description": "The accessory name that appears by default in HomeKit."
			},
			"ip": {
				"title": "IP Address (REQUIRED)",
				"type": "string",
				"placeholder": "0.0.0.0",
				"description": "The IP address of your device on the LAN. Can also be the mDNS .local address for supported devices (do not include http://)."
			},
			"model": {
				"title": "Device Model (REQUIRED)",
				"type": "string",
				"placeholder": "awair-r2",
				"description": "Default = awair-r2, Options: `awair-mint`, `awair-omni`, `awair-r2`, or 'awair-element'.",
				"typeahead": {
					"source": ["awair-mint", "awair-omni", "awair-r2", "awair-element"]
				}
			},
			"manufacturer": {
				"title": "Manufacturer",
				"type": "string",
				"placeholder": "Awair",
				"description": "Manufacturer, default = `Awair`"
			},
			"serial": {
				"title": "Serial Number",
				"type": "string",
				"placeholder": "unknown serial",
				"description": "Default = 'unknown serial', Options: MAC or devType_devId."
			},
			"version": {
				"title": "Version",
				"type": "string",
				"placeholder": "unknown version",
				"description": "Default = 'unknown version', enter a firmware version number."
			},
			"carbonDioxideThreshold": {
				"title": "Carbon Dioxide Threshold",
				"type": "integer",
				"placeholder": 0,
				"description": "The CO2 level at which HomeKit will trigger an alert for the CO2 in ppm. Default = 0 [OFF]."
			},
			"carbonDioxideThresholdOff": {
				"title": "Carbon Dioxide Threshold",
				"type": "integer",
				"placeholder": 0,
				"description": "The CO2 level at which HomeKit will turn off the trigger alert for the CO2 in ppm, to ensure that it doesn't trigger on/off too frequently choose a number lower than `carbonDioxideThreshold`. Default = `0`."
			},
			"voc_mixture_mw": {
				"title": "Reference Gas Molecular Weight",
				"type": "number",
				"placeholder": 72.66578273019740,
				"description": "The Molecular Weight (g/mol) of a reference gas or mixture that you use to convert from ppb to ug/m^3."
			},
			"air_quality_method": {
				"title": "Air quality calculation method",
				"type": "string",
				"placeholder": "awair-score",
				"description": "Air quality calculation method used to define the Air Quality Chracteristic. Default = `awair-score`, Options: 'awair-score' and `awair-aqi`.",
				"typeahead": {
					"source": ["awair-score", "awair-aqi", "awair-pm25"]
				}
			},
			"polling_interval": {
				"title": "Polling frequency",
				"type": "integer",
				"placeholder": 10,
				"description": "The frequency (units: seconds) that you would like to update the data in HomeKit. Default = `10` [10 seconds]."
			},
			"limit": {
				"title": "Data Points Returned",
				"type": "integer",
				"default": 1,
				"description": "Number of consecutive 10 second 'raw' data points returned per request, used for custom averaging of sensor values from `/air-data/` endpoints. (Default = `1` [1 x 10 second sample]"
			},
			"logging": {
				"title": " Whether to output logs to the Homebridge logs",
				"type": "boolean",
				"default": false
			},
			"logging_level": {
				"title": " Whether to output logs to the Homebridge logs and what level of reporting: 0, 1, 2, 3, etc.",
				"type": "integer",
				"default": 0
			}
		},
		"required": ["name", "ip", "model"]
	},
	"layout": [
		"name",
		"ip",
		"model",
		{
			"type": "fieldset",
			"title": "Optional Configuration Settings",
			"expandable": true,
			"expanded": false,
			"items": [
				"manufacturer",
				"serial",
				"version",
				"carbonDioxideThreshold",
				"carbonDioxideThresholdOff",
				"voc_mixture_mw",
				"air_quality_method",
				"polling_interval",
				"limit",
				"logging",
				"logging_level"
			]
		}
	]
}