// user.h

//---------

// This file contains user definable compiler directives for aArtisanQ_PID



// *************************************************************************************

// NOTE TO USERS: the following parameters should be

// be reviewed to suit your preferences and hardware setup.  

// First, load and edit this sketch in the Arduino IDE.

// Next compile the sketch and upload it to the Arduino.



#ifndef USER_H

#define USER_H



////////////////////

// Roasting software

// Comment out all if using TC4 stand alone

//#define ROASTLOGGER

#define ARTISAN

//#define ANDROID



////////////////////

// Base configurations (leave only one uncommented)

What is different between CONFIG_PWM and CONFIG_PAC3? I want to connect the SSR or the heater on OT1. Is CONFIG_PAC3 the right one?

//#define CONFIG_PWM // slow PWM on OT1 (heater); fast PWM output (3.922kHz) on IO3 (DC fan); ZCD not required

//#define CONFIG_PAC2 // phase angle control on OT1 (heater) and OT2 (fan); IO2 used to read the ZCD; IO3 undefined

//#define CONFIG_PAC2_IO3HTR // phase angle control on OT1 (heater) and OT2 (fan); IO2 reads the req'd ZCD; IO3 reserved for fast PWM output for heater

#define CONFIG_PAC3 // phase angle control on OT1 (heater) and OT2 (fan); IO3 reads the req'd ZCD; IO3 not available for output

// end of base configurations

/////////////////////////////



////////////////////

// Temperature Unit

#define CELSIUS // controls only the initial conditions.  Comment out for F.



////////////////////

// LCD Options

// Comment out non required features

//#define LCD // if output on an LCD screen is desired

//#define LCDAPTER // if the I2C LCDapter board is to be used

//#define LCD_4x20 // if using a 4x20 LCD instead of a 2x16



// AC Power Options

I have 50Hz. Is it relevant for me?

// Needed for PHASE_ANGLE_CONTROL option

//#define FREQ60 // 60Hz

#define FREQ50 // 50Hz



////////////////////

// Thermocouple Input Options

I have at the moment 2 thermocouples on TC1 and TC2. Does it makes sense to comment the TC3 and 4 out?

// TC type is selectable by input channel

// permissable options:  typeT, typeK, typeJ

#define TC_TYPE1 typeK  // thermocouple on TC1

#define TC_TYPE2 typeK  // thermocouple on TC2

#define TC_TYPE3 typeK  // thermocouple on TC3

#define TC_TYPE4 typeK  // thermocouple on TC4



////////////////////

// BAUD Rate for serial communication

//#define BAUD 19200 // useful for BT links

#define BAUD 115200  // default



////////////////////

// Analogue inputs (optional)

// Comment out if not required

//#define ANALOGUE1 // if potentiometer connected on ANLG1

//#define ANALOGUE2 // if potentiometer connected on ANLG2



////////////////////

// Duty Cycle Adjustment Increment

// Used for rounding/increment for analogue inputs and power UP/DOWN commands

#define DUTY_STEP 1 // Use 1, 2, 4, 5, or 10.



////////////////////

// Physical input channel for RoR display on LCD

Do I have to comment it out if I do not have a LCD?

// Corresponds to Thermocouple inputs T1-T4

#define ROR_CHAN 1



////////////////////

// PID Control Options

I want to control with artisan roastoscope and not with standalone PID. What do i have to set here? 

#define PID_CONTROL

#define PID_CHAN 2 // physical channel for PID input (corresponding to thermocouple inputs T1-T4) 

#define CT 1000 // default cycle time for the PID, in ms

#define PRO 5.00 // initial proportional parameter

#define INT 0.15 // initial integral parameter

#define DER 0.00 // initial derivative parameter



#define NUM_PROFILES 2 // number of profiles stored in EEPROM



////////////////////

// Heater and Fan Limits/Options

What do I have to set here? In the first step I will not control the FAN.

#define MIN_OT1 0 // Set output % for lower limit for OT1.  0% power will always be available

#define MAX_OT1 100 // Set output % for upper limit for OT1



#define MIN_OT2 0 // Set output % for lower limit for OT2.  0% power will always be available

#define MAX_OT2 100 // Set output % for upper limit for OT2



#define MIN_IO3 0 // Set output % for lower limit for IO3.  0% power will always be available

#define MAX_IO3 100  // Set output % for upper limit for IO3



// cut power to Heater if fan duty is less than HTR_CUTOFF_FAN_VAL (to protect heater in air roaster). Set to 0 for no cutoff

#define HTR_CUTOFF_FAN_VAL 0 // default

// #define HTR_CUTOFF_FAN_VAL 10  //optional value



#define FAN_AUTO_COOL 13 // Set fan output duty for auto cool when using PID;STOP command



////////////////////

// Command Echo

//#define COMMAND_ECHO // Echo all serial commands to LCD for debugging



////////////////////

// Temperature Reading Filters

I will let it on default.

#define BT_FILTER 10 // filtering level (percent) for BT

#define ET_FILTER 10 // filtering level (percent) for ET

#define AMB_FILTER 70 // 70% filtering on ambient sensor readings



// use RISE_FILTER to adjust the sensitivity of the RoR calculation

// higher values will give a smoother RoR trace, but will also create more

// lag in the RoR value.  A good starting point is 80%, but for air poppers

// or other roasters where BT might be jumpy, then a higher value of RISE_FILTER

// will be needed.  Theoretical max. is 99%, but watch out for the lag when

// you get above 95%.

#define RISE_FILTER 85 // heavy filtering on non-displayed BT for RoR calculations

#define ROR_FILTER 80 // post-filtering for the computed RoR values



// Thermocouple inputs

#define NC 4 // maximum number of physical channels on the TC4



////////////////////

// Calibration Values

Is there a documentation about the calibration? Do I need ist?

// default values for systems without calibration values stored in EEPROM

#define CAL_GAIN 1.00 // you may substitute a known gain adjustment from calibration

#define UV_OFFSET 0 // you may subsitute a known value for uV offset in ADC

#define AMB_OFFSET 0.0 // you may substitute a known value for amb temp offset (Celsius)



////////////////////

// Time Base for slow PWM on OT1, OT2

What should I set here? 

// When NOT using PHASE_ANGLE_CONTROL option

// choose one of the following for the PWM time base for heater output on OT1 or OT2

//#define TIME_BASE pwmN4sec  // recommended for Hottop D which has mechanical relay

//#define TIME_BASE pwmN2sec

#define TIME_BASE pwmN1Hz  // recommended for most electric heaters controlled by standard SSR

//#define TIME_BASE pwmN2Hz

//#define TIME_BASE pwmN4Hz

//#define TIME_BASE pwmN8Hz 

//#define TIME_BASE 15 // should result in around 977 Hz (TODO these need testing)

//#define TIME_BASE 7 // approx. 1.95kHz

//#define TIME_BASE 6 // approx. 2.2kHz

//#define TIME_BASE 3 // approx. 3.9kHz



////////////////////

// Debuging Options

// Useful for debugging only -- leave inactive otherwise

//#define MEMORY_CHK



// This turns on the "# xxxxxxx\n" acknowledgements after commands

//#define ACKS_ON



////////////////////

What should I set here? 

// Output Pin Setup

Do I have to set something here?

// phase angle control and integral cycle control outputs

#define OT1 9 // OT1 is on pin D9

#define OT2 10 // OT2 is on pin D10

#define OT_PAC OT2 // phase angle control on OT2 (AC fan, usually)

#define OT_ICC OT1 // integral cycle control on OT1 (AC heater, usually)

#define LED_PIN 13



//////////////////////////////////////////////////////

// Set up parameters for the base configurations

Ok, here I do not understand anything. What should I set here? 

#ifdef CONFIG_PWM // nothing special to configure -- this is the default

#endif



#ifdef CONFIG_PAC2_IO3HTR

  #define PHASE_ANGLE_CONTROL // phase angle control for OT2(fan) and ICC control for OT1(heater)

  #define IO3_HTR_PAC // use PWM (3.922kHz) out on IO3 for heater in PHASE ANGLE CONTROL mode

  // zero cross detector (ZCD) connected to I/O2

  #define EXT_INT 0 // interrupt 0

  #define INT_PIN 2 // pin 2

#endif



#ifdef CONFIG_PAC2

  #define PHASE_ANGLE_CONTROL // phase angle control for OT2(fan) and ICC control for OT1(heater)

  // zero cross detector (ZCD) connected to I/O2

  #define EXT_INT 0 // interrupt 0

  #define INT_PIN 2 // pin 2

#endif



#ifdef CONFIG_PAC3

  #define PHASE_ANGLE_CONTROL // phase angle control for OT2(fan) and ICC control for OT1(heater)

  // zero cross detector (ZCD) connected to I/O3

  #define EXT_INT 1 // interrupt 1

  #define INT_PIN 3

#endif



////////////////////

// Heater and Fan Duty Dispay Options

// These should NOT need adjusting.  They control what gets streamed back to via serial

// These have no effect on operation and only affect what gets displayed/logged by Artisan

#ifdef PHASE_ANGLE_CONTROL

  #ifdef IO3_HTR_PAC // If using PWM on IO3 for a heater

    #define HEATER_DUTY levelIO3 // Heater output is assumed levelIO3 with heater connected to IO3

  #else // If using ICC control of a heater connected to OT1

    #define HEATER_DUTY levelOT1 // Heater output is assumed levelOT1 with heater connected to OT1

  #endif

  #define FAN_DUTY levelOT2 // Fan output is assumed levelOT2 for phase angle control mode on OT2

#else // PWM Mode

  #define HEATER_DUTY levelOT1 // Heater output is assumed levelOT1 with heatre connected to OT1

  #define FAN_DUTY levelIO3 // Fan output is assumed levelIO3 for PWM control of fan connected to IO3

#endif



////////////////////

// Phase Angle Control Options

What should I set here? 

// When using PHASE_ANGLE_CONTROL option

// Selct load type being switched by phase angle control (has no effect on the ICC output)

#define TRIAC_MOTOR // inductive loads need a longer pulse width to fire at 100%

//#define TRIAC_HEATER // enable this for resistive loads, like heaters



#endif