add support for lock mode and retrieving the KEYSPD

Author: ftl

pkg/protocol/command.go

@@ -462,6 +462,16 @@ var (
 			Long:  "set_vfo_opt",
 			Args:  1,
 		},
+		{
+			Short: 0xa2,
+			Long:  "set_lock_mode",
+			Args:  1,
+		},
+		{
+			Short:     0xa3,
+			Long:      "get_lock_mode",
+			Cacheable: true,
+		},
 		{
 			Short: 0xf1,
 			Long:  "halt",

pkg/protocol/response.go

@@ -1,11 +1,74 @@
 package protocol
 
-import "strconv"
+import (
+	"strconv"
+)
+
+type HamlibError string
+
+func (e HamlibError) Error() string {
+	message, ok := HamlibErrorMessages[string(e)]
+	if ok {
+		return message
+	}
+	return "unknown hamlib error: " + string(e)
+}
+
+const (
+	InvalidParameter             HamlibError = "-1"
+	InvalidConfiguration         HamlibError = "-2"
+	MemoryShortage               HamlibError = "-3"
+	FeatureNotImplemented        HamlibError = "-4"
+	CommunicationTimedOut        HamlibError = "-5"
+	IOError                      HamlibError = "-6"
+	InternalHamlibError          HamlibError = "-7"
+	ProtocolError                HamlibError = "-8"
+	CommandRejectedByTheRig      HamlibError = "-9"
+	CommandPerformedButTruncated HamlibError = "-10"
+	FeatureNotAvailable          HamlibError = "-11"
+	TargetVFOUnaccessible        HamlibError = "-12"
+	CommunicationBusError        HamlibError = "-13"
+	CommunicationBusCollision    HamlibError = "-14"
+	NullRigHandle                HamlibError = "-15"
+	InvalidVFO                   HamlibError = "-16"
+	ArgumentOutOfDomain          HamlibError = "-17"
+	FunctionDeprecated           HamlibError = "-18"
+	SecurityError                HamlibError = "-19"
+	RigNotPoweredOn              HamlibError = "-20"
+)
+
+var HamlibErrorMessages = map[string]string{
+	"0":   "Command completed successfully",
+	"-1":  "Invalid parameter",
+	"-2":  "Invalid configuration",
+	"-3":  "Memory shortage",
+	"-4":  "Feature not implemented",
+	"-5":  "Communication timed out",
+	"-6":  "IO error",
+	"-7":  "Internal Hamlib error",
+	"-8":  "Protocol error",
+	"-9":  "Command rejected by the rig",
+	"-10": "Command performed, but arg truncated, result not guaranteed",
+	"-11": "Feature not available",
+	"-12": "Target VFO unaccessible",
+	"-13": "Communication bus error",
+	"-14": "Communication bus collision",
+	"-15": "NULL RIG handle or invalid pointer parameter",
+	"-16": "Invalid VFO",
+	"-17": "Argument out of domain of func",
+	"-18": "Function deprecated",
+	"-19": "Security error password not provided or crypto failure",
+	"-20": "Rig is not powered on",
+}
 
 func OKResponse(cmd CommandKey) Response {
 	return Response{Command: cmd, Result: "0"}
 }
 
+func ErrorResponse(cmd CommandKey, err HamlibError) Response {
+	return Response{Command: cmd, Result: string(err)}
+}
+
 func GetFreqResponse(frequency int) Response {
 	return Response{
 		Command: "get_freq",
@@ -77,6 +140,28 @@ func GetPTTResponse(enabled bool) Response {
 	}
 }
 
+func GetLevelKeyspdResponse(wpm int) Response {
+	return Response{
+		Command: "get_level_keyspd",
+		Data:    []string{strconv.Itoa(wpm)},
+		Keys:    []string{"KEYSPD"},
+		Result:  "0",
+	}
+}
+
+func GetLockModeResponse(enabled bool) Response {
+	lockModeEnabled := "0"
+	if enabled {
+		lockModeEnabled = "1"
+	}
+	return Response{
+		Command: "get_lock_mode",
+		Data:    []string{lockModeEnabled},
+		Keys:    []string{"Locked"},
+		Result:  "0",
+	}
+}
+
 var NoResponse = Response{}
 
 var ChkVFOResponse = Response{