homebridge-tahoma

v2.2.59

Sample Platform plugin for TaHoma and Cozytouch services (Somfy,Atlantic,Thermor,Sauter): https://github.com/dubocr/homebridge-tahoma For more information about how to use this package see README

Latest version published 2 months ago

License: Apache-2.0

NPM

GitHub

Package Health Score

62 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.2.59	\|	11/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.54	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.72	\|	03/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.9	\|	06/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.51	\|	04/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (201)

GitHub Stars: 140
Forks: 42
Contributors: 20

Direct Usage Popularity

The npm package homebridge-tahoma receives a total of 201 downloads a week. As such, we scored homebridge-tahoma popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package homebridge-tahoma, we found that it has been starred 140 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the homebridge-tahoma repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like homebridge-tahoma is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 51
Open PR: 4
Last Release: 2 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of homebridge-tahoma based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that homebridge-tahoma demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=12.4.0

Age: 8 years
Dependencies: 2 Direct
Versions: 255
Install Size: 511 kB
Dist-tags: 2
# of Files: 348
Maintainers: 1
TS Typings: No

homebridge-tahoma has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Overkiz (Somfy) - Homebridge-TaHoma

Homebridge plugin supporting Overkiz based platforms :

Service code	Vendor	Product compatibility
`local`	Somfy local API	TaHoma, TaHoma Switch (configure local API)
`somfy_europe`	Somfy Europe	TaHoma, TaHoma Switch, Connexoon IO, Kit de connectivité Orange
`somfy_australia`	Somfy Australia	Connexoon RTS and other products in Australia
`somfy_north_america`	Somfy North America	TaHoma and other product in North America
`cozytouch`	Atlantic, Thermor, Sauter	Cozytouch
`flexom`	Bouygues	Flexom
`hi_kumo`	Hitachi	Hi hi_kumo
`rexel`	Rexel	Energeasy connectivité

Installation

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

Configuration

Minimal configuration sample:

{
	"bridge": {
		...
	},

	"description": "...",

	"accessories": [],

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

			"service": "somfy_europe",
			"user": "user@me.com",
			"password": "MyPassw0rd",
		}
	]
}

Configuration parameters:

Parameter	Type	Default	Note
`service`	String	'somfy_europe'	optional, service name (see above)
`user`	String	null	mandatory, your service account username (or gateway PIN / IP address)
`password`	String	null	mandatory, your service account password (or API token)
`pollingPeriod`	Integer	30	optional, bridge polling period in seconds
`refreshPeriod`	Integer	30	optional, device states refresh period in minutes
`exclude`	String[]	[]	optional, protocol, ui, widget or device name to exclude
`exposeScenarios`	Boolean	false	optional, expose 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)

Configure Local API

Local API service is available on TaHoma and TaHoma switch gateways.

WARNING: Switching to local API will break your HomeKit configuration (automations) as local API device identifiers actually differs.

To use Local API you will have to:

Activate developer mode (www.somfy.com > My Account > Activate developer mode)
Generate API credentials at https://dev.duboc.pro/homebridge-tahoma
Configure the plugin service to Local API: "service":"local"

When using Local API service, please fill user with your gateway PIN number or IPv4 address and password with the token generated at step 2

For more information, browse https://developer.somfy.com/developer-mode

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 / String	false	optional, use low speed for roller shutter supporting it. If string, specify slot time with format "HH:MM-HH:MM". Low speed will be enabled between them.
`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
`pedestrianDuration`	Integer	0	optional, duration for pedestrian position for RTS gates

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": "user@me.com",
			"password": "MyPassw0rd",
			"service": "somfy_europe",
			"exclude": ["hue", "rts", "Main door", "Main door", "PositionableHorizontalAwning"],

			"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 unexpected behaviour or unsupported device.

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

homebridge-tahoma dependencies

moment overkiz-client

homebridge-tahoma development dependencies

@types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint homebridge nodemon rimraf ts-node typescript

FAQs

What is homebridge-tahoma?

Sample Platform plugin for TaHoma and Cozytouch services (Somfy,Atlantic,Thermor,Sauter): https://github.com/dubocr/hom... Visit Snyk Advisor to see a full health score report for homebridge-tahoma, including popularity, security, maintenance & community analysis.

Is homebridge-tahoma popular?

The npm package homebridge-tahoma receives a total of 201 weekly downloads. As such, homebridge-tahoma popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is homebridge-tahoma well maintained?

We found indications that homebridge-tahoma maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is homebridge-tahoma safe to use?

While scanning the latest version of homebridge-tahoma, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 21 December-2024, at 09:42 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP