########################################################################
### FILE:	tbcalgorithmregisters.mod
### PURPOSE:	Initializes algorithm-specific registers for each zone
### AUTHOR:	Tor Slettnes <tor@slett.net>
###
### Copyrights (C) 2006 Applied Biosystems.  All rights reserved.
########################################################################

DEFINT TBCZoneAlgorithmTable $Branch$ <multiline>
    $Branch$:VAR ControlZones  0

    REPeat -counter=n -start=1 $($Branch$:ZoneCount?) <multiline>
        TBCZoneAlgorithmBuildTable $Branch$ Zone${n}
    </multiline>

    $Branch$:DEFine   TYPe? 'RETurn ${ControlZones}zone'
    $Branch$:DESCribe TYPe? 'Return the block type associated with this thermal block controller branch'

    $Branch$:DEFine   ControlZones? 'RETurn ${ControlZones}'
    $Branch$:DESCribe ControlZones? 'Return the number of control zones in this block'
</multiline>


DEFINT TBCZoneAlgorithmBuildTable $Branch$ $Zone$ <multiline>
    LVAR AlgoID $($Branch$:$Zone$:AlgorithmID?)
    LVAR Spec   $(TBCZoneAlgorithm${AlgoID}Table $Branch$ $Zone$)
    XARGS "$Branch$:ZONe+ ${Spec} $Zone$:CONTrol $Zone$:SetPoint $Zone$:RampRate"
</multiline>



########################################################################
### Algorithm ID 1: Multizone Block Controller

DEFINT TBCZoneAlgorithm1Table $Branch$ $Zone$ <multiline>
  $Branch$:$Zone$:LOADDEF tbcregisters Algorithm1Table -offset=18

  $Branch$:REGisterGroup+ -append SetPoints?          $Zone$:SetPoint?
  $Branch$:REGisterGroup+ -append RampRates?          $Zone$:RampRate?
  $Branch$:REGisterGroup+ -append SampleTemperatures? $Zone$:SampleTemperature?
  $Branch$:ADDValue ControlZones 1

  $Branch$:$Zone$:SetPoint ${BlockIdleSetting:-25.0}
  $Branch$:$Zone$:CONTrol  1

  RETurn $Zone$
</multiline>



########################################################################
### Algorithm ID 2: Isothermal Block Controller
###                 Alias for multizone block controller

ALIas -hidden TBCZoneAlgorithm2Table TBCZoneAlgorithm1Table



########################################################################
### Algorithm ID 3: Fan Controller

DEFINT TBCZoneAlgorithm3Table $Branch$ $Zone$ <multiline>
   $Branch$:$Zone$:LOADDEF tbcregisters Algorithm3Table -offset=18
   $Branch$:$Zone$:CONTrol 1
   RETurn Fan
</multiline>


########################################################################
### Algorithm ID 4: Cover Controller

DEFINT TBCZoneAlgorithm4Table $Branch$ $Zone$ <multiline>
   $Branch$:$Zone$:LOADDEF tbcregisters Algorithm4Table -offset=18

   ### Define alias to configure idle setpoint
   ALIas+ -replaceExisting -hidden CoverIdleSetPoint $Branch$:NVRAM 0x0007 REAL

   RETurn Cover
</multiline>

########################################################################
### Algorithm ID 5: Edge Heater Controller

DEFINT TBCZoneAlgorithm5Table $Branch$ $Zone$ <multiline>
   $Branch$:$Zone$:LOADDEF tbcregisters Algorithm5Table -offset=18
    RETurn EdgeHeater$Zone$ -follow=Zone1
</multiline>

########################################################################
### Algorithm ID 6: TNU Controller

DEFINT TBCZoneAlgorithm6Table $Branch$ $Zone$ <multiline>
    RETurn TNUController
</multiline>