##
## Reference schedule configuration file with explanations
##


## -------------------------------
##
## Global configuration parameters
##
## -------------------------------

##
## Name and description of particular brew. 
##
Name "Reference Configuration File"
Desc "	An example configuration file for reference."

##
## Assign names to sensors for later identification and log file
## output.
##
Sensor 2 Wort
Sensor 4 Ambient
Sensor 1 Computer_On_Fire  

##
## Absolute path to log file.
##
LogFile "/home/paul/BrewMeister/brew.log"

##
## Relay output to turn heating device and cooling
## device on.  
##
HeatBitMap 128  # Bitmap to turn heat on
CoolBitMap 64   # Bitmap to turn cold on

##
## Absolute path name to script that should be executed after
## each stage transition.  No arguments will be passed to it,
## so it should expect none.  Any information it needs can 
## be obtained through a call to BAdmin
##
TransitionScript "/home/paul/BrewMeister/transitionNotify.sh"

## ---------------------------
## 
## List of fermentation stages
##
## ---------------------------

##
## Stages are automatically numbered, starting with 0,
## in the order that they appear in the schedule file.
##

##
## Stage 0
##
## Holds single target temperature for finite duration
## based on readings from one sensor.
##
Stage {
	## Name and description of stage
	Name "First Stage (0)"
	Desc "	Holds single target temperature for finite duration
		based on readings from one sensor."

	## Duration of the stage.  
	## Units : w - weeks
	##         d - days
	##         h - hours
	##         min - minutes
	Duration 1d

	## Target temperature 
	Temp 70

	## Sensor to hold at target temperature
	Control Ambient
}

##
## Stage 1
##
## Interpolated target temperature over finite duration
## based on readings from two sensors.
##
Stage {
	Name "Second Stage (1)"
	Desc "	Interpolated target temperature over finite duration
		based on readings from two sensors."

	Duration 5h

	## Target temperature for stage changes linearly from
	## StartTemp to EndTemp over the course of the stage.
	StartTemp 70
	EndTemp 65

	## The Projected temperature sensor measures something
	## that heats or cools what is being controlled.
	## Here, the air around the fermenter heats/cools the 
	## fermenter itself, and can be used to make better decisions about
	## control of the heating/cooling devices.
	Control Wort
	Projected Ambient
}

##
## Stage 2
##
## Holds single target temperature for indefinite duration
## based on readings from two sensors.
## 
Stage {
	Name "Third Stage (2)"
	Desc "	Holds single target temperature for indefinite duration
		based on readings from two sensors."

	## If Duration is Indef, then the stage lasts until
	## user intervention from the BAdmin utility.  
	##
	## Interpolated temperatures over indefinite 
	## duration are illegal for obvious reasons.
	##
	Duration Indef
	Temp 65

	Control Wort
	Projected Ambient
}