freshroastsr700 0.2.4

A Python module to control a FreshRoastSR700 coffee roaster.

A Python module to control a FreshRoastSR700 coffee roaster.

Usage

import time
import multiprocessing
import freshroastsr700

# freshroastsr700 uses multiprocessing under the hood.
# call multiprocessing.freeze_support() if you intend to
# freeze your app for packaging.
multiprocessing.freeze_support()

# Create a roaster object.
roaster = freshroastsr700.freshroastsr700()

# Conenct to the roaster.
roaster.connect()

# Set roasting variables.
roaster.heat_setting = 3
roaster.fan_speed = 9
roaster.time_remaining = 20

# Begin roasting.
roaster.roast()

# This ensures the example script does not end before the roast.
time.sleep(30)

# Disconnect from the roaster.
roaster.disconnect()

API & Documentation

Complete code documentation and a breakdown of the FreshroastSR700 communication protocol can be found at freshroastsr700.readthedocs.org. The Fresh Roast SR700 can be purchased directly from the manufacturer at homeroastingsupplies.com.

Installation

The latest release of this package can be installed by running:

pip install freshroastsr700

Please note that on OS X and Windows systems, you will need to install te ChiHeng CH341 driver in order for the freshroastsr700 module to talk to hardware. The easiest way to do this is to download the Openroast installer package, which bundles these drivers.

Version History

Version 0.2.4 - Oct 2017

• Resolves feature request documented in issue #31 freshroastsr700 object can now be instantiated with manual control of the software-based heater algorithm. Tested in Ubuntu 16.04.

Version 0.2.3 - May 2017

• Resolves issues #22, 23, 24 and 25, and 29 (the latter introduced by 0.2.2). Added logic to handle hardware connects and hardware disconnects properly in all supported OSes. Software now supports multiple connect()-disconnect() cycles using the same freshroastsrs700 object instance. Tested in Windows 10 64-bit and Ubuntu 14.04.

Version 0.2.2 - May 2017

• [Introduced issue #29. Inoperable in Windows environments - do not use.]

Version 0.2.1 - March 2017

• Resolves issue #20 by managing hardware discovery logic in the comm process, eliminating the need for the thread heretofore associated with auto_connect. Openroast 1.2 (currently in development) now operates properly in Windows 10 64-bit, with this fix.

Version 0.2.0 - March 2017

• Completely rewritten PID control for tighter tracking against target temperature (when freshroastsr700 is instantiated with thremostat=True).

• Callback functions for update_data_func and state_transition_func now called from a thread belonging to the process that instantiated freshroastsr700. This was necessary for Openroast version 1.2 code refactoring.

• Reduced processor load for PID control as part of code refactoring.

Version 0.1.1 - Dec 28 2017

• Added support for python 2.7.

Version 0.1.0

• (no notes)

License

MIT License. Please refer to LICENSE in this package for details.