Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Serge Wagener
|
43e3fdf35f | ||
|
Serge Wagener
|
d07d621e45 | ||
|
Serge Wagener
|
c8d117a894 | ||
|
Serge Wagener
|
9a6c9e681d | ||
|
Serge Wagener
|
0394d789f8 |
No files matched your search
@@ -29,32 +29,15 @@ This plugin currently supports the following services (and characteristics):
|
||||
| [Thermostat](#thermostat) | Thermostat with temperature sensor and heating state |
|
||||
| [WindowCovering](#window-covering) | Window covering (shutters, blinds, ...) |
|
||||
|
||||
Other accessories are being worked on and will be added as soon as ready.
|
||||
|
||||
## Requirements
|
||||
* [SmartHomeNG](https://github.com/smarthomeNG/smarthome)
|
||||
* [homebridge](https://www.npmjs.com/package/homebridge)
|
||||
* [Node.js >=14.18.1](https://nodejs.org/en/)
|
||||
* [Homebridge](https://homebridge.io)
|
||||
|
||||
## Installation
|
||||
### Install nodejs >=14.18.1
|
||||
See [NodeJS](https://nodejs.org/en/) website for details depending on your OS.
|
||||
## Installation of plugin
|
||||
|
||||
### Install libavahi-compat-libdnssd-dev lib
|
||||
For me i needed these libraries to be installed for my homebridge to work. See their [Homepage](https://homebridge.io) for installation instructions.
|
||||
Below is what i did on my Debian Bullseye installation:
|
||||
|
||||
|
||||
sudo apt install libavahi-compat-libdnssd-dev
|
||||
|
||||
|
||||
### Install homebridge >=1.3.5 from NPM repository
|
||||
|
||||
npm install -g homebridge --unsafe-perm
|
||||
|
||||
|
||||
### Install this plugin from NPM repository
|
||||
|
||||
npm install -g homebridge-smarthomeng --unsafe-perm
|
||||
Use [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x#readme) or install manually using ```npm install -g homebridge-smarthomeng```
|
||||
|
||||
|
||||
## Configuration
|
||||
@@ -63,13 +46,13 @@ If you already have a working homebridge installation just add the platform sect
|
||||
### Platform configuration
|
||||
The following parameters are available to configure the plugin as platform in homebridge.
|
||||
|
||||
| Parameter | Possible values | Mandatory | Description |
|
||||
|:----------|:---------------------------------------|:----------|:----------------------------------------------------|
|
||||
| platform | Any \<string> | Yes | Internal name of your platform |
|
||||
| name | Any \<string> | Yes | Visible name in HomeKit |
|
||||
| host | IP address or FQDN of your SHNG server | Yes | Your SHNG host |
|
||||
| port | Port \<number> | No | Listening port of websocket module. Default is 2424 |
|
||||
| tls | \<boolean> | No | Should TLS encryption be used. Defaults is 'false' |
|
||||
| Parameter | Possible values | Mandatory | Default | Description |
|
||||
|:----------|:---------------------------------------|:----------|:--------|:------------------------------------|
|
||||
| platform | Any \<string> | Yes | | Internal name of your platform |
|
||||
| name | Any \<string> | Yes | | Visible name in HomeKit |
|
||||
| host | IP address or FQDN of your SHNG server | Yes | | Your SHNG host |
|
||||
| port | Port \<number> | No | 2424 | Listening port of websocket module. |
|
||||
| tls | \<boolean> | No | False | Should TLS encryption be used. |
|
||||
|
||||
#### Example configuration:
|
||||
```json
|
||||
@@ -160,11 +143,11 @@ For now this accessory only supports turning the fan on and off. Further improve
|
||||
This accessory is used for opening/closing garage doors or any other automatic gate.
|
||||
|
||||
#### Characteristics in addition to [common characteristics](#common-accessories-characteristics)
|
||||
| Parameter | Possible values | Mandatory | Default | Description |
|
||||
|:---------------------------|:----------------|:----------|:--------|:------------------------------------------------------------------|
|
||||
| CurrentDoorState | \<item> | Yes | | SHNG item to monitor the current door state |
|
||||
| TargetDoorState | \<item> | Yes | | SHNG item to monitor and set the target position |
|
||||
| ObstructionDetected | \<item> | No | | SHNG item to monitor if the door is blocked |
|
||||
| Parameter | Possible values | Mandatory | Description |
|
||||
|:--------------------|:----------------|:----------|:------------------------------------------------------------------|
|
||||
| CurrentDoorState | \<item> | Yes | SHNG item to monitor the current door state |
|
||||
| TargetDoorState | \<item> | Yes | SHNG item to monitor and set the target position |
|
||||
| ObstructionDetected | \<item> | No | SHNG item to monitor if the door is blocked |
|
||||
|
||||
#### Additional comments
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
"private": false,
|
||||
"displayName": "SmartHomeNG",
|
||||
"name": "homebridge-smarthomeng",
|
||||
"version": "2.0.5",
|
||||
"version": "2.0.6",
|
||||
"description": "SmartHomeNG plugin for Homebridge",
|
||||
"license": "Apache-2.0",
|
||||
"repository": {
|
||||
|
||||
+92
-89
@@ -75,97 +75,100 @@ export class SmartHomeNGPlatform implements StaticPlatformPlugin {
|
||||
|
||||
// convert all configured accessory keys to lowercase to tolerate user case errors
|
||||
const accessories = JSON.parse(JSON.stringify(uncapitalizeKeys(this.config.accessories)));
|
||||
|
||||
for (const accessory of accessories) {
|
||||
if (!accessory.manufacturer) {
|
||||
accessory.manufacturer = 'SmartHomeNG';
|
||||
}
|
||||
if (!accessory.model) {
|
||||
accessory.model = 'SHNG Item';
|
||||
}
|
||||
|
||||
if (accessory.type !== '') {
|
||||
this.log.info('Parsing accessory:', accessory.name, 'of type', accessory.type);
|
||||
// set lo lowercase to ignore user case errors
|
||||
switch (accessory.type.toLowerCase()) {
|
||||
|
||||
// Presence sensor
|
||||
case 'occupancysensor':
|
||||
devices.push(new OccupancySensor(this, accessory));
|
||||
break;
|
||||
// Motion sensor
|
||||
case 'motionsensor':
|
||||
devices.push(new MotionSensor(this, accessory));
|
||||
break;
|
||||
|
||||
// Contact sensor
|
||||
case 'contactsensor':
|
||||
devices.push(new ContactSensor(this, accessory));
|
||||
break;
|
||||
|
||||
// Doorbell
|
||||
case 'doorbell':
|
||||
devices.push(new Doorbell(this, accessory));
|
||||
break;
|
||||
|
||||
// Security system
|
||||
case 'securitysystem':
|
||||
devices.push(new SecuritySystem(this, accessory));
|
||||
break;
|
||||
|
||||
// Switch
|
||||
case 'switch':
|
||||
devices.push(new Switch(this, accessory));
|
||||
break;
|
||||
|
||||
// Lightbulb
|
||||
case 'lightbulb':
|
||||
devices.push(new Lightbulb(this, accessory));
|
||||
break;
|
||||
|
||||
// Outlet
|
||||
case 'outlet':
|
||||
devices.push(new Outlet(this, accessory));
|
||||
break;
|
||||
|
||||
// Fan (uses Fanv2)
|
||||
case 'fan':
|
||||
devices.push(new Fan(this, accessory));
|
||||
break;
|
||||
|
||||
// Temperature sensor
|
||||
case 'temperaturesensor':
|
||||
devices.push(new TemperatureSensor(this, accessory));
|
||||
break;
|
||||
|
||||
// Thermostat
|
||||
case 'thermostat':
|
||||
devices.push(new Thermostat(this, accessory));
|
||||
break;
|
||||
|
||||
// WindowCovering
|
||||
case 'windowcovering':
|
||||
devices.push(new WindowCovering(this, accessory));
|
||||
break;
|
||||
|
||||
// Garage door
|
||||
case 'garagedoor':
|
||||
devices.push(new GarageDoor(this, accessory));
|
||||
break;
|
||||
|
||||
// Humidity sensor
|
||||
case 'humiditysensor':
|
||||
devices.push(new HumiditySensor(this, accessory));
|
||||
break;
|
||||
|
||||
// Show error for (yet ?) unsupported device
|
||||
default:
|
||||
this.log.warn('Accessory type', accessory.type, 'for', accessory.name, 'not recognized !');
|
||||
break;
|
||||
this.log.debug(accessories);
|
||||
if (Object.keys(accessories).length > 0) {
|
||||
for (const accessory of accessories) {
|
||||
if (!accessory.manufacturer) {
|
||||
accessory.manufacturer = 'SmartHomeNG';
|
||||
}
|
||||
if (!accessory.model) {
|
||||
accessory.model = 'SHNG Item';
|
||||
}
|
||||
|
||||
if (accessory.type !== '') {
|
||||
this.log.info('Parsing accessory:', accessory.name, 'of type', accessory.type);
|
||||
// set lo lowercase to ignore user case errors
|
||||
switch (accessory.type.toLowerCase()) {
|
||||
|
||||
// Presence sensor
|
||||
case 'occupancysensor':
|
||||
devices.push(new OccupancySensor(this, accessory));
|
||||
break;
|
||||
// Motion sensor
|
||||
case 'motionsensor':
|
||||
devices.push(new MotionSensor(this, accessory));
|
||||
break;
|
||||
|
||||
// Contact sensor
|
||||
case 'contactsensor':
|
||||
devices.push(new ContactSensor(this, accessory));
|
||||
break;
|
||||
|
||||
// Doorbell
|
||||
case 'doorbell':
|
||||
devices.push(new Doorbell(this, accessory));
|
||||
break;
|
||||
|
||||
// Security system
|
||||
case 'securitysystem':
|
||||
devices.push(new SecuritySystem(this, accessory));
|
||||
break;
|
||||
|
||||
// Switch
|
||||
case 'switch':
|
||||
devices.push(new Switch(this, accessory));
|
||||
break;
|
||||
|
||||
// Lightbulb
|
||||
case 'lightbulb':
|
||||
devices.push(new Lightbulb(this, accessory));
|
||||
break;
|
||||
|
||||
// Outlet
|
||||
case 'outlet':
|
||||
devices.push(new Outlet(this, accessory));
|
||||
break;
|
||||
|
||||
// Fan (uses Fanv2)
|
||||
case 'fan':
|
||||
devices.push(new Fan(this, accessory));
|
||||
break;
|
||||
|
||||
// Temperature sensor
|
||||
case 'temperaturesensor':
|
||||
devices.push(new TemperatureSensor(this, accessory));
|
||||
break;
|
||||
|
||||
// Thermostat
|
||||
case 'thermostat':
|
||||
devices.push(new Thermostat(this, accessory));
|
||||
break;
|
||||
|
||||
// WindowCovering
|
||||
case 'windowcovering':
|
||||
devices.push(new WindowCovering(this, accessory));
|
||||
break;
|
||||
|
||||
// Garage door
|
||||
case 'garagedoor':
|
||||
devices.push(new GarageDoor(this, accessory));
|
||||
break;
|
||||
|
||||
// Humidity sensor
|
||||
case 'humiditysensor':
|
||||
devices.push(new HumiditySensor(this, accessory));
|
||||
break;
|
||||
|
||||
// Show error for (yet ?) unsupported device
|
||||
default:
|
||||
this.log.warn('Accessory type', accessory.type, 'for', accessory.name, 'not recognized !');
|
||||
break;
|
||||
}
|
||||
} else {
|
||||
this.log.warn('Ignoring accessory (no type given): ' + accessory);
|
||||
}
|
||||
} else {
|
||||
this.log.warn('Ignoring accessory (no type given): ' + accessory);
|
||||
}
|
||||
|
||||
}
|
||||
callback(devices);
|
||||
this.log.debug('Finished building accessories list');
|
||||
|
||||
Reference in new issue
Block a user