2.0.3 • Published 10 months ago

homebridge-cool-automation v2.0.3

Weekly downloads
68
License
GNU
Repository
github
Last release
10 months ago

homebridge-cool-automation

Downloads Version verified-by-homebridge

Homebridge plugin for Cool Automation - HVAC Systems Controller

Requirements

 

check with: node -v & homebridge -V and update if needed

Installation

The plugin can be easily installed configured via Homebridge UI.

Otherwise, follow these instructions

  1. Install homebridge using: sudo npm install -g homebridge --unsafe-perm
  2. Install this plugin using: sudo npm install -g homebridge-cool-automation
  3. Update your configuration file. See config-sample.json in this repository for a sample.

* install from git: sudo npm install -g git+https://github.com/nitaybz/homebridge-cool-automation.git

Config file

Easy config (required):

"platforms": [
    {
        "platform": "CoolAutomation",
        "hubs": [
            {
                "ip": "192.168.1.100",
                "port": 10102
            }
        ],
    }
]

Advanced config (optional):

"platforms": [
    {
        "platform": "CoolAutomation",
        "hubs": [
            {
                "ip": "192.168.1.100",
                "port": 10102
            },
            {
                "ip": "192.168.1.101",
                "port": 10102
            }
        ],
        "statePollingInterval": 30,
        "minTemperature": 16,
        "maxTemperature": 30,
        "coolMode": true,
        "heatMode": true,
        "autoMode": false,
        "fanMode": true,
        "dryMode": true,
        "vlowFspeed": false,
        "lowFspeed": true,
        "medFspeed": true,
        "highFspeed": true,
        "topFspeed": false,
        "autoFspeed": true,
        "debug": false
    }
]

Only ip and port are device-specific settings. All other settings are platform-wide.

Configuration Parameters

Platform-wide Settings

ParameterDescriptionRequiredDefaultType
statePollingIntervalTime in seconds between each status polling of the devicesNo30Integer
minTemperatureMinimum Temperature to show in HomeKit ControlNo16Integer
maxTemperatureMaximum Temperature to show in HomeKit ControlNo30Integer
coolModeEnable COOL mode controlNotrueBoolean
heatModeEnable HEAT mode controlNotrueBoolean
autoModeEnable AUTO mode controlNofalseBoolean
fanModeEnable FAN mode control - Adds extra fan accessoryNotrueBoolean
dryModeEnable DRY mode control - Adds extra dehumidifier accessoryNotrueBoolean
vlowFspeedVLOW Fan SpeedNofalseBoolean
lowFspeedLOW Fan SpeedNotrueBoolean
medFspeedMED Fan SpeedNotrueBoolean
highFspeedHIGH Fan SpeedNotrueBoolean
topFspeedTOP Fan SpeedNofalseBoolean
autoFspeedAUTO Fan SpeedNotrueBoolean
debugEnable Debug LoggingNofalseBoolean

Hub-specific Settings

ParameterDescriptionRequiredDefaultType
ipIP Address of the Cool Master DeviceYes-String
portPort number for communicationNo10102Integer

Important: Only ip and port are hub-specific settings. All other configurations are platform-wide and apply to all hubs.

Fan speeds & "AUTO" speed

Since HomeKit control over fan speed is with a slider between 0-100, the plugin converts the steps you have in the Electra app to values between 1 to 100, when 100 is highest and 1 is lowest. Setting the fan speed to 0, should actually set it to "AUTO" speed.

Available fan speeds: AUTO, VLOW, LOW, MED, HIGH, TOP enable or disable them inside the config

Issues & Debug

If you experience any issues with the plugin please refer to the Issues tab and check if your issue is already described there, if it doesn't, please create a new issue with as much detailed information as you can give (logs are crucial).

if you want to even speed up the process, you can add "debug": true to your config, which will give me more details on the logs and speed up fixing the issue.


Support homebridge-cool-automation

homebridge-cool-automation is a free plugin under the GNU license. it was developed as a contribution to the homebridge/hoobs community with lots of love and thoughts. Creating and maintaining Homebridge plugins consume a lot of time and effort and if you would like to share your appreciation, feel free to "Star" or donate.

2.0.3

10 months ago

2.0.2

10 months ago

2.0.1

10 months ago

2.0.0

10 months ago

1.0.2

1 year ago

1.0.3

1 year ago

1.0.1

2 years ago

1.0.0

2 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

5 years ago

0.0.4

5 years ago

0.0.3

5 years ago

0.0.2

5 years ago

0.0.1

5 years ago