homebridge-frisquet-connect

Homebridge plugin to easily manage Frisquet Connect hardware by Frisquet from Apple HomeKit.

• Built with TypeScript for static type checking with exported types along the library.

Documentation

Installation

1. Add homebridge-frisquet-connect plugin to your homebridge install:

• eg. using oznu/docker-homebridge, update ./volumes/homebridge/package.json

{
  "private": true,
  "description": "This file keeps track of which plugins should be installed.",
  "dependencies": {
    "homebridge-dummy": "^0.4.0",
    "homebridge-frisquet-connect": "^0.2.1"
  }
}

2. Configure the homebridge-frisquet-connect platform, providing your Tydom identifiers:

{
  "bridge": {
    "name": "Homebridge 27C9",
    "username": "0E:21:1B:E7:27:C9",
    "port": 53619,
    "pin": "031-45-154"
  },
  "accessories": [],
  "platforms": [
    {
      "platform": "FrisquetConnect",
      "username": "[email protected]",
      "password": "YourPassw0rd"
    }
  ]
}

Configurations

| Field | Description | | --------- | --------------------------------- | | hostname | Frisquet Connect hostname | | username | Frisquet Connect username (email) | | password | Frisquet Connect password |

Debug

This library uses debug to provide high verbosity logs, just pass the following environment:

DEBUG=homebridge-frisquet-connect

Available scripts

| Script | Description | | ------------- | ---------------------------- | | start | alias to spec:watch | | test | Run all tests | | spec | Run unit tests | | spec:coverage | Run unit tests with coverage | | spec:watch | Watch unit tests | | lint | Run eslint static tests | | pretty | Run prettier static tests | | build | Compile the library | | build:watch | Watch compilation |

Authors

Olivier Louvignes

• http://olouv.com
• http://github.com/mgcrea

License

The MIT License

Copyright (c) 2020 Olivier Louvignes <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.