GithubHelp home page GithubHelp logo

hamzamihaidanielx / homebridge-tahoma Goto Github PK

View Code? Open in Web Editor NEW

This project forked from dubocr/homebridge-tahoma

0.0 1.0 0.0 2.21 MB

Homebridge plugin for Tahoma and Cozytouch

License: Apache License 2.0

TypeScript 100.00%

homebridge-tahoma's Introduction

homebridge-tahoma

Supports TaHoma (Somfy), Connexoon (Somfy), Cozytouch (Atlantic,Thermor,Sauter) and E.Connect 2 (Rexel) platforms on HomeBridge

Main plugin upgrade

New plugin release 2.x.x will have many breaking changes. It will offer better stability for future development but this imply breaking devices identifiers from previous releases. After installing, this version, your devices will be removed from Homekit automation and you will have to configure them again. We appologize for that.

Be careful to update your config file based on following documentation or using Hoobs/Homebridge-UI plugin config management.

Installation

  1. Install homebridge using: npm install -g homebridge
  2. Install this plugin using: npm install -g homebridge-tahoma
  3. Update your configuration file. See bellow for a sample.

Configuration

Minimal configuration sample:

{
	"bridge": {
		...
	},

	"description": "...",

	"accessories": [],

	"platforms":[
		{
			"platform": "Tahoma",
			"name": "My TaHoma Box",

			"service": "tahoma",
			"user": "[email protected]",
			"password": "MyPassw0rd",
		}
	]
}

Configuration parameters:

Parameter Type Default Note
service String 'tahoma' optional, service name ('tahoma', 'connexoon', 'connexoon_rts', 'cozytouch' or 'rexel')
user String null mandatory, your service account username
password String null mandatory, your service account password
pollingPeriod Integer 30 optional, bridge polling period in seconds
refreshPeriod Integer 30 optional, device states refresh period in minutes
exclude String[] [] optional, list of protocols (hue,enocean,zwave,io,rts), ui name, widget name or device name to exclude
exposeScenarios Boolean false optional, expose TaHoma/Connexoon/Cozytouch scenarios as HomeKit switches. Could also specify a list of string corresponding to scenarios names to expose
devicesConfig Object[] [] optional list of device specific configuration (see below)

Specific device configuration

This option allows you to apply a specific configuation to device or group of device. One configuration is composed of a key attribute containing device name, widget, uiClass, protocol or unique identifier and as many parameter depending of device type.

{
	"key": "Bedroom door",
	"param1": "value1"
	...
}
Alarm parameters Type Default Note
stayZones String 'A' optional, active zones (A,B,C) in 'Stay' mode
nightZones String 'B' optional, active zones (A,B,C) in 'Night' mode
occupancySensor Boolean false optional, add an occupancy widget linked to the alarm
WindowCovering parameters Type Default Note
defaultPosition Integer 0 optional, final position for UpDown rollershutter after any command
reverse Boolean false optional, reverse up/down in case of bad mounting
lowSpeed Boolean false optional, use low speed for roller shutter supporting it
blindMode String null optional, change main slider action to orientation. By default, both closure and orientation will be set. When setting blindMode: true the blinds work in the following way: Opening the blinds or setting them to 100% will fully open them. Closing the blinds or setting them to 0% will fully close them. Setting the blinds to a value between 1% and 99% will first close the blinds and then adjust thier horizontal tilt in a way that 99% means fully horizonal = more light, and 1% means nearly closed = less light.
blindsOnRollerShutter Boolean false optional, when blinds are installed on roller shutter motors allow slats to stay horizontal (opened) at intermediate position
movementDuration Integer 0 optional, duration of a full shutter movement from 'open' to 'close' in seconds. Will be used to approximate shutter intermediate position. (0 = disable feature)
GarageDoorOpener parameters Type Default Note
cyclic Boolean false optional, restore closed state after cycleDuration seconds for stateless devices with cyclic behaviour
cycleDuration Integer false optional, cycle duration (in seconds) for cyclic mode (default: 5 sec)
reverse Boolean false optional, reverse up/down in case of bad mounting
HeatingSystem parameters Type Default Note
derogationDuration Integer 1 optional, duration (in hours) for derogation orders
comfort Integer 19 optional, comfort temperature used as display for heaters controled by pilot wire
eco Integer 17 optional, comfort temperature used as display for heaters controled by pilot wire

Full configuration example:

{
	"bridge": {
		...
	},

	"description": "...",

	"accessories": [],

	"platforms":[
		{
			"platform": "Tahoma",
			"name": "My Tahoma Bridge",

			"user": "[email protected]",
			"password": "MyPassw0rd",
			"service": "tahoma",
			"exclude": ["hue", "rts", "Main door"],

			"devicesConfig": [
				{
					"key": "Alarm",
					"stayZones": "A,C"
				},
				{
					"key": "Bedroom blind",
					"blindMode": true
				},
				{
					"key": "GarageDoor",
					"reverse": true
				},
				{
					"key": "UpDownRollerShutter",
					"defaultPosition": 50
				}
			]
		}
	]
}

Contribute

You are welcome to contribute to this plugin development by opening an issue in case of bad behaviour or not implemented device.

Any support request must follow this process :

  1. Execute failling operations from official app then from Homekit
  2. Report your config to https://dev.duboc.pro/tahoma
  3. Browse or open issue with title corresponding to your device widget name (see picture below)
  4. Provide your bridge last 4 digits (number visible as SETUP-XXXX-XXXX-XXXX at step 2.) Widget

I do not expect any reward concerning this plugin, however, some users ask me for a Donate button as sign of contribution. Feel free to use it.

homebridge-tahoma's People

Contributors

dubocr avatar lboue avatar mymartek avatar awph avatar ingmarstein avatar mman avatar fafoulon avatar torandreroland avatar

Watchers

James Cloos avatar

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.