{"_id":"@ds-flair/homebridge-flair","name":"@ds-flair/homebridge-flair","dist-tags":{"latest":"0.0.0-development"},"versions":{"0.0.0-development":{"displayName":"Homebridge Flair","name":"@ds-flair/homebridge-flair","version":"0.0.0-development","publishConfig":{"registry":"https://registry.npmjs.org/"},"description":"Brings the flair smart vents into homekit","license":"ISC","repository":{"type":"git","url":"git://github.com/danielschaffer/homebridge-flair.git"},"bugs":{"url":"https://github.com/danielschaffer/homebridge-flair/issues"},"engines":{"node":">=10.17.0","homebridge":">0.4.53"},"main":"dist/index.js","scripts":{"lint":"eslint src/**.ts --max-warnings=0","lint:fix":"eslint --fix src/**","watch":"npm run build && npm link && nodemon","build":"rimraf ./dist && tsc"},"release":{"branches":["main"],"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/npm","@semantic-release/github"]},"keywords":["homebridge-plugin","flair"],"dependencies":{"class-transformer":"^0.5.1","@ds-flair/flair-api-ts":"0.0.0-development","reflect-metadata":"^0.1.13"},"devDependencies":{"@semantic-release/changelog":"6.0.2","@semantic-release/commit-analyzer":"9.0.2","@semantic-release/git":"10.0.1","@semantic-release/github":"8.0.7","@semantic-release/npm":"9.0.1","@semantic-release/release-notes-generator":"10.0.3","@types/node":"18.11.18","@typescript-eslint/eslint-plugin":"5.47.1","@typescript-eslint/parser":"5.47.1","eslint":"8.31.0","homebridge":"1.6.0","nodemon":"2.0.20","rimraf":"3.0.2","ts-node":"10.9.1","typescript":"4.9.4"},"_id":"@ds-flair/homebridge-flair@0.0.0-development","gitHead":"a2f59300c6a76488e7a0f338623637e4eb3f9cd5","types":"./dist/index.d.ts","homepage":"https://github.com/danielschaffer/homebridge-flair#readme","_nodeVersion":"18.18.2","_npmVersion":"9.8.1","dist":{"integrity":"sha512-LyMB/gwJYbWGc2YxXPU87PI73b54uQj5u27Qwh/RA8Qh323w+4Re04FXl7NWjsWjx7P9h7Dp+vIWoFk3DQbdTg==","shasum":"941d493fd585b653a0b74a1e16b18ac6c851d38d","tarball":"https://registry.npmjs.org/@ds-flair/homebridge-flair/-/homebridge-flair-0.0.0-development.tgz","fileCount":70,"unpackedSize":105614,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICa3O751Gk31GkX+6K6rmutKrK06rAW8Uzu3ERBS7tXuAiEAq7eNc7gYq5Q1vpcOdkp9UtSNthfWSaFzxGDB11b8njA="}]},"_npmUser":{"name":"danielschaffer","email":"dan@dandoes.net"},"directories":{},"maintainers":[{"name":"danielschaffer","email":"dan@dandoes.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/homebridge-flair_0.0.0-development_1701027695008_0.7853954368377003"},"_hasShrinkwrap":false}},"time":{"created":"2023-11-26T19:41:34.878Z","0.0.0-development":"2023-11-26T19:41:35.222Z","modified":"2023-11-26T19:41:35.515Z"},"maintainers":[{"name":"danielschaffer","email":"dan@dandoes.net"}],"description":"Brings the flair smart vents into homekit","homepage":"https://github.com/danielschaffer/homebridge-flair#readme","keywords":["homebridge-plugin","flair"],"repository":{"type":"git","url":"git://github.com/danielschaffer/homebridge-flair.git"},"bugs":{"url":"https://github.com/danielschaffer/homebridge-flair/issues"},"license":"ISC","readme":"# homebridge-flair\n[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)\n\n[Flair Smart Vent](https://flair.co/products/vent) plug-in for [Homebridge](https://github.com/nfarina/homebridge) using the Flair API.\n\n\n# Installation\n\n<!-- 2. Clone (or pull) this repository from github into the same path Homebridge lives (usually `/usr/local/lib/node_modules`). Note: the code currently on GitHub is in beta, and is newer than the latest published version of this package on `npm` -->\n1. Install homebridge using: `npm install -g homebridge`\n2. Install this plug-in using: `npm install -g homebridge-flair`\n3. Update your configuration file. See example `config.json` snippet below.\n\n# Configuration\n\nConfiguration sample (edit `~/.homebridge/config.json`):\n\n```json\n{\n    \"platforms\": [\n        {\n            \"clientId\": \"client_id\",\n            \"clientSecret\": \"client_secret\",\n            \"username\": \"user\",\n            \"password\": \"pass\",\n            \"pollInterval\": 60,\n            \"platform\": \"Flair\",\n            \"ventAccessoryType\": \"windowCovering\"\n        }\n    ]\n}\n```\n\n# Obtaining Credentials\n\nIn order to use this plugin you will need to obtain a client id and client secret from Flair. \n\nStart by creating a Flair account at [my.flair.co](https://my.flair.co/) (if you haven't already), then use [this web form to request credentials](https://forms.gle/VohiQjWNv9CAP2ASA).\n\nMore [API docs and details](https://flair.co/api)\n\n# Auto Vs Manual Mode\n\nWhen you use Pucks with your setup the pucks will appear in the app as a Thermostat. \n\n~~If you turn those thermostats off it will put the Flair system into Manual mode. If you turn the thermostat to any other setting it will set your system to Flair's Auto mode.~~ As of Version 1.3.0 homekit does not do any switching from Auto to Manual mode. This must be done through the flair app, the Puck thermostats now respect the \"off\" setting.\n\n# Vent Accessory Type\n\nYou can specify how vent accessories are shown in HomeKit with the `ventAccessoryType` property.\n\n`windowCovering` - Window Covering\n`fan` - Fan\n`airPurifier` - Air Purifier\n`hidden` - Hidden, this is useful if you have a puck in each room and want to only expose the room \"thermostats\"\n\n\n### Commit format\n\nCommits should be formatted as `type(scope): message`\n\nThe following types are allowed:\n\n| Type | Description |\n|---|---|\n| feat | A new feature |\n| fix | A bug fix |\n| docs | Documentation only changes |\n| style | Changes that do not affect the meaning of the code (white-space, formatting,missing semi-colons, etc) |\n| refactor | A code change that neither fixes a bug nor adds a feature |\n| perf | A code change that improves performance |\n| test | Adding missing or correcting existing tests |\n| chore | Changes to the build process or auxiliary tools and libraries such as documentation generation |\n\n### Releasing\n\nA new version is released when a merge or push to `main` occurs.\n\nWe use the rules at [default-release-rules.js](https://github.com/semantic-release/commit-analyzer/blob/master/lib/default-release-rules.js) as our guide to when a series of commits should create a release.\n","readmeFilename":"README.md"}