0.3.52 • Published 3 years ago

homebridge-tahoma-mwl v0.3.52

Weekly downloads
8
License
ISC
Repository
github
Last release
3 years ago

homebridge-tahoma

Supports TaHoma (Somfy), Connexoon (Somfy), Cozytouch (Atlantic,Thermor,Sauter) and E.Connect 2 (Rexel) 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:

ParameterTypeDefaultNote
userStringnullmandatory, your TaHoma/Connexoon/Cozytouch/E.Connect account username
passwordStringnullmandatory, your TaHoma/Connexoon/Cozytouch/E.Connect account password
serviceString'TaHoma'optional, service name ('TaHoma', 'Connexoon', 'Connexoon RTS', 'Cozytouch' or 'Rexel')
refreshPeriodInteger1800optional, device states refresh period in seconds
pollingPeriodInteger0optional, bridge polling period in seconds for sensors events (0: no polling)
excludeString[][]optional, list of protocols (hue,enocean,zwave,io,rts), device types (eg. RollerShutter), device definitions (eg. WindowCovering) or device (name) to exclude
exposeScenariosBooleanfalseoptional, expose TaHoma/Connexoon/Cozytouch scenarios as HomeKit switches. Could also specify a list of string corresponding to scenarios names to expose
forceTypeObject{}optional, list of device (name) to force with another type (see below). Ex. Fan recognised as Light can be force to Fan type
AlarmObject{}optional, Alarm configuration object (see below)
WindowCoveringObject{}optional, WindowCovering configuration object (see below)
GarageDoorOpenerObject{}optional, GarageDoorOpener configuration object (see below)
Alarm parametersTypeDefaultNote
STAY_ARMString'A'optional, active zones (A,B,C) in 'Stay' mode
NIGHT_ARMString'B'optional, active zones (A,B,C) in 'Night' mode
occupancySensorBooleanfalseoptional, add an occupancy widget linked to the alarm
WindowCovering parametersTypeDefaultNote
initPositionInteger50optional, default position for UpDown rollershutter
defaultPositionInteger0optional, final position for UpDown rollershutter after any command
reverseBooleanfalseoptional, reverse up/down in case of bad mounting
blindModeStringnulloptional, define main slider action (slates orientation or closure). By default, both closure and orientation will be set. When setting blindMode: "orientation" 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. When setting blindMode: "closure" the blinds work in the following way: Closing the blinds or setting them to 0% will fully close them. Opening the blinds or setting them to 100% will open them with specified orientation.
GarageDoorOpener parametersTypeDefaultNote
cyclicBooleanfalseoptional, activate restoring initial state for cyclic device without
reverseBooleanfalseoptional, reverse up/down in case of bad mounting
statelessBooleanfalseoptional, force stateless device detection (if your device hasn't state reports but don't react as it in HomeKit)

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.