primal79 / homebridge-tahoma

Homebridge plugin for Tahoma and Cozytouch

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

homebridge-tahoma

Supports TaHoma (Somfy), Connexoon (Somfy) and Cozytouch (Atlantic,Thermor,Sauter) platforms on HomeBridge

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",
			
			"user": "user@me.com",
			"password": "MyPassw0rd",
		}
	]
}

Configuration parameters:

Parameter Type Default Note
user String null mandatory, your TaHoma/Connexoon/Cozytouch account username
password String null mandatory, your TaHoma/Connexoon/Cozytouch account password
service String 'TaHoma' optional, service name ('TaHoma', 'Connexoon', 'Connexoon RTS' or 'Cozytouch')
refreshPeriod Integer 600 optional, device states refresh period in seconds
exclude String[] [] optional, list of protocols (hue,enocean,zwave,io,rts) 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
forceType Object {} optional, list of device (name) to force with another type (see below). Ex. Fan recognised as Light can be force to Fan type
Alarm Object {} optional, Alarm configuration object (see below)
WindowCovering Object {} optional, WindowCovering configuration object (see below)
Alarm parameters Type Default Note
STAY_ARM String 'A' optional, active zones (A,B,C) in 'Stay' mode
NIGHT_ARM 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 50 optional, default position for UpDown rollershutter
reverse Boolean false optional, reverse up/down in case of bad mounting
blindMode Boolean false optional, control horizonally adjustable blinds with just one slider. 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.

Full configuration example:

{
	"bridge": {
		...
	},

	"description": "...",

	"accessories": [],

	"platforms":[
		{
			"platform": "Tahoma",
			"name": "My Tahoma",
			
			"user": "user@me.com",
			"password": "MyPassw0rd",
			"service": "TaHoma",
			"exclude": ["hue","rts","Garage Door"],
			"forceType": {"Beedrom Fan": "Fan"}
			"Alarm": {
				"STAY_ARM": "A,C",
				"NIGHT_ARM": "B"
			}
		}
	]
}

Limitation

Some devices or configurations could not operate properly due to limited tests. Don't hesitate to open an issue if your device doesn't work properly. Before opening issue, please submit your config with this form

Contribute

You are welcome to contribute to this plugin development by adding new kind of devices by adding implementation .js file in accessories folder or improving existing 'js' file. These documentations could help you developing plugin : Obtaining my config, HomeKit services and characteristics

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.

About

Homebridge plugin for Tahoma and Cozytouch

License:Apache License 2.0


Languages

Language:JavaScript 100.0%