feat: centralize hayward command building #5
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| package org.openhab.binding.haywardomnilogic.internal.net; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
|
|
||
| /** | ||
| * Helper for building XML command strings sent to the Hayward cloud. | ||
| */ | ||
| @NonNullByDefault | ||
| public class CommandBuilder { | ||
|
|
||
| private static final String SET_HEATER_ENABLE = """ | ||
| <Name>SetHeaterEnable</Name> | ||
| <Parameters> | ||
| <Parameter name=\"Token\" dataType=\"String\">%s</Parameter> | ||
| <Parameter name=\"MspSystemID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"PoolID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"HeaterID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"Enabled\" dataType=\"bool\">%s</Parameter> | ||
| </Parameters> | ||
| """; | ||
|
|
||
| private static final String SET_UI_HEATER_CMD = """ | ||
| <Name>SetUIHeaterCmd</Name> | ||
| <Parameters> | ||
| <Parameter name=\"Token\" dataType=\"String\">%s</Parameter> | ||
| <Parameter name=\"MspSystemID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"PoolID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"HeaterID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"Temp\" dataType=\"int\">%s</Parameter> | ||
| </Parameters> | ||
| """; | ||
|
|
||
| private CommandBuilder() { | ||
| // utility class | ||
| } | ||
|
|
||
| public static String buildSetHeaterEnable(String prefix, String token, int mspSystemID, String poolID, | ||
| String heaterID, String enabled) { | ||
| return prefix | ||
| + String.format(SET_HEATER_ENABLE, token, mspSystemID, poolID, heaterID, enabled) | ||
| + closingTag(prefix); | ||
| } | ||
|
|
||
| public static String buildSetUIHeaterCmd(String prefix, String token, int mspSystemID, String poolID, | ||
| String heaterID, String temp) { | ||
| return prefix + String.format(SET_UI_HEATER_CMD, token, mspSystemID, poolID, heaterID, temp) | ||
| + closingTag(prefix); | ||
| } | ||
|
|
||
| private static String closingTag(String prefix) { | ||
| if (prefix.contains("<Request>")) { | ||
| return "</Request>"; | ||
| } else if (prefix.contains("<GetTelemetry>")) { | ||
| return "</GetTelemetry>"; | ||
| } else { | ||
| return ""; | ||
| } | ||
| } | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| package org.openhab.binding.haywardomnilogiclocal.internal.net; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
|
|
||
| /** | ||
| * Helper for building XML command strings sent to the Hayward controller. | ||
| */ | ||
| @NonNullByDefault | ||
| public class CommandBuilder { | ||
|
|
||
| private static final String SET_HEATER_ENABLE = """ | ||
| <Name>SetHeaterEnable</Name> | ||
| <Parameters> | ||
| <Parameter name=\"Token\" dataType=\"String\">%s</Parameter> | ||
| <Parameter name=\"MspSystemID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"PoolID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"HeaterID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"Enabled\" dataType=\"bool\">%s</Parameter> | ||
| </Parameters> | ||
| """; | ||
|
|
||
| private static final String SET_UI_HEATER_CMD = """ | ||
| <Name>SetUIHeaterCmd</Name> | ||
| <Parameters> | ||
| <Parameter name=\"Token\" dataType=\"String\">%s</Parameter> | ||
| <Parameter name=\"MspSystemID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"PoolID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"HeaterID\" dataType=\"int\">%s</Parameter> | ||
| <Parameter name=\"Temp\" dataType=\"int\">%s</Parameter> | ||
| </Parameters> | ||
| """; | ||
|
|
||
| private CommandBuilder() { | ||
| // utility class | ||
| } | ||
|
|
||
| public static String buildSetHeaterEnable(String prefix, String token, int mspSystemID, String poolID, | ||
| String heaterID, String enabled) { | ||
| return prefix | ||
| + String.format(SET_HEATER_ENABLE, token, mspSystemID, poolID, heaterID, enabled) | ||
| + closingTag(prefix); | ||
| } | ||
|
|
||
| public static String buildSetUIHeaterCmd(String prefix, String token, int mspSystemID, String poolID, | ||
| String heaterID, String temp) { | ||
| return prefix + String.format(SET_UI_HEATER_CMD, token, mspSystemID, poolID, heaterID, temp) | ||
|
Comment on lines
+37
to
+46
There was a problem hiding this comment. [P0] Use String for mspSystemID in local command builder The local variant of Useful? React with 👍 / 👎. |
||
| + closingTag(prefix); | ||
| } | ||
|
|
||
| private static String closingTag(String prefix) { | ||
| if (prefix.contains("<Request>")) { | ||
| return "</Request>"; | ||
| } else if (prefix.contains("<GetTelemetry>")) { | ||
| return "</GetTelemetry>"; | ||
| } else { | ||
| return ""; | ||
| } | ||
| } | ||
| } | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[P0] Align mspSystemID parameter type with callers
The new
CommandBuilderexpectsint mspSystemIDin bothbuildSetHeaterEnableandbuildSetUIHeaterCmd, butHaywardAccount.mspSystemIDis defined as aStringand the handlers pass that string directly. This mismatch means the binding no longer compiles because there is no implicit conversion fromStringtoint. Either accept aStringhere or parse it at the call site before invoking the builder.Useful? React with 👍 / 👎.