Coder Social home page Coder Social logo

lpostiglione / homebridge-tedee-bridge Goto Github PK

View Code? Open in Web Editor NEW

This project forked from lukasroegner/homebridge-tedee

0.0 0.0 0.0 264 KB

Homebridge plugin for the smart lock Tedee, using local API.

Home Page: https://www.npmjs.com/package/homebridge-tedee-bridge

License: MIT License

TypeScript 100.00%
homebridge homebridge-plugin homebridge-plugins tedee

homebridge-tedee-bridge's Introduction

Homebridge Tedee Plugin

This project is a homebridge plugin for Tedee smart locks. The Tedee bridge is required for this plugin to work.

The Tedee smart lock is exposed as a lock in HomeKit with support for:

  • Lock/Unlock/Unlatch
  • Battery status

Installation

Please install the plugin with the following command:

npm install -g homebridge-tedee-bridge

Configuration

{
  "platforms": [
    {
      "platform": "TedeeBridge",
      "apiKey": "TEDEE-API-KEY",
      "devices": [
        {
          "name": "DEVICE-NAME",
          "ignored": false
        }
      ],
      "bridgeIp": "TEDEE-BRIDGE-IP",
      "maximumApiRetry": 3,
      "timeout": 10000,
      "webhookPort": 3003
    }
  ]
}

Configuration Parameters

Platform

Parameter Required Description
platform Yes The platform name, should be "TedeeBridge"
apiKey Yes The API key for your Tedee bridge
devices No Array of your devices managed by the bridge
bridgeIp No The IP address of your Tedee bridge
maximumApiRetry No The amount of attempts to call the Bridge API. Defaults to 3 attempts (incl. initial one)
timeout No The timeout for the API calls in milliseconds. Defaults to 10000 ms
webhookPort No The port on which the callback server should listen. Defaults to 3003
Device
Parameter Required Description
name Yes The name of the lock. This name has to match the name that is configured in the Tedee app
ignored Yes If set to true, the lock will not be controlled by this plugin.

API Key

To obtain the API key, you need to log in to the Tedee app and navigate to the settings of your bridge. There you will find the API key. Selecting API Token type

Bear in mind there are two types of Authentication Tokens:

  1. Encrypted - This must be selected for the plugin to work!
  2. Plain - unsecured, which must be used for development purposes only! and never in production environment.

More information can be found in the Tedee API documentation.

Usage

  • When you change the HomeKit switch to locked, the smart lock with lock the door.
  • When you change the HomeKit switch from locked to unlocked, the smart door will unlock the door. If you have "auto pull spring" enabled in the Tedee app, it will also unlatch.
  • When you change the HomeKit switch from unlocked to unlocked, you have the unlatching enabled ("pull spring" in the Tedee app) then the lock will unlatch.

Thanks

Special thanks to Tedee for providing the API and the bridge for this plugin. Special thanks to Lukas Rögner for the initial implementation of the plugin.

homebridge-tedee-bridge's People

Contributors

lpostiglione avatar lukasroegner avatar mobilemanic avatar

homebridge-tedee-bridge's Issues

tedee still opens

Hello and thank you for providing this plugin. I use my Tedee with a bridge.

I have created an automation that locks my lock every evening at 23.00. Every morning the lock closes at 6.00
I left the house early one morning and unlocked the lock manually and left, but the automation still unlocked the lock and retracted the tongue even though I had already done this before and the door opened. Is there a solution so that I can configure this in the json? It should recognize when the lock is open and the automation does not go through anyway?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.