# Generated driver for mercury_valve
# vim: ft=tcl tabstop=8  softtabstop=2  shiftwidth=2  nocindent  smartindent
#

namespace eval ::scobj::mercury_valve {
  set debug_threshold 5
}

proc ::scobj::mercury_valve::debug_log {tc_root debug_level debug_string} {
  set catch_status [ catch {
    set debug_threshold [hgetpropval ${tc_root} debug_threshold]
    if {${debug_level} >= ${debug_threshold}} {
      set fd [open "../log/mercury_valve_[basename ${tc_root}].log" "a"]
      set line "[clock format [clock seconds] -format "%T"] ${debug_string}"
      puts ${fd} "${line}"
      close ${fd}
    }
  } catch_message ]
}

proc ::scobj::mercury_valve::sics_log {debug_level debug_string} {
  set catch_status [ catch {
    set debug_threshold ${::scobj::mercury_valve::debug_threshold}
    if {${debug_level} >= ${debug_threshold}} {
      sicslog "::scobj::mercury_valve::${debug_string}"
    }
  } catch_message ]
}

# checklimits function for driveable interface
proc ::scobj::mercury_valve::checklimits {tc_root} {
  set catch_status [ catch {
    debug_log ${tc_root} 1 "checklimits tc_root=${tc_root} sct=[sct] target=[sct target]"
    set setpoint [sct target]
    if { [hpropexists [sct] lowerlimit] } {
      set lolimit [sct lowerlimit]
    } else {
      # lowerlimit not set, use target
      set lolimit [sct target]
    }
    if { [hpropexists [sct] upperlimit] } {
      set hilimit [sct upperlimit]
    } else {
      # upperlimit not set, use target
      set hilimit [sct target]
    }
# checklimits hook code goes here
    if { ${setpoint} < ${lolimit} || ${setpoint} > ${hilimit} } {
      sct driving 0
      error "setpoint ${setpoint} violates limits (${lolimit}..${hilimit}) on [sct]"
    }
    return OK
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

# check function for hset change
proc ::scobj::mercury_valve::checkrange {tc_root} {
  set catch_status [ catch {
    debug_log ${tc_root} 1 "checkrange tc_root=${tc_root} sct=[sct] target=[sct target]"
    set setpoint [sct target]
    if { [hpropexists [sct] lowerlimit] } {
      set lolimit [sct lowerlimit]
    } else {
      # lowerlimit not set, use target
      set lolimit [sct target]
    }
    if { [hpropexists [sct] upperlimit] } {
      set hilimit [sct upperlimit]
    } else {
      # upperlimit not set, use target
      set hilimit [sct target]
    }
# checkrange hook code goes here
    if { ${setpoint} < ${lolimit} || ${setpoint} > ${hilimit} } {
      error "setpoint ${setpoint} violates limits (${lolimit}..${hilimit}) on [sct]"
    }
    return OK
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

# checkstatus function for driveable interface
proc ::scobj::mercury_valve::checkstatus {tc_root} {
  set catch_status [ catch {
# checkstatus hook code goes here
    if {[sct driving]} {
      set sp "[sct target]"
      set pv "[hval ${tc_root}/[sct driveable]]"
      if { abs(${pv} - ${sp}) <= [sct tolerance] } {
        if { [hpropexists [sct] settle_time] } {
          if { [hpropexists [sct] settle_time_start] } {
            if { [sct utime] - [sct settle_time_start] >= [sct settle_time]} {
              sct driving 0
              return "idle"
            }
            return "busy"
          } else {
            sct utime settle_time_start
            return "busy"
          }
        }
        sct driving 0
        return "idle"
      }
      if { [hpropexists [sct] settle_time_start] } {
        hdelprop [sct] settle_time_start
      }
      return "busy"
    } else {
      return "idle"
    }
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

# function to request the read of a parameter on a device
proc ::scobj::mercury_valve::getValue {tc_root nextState cmd_str} {
  set catch_status [ catch {
    debug_log ${tc_root} 1 "getValue tc_root=${tc_root} sct=[sct] cmd=${cmd_str}"
    if { [hpropexists [sct] geterror] } {
      hdelprop [sct] geterror
    }
    set cmd "${cmd_str}"
# getValue hook code goes here
    debug_log ${tc_root} 1 "getValue sct send ${cmd}"
    if {![string equal -nocase -length 10 ${cmd} "@@NOSEND@@"]} {
      sct send "${cmd}"
    }
    return ${nextState}
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

# halt function for driveable interface
proc ::scobj::mercury_valve::halt {tc_root} {
  set catch_status [ catch {
    debug_log ${tc_root} 1 "halt tc_root=${tc_root} sct=[sct] driving=[sct driving]"
    ### TODO hset [sct] [hval [sct]]
# halt hook code goes here
    sct driving 0
    return "idle"
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

# function to check the write parameter on a device
proc ::scobj::mercury_valve::noResponse {tc_root} {
  set catch_status [ catch {
    debug_log ${tc_root} 1 "noResponse tc_root=${tc_root} sct=[sct] resp=[sct result]"
# noResponse hook code goes here
    return "idle"
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

# function to parse the read of a parameter on a device
proc ::scobj::mercury_valve::rdValue {tc_root} {
  set catch_status [ catch {
    debug_log ${tc_root} 1 "rdValue tc_root=${tc_root} sct=[sct] result=[sct result]"
    if { [hpropexists [sct] geterror] } {
      hdelprop [sct] geterror
    }
    set data [sct result]
    set nextState "idle"
    if {[string equal -nocase -length 7 ${data} "ASCERR:"]} {
      # the protocol driver has reported an error
      sct geterror "${data}"
      error "[sct geterror]"
    }
# rdValue hook code starts
    scan [lindex [split "$data" ":"] end] "%g" data
# rdValue hook code ends
    if { [hpropexists [sct] geterror] } {
      debug_log ${tc_root} 9 "[sct] error: [sct geterror]"
      error "[sct geterror]"
    }
    if { ${data} != [sct oldval] } {
      debug_log ${tc_root} 1 "[sct] changed to new:${data}, from old:[sct oldval]"
      sct oldval ${data}
      sct update ${data}
      sct utime readtime
    }
    return ${nextState}
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

# function to write a parameter value on a device
proc ::scobj::mercury_valve::setValue {tc_root nextState cmd_str} {
  set catch_status [ catch {
    debug_log ${tc_root} 1 "setValue tc_root=${tc_root} sct=[sct] cmd=${cmd_str}"
    if { [hpropexists [sct] geterror] } {
      hdelprop [sct] geterror
    }
    set par [sct target]
    set cmd "${cmd_str}${par}"
# setValue hook code goes here
    if { [hpropexists [sct] driving] } {
      if { [hpropexists [sct] writestatus] && [sct writestatus] == "start" } {
        sct driving 1
      }
    }
    debug_log ${tc_root} 1 "setValue sct send ${cmd}"
    if {![string equal -nocase -length 10 ${cmd} "@@NOSEND@@"]} {
      sct send "${cmd}"
    }
    return ${nextState}
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

# function to write a parameter value on a device
proc ::scobj::mercury_valve::setValve {tc_root nextState cmd_str} {
  set catch_status [ catch {
    debug_log ${tc_root} 1 "setValve tc_root=${tc_root} sct=[sct] cmd=${cmd_str}"
    if { [hpropexists [sct] geterror] } {
      hdelprop [sct] geterror
    }
    set par [sct target]
    set cmd "${cmd_str}${par}"
# setValve hook code starts
    if { [hpropexists [sct] pid_bias] } {
      set par [expr ${par} + [hgetpropval [sct] pid_bias]]
      set cmd "${cmd_str}${par}"
    }
    sct update [sct target]
# setValve hook code ends
    if { [hpropexists [sct] geterror] } {
      debug_log ${tc_root} 9 "[sct] error: [sct geterror]"
      error "[sct geterror]"
    }
    if { [hpropexists [sct] driving] } {
      if { [hpropexists [sct] writestatus] && [sct writestatus] == "start" } {
        sct driving 1
      }
    }
    debug_log ${tc_root} 1 "setValve sct send ${cmd}"
    if {![string equal -nocase -length 10 ${cmd} "@@NOSEND@@"]} {
      sct send "${cmd}"
    }
    return ${nextState}
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

proc ::scobj::mercury_valve::mkDriver { sct_controller name ip_address tcp_port id valve_tol } {
  ::scobj::mercury_valve::sics_log 9 "::scobj::mercury_valve::mkDriver ${sct_controller} ${name} ${ip_address} ${tcp_port} ${id} ${valve_tol}"
  set ns "[namespace current]"
  set catch_status [ catch {

    MakeSICSObj ${name} SCT_OBJECT

    sicslist setatt ${name} klass environment
    sicslist setatt ${name} long_name ${name}

    set scobj_hpath /sics/${name}

    hfactory ${scobj_hpath}/Valve plain spy none
    hsetprop ${scobj_hpath}/Valve data "true"
    hsetprop ${scobj_hpath}/Valve klass "@none"
    hsetprop ${scobj_hpath}/Valve type "part"

    hfactory ${scobj_hpath}/Valve/sensor plain user float
    hsetprop ${scobj_hpath}/Valve/sensor read ${ns}::getValue ${scobj_hpath} rdValue {READ:DEV:DB4.G1:AUX:SIG:OPEN}
    hsetprop ${scobj_hpath}/Valve/sensor rdValue ${ns}::rdValue ${scobj_hpath}
    hsetprop ${scobj_hpath}/Valve/sensor control true
    hsetprop ${scobj_hpath}/Valve/sensor data true
    hsetprop ${scobj_hpath}/Valve/sensor mutable true
    hsetprop ${scobj_hpath}/Valve/sensor nxsave true
    hsetprop ${scobj_hpath}/Valve/sensor permlink data_set "G[format "%02d" ${id}]S07"
    hsetprop ${scobj_hpath}/Valve/sensor @description "G[format "%02d" ${id}]S07"
    hsetprop ${scobj_hpath}/Valve/sensor oldval 0.0
    hsetprop ${scobj_hpath}/Valve/sensor klass "parameter"
    hsetprop ${scobj_hpath}/Valve/sensor sdsinfo "::nexus::scobj::sdsinfo"
    hsetprop ${scobj_hpath}/Valve/sensor type "part"
    hsetprop ${scobj_hpath}/Valve/sensor nxalias "${name}_Valve_sensor"

    hfactory ${scobj_hpath}/Valve/setpoint plain user float
    hsetprop ${scobj_hpath}/Valve/setpoint write ${ns}::setValve ${scobj_hpath} noResponse {SET:DEV:DB4.G1:AUX:SIG:OPEN:}
    hsetprop ${scobj_hpath}/Valve/setpoint noResponse ${ns}::noResponse ${scobj_hpath}
    hsetprop ${scobj_hpath}/Valve/setpoint check ${ns}::checkrange ${scobj_hpath}
    hsetprop ${scobj_hpath}/Valve/setpoint driving 0
    hsetprop ${scobj_hpath}/Valve/setpoint checklimits ${ns}::checklimits ${scobj_hpath}
    hsetprop ${scobj_hpath}/Valve/setpoint checkstatus ${ns}::checkstatus ${scobj_hpath}
    hsetprop ${scobj_hpath}/Valve/setpoint halt ${ns}::halt ${scobj_hpath}
    hsetprop ${scobj_hpath}/Valve/setpoint driveable Valve/sensor
    hsetprop ${scobj_hpath}/Valve/setpoint control true
    hsetprop ${scobj_hpath}/Valve/setpoint data true
    hsetprop ${scobj_hpath}/Valve/setpoint mutable true
    hsetprop ${scobj_hpath}/Valve/setpoint nxsave true
    hsetprop ${scobj_hpath}/Valve/setpoint lowerlimit 0
    hsetprop ${scobj_hpath}/Valve/setpoint upperlimit 100
    hsetprop ${scobj_hpath}/Valve/setpoint tolerance ${valve_tol}
    hsetprop ${scobj_hpath}/Valve/setpoint permlink data_set "G[format "%02d" ${id}]SP07"
    hsetprop ${scobj_hpath}/Valve/setpoint @description "G[format "%02d" ${id}]SP07"
    hsetprop ${scobj_hpath}/Valve/setpoint oldval 0.0
    hsetprop ${scobj_hpath}/Valve/setpoint klass "parameter"
    hsetprop ${scobj_hpath}/Valve/setpoint sdsinfo "::nexus::scobj::sdsinfo"
    hsetprop ${scobj_hpath}/Valve/setpoint settle_time "30"
    hsetprop ${scobj_hpath}/Valve/setpoint type "drivable"
    hsetprop ${scobj_hpath}/Valve/setpoint nxalias "${name}_Valve_setpoint"

    if {[string equal -nocase [SplitReply [environment_simulation]] "false"]} {
      ${sct_controller} poll ${scobj_hpath}/Valve/sensor 5
      ${sct_controller} write ${scobj_hpath}/Valve/setpoint
    } else {
      ::scobj::mercury_valve::sics_log 9 "[environment_simulation] => No poll/write for mercury_valve"
    }
    hsetprop ${scobj_hpath} klass environment
    hsetprop ${scobj_hpath} data true
    hsetprop ${scobj_hpath} debug_threshold 5
    if {[string equal -nocase [SplitReply [environment_simulation]] "false"]} {
      ansto_makesctdrive ${name}_Valve_setpoint ${scobj_hpath}/Valve/setpoint ${scobj_hpath}/Valve/sensor ${sct_controller}
    }
# mkDriver hook code goes here
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

namespace eval ::scobj::mercury_valve {
  namespace export debug_threshold
  namespace export debug_log
  namespace export sics_log
  namespace export mkDriver
}

proc add_mercury_valve {name ip_address tcp_port {id 99} {valve_tol 2}} {
  set catch_status [ catch {
    ::scobj::mercury_valve::sics_log 9 "add_mercury_valve ${name} ${ip_address} ${tcp_port} ${id} ${valve_tol}"
    if {[string equal -nocase [SplitReply [environment_simulation]] "false"]} {
      if {[string equal -nocase "aqadapter" "${ip_address}"]} {
        ::scobj::mercury_valve::sics_log 9 "makesctcontroller sct_${name} aqadapter ${tcp_port}"
        makesctcontroller sct_${name} aqadapter ${tcp_port}
      } else {
        ::scobj::mercury_valve::sics_log 9 "makesctcontroller sct_${name} std ${ip_address}:${tcp_port}"
        makesctcontroller sct_${name} std ${ip_address}:${tcp_port}
      }
    } else {
      ::scobj::mercury_valve::sics_log 9 "[environment_simulation] => No sctcontroller for mercury_valve"
    }
    ::scobj::mercury_valve::sics_log 1 "::scobj::mercury_valve::mkDriver sct_${name} ${name} ${ip_address} ${tcp_port} ${id} ${valve_tol}"
    ::scobj::mercury_valve::mkDriver sct_${name} ${name} ${ip_address} ${tcp_port} ${id} ${valve_tol}
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

clientput "file evaluation of sct_mercury_valve.tcl"
::scobj::mercury_valve::sics_log 9 "file evaluation of sct_mercury_valve.tcl"

proc ::scobj::mercury_valve::read_config {} {
  set catch_status [ catch {
    set ns "::scobj::mercury_valve"
    dict for {k u} $::config_dict {
      if { [dict exists $u "implementation"] } {
        if { !([dict exists $u "name"] && [dict exists $u "enabled"]) } {
          continue
        }
        set enabled [string tolower [dict get $u "enabled"]]
        if { ! ([string equal -nocase $enabled "true" ] || [string equal -nocase $enabled "always"]) } {
          continue
        }
        set name [dict get $u name]
        set implementation [dict get $u "implementation"]
        if { !([dict exists $::config_dict $implementation]) } {
          continue
        }
        set v [dict get $::config_dict $implementation]
        if { !([dict exists $v "driver"]) } {
          continue
        }
        if { [string equal -nocase [dict get $v "driver"] "mercury_valve"] } {
          if { ![string equal -nocase [SplitReply [environment_simulation]] "false"] } {
            set asyncqueue "null"
            ${ns}::sics_log 9 "[environment_simulation] => using null asyncqueue"
          } elseif { [dict exists $v "asyncqueue"] } {
            set asyncqueue [dict get $v "asyncqueue"]
            if { [string equal -nocase ${asyncqueue} "sct"] } {
              set ip_address [dict get $v ip]
              set tcp_port [dict get $v port]
              }
          } else {
            if { [dict exists $v "asyncprotocol"] } {
              set asyncprotocol [dict get $v "asyncprotocol"]
            } else {
              set asyncprotocol ${name}_protocol
              MakeAsyncProtocol ${asyncprotocol}
              if { [dict exists $v "terminator"] } {
                ${asyncprotocol} sendterminator "[dict get $v "terminator"]"
                ${asyncprotocol} replyterminator "[dict get $v "terminator"]"
              }
            }
            set asyncqueue ${name}_queue
            set ip_address [dict get $v ip]
            set tcp_port [dict get $v port]
            MakeAsyncQueue ${asyncqueue} ${asyncprotocol} ${ip_address} ${tcp_port}
            if { [dict exists $v "timeout"] } {
              ${asyncqueue} timeout "[dict get $v "timeout"]"
            }
          }
          set arg_list [list]
          set missing_list [list]
          foreach arg {id valve_tol} {
            if {[dict exists $u $arg]} {
              lappend arg_list "[dict get $u $arg]"
            } elseif {[dict exists $v $arg]} {
              lappend arg_list "[dict get $v $arg]"
            } else {
              ${ns}::sics_log 9 "Missing configuration value $arg"
              lappend missing_list $arg
            }
          }
          if { [llength $missing_list] > 0 } {
              error "$name is missing configuration values $missing_list"
          }
          if { [string equal -nocase ${asyncqueue} "sct"] } {
            add_mercury_valve ${name} ${ip_address} ${tcp_port} {*}$arg_list
          } else {
            add_mercury_valve ${name} "aqadapter" ${asyncqueue} {*}$arg_list
          }
        }
      }
    }
  } catch_message ]
  handle_exception ${catch_status} ${catch_message}
}

if { [info exists ::config_dict] } {
  ::scobj::mercury_valve::read_config
} else {
  ::scobj::mercury_valve::sics_log 5 "No config dict"
}