Added support for speaking words and phrases

Signed-off-by: Matt Myers <[email protected]>

Author: matchews

bundles/org.openhab.binding.elkm1/src/main/java/org/openhab/binding/elkm1/internal/elk/ElkCommand.java

@@ -33,42 +33,43 @@ public enum ElkCommand {
     AlarmMemory("AM"),
     ArmingStatusRequest("as"),
     ArmingStatusRequestReply("AS"),
-    AlarmReporting("AR"),
     AlarmReportAcknowledge("ar"),
-    AlarmReportingTest("AT"),
+    AlarmReporting("AR"),
     AlarmReportTestAcknowledge("at"),
+    AlarmReportingTest("AT"),
     AlarmZoneRequest("az"),
     AlarmZoneRequestReply("AZ"),
     OutputChangeUpdate("CC"),
+    ControlOutputOff("cf"),
+    ControlOutputOn("cn"),
     CustomValueReply("CR"),
     OutputStatusReply("CS"),
-    ControlOutputOn("cn"),
-    ControlOutputOff("cf"),
     EntryExitData("EE"),
     SendEmailTrigger("EM"),
     ValidOrInvalidUserCode("IC"),
     KeypadKeyChangeUpdate("KC"),
     SystemLogUpdate("LD"),
     PLCChangeUpdate("PC"),
-    BypassedZoneState("ZB"),
-    ZoneChangeUpdateReport("ZC"),
-    ZoneDefintionRequest("zd"),
-    ZoneDefinitionReply("ZD"),
-    ZonePartition("zp"),
-    ZonePartitionReply("ZP"),
-    ZoneStatusRequest("zs"),
-    ZoneStatusReply("ZS"),
-    TaskChangeUpdate("TC"),
+    RawCommand("rc"),
     StringTextDescription("sd"),
     StringTextDescriptionReply("SD"),
     SpeakPhraseAtVoiceOutput("sp"),
     TemperatureReply("ST"),
     SpeakWordAtVoiceOutput("sw"),
+    TaskChangeUpdate("TC"),
     ThermostatDataReply("TR"),
     RequestVersionNumber("vn"),
     RequestVersionNumberReply("VN"),
     EthernetModuleTest("XK"),
     EthernetModuleTestAcknowledge("xk"),
+    BypassedZoneState("ZB"),
+    ZoneChangeUpdateReport("ZC"),
+    ZoneDefintionRequest("zd"),
+    ZoneDefinitionReply("ZD"),
+    ZonePartition("zp"),
+    ZonePartitionReply("ZP"),
+    ZoneStatusRequest("zs"),
+    ZoneStatusReply("ZS"),
     ZoneAnalogVolatageReply("ZV");
 
     private final String myValue;

bundles/org.openhab.binding.elkm1/src/main/java/org/openhab/binding/elkm1/internal/elk/ElkVoicePhrases.java

@@ -13,14 +13,11 @@
 
 package org.openhab.binding.elkm1.internal.elk;
 
-import org.eclipse.jdt.annotation.NonNullByDefault;
-
 /**
  * The phrases the elk can speak.
  *
  * @author David Bennett - Initial Contribution
  */
-@NonNullByDefault
 public enum ElkVoicePhrases {
     SilenceDelay(0),
     Zone1(1),
@@ -355,4 +352,16 @@ private ElkVoicePhrases(int value) {
     public int getValue() {
         return value;
     }
+
+    /**
+     * Get an elk voice phrase from the integer value.
+     */
+    public static ElkVoicePhrases fromValue(Integer val) {
+        for (ElkVoicePhrases cmd : ElkVoicePhrases.values()) {
+            if (cmd.getValue() == val) {
+                return cmd;
+            }
+        }
+        return null;
+    }
 }

bundles/org.openhab.binding.elkm1/src/main/java/org/openhab/binding/elkm1/internal/elk/ElkVoiceWords.java

@@ -13,14 +13,11 @@
 
 package org.openhab.binding.elkm1.internal.elk;
 
-import org.eclipse.jdt.annotation.NonNullByDefault;
-
 /**
  * The set of words the elk can speak.
  *
  * @author David Bennett - Initial Contribution
  */
-@NonNullByDefault
 public enum ElkVoiceWords {
     _Custom1(1),
     _Custom2(2),
@@ -498,4 +495,16 @@ private ElkVoiceWords(int value) {
     public int getValue() {
         return value;
     }
+
+    /**
+     * Get an elk voice word from the integer value.
+     */
+    public static ElkVoiceWords fromValue(int val) {
+        for (ElkVoiceWords cmd : ElkVoiceWords.values()) {
+            if (cmd.getValue() == val) {
+                return cmd;
+            }
+        }
+        return null;
+    }
 }

bundles/org.openhab.binding.elkm1/src/main/java/org/openhab/binding/elkm1/internal/handler/ElkM1BridgeHandler.java

@@ -24,11 +24,14 @@
 import org.openhab.binding.elkm1.internal.config.ElkAlarmConfig;
 import org.openhab.binding.elkm1.internal.elk.ElkAlarmArmedState;
 import org.openhab.binding.elkm1.internal.elk.ElkAlarmConnection;
+import org.openhab.binding.elkm1.internal.elk.ElkCommand;
 import org.openhab.binding.elkm1.internal.elk.ElkDefinition;
 import org.openhab.binding.elkm1.internal.elk.ElkListener;
 import org.openhab.binding.elkm1.internal.elk.ElkMessage;
 import org.openhab.binding.elkm1.internal.elk.ElkMessageFactory;
 import org.openhab.binding.elkm1.internal.elk.ElkTypeToRequest;
+import org.openhab.binding.elkm1.internal.elk.ElkVoicePhrases;
+import org.openhab.binding.elkm1.internal.elk.ElkVoiceWords;
 import org.openhab.binding.elkm1.internal.elk.message.ArmAway;
 import org.openhab.binding.elkm1.internal.elk.message.ArmToNight;
 import org.openhab.binding.elkm1.internal.elk.message.ArmToNightInstant;
@@ -41,6 +44,8 @@
 import org.openhab.binding.elkm1.internal.elk.message.EthernetModuleTest;
 import org.openhab.binding.elkm1.internal.elk.message.EthernetModuleTestReply;
 import org.openhab.binding.elkm1.internal.elk.message.OutputOn;
+import org.openhab.binding.elkm1.internal.elk.message.SpeakPhraseAtVoiceOutput;
+import org.openhab.binding.elkm1.internal.elk.message.SpeakWordAtVoiceOutput;
 import org.openhab.binding.elkm1.internal.elk.message.StringTextDescription;
 import org.openhab.binding.elkm1.internal.elk.message.StringTextDescriptionReply;
 import org.openhab.binding.elkm1.internal.elk.message.ValidOrInvalidUserCode;
@@ -69,7 +74,6 @@
  *
  * @author David Bennett - Initial contribution
  */
-
 public class ElkM1BridgeHandler extends BaseBridgeHandler implements ElkListener {
     private final Logger logger = LoggerFactory.getLogger(ElkM1BridgeHandler.class);
     private ScheduledFuture<?> initializeFuture;
@@ -401,11 +405,19 @@ public void updateArmedState(int area, ElkAlarmArmedState armed) {
         }
     }
 
-    public void sendELKCommand(String command) {
-        String messageType = command.substring(0, 2);
+    public void sendELKCommand(String commandString) {
+        ElkCommand messageType = ElkCommand.fromValue(commandString.substring(0, 2));
         switch (messageType) {
-            case "cn":
-                connection.sendCommand(new OutputOn(command));
+            case ControlOutputOn:
+                connection.sendCommand(new OutputOn(commandString));
+                break;
+            case SpeakPhraseAtVoiceOutput:
+                connection.sendCommand(new SpeakPhraseAtVoiceOutput(
+                        ElkVoicePhrases.fromValue(Integer.parseInt(commandString.substring(2)))));
+                break;
+            case SpeakWordAtVoiceOutput:
+                connection.sendCommand(new SpeakWordAtVoiceOutput(
+                        ElkVoiceWords.fromValue(Integer.parseInt(commandString.substring(2)))));
                 break;
         }
     }