Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[haywardomnilogic] Added support ColorLogic V2 Lights, Updated Chlor Enable, Alert, Error, Status #15478

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

[haywardomnilogic] Added support ColorLogic V2 Lights, Updated Chlor Enable, Alert, Error, Status #15478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
51be53f
Update polling times based on Hayward API recommendations
matchews Aug 17, 2023
b816157
Added support for Hayward ColorLogic V2 Lights (Speed, Brightness & A…
matchews Aug 17, 2023
8a6baa4
Update chlorEnable based on updated getTelemetry API
matchews Aug 19, 2023
7e2c15f
Updated chlorinator error, status and alert channels to string bit ar…
matchews Aug 19, 2023
110734e
Updates to deploy dimensionless:frequency, update patterns and option…
matchews Aug 21, 2023
170a628
Update i18n properties
matchews Aug 22, 2023
df81e9f
pumpHandler pumpRPM command bug fix
matchews Aug 27, 2023
c793c0e
Review changes requested by lolodomo
matchews Nov 21, 2023
8ff6929
Added Thing upgrade instructions
matchews Jan 24, 2024
bb640a9
Fix Readme.MD formatting
matchews Apr 8, 2024
abc92b4
Fix Readme.MD formatting
matchews Apr 8, 2024
de0ce9f
Simplify bridge.getHandler() code
matchews Apr 8, 2024
911c777
rename instructions.xml
matchews Apr 8, 2024
01d0500
Fixed bug in thing update instructions
matchews Apr 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
65 changes: 53 additions & 12 deletions bundles/org.openhab.binding.haywardomnilogic/README.md
View file
Open in desktop
Expand Up @@ -34,8 +34,8 @@ Hayward OmniLogic Connection Parameters:
| Host Name | <https://app1.haywardomnilogic.com/HAAPI/HomeAutomation/API.ash> | Yes | Host name of the Hayward API server |
| User Name | None | Yes | Your Hayward User Name (not email address) |
| Password | None | Yes | Your Hayward User Password |
| Telemetry Poll Delay | 12 | Yes | Telemetry Poll Delay (10-60 seconds) |
| Alarm Poll Delay | 60 | Yes | Alarm Poll Delay (0-120 seconds, 0 disabled) |
| Telemetry Poll Delay | 3 | Yes | Telemetry Poll Delay (2-60 seconds) |
| Alarm Poll Delay | 10 | Yes | Alarm Poll Delay (0-120 seconds, 0 disabled) |

## Channels

Expand Down Expand Up @@ -65,14 +65,53 @@ Hayward OmniLogic Connection Parameters:
|-----------------------|----------------------|----------------------------------------------------------|:----------:|
| chlorEnable | Switch | Chlorinator enable | R/W |
| chlorOperatingMode | String | Chlorinator operating mode | R |
| chlorTimedPercent | Number:Dimensionless | Chlorinator timed percent | R/W |
| chlorTimedPercent | Number:Dimensionless | Chlorinator salt output (%) | R/W |
| chlorOperatingState | Number | Chlorinator operating state | R |
| chlorScMode | String | Chlorinator super chlorinate mode | R |
| chlorError | Number | Chlorinator error | R |
| chlorAlert | String | Chlorinator alert | R |
| chlorError | String | Chlorinator error bit array | R |
| chlorAlert | String | Chlorinator alert bit array | R |
| chlorAvgSaltLevel | Number:Dimensionless | Chlorinator average salt level in Part per Million (ppm) | R |
| chlorInstantSaltLevel | Number:Dimensionless | Chlorinator instant salt level in Part per Million (ppm) | R |
| chlorStatus | Number | Chlorinator K1/K2 relay status | R |
| chlorStatus | String | Chlorinator status bit array | R |

### Chlorinator Error Bit Array

|Bits |Value |Description |
|------|--------------------------------------------------------------------|-------------------------------|
|1:0 |00 = OK<br> 01 = Short<br> 10 = Open |Current Sensor |
|3:2 |00 = OK<br> 01 = Short<br> 10 = Open |Voltage Sensor |
|5:4 |00 = OK<br> 01 = Short<br> 10 = Open |Cell Temp Sensor |
|7:6 |00 = OK<br> 01 = Short<br> 10 = Open |Board Temp Sensor |
|9:8 |00 = OK<br> 01 = Short<br> 10 = Open |K1 Relay |
|11:10 |00 = OK<br> 01 = Short<br> 10 = Open |K2 Relay |
|13:12 |00 = OK<br> 01 = Type<br> 10 = Authentication <br> 11 = Comm Loss |Cell Errors |
|14 |0 |Aquarite PCB Error |

### Chlorinator Alert Bit Array

|Bits |Value |Description |
|------|--------------------------------------------------------------------|-------------------------------|
|1:0 |00 = OK<br> 01 = Salt Low<br> 10 = Salt too Low |Low salt |
|2 |0 = OK<br> 1 = High |High Current |
|3 |0 = OK<br> 1 = Low |Low Voltage |
|5:4 |00 = OK<br> 01 = Low<br> 10 = Scaleback<br> 11 = High |Cell Water Temp |
|7:6 |00 = OK<br> 01 = High<br> 10 = Clearing |Board Temp |
|8 |0 |Not Used |
|10:9 |0 |Not Used |
|12:11 |00 = OK<br> 01 = Clean |Cell Cleaning/Runtime |

### Chlorinator Status Bit Array

|Bits |Value |Description |
|------|----------------------------------------------------------------|-------------------------------|
|0 |0 = OK<br>1 = Error Present |Error Present |
|1 |0 = OK<br>1 = Alert Present |Alert Present |
|2 |0 = Standy<br>1 = Generating |Generating |
|3 |0 = Not Paused<br>1 = Paused<br> |Paused |
|4 |0 = Local Not Paused<br>1 = Local Paused<br> |Local Pause |
|5 |0 = Not Authenticated<><BR>1 = Authenticated |T-Cell Authenticated |
|6 |0 = K1 Relay Off<br> 1 = K1 Relay On |K1 Relay Active |
|7 |0 = K2 Relay Off<br> 1 = K2 Relay On |K2 Relay Active |

### Colorlogic Light Channels

Expand All @@ -88,11 +127,11 @@ Hayward OmniLogic Connection Parameters:
|---------------------|----------------------|------------------------|:----------:|
| filterEnable | Switch | Filter enable | R/W |
| filterValvePosition | String | Filter valve position | R |
| filterSpeedPercent | Number:Dimensionless | Filter speed in % | R/W |
| filterSpeedRpm | Number | Filter speed in RPM | R/W |
| filterSpeedPercent | Number:Dimensionless | Filter speed (%) | R/W |
| filterSpeedRpm | Number:Frequency | Filter speed (rpm) | R/W |
| filterSpeedSelect | String | Filter speed presets | R/W |
| filterState | String | Filter state | R |
| filterLastSpeed | Number:Dimensionless | Filter last speed in % | R |
| filterLastSpeed | Number:Dimensionless | Filter last speed (%) | R |

### Heater Channels

Expand All @@ -106,11 +145,11 @@ Hayward OmniLogic Connection Parameters:
| Channel Type ID | Item Type | Description | Read Write |
|------------------|----------------------|----------------------|:----------:|
| pumpEnable | Switch | Pump enable | R/W |
| pumpSpeedPercent | Number:Dimensionless | Pump speed in % | R/W |
| pumpSpeedRpm | Number | Pump speed in RPM | R/W |
| pumpSpeedPercent | Number:Dimensionless | Pump speed (%) | R/W |
| pumpSpeedRpm | Number: Frequency | Pump speed in rpm | R/W |
| pumpSpeedSelect | String | Pump speed presets | R/W |
| pumpState | String | Pump state | R |
| pumpLastSpeed | Number:Dimensionless | Pump last speed in % | R |
| pumpLastSpeed | Number:Dimensionless | Pump last speed (%) | R |

### Relay Channels

Expand All @@ -125,6 +164,8 @@ Hayward OmniLogic Connection Parameters:
| heaterEnable | Switch | Heater enable | R |
| heaterCurrentSetpoint | Number:Temperature | Heater Current Setpoint | R/W |

**Item Types Number:Dimensionless should have the units (i.e. %, ppm) defined in the Unit metadata

## Full Example

After installing the binding, you will need to manually add the Hayward Connection thing and enter your credentials.
Expand Down
9 changes: 7 additions & 2 deletions .../src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardBindingConstants.java
View file
Open in desktop
Expand Up @@ -26,7 +26,7 @@
@NonNullByDefault
public class HaywardBindingConstants {

private static final String BINDING_ID = "haywardomnilogic";
public static final String BINDING_ID = "haywardomnilogic";

// List of all Thing Type UIDs
public static final ThingTypeUID THING_TYPE_BACKYARD = new ThingTypeUID(BINDING_ID, "backyard");
Expand Down Expand Up @@ -87,8 +87,13 @@ public class HaywardBindingConstants {

// List of all Channel ids (colorlogic)
public static final String CHANNEL_COLORLOGIC_ENABLE = "colorLogicLightEnable";
public static final String CHANNEL_COLORLOGIC_LIGHTSTATE = "colorLogicLightState";
public static final String CHANNEL_COLORLOGIC_STATE = "colorLogicLightState";
public static final String CHANNEL_COLORLOGIC_CURRENTSHOW = "colorLogicLightCurrentShow";
public static final String CHANNEL_COLORLOGIC_BRIGHTNESS = "colorLogicLightBrightness";
public static final String CHANNEL_COLORLOGIC_SPEED = "colorLogicLightSpeed";

public static final String TYPE_COLORLOGIC_LIGHTBRIGHTNESS = "lightBrightness";
public static final String TYPE_COLORLOGIC_LIGHTSPEED = "lightSpeed";

public static final String PROPERTY_COLORLOGIC_TYPE = "colorlogicType";

Expand Down
1 change: 0 additions & 1 deletion ...ic/src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardHandlerFactory.java
View file
Open in desktop
Expand Up @@ -104,7 +104,6 @@ public HaywardHandlerFactory(final @Reference HaywardDynamicStateDescriptionProv
}
if (thingTypeUID.equals(HaywardBindingConstants.THING_TYPE_RELAY)) {
return new HaywardRelayHandler(thing);

}
if (thingTypeUID.equals(HaywardBindingConstants.THING_TYPE_VIRTUALHEATER)) {
return new HaywardVirtualHeaterHandler(thing);
Expand Down
9 changes: 7 additions & 2 deletions ...ogic/src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardThingHandler.java
View file
Open in desktop
Expand Up @@ -79,14 +79,19 @@ public State toState(String type, String channelID, String value) throws NumberF
return new QuantityType<>(Integer.parseInt(value), Units.PERCENT);
case HaywardBindingConstants.CHANNEL_FILTER_SPEEDPERCENT:
return new QuantityType<>(Integer.parseInt(value), Units.PERCENT);
case HaywardBindingConstants.CHANNEL_FILTER_SPEEDRPM:
case HaywardBindingConstants.CHANNEL_PUMP_LASTSPEED:
return new QuantityType<>(Integer.parseInt(value), Units.PERCENT);
case HaywardBindingConstants.CHANNEL_PUMP_SPEEDPERCENT:
return new QuantityType<>(Integer.parseInt(value), Units.PERCENT);
case HaywardBindingConstants.CHANNEL_PUMP_SPEEDRPM:
}
return StringType.valueOf(value);
case "Number:Frequency":
switch (channelID) {
case HaywardBindingConstants.CHANNEL_FILTER_SPEEDRPM:
return new QuantityType<>(Integer.parseInt(value), Units.RPM);
case HaywardBindingConstants.CHANNEL_PUMP_SPEEDRPM:
return new QuantityType<>(Integer.parseInt(value), Units.RPM);
}
case "Number:Temperature":
Bridge bridge = getBridge();
if (bridge != null) {
Expand Down
9 changes: 9 additions & 0 deletions ...java/org/openhab/binding/haywardomnilogic/internal/discovery/HaywardDiscoveryService.java
View file
Open in desktop
Expand Up @@ -129,6 +129,15 @@ public synchronized void mspConfigDiscovery(String xmlResponse) {
final List<String> colorLogicProperty1 = thingHandler.evaluateXPath("//Backyard//ColorLogic-Light/Type/text()",
xmlResponse);

final List<String> colorLogicProperty2 = thingHandler
.evaluateXPath("//Backyard//ColorLogic-Light/V2-Active/text()", xmlResponse);

for (int i = 0; i < colorLogicProperty2.size(); i++) {
if (colorLogicProperty1.get(i).equals("COLOR_LOGIC_UCL") && colorLogicProperty2.get(i).equals("yes")) {
lolodomo marked this conversation as resolved.
Show resolved Hide resolved
colorLogicProperty1.set(i, "COLOR_LOGIC_UCL_V2");
}
}

discoverDevices(thingHandler, xmlResponse, "ColorLogic-Light", HaywardTypeToRequest.COLORLOGIC,
HaywardBindingConstants.THING_TYPE_COLORLOGIC, (props, i) -> {
props.put(HaywardBindingConstants.PROPERTY_COLORLOGIC_TYPE, colorLogicProperty1.get(i));
Expand Down