package.json

{
  "name": "homebridge-edomoticz",
  "version": "2.1.48",
  "description": "homebridge-plugin for Domoticz https://github.com/nfarina/homebridge",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/patchworkboy/homebridge-eDomoticz.git"
  },
  "preferGlobal": true,
  "keywords": [
    "homebridge-plugin",
    "eDomoticz",
    "Domoticz"
  ],
  "engines": {
    "node": ">=0.12.0",
    "homebridge": ">=0.2.5"
  },
  "dependencies": {
    "inherits": "^2.0.1",
    "mqtt": "^2.15.0",
    "request": "^2.81.0"
  },
  "author": {
    "name": "PatchworkBoy",
    "url": "aka Marci"
  },
  "license": "GPL-3.0",
  "bugs": {
    "url": "https://github.com/patchworkboy/homebridge-eDomoticz/issues"
  },
  "homepage": "https://github.com/patchworkboy/homebridge-eDomoticz#readme",
  "readme": "# homebridge-eDomoticz\nA fully-fledged up-to-date Homebridge-Plugin\nfor use with [Homebridge](https://github.com/nfarina/homebridge) v0.2.1+\nand [Domoticz](https://github.com/domoticz/domoticz)\n\n##Supports:\n###Standard HomeKit Types:\n- Sockets (on/off) - Domoticz SwitchTypeVal: 0\n- Lamps (on/off) - Domoticz SwitchTypeVal: 0\n- Contact Sensors - Domoticz SwitchTypeVal: 2\n- Blinds - Domoticz SwitchTypeVal: 3\n- Smoke Detectors - Domoticz SwitchTypeVal: 5\n- Blinds (inverted) - Domoticz SwitchTypeVal: 6\n- Lamps (dimmer) - Domoticz SwitchTypeVal: 7\n- Motion Sensors - Domoticz SwitchTypeVal: 8\n- Push Switches -  Domoticz SwitchTypeVal: 9\n- Lock Mechanisms - Domoticz SwitchTypeVal: 11\n- Blinds (%) - Domoticz SwitchTypeVal: 13\n- Blinds (& inverted) - Domoticz SwitchTypeVal: 16\n\n##Provides:\n###Custom HomeKit Types:\n- General kWh power meters - Types: General, Current; SubType: kWh, mapped to Eve chars where possible\n- CurrentCost USB power meter - Type: Usage, SubType: Electric, mapped to Eve chars where possible\n- P1 Smart Meter (Electric & Gas), mapped to Eve chars where possible\n- EvoHome** / OpenTherm Thermostat support - Types: Heating, Thermostat; SubTypes: Zone, SetPoint\n- YouLess Meter (Current, Total and Today Total Consumption) - Type: YouLess Meter; SubType: YouLess counter, mapped to Eve chars where possible\n- General Usage % meters (eg: Motherboard Sensors Hardware Device - CPU %, Mem %, HDD % etc) - Type: General; SubType: Percentage\n- Temperature, Temp + Humidity, Temp + Humidity + Baro (Current Temperature, Current Humidity, Current Pressure in hPA) - Type: Temp, Temp + Humidty, Temp + Humidity + Baro [id'd as Eve Weather]\n- DarkSkies Virtual Weather Station Sensors (Wind, Solar Radiation, Rainfall, Visibility, Barometer [id'd as Eve Weather])\n\n** assumes the EvoHome has been setup according to [this script method](https://www.domoticz.com/wiki/Evohome#Scripting_for_RFG100).\n\n###Todo:\n- [ ] homebridge [plugin 2.0](https://github.com/nfarina/homebridge/pull/497) support\n- [x] MQTT-based realtime updates\n- [x] Hue/RGB\n- [x] Blinds\n- [x] m3 (gas usage)\n- [x] Motion sensors\n- [x] Smoke Detectors\n- [x] Brightness/Dimming\n- [x] kWh (electricity usage)\n- [x] General % usage\n- [x] Humidity\n- [x] Pressure\n- [x] YouLess Meter\n- [x] Open/Closed contact sensors\n- [ ] ...more sensors (ongoing)!\n\n## Installation\n```\nsudo npm install -g homebridge-edomoticz\n```\n\n## Update\n```\nsudo npm update -g homebridge-edomoticz\n```\n\n## Configuration\n\n~/.homebridge/config.json example:\n```\n{\n    \"bridge\": {\n        \"name\": \"Homebridge\",\n        \"username\": \"CC:21:3E:E4:DE:33\",\n        \"port\": 51826,\n        \"pin\": \"031-45-154\"\n    },\n    \"description\": \"Configuration file for (e)xtended Domoticz platform.\",\n    \"platforms\": [\n        {\n            \"platform\": \"eDomoticz\",\n            \"name\": \"eDomoticz\",\n            \"server\": \"127.0.0.1\",\n            \"port\": \"8080\",\n            \"ssl\": 0,\n            \"roomid\": 0,\n            \"mqttenable\": 1,\n            \"mqttserver\": \"127.0.0.1\",\n            \"mqttport\": \"1883\",\n            \"mqttauth\": 0,\n            \"mqttuser\": \"\",\n            \"mqttpass\": \"\"\n        }\n    ],\n    \"accessories\": []\n}\n```\n\n## Tips\n\n### Authentication\nIf Domoticz is set up to use basic or form login authentication, set \"server\":\"user:pass@ip\" within config.json. The plugin will internally extract the username and password, base64 encode it and send it as a http authorization header whenever it talks to your Domoticz server.\n\n### SSL\nSet \"ssl\":1 in config.json to turn on SSL (ie: server connects with https:// rather than http://). You will need to specify your SSL port - usually \"port\":\"443\" by default.\n\n### Issues pairing to Homebridge when you have a lot of Domoticz sensors...\nIf you have more than 100 devices in Domoticz, you need to limit the number of devices exposed to HomeKit (HomeKit only supports 100 Accessories on a single bridge - whilst we could combine multiple sensors into a single homekit accessory within the plugin, the possible combinations out there are endless, so we won't).\n\nTherefore, to reduce the number of devices exposed from Domoticz, create a roomplan within Domoticz via Setup > More Options > Plans > roomplan. Add only the devices you wish to be exposed to HomeKit to this new roomplan within Domoticz, and then get it's roomidx number. Set \"roomid\" in your config.json file to this room number.\n\n### Is my <<some accessory>> supported??\nSee [Domoticz API Reference](https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's#Retrieve_status_of_specific_device) - query your device as per the instructions there, and if your device’s SwitchTypeVal isn't in the 'Supports:' list or Type/SubType aren’t in the ’Provides:' list above then it'll just appear as an On/Off switch. [Open a new issue](https://github.com/PatchworkBoy/homebridge-eDomoticz/issues/new) including the output from the json api and I’ll get look into supporting that particular device more fully!\n\n### What does the Override slider represent on the EvoHome Thermostat?\nOverride-Until time in minutes from the current time. Allows setting an override-until time upto 8 hours in the future. Setting this slider to 0 will set the heating mode to Auto. Setting it to 481 will set the override as a PermanentOverride.\n\n### Logging\nComplies with Homebridge's native logging & debugging methodology - see https://github.com/nfarina/homebridge/wiki/Basic-Trouble-Shooting\n",
  "readmeFilename": "README.md",
  "_id": "homebridge-edomoticz@2.1.8",
  "_from": "homebridge-edomoticz",
  "_resolved": "file:homebridge-edomoticz"
}