ModuleRemoteRelay.tcl

###############################################################################
#
# RemoteRelay module implementation by F8ASB  (F8ASB.COM)
# Activating RemoteRelay Module 9#
# Remote 4 relays on Pin 20,21,22,23 of the Raspberry
# 3 choices:
# OFF = 0  ON = 1 PULSE 100ms = 2
# For example: 201#  -> put ON Relay K1
#               20 (gpio from relay) + choice  
###############################################################################


#
# This is the namespace in which all functions and variables below will exist.
# The name must match the configuration variable "NAME" in the
# [ModulePropagationMonitor] section in the configuration file. The name may
# be changed but it must be changed in both places.
#
namespace eval RemoteRelay {
#
# Check if this module is loaded in the current logic core
#
if {![info exists CFG_ID]} {
  return;
}

#
# Extract the module name from the current namespace
#
set module_name [namespace tail [namespace current]]


#
# A convenience function for printing out information prefixed by the
# module name
#
#   msg - The message to print
#
proc printInfo {msg} {
  variable module_name
  puts "$module_name: $msg"
}


#
# A convenience function for calling an event handler
#
#   ev - The event string to execute
#
proc processEvent {ev} {
  variable module_name
  ::processEvent "$module_name" "$ev"
}



#
# Executed when this module is being activated
#
proc activateInit {} {
  printInfo "Module activated"
  
}


#
# Executed when this module is being deactivated.
#
proc deactivateCleanup {} {
  printInfo "Module deactivated"

}


#
# Executed when a DTMF digit (0-9, A-F, *, #) is received
#
#   char - The received DTMF digit
#   duration - The duration of the received DTMF digit
#
proc dtmfDigitReceived {char duration} {
  printInfo "DTMF digit $char received with duration $duration milliseconds"

}


#
# Executed when a DTMF command is received
#
#   cmd - The received DTMF command
#
proc dtmfCmdReceived {cmd} {
  printInfo "DTMF command received: $cmd"
# ON command 201 211 221 231
  if {$cmd == "201"} {
    printInfo "Relay K1 ON"
    playMsg "relay1on";
    puts "Executing external command"
    exec gpio -g write 20 1 &
  } elseif {$cmd == "211"} {
    printInfo "Relay K2 ON"
    playMsg "relay2on";
    puts "Executing external command"
    exec gpio -g write 21 1 &
  } elseif {$cmd == "221"} {
    printInfo "Relay K3 ON"
    playMsg "relay3on";
    puts "Executing external command"
    exec gpio -g write 22 1 &
} elseif {$cmd == "231"} {
    printInfo "Relay K4 ON"
    playMsg "relay4on";
    puts "Executing external command"
    exec gpio -g write 23 1 &
#OFF command 200 210 220 230
} elseif {$cmd == "200"} {
    printInfo "Relay K1 OFF"
    playMsg "relay1off";
    puts "Executing external command"
    exec gpio -g write 20 0 &
  } elseif {$cmd == "210"} {
    printInfo "Relay K2 OFF"
    playMsg "relay2off";
    puts "Executing external command"
    exec gpio -g write 21 0 &
  } elseif {$cmd == "220"} {
    printInfo "Relay K3 OFF"
    playMsg "relay3off";
    puts "Executing external command"
    exec gpio -g write 22 0 &
  } elseif {$cmd == "230"} {
    printInfo "Relay K4 OFF"
    playMsg "relay4off";
    puts "Executing external command"
    exec gpio -g write 23 0 &
# PULSE command 202 212 222 232
  } elseif {$cmd == "202"} {
    printInfo "Relay K1 PULSE"
    playMsg "relay1pulse";
    puts "Executing external command"
    exec gpio -g write 20 1 &
    after 100
    exec gpio -g write 20 0 &
  } elseif {$cmd == "212"} {
    printInfo "Relay K2 PULSE"
    playMsg "relay2pulse";
    puts "Executing external command"
    exec gpio -g write 21 1 &
    after 100
    exec gpio -g write 21 0 &
  } elseif {$cmd == "222"} {
    printInfo "Relay K3 PULSE"
    playMsg "relay3pulse";
    puts "Executing external command"
    exec gpio -g write 22 1 &
    after 100
    exec gpio -g write 22 0 &
  } elseif {$cmd == "232"} {
    printInfo "Relay K4 PULSE"
    playMsg "relay4pulse";
    puts "Executing external command"
    exec gpio -g write 23 1 &
    after 100
    exec gpio -g write 23 0 &
 } elseif {$cmd == ""} {
    deactivateModule
  } else {
    processEvent "unknown_command $cmd"
  }

}


#
# Executed when a DTMF command is received in idle mode. That is, a command is
# received when this module has not been activated first.
#
#   cmd - The received DTMF command
#
proc dtmfCmdReceivedWhenIdle {cmd} {
  printInfo "DTMF command received when idle: $cmd"
  
}


#
# Executed when the squelch open or close.
#
#   is_open - Set to 1 if the squelch is open otherwise it's set to 0
#
proc squelchOpen {is_open} {
  if {$is_open} {set str "OPEN"} else { set str "CLOSED"}
  printInfo "The squelch is $str"
  
}


#
# Executed when all announcement messages has been played.
# Note that this function also may be called even if it wasn't this module
# that initiated the message playing.
#
proc allMsgsWritten {} {
  printInfo "Test allMsgsWritten called..."
  
}



# end of namespace
}


#
# This file has not been truncated
#