Updated README for details on Artisan

README.md

@@ -7,18 +7,19 @@
 This repository contains the code for a PID controlled coffee roaster, run on a Teensy 3.5/3.6 development board.
 
 A quick summary of the features:
-* Auto mode which will control the temperature (bean or environment) and fan speed to a settable profile.  
-* Manual mode where temperature and fan speed can be controlled in real time.
-* Measured temperatures, set value, fan speed, and heater duty cycle saved to an SD card as a CSV file at 2 Hz while roasting.  See image above showing data from a roast.  I've also included a python script used to plot this data from the SD card.  The script requires the python module "matplotlib".   
+* *Auto Mode* which will control the temperature (bean or environment) and fan speed to a settable profile.  
+* *Manual Mode* where temperature and fan speed can be controlled in real time.
+* Measured temperatures, set value, fan speed, and heater duty cycle saved to an SD card as a CSV file at 2 Hz while roasting.  See image above showing data from a roast.  I've also included a python script used to plot this data from the SD card.  The script requires the python module "matplotlib".  
+* DC Fan PWM control.  (The MOSFET on the PCB can handle quite a bit of current.  I am using a 22 Amp, 260 Watt fan, and the MOSFET has additional headroom beyond that).    
 * The roasting profile can be set as a sequence of up to 9 segments.  The set temperature and fan speed are linearly interpolated from one segment to the next.  This profile can be set and saved to EEPROM via the LCD screen interface.  
 * Separate tuneable PID values for the environment temperature and bean temperature.  A tuning mode for each controller is available allowing one to monitor the step response and tune the gains in real time.
+* (Optional) interface with [Artisan Roaster Scope](https://artisan-scope.org/).  The roast can be logged by Artisan in Auto or Manual mode, or even have Artisan control the set temperature and fan speed in Manual mode.  
 
 I loosely based my roaster build off of a few of the fluid bed roasters over at the Home Roaster's forum using a Pyrex Bake-A-Round baking tube and inverted cocktail shaker lid.  For example, see Old Gear Head's fluid bed roaster design at: https://forum.homeroasters.org/forum/viewthread.php?thread_id=2207.   
 
 Here are the parts needed for the electronics board:
 * PCB (Order using gerber files in Eagle directory, or ask me and I'll send you one for a small amount.  Alternatively, the electronics can be soldered to a stripboard)
 * Teensy 3.5 (or 3.6), $24.25 from pjrc.com + MicroSD card
-* 20x4 character I2C LCD screen ($9 on eBay)
 * 2x MAX31855KASA+ thermocouple ICs ($5 each)
 * 4x SMD ferrite beads (I used 470 ohms 0805 package)
 * 3x BSS138 MOSFET transistors
@@ -29,6 +30,7 @@ Here are the parts needed for the electronics board:
 * Various resistors and capacitors (see schematic in Eagle directory)
 
 Here are the additional parts I used:
+* 20x4 character I2C LCD screen ($9 on eBay)
 * Two K-type thermocouples
 * Metal thermocouple probe shield (e.g., look for the 5mm x 50 mm thermocouple probe from Uxcell on Amazon, and cut off the end of the metal shield)
 * Fotek SSR-40 DA Solid State Relay + Heat Sink ($12.50 on eBay)
@@ -40,9 +42,13 @@ Here are the additional parts I used:
 * Airhead "Air Pig" 12V, 22 Amp air pump ($42 at Amazon)
 * 340 Silicone O-Rings 3.5" diam
 
+<img src="/images/IMG_2243.JPG" width="400"> <img src="/images/traces.png" width="225"> 
+
+A schematic and PCB design (see Eagle folder) is included in this repository.  The Gerber files can be uploaded to a PCB manufacturer (e.g., JLCPCB, SchenZhen2U, or Seeed Studio), typically for a few dollars a board and a minimum order of 5-10 boards.  Alternatively, contact me and I can send you one (without components) at cost plus shipping.  The electronics can also be soldered to a breadboard.  If using a breadboard, you will also need two MAX31855 breakout boards from Adafruit, as well as a logic level converter for the I2C LCD communication.
+
 The DC motor is driven by the 12V power supply, with PWM speed control from the microcontroller.  It is vitally important that a few small capacitors be soldered directly to the motor leads to reduce voltage noise on the DC power, otherwise the inevitable voltage spikes from the DC motor will reset the microcontroller in the middle of your roast.  Not good!  I used a 22 nF capacitor across the leads, and then two 10 nF capacitors from each lead directly to the motor housing.   
 
-The 12V, 22 Amp DC motor I used draws a lot of current, so be sure to use beefy wires (e.g., 14 AWG) all the way to the MOSFET.  Be sure to use a heat sink on the IRLB8721PBF MOSFET.  The wide traces on the back of the PCB are inadequate to handle 22A.  I recommend laying down a heavy layer of solder directly to these traces.  Better yet, solder exposed 14 AWG wire directly to the traces.   
+The 12V, 22 Amp DC motor I used draws a lot of current, so be sure to use beefy wires (e.g., 14 AWG) all the way to the MOSFET.  Be sure to use a heat sink on the IRLB8721PBF MOSFET.  The wide traces on the back of the PCB are inadequate to handle 22A.  I recommend laying down a heavy layer of solder directly to these traces.  Better yet, solder exposed 14 AWG wire directly to the traces.  See photos above.
 
 I enclosed the DC motor in my own 3D printed case and threw away the pig shaped case on the Airhead "Air Pig".  I've included the 3D printed case model in this repository, which encloses the motor and is sealed with a 3.5" O-ring.  I'm sure the pig shaped case would work too, but don't use the corrugated hose which produces too much drag.  
 
@@ -54,5 +60,14 @@ I have also included a few 3D printed parts I used, which may be useful.  This r
 
 The plans for a 1/4" ply laser cut case are also included if you have access to a laser cutter.  Or build your own!  
 
+# Artisan Roaster Scope Instructions
+Artisan is not required for this roaster, as the Teensy firmware can already track a stored profile and save the roast data to an SD card without an external interface.  I still highly recommend Artisan as it includes additional visual analysis tools.  
+
+Coffee Roaster uses the same Artisan communication protocol as a TC4.  To use this Teensy code with Artisan, set up the device as a TC4 in Config>Device on the ET/BT tab.  Check the "Control" and "PID Firmware" checkboxes.  On the Extra Devices tab, set up the ArduinoTC4_34, ArduinoTC4_56 (Label 1 = Heater, Label 2 = Fan), and ArduinoTC4_78 (Label 1 = SV, Label 2 = Ambient).  Check the LCD 1, LCD 2, Curve 1, and Curve 2 checkboxes for ArduinoTC4_56 and _78, but uncheck for _34.  The YouTube video [Artisan Roaster Scope - Setup for TC4](https://youtu.be/0-Co-pXF2NM) walks through the setup procedure.
+
+The above steps are sufficient for logging your roast with Artisan.  To control the roast using Artisan, check out the YouTube video [Artisan Roaster Scope - TC4 PID Control](https://youtu.be/ykuUCXhGAC4).  This video has four parts.  The two parts labeled "Background Follow TC4 PID" and "Ramp/Soak Profile TC4 PID" can be used with this code.  The "Artisan PID" variants are not currently supported.  
+
+If using Artisan to control your roaster, you will also need to set up the DC Fan control  To do this, open the Config>Events dialog, change the first Event name to Fan, go to the Sliders tab, and set the Fan Action to Serial Command, and add the command "DCFAN;{}" to the selection box, without the quotes.  
+
 <img src="/images/IMG_2028.JPG" alt="Roaster">