' put_met.cri
' adapted from kcirving program das2-12sep2012.cri, modified by Joel Bailey  7/8/2015
' constants for base logger-diagnostics precip-te525m rh-pwr-on air-hp45c wind-rmyoung air-109 barometer-cs106 rh-pwr-off netrad-nrlite snow-sr50a time-variables relay-control-sub thermistors call-met-tables
' 7/29/2015 - Joel Bailey - Changed on/off time of modem to once an hour instead of every 30 mins
' 7/31/2015 - Joel Bailey - Added 2 second delay on CP8 for PB measurement, changed Steinhart Constants for ATB, added RadRaw readings
' 4/20/2017 -Emily Youcha -  Fixed 8 record limit on Met table. 
'r/20/2017 - Emily Youcha - Added a wiring diagram in comments
'4/20/2017 - Emily Youcha - added Rad Table, NR01 Contants, NR01 Variables and Units
'4/20/2017 - EKY to do: I want to move ATB to multiplexor
'4/20/2017 EKY to do: put multiplexor in 2/32 mode? to accomodate half bridge + volt diff measurements for NR01?
'4/20/2017 EKY to do: need to remove eppleys from program, add NR01.
'5/8/2017 Joel Bailey removed old Epply and adapted NR01 measurements
'5/15/2017 EKY added sensitivities and constants for NR01 for s/n 1809
' 5/17/2017 EKY changed multiplexor scan rate to 60 s
' 6/7/2017 EKY changed multiplier from 1000 to 1 in line 497 (Voltdiff for radiometers) because it is already in the const
' 6/8/2017 EKY changed equations SR01Up=SR01up/SR01Upcal to SR01Up=SR01up*SR01Upcal 

'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
'''  LOGGER WIRING   ''''''''''''''''''''''''''''''''''''''
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

' SE1  -- AT
' SE2  -- RH
' SE3  -- NR Lite
' SE4  -- NR Lite
' SE5  -- ATB
' SE6  --
' SE7  --
' SE8  -- WD
' SE9  -- AM16/32B #1 Com ODD HI
' SE10 -- AM16/32B #1 Com ODD Lo  Jumper to AG
' AG   -- Connected to SE10
' SE11 -- 4WPB100 H
' SE12 -- 4WPB100 L    
' AGND -- 4WPB100 AG
' SE13 -- NR01 Cable 2 - White Wire
' SE14 -- NR01 Cable 2 - Green Wire
' SE15 -- Barometric Pressure
' SE16 --

' VX1 -- WD
' VX2 -- 4WPB100 Wire top wire
' VX3 -- 

' P1 -- WS
' P2 -- Precip

' C1 -- AM16/32B #1  -- RES
' C2 -- AM16/32B #1 -- CLK
' C3 --
' C4 --
' C5 -- SR50
' C6 --
' C7 --
' C8 -- Barometric Pressure
' SW12V -- Radio Power

' Module connected to SE11 and SE12
' 4WPB100 - L Connector - NR01 - Red Wire Cable 2
' 4WPB100 - G Connector - Blue Wire Cable 2 

' AM16/32B #1 in 2/32 Mode
' RES - CR1000 C1
' CLK - CR1000 C2
' 12V  - CR1000 12V
' G    - CR1000 G
' COM ODD HI - CR1000 SE9,  Precision Resistor to CR1000 VX2
' COM ODD LO - CR1000 SE10,  Precision Resistor to CR1000 VX2
' Com EVEN HI - 
' Com EVEN LO - 
' AM16/32B 1H - NR01 Cable 1 Red Wire
' AM16/32B 1L - NR01 Cable 1 Blue Wire
' AM16/32B 2H - NR01 Cable 1 White Wire
' AM16/32B 2L - NR01 Cable 1 Green Wire
' AM16/32B 3H - NR01 Cable 1 Brown Wire
' AM16/32B 3L - NR01 Cable 1 Yellow Wire
' AM16/32B 4H - NR01 Cable 1 Purple  Wire
' AM16/32B 4L - NR01 Cable 1 Grey Wire


'Define Constants
Const NR_WS_CORR = 0.021286

'' Steinhart & Hart constants
Const kA = 0.0014654354
Const kB = 0.0002386780
Const kC = 0.0000001000

's/n 1809 for Put Met on May 15, 2017
'Sr01 down: 13.60x10-6
'Sr01 up: 12.46x10-6
'IR01 down: 11.48x10-6
'IR01 up: 11.24x10-6

'Added NR01 Constants
'Update with actual sensitivities --- Get from notes/instrument.
'Calibration sheet, sensor sensitivity uV/W/m^2
'Pyranometer Up SR01 13.60
'Pyranometer Down SR01 12.46
'Pyrgeometer Up IR01 11.48
'Pyrgeometer Down IR01 11.24
'Define Constants
'(1000/Sensitivity)  Update below when we get actual correct sensitivites

ConstTable
  '(put in actual sensitity multiply by 1000 in the instruction)
  Const SR01Upcal = 80.257
  Const SR01Downcal = 73.529
  Const IR01Upcal= 87.108
  Const IR01Downcal= 88.968
  Const PAKBUS_INFO = 180
  Const P_MODL = "TE525MM"
  Const P_TIP = 0.1
  Const P_UNITS = "mm"
  Const P__PP = 2
  Const RH_RELAY__CP = 4
  Const RH_MODL = "HP45C"
  Const RH_SN = ""
  Const RH_MULT = 0.1
  Const RH_OFS = 0
  Const AT_MULT = 0.1
  Const AT_OFS = -40
  Const AT__SE = 1
  Const RH__SE = 2
  Const WS_MODL = "RMY 05103"
  Const WS_UNITS = "m/s"
  Const WS_MULT = 0.098
  Const WD_UNITS = "deg"
  Const WD_OFS = 0
  Const WD_MULT = 355
  Const WS__PP = 1
  Const WD__SE = 8
  Const WD__EX = Vx1
  Const ATB_MODL = "ATB_GW_SCI"
  Const ATB_SN = ""
  Const ATB_MULT = 1
  Const ATB_OFS = 0
  Const ATB__SE = 5
  Const ATB__EX = Vx3
  Const PB_MODL = "CS106"
  Const PB_SN = " "
  Const PB_UNITS = "mBar"
  Const PB_MULT = 0.24
  Const PB_OFS = 600
  Const PB__SE = 15
  Const PB__CP = 8
  Const NR_MODL = "NR-LITE"
  Const NR_SN = "114128"
  Const NR_CALIB = 11.9
  Const NR_CALIB_UNITS = "uV/W/m^2"
  Const NR_UNITS = "W/m^2"
  Const NR__DIFF = 2
  Const RAD__DIFF = 5
  Const RAD_TEMP__DIFF = 6
  Const RAD_TEMP__EX = VX2
  Const SNW_MODL = "SR50A"
  Const SNW_SN = "4415"
  Const SNW_HT_CM = 152
  Const SNW_SDI_ADDR = 0
  Const SDI12__CP = 5
  Const MODM_PWR__CP = 9
  Const MODM_MODL = "9522B"
  Const MODM_SN = ""
  Const MODM_ON_MIN = 0
  Const MODM_OFF_MIN = 10
  Const MODM_PERIOD = 60
  Const MODM_V_LIM = 12.4
  Const MODM_HOLD_V_LIM = 12.6
  Const THERMISTOR_TYPE = "PS302J2"
  Const THERMISTOR_QTY = 1
  Const R_REF_OHMS = 1000
  Const MUX_RESET__CP = 1
  Const MUX_CLOCK__CP = 2
  Const NO_OF_EPPLEY = 4
EndConstTable

' base:
Public progSig As Long

' logger-diagnostics:
Public battery, PanelT
Units PanelT = degC
Units battery = Volts

' precip-te525m:
Public precip
Units precip = P_UNITS

' air-hc2s3:
Public at, rh, dp
Units at = degC
Units dp = degC
Units rh = percent

' wind-rmyoung:
Public ws, wd
Alias ws = windSpeed
Units ws = WS_UNITS
Alias wd = windDir
Units wd = WD_UNITS

' air-109:
Public atb
Units atb = degC

' barometer-cs106:
Public pb
Units pb = mbar

' netrad-nrlite:
Public nr(2)
Alias nr = netRad_raw,netRad
Units nr() = NR_UNITS

'NR01 Huksflux Variables and units
Public NR01(4) 
Public NR01TC
Alias NR01(1) = SR01Up
Alias NR01(2) = SR01Dn
Alias NR01(3) = IR01Up
Alias NR01(4) = IR01Dn
Public NR01TC_C
Public NR01TK
Public NetRs
Public NetRl
Public Albedo
Public UpTot
Public DnTot
Public NetTot_NR01
Public IR01UpCo
Public IR01DnCo
Units NR01TC=DegC
Units SR01Up=W/m^2
Units SR01Dn=W/m^2
Units IR01Up=W/m^2
Units IR01Dn=W/m^2
Units NR01TK=degK
Units NetRs=W/m^2
Units NetRl=W/m^2
Units Albedo=W/m^2
Units UpTot=W/m^2
Units DnTot=W/m^2
Units NetTot_NR01=W/m^2
Units IR01UpCo=W/m^2
Units IR01DnCo=W/m^2

' snow-sr50a:
Public sr50_raw(2), sr50_down, snowdepth, sr50_height
Alias sr50_raw(2) = sr50_quality

' time-variables:
Dim Time(9)
Alias Time(4) = thisHour
Alias Time(5) = thisMinute
Alias Time(9) = thisDOY

' modem:
Public modemOnMin, modemOffMin, modemPeriod, modemVlim, modemHldVlim
Public modemHold As Boolean, modemForce As Boolean

' thermistors:
Public therm_R
Dim therm_X
Units therm_R = Ohms

' Daily: base precip-te525m air-hc2s3 wind-rmyoung air-109 netrad-nrlite snow-sr50a
DataTable(Daily,1,-1)
  DataInterval(0,1440,Min,0)
  Sample(1,progSig,uint2)
  Totalize(1,precip,fp2,0)
  Average(1,at,fp2,0)
  WindVector(1,windSpeed,windDir,fp2,0,0,0,0)
  Average(1,atb,fp2,0)
  Average(1,netRad,fp2,0)
  Average(1,snowdepth,fp2,0)
EndTable

' HrlyAtms: base precip-te525m air-hc2s3 wind-rmyoung air-109 barometer-cs106 netrad-nrlite snow-sr50a
DataTable(HrlyAtms,1,-1)
  DataInterval(0,60,Min,0)
  Sample(1,progSig,uint2)
  Totalize(1,precip,fp2,0)
  Sample(1,at,fp2)
  Average(1,at,fp2,0)
  Minimum(1,at,fp2,0,0)
  Maximum(1,at,fp2,0,0)
  Sample(1,rh,fp2)
  Minimum(1,rh,fp2,0,0)
  Maximum(1,rh,fp2,0,0)
  Sample(1,dp,fp2)
  Average(1,dp,fp2,0)
  Minimum(1,dp,fp2,0,0)
  Maximum(1,dp,fp2,0,0)
  Sample(1,windSpeed,fp2)
  Sample(1,windDir,fp2)
  WindVector(1,windSpeed,windDir,fp2,0,0,0,0)
  Maximum(1,windSpeed,fp2,0,0)
  Sample(1,atb,fp2)
  Average(1,atb,fp2,0)
  Minimum(1,atb,fp2,0,0)
  Maximum(1,atb,fp2,0,0)
  Sample(1,pb,fp2)
  Average(1,pb,fp2,0)
  Average(1,netRad,fp2,0)
  Average(1,snowdepth,fp2,0)
EndTable

' HrlyDiag: base logger-diagnostics
DataTable(HrlyDiag,1,-1)
  DataInterval(0,60,Min,0)
  Sample(1,progSig,uint2)
  Average(1,battery,fp2,0)
  Average(1,PanelT,fp2,0)
EndTable

' Met: base precip-te525m air-hc2s3 wind-rmyoung air-109 barometer-cs106 netrad-nrlite snow-sr50a
DataTable(Met,1,-1)
  DataInterval(0,60,Min,0)
  Sample(1,progSig,uint2)
  Totalize(1,precip,fp2,0)
  Average(1,at,fp2,0)
  Sample(1,rh,fp2)
  WindVector(1,windSpeed,windDir,fp2,0,0,0,0)
  Average(1,atb,fp2,0)
  Average(1,pb,fp2,0)
  Average(1,netRad,fp2,0)
  Average(1,snowdepth,fp2,0)
EndTable

' SR50: base air-hc2s3 snow-sr50a
DataTable(SR50,1,-1)
  DataInterval(0,60,Min,0)
  Sample(1,progSig,uint2)
  Average(1,at,fp2,0)
  Average(1,snowdepth,fp2,0)
  Sample(1,sr50_height,fp2)
  Average(1,sr50_quality,fp2,0)
EndTable

' NR01 Radiometer
DataTable(radNR01,True,-1)
  DataInterval(0,60,Min,10)
  Sample(1,progSig,uint2)
  Average(1,SR01Up,FP2,False)
  Average(1,SR01Dn,FP2,False)
  Average(1,IR01Up,FP2,False)
  Average(1,IR01Dn,FP2,False)
  Average(1,NR01TC,FP2,False)
  Average(1,NR01TK,FP2,False)
  Average(1,NetRs,FP2,False)
  Average(1,NetRl,FP2,False)
  Average(1,Albedo,FP2,False)
  Average(1,UpTot,FP2,False)
  Average(1,DnTot,FP2,False)
  Average(1,NetTot_NR01,FP2,False)
  Average(1,IR01UpCo,FP2,False)
  Average(1,IR01DnCo,FP2,False)
EndTable

' relay-control-sub:relayControl()
Sub relayControl(relayPort,onMin,offMin,period,Vlimit,holdVlimit,hold,force)
  ' uses globals thisMinute, battery
  If force Then Call setRelayState(relayPort,1)
  If thisMinute MOD period = onMin AND battery >= Vlimit Then Call setRelayState(relayPort,1)
  If thisMinute MOD period = onMin AND battery < holdVlimit Then hold = 0
  If thisMinute MOD period = offMin AND NOT hold Then Call setRelayState(relayPort,0)
EndSub

' relay-control-sub:setPortState()
Sub setRelayState(relay,state As Boolean)
  ' portSet() does not allow variable for port, so brute force it:
  If relay = 9 Then
    PortSet(9,state)
  Else If relay = 8 Then
    PortSet(8,state)
  Else If relay = 7 Then
    PortSet(7,state)
  Else If relay = 6 Then
    PortSet(6,state)
  Else If relay = 5 Then
    PortSet(5,state)
  Else If relay = 4 Then
    PortSet(4,state)
  Else If relay = 3 Then
    PortSet(3,state)
  Else If relay = 2 Then
    PortSet(2,state)
  Else If relay = 1 Then
    PortSet(1,state)
  EndIf
EndSub


' thermistors:calc_thermistors()
Sub calc_thermistors()
  Dim lnR
  '' calculate thermistor resistance from ratio and ref R:
  therm_R = R_REF_OHMS * therm_X / (1-therm_X)
  '' calculate natural log of thermistor resistance:
  lnR = LN(therm_R)
  '' use Steinhart & Hart equation to derive temperature:
  atb = (1/(kA + kB*lnR + kC*lnR^3)) - 273.15
EndSub
BeginProg

  ' for base:
  progSig = status.ProgSignature

  ' for snow-sr50a:
  sr50_height = SNW_HT_CM

  ' for modem:
  modemOnMin = (MODM_ON_MIN + MODM_PERIOD) MOD MODM_PERIOD
  modemOffMin = (MODM_OFF_MIN + MODM_PERIOD) MOD MODM_PERIOD
  modemPeriod = MODM_PERIOD
  modemVlim = MODM_V_LIM
  modemHldVlim = MODM_HOLD_V_LIM

  Scan(60,sec,0,0)
    ' logger-diagnostics:
    PanelTemp(PanelT,250)
    battery(battery)

    ' precip-te525m:
    PulseCount(precip,1,P__PP,2,0,P_TIP,0)

    ' rh-pwr-on:
    PortSet(RH_RELAY__CP,1)
    Delay(0,2000,mSec)

    ' air-hc2s3:
    VoltSe(at,1,mV2500,AT__SE,1,0,250,AT_MULT,AT_OFS)
    VoltSe(rh,1,mV2500,RH__SE,1,0,250,RH_MULT,RH_OFS)
    DewPoint(dp,at,rh)

    ' wind-rmyoung:
    PulseCount(ws,1,WS__PP,1,1,WS_MULT,0)
    BrHalf(wd,1,mV2500,WD__SE,WD__EX,1,2500,1,0,250,WD_MULT,WD_OFS)

    ' air-109:
    'Therm109(atb,1,ATB__SE,ATB__EX,0,250,ATB_MULT,ATB_OFS)
    BrHalf (therm_X,1,mV2500,ATB__SE,ATB__EX,1,2500,True,0,250,ATB_MULT,ATB_OFS)

    'run subroutine to calculate degrees for each thermistor
    calc_thermistors()

    ' barometer-cs106: allow 2 secs for warm up
    PortSet(PB__CP,1)
    Delay (0,2,Sec)
    VoltSe(pb,1,mV2500,PB__SE,1,0,250,PB_MULT,PB_OFS)
    PortSet(PB__CP,0)

    ' rh-pwr-off:
    PortSet(RH_RELAY__CP,0)

    ' netrad-nrlite:
    VoltDiff(nr,1,mv25,NR__DIFF,True,0,250,1000/NR_CALIB,0)
    netRad = netRad_raw
    If windSpeed > 5 Then netRad = netRad_raw * (1 + NR_WS_CORR * (windSpeed-5))

    ' snow-sr50a:
    '' read SR50A snow depth sensor:
    ''    read distance in m (positive) and quality number into sr50_raw()
    ''    make distance down negative, convert to cm
    ''    apply correction for speed of sound as f(temperature, 0C)
    ''    calculate snow depth as sum of sensor height and distance down
    ''
    SDI12Recorder(sr50_raw, SDI12__CP, SNW_SDI_ADDR, "M1!", 1, 0)
    sr50_raw = sr50_raw * -100.0
    sr50_down = sr50_raw * SQR((at+273.15) / 273.15)
    snowdepth = sr50_height + sr50_down

    ' time-variables:
    RealTime(Time())

    ' modem:
    relayControl(MODM_PWR__CP,modemOnMin,modemOffMin,modemPeriod,modemVlim,modemHldVlim,modemHold,modemForce)

    ' call-met-tables:
    CallTable Daily
    CallTable HrlyAtms
    CallTable HrlyDiag
    CallTable SR50
    CallTable Met
  NextScan

  SlowSequence
  Scan(60,sec,0,0)
    'Turn AM16/32 Multiplexer On
    PortSet(MUX_RESET__CP,1)
    Dim i
    i=1
    SubScan(0,uSec,4)
      'Switch to next AM16/32 Multiplexer channel
      PulsePort(MUX_CLOCK__CP,10000)
      VoltDiff(NR01(i),1,AutoRange,RAD__DIFF,True,0,250,1,0)
      i=i+1
      Delay(0,150,mSec)
    NextSubScan
    'Turn AM16/32 Multiplexer Off
    PortSet(MUX_RESET__CP,0)
    
    BrHalf4W(NR01TC,1,mV25,mV25,RAD_TEMP__DIFF,RAD_TEMP__EX,1,2100,True,True,0,250,1,0)
    PRT(NR01TC_C,1,NR01TC,1,0)
    SR01Up = SR01Up*SR01Upcal
    SR01Dn = SR01Dn*SR01Downcal
    IR01Up = IR01Up*IR01Upcal 
    IR01Dn = IR01Dn*IR01Downcal
    
    'Calculate radiation products
    NR01TK=NR01TC_C+273.15
    NetRs=SR01Up-SR01Dn
    NetRl=IR01Up-IR01Dn
    Albedo=SR01Dn/SR01Up
    UpTot=SR01Up+IR01Up
    DnTot=SR01Dn+IR01Dn
    NetTot_NR01=UpTot-DnTot
    IR01UpCo=IR01Up+5.67*10^-8*NR01TK^4
    IR01DnCo=IR01Dn+5.67*10^-8*NR01TK^4

    'call rad tables
    CallTable Daily
    CallTable HrlyAtms
    CallTable Met
    CallTable radNR01
  NextScan
EndProg