neal
/
Typica
Watch 1
Star 0
Fork 0
Code Issues 15 Pull Requests 0 Releases 11 Activity
Browse Source

Merge branch 'master' into development

Neal Wilson 8 years ago
parent
7534f0af49 363c879c65
commit
a385f6521d
20 changed files with 354 additions and 36 deletions
Split View Show Diff Stats
  1. 1
    1
      docs/documentation.html
  2. 31
    0
      docs/documentation/appendix-a.1.html
  3. 31
    0
      docs/documentation/appendix-a.2.html
  4. 28
    0
      docs/documentation/appendix-a.3.html
  5. 28
    0
      docs/documentation/appendix-a.4.html
  6. 32
    0
      docs/documentation/appendix-a.5.html
  7. 28
    0
      docs/documentation/appendix-a.6.html
  8. 62
    0
      docs/documentation/faq.html
  9. 4
    0
      docs/documentation/firsttime.html
  10. 12
    8
      docs/documentation/part1.html
  11. 1
    1
      docs/documentation/part2.html
  12. 19
    9
      docs/documentation/platforms.html
  13. 3
    12
      docs/documentation/requiredsoftware.html
  14. 5
    1
      docs/documentation/windowreference/logging.html
  15. 56
    0
      docs/documentation/windowreference/manageroasted.html
  16. BIN
      docs/documentation/windowreference/manageroasted.png
  17. 2
    1
      docs/style.css
  18. 3
    0
      web/output/index.html
  19. 3
    3
      web/src/pages/downloads.m4
  20. 5
    0
      web/src/pages/index.m4

+ 1
- 1
docs/documentation.html View File 

@@ -63,7 +63,7 @@
63 63 
 								<li><a href="documentation/dataentry.html#profiles">Saving and Using Target Roast Profiles</a></li>
64 64 
 							</ul>
65 65 
 						</ul>
66 
-						<li><a>Tips, Tricks, and Frequently Asked Questions</a></li>
66 
+						<li><a href="documentation/faq.html">Tips, Tricks, and Frequently Asked Questions</a></li>
67 67 
 					</ul>
68 68 
 					<li><a href="documentation/part2.html">Part 2: Comprehensive Feature Documentation</a></li>
69 69 
 					<li><a>Part 3: Interoperability Specifications</a></li>

+ 31
- 0
docs/documentation/appendix-a.1.html View File 

@@ -0,0 +1,31 @@
1 
+<html>
2 
+	<head>
3 
+		<title>Typica - Data for Coffee Roasters</title>
4 
+		<link rel="stylesheet" type="text/css" href="../style.css">
5 
+	</head>
6 
+	<body>
7 
+		<div id="page">
8 
+			<div id="topmatter">
9 
+				<div id="topbanner">
10 
+					<img src="../logo96.png" height="96px" width="96px" alt="Typica logo" />
11 
+					<h1>Typica</h1>
12 
+					<h2>Data for Coffee Roasters</h2>
13 
+				</div>
14 
+				<div id="menu">
15 
+					<a class="tab" href="index.html">Project Home</a>
16 
+					<a class="tab" href="downloads.html" >Downloads</a>
17 
+					<a class="tab active" >Documentation</a>
18 
+					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19 
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20 
+				</div>
21 
+			</div>
22 
+			<div id="maintext">
23 
+				<h1>Appendix A.1: Hardware Compatibility Notes - National Instruments NI USB-9211</h1>
24 
+				<p>NI USB-9211 is the model name for a National Instruments NI 9211 module paired with an NI USB-9161 USB Carrier. National Instruments has many combinations of the NI 9211 module with other devices featuring very similar model names and different software compatability. Please check carefully.</p>
25 
+				<p>This hardware is known to work with Microsoft Windows. Typica requires that NI-DAQmx Base 2.2 is installed to use this hardware on Microsoft Windows.</p>
26 
+				<p>This hardware is known to work with Mac OS X. Typica requires that NI-DAQmx Base 2.1 is installed to use this hardware on Mac OS X.</p>
27 
+				<p>National Instruments claims that this hardware will work with Linux, however it may be difficult to make this work with most Linux distributions. There are minor differences in the way NI-DAQmx Base is loaded in Typica on Windows and Mac OS X and Typica may require minor modification to use this hardware on Linux. Confirmation that this works or a patch to make this work would be appreciated.</p>
28 
+			</div>
29 
+		</div>
30 
+	</body>
31 
+</html>

+ 31
- 0
docs/documentation/appendix-a.2.html View File 

@@ -0,0 +1,31 @@
1 
+<html>
2 
+	<head>
3 
+		<title>Typica - Data for Coffee Roasters</title>
4 
+		<link rel="stylesheet" type="text/css" href="../style.css">
5 
+	</head>
6 
+	<body>
7 
+		<div id="page">
8 
+			<div id="topmatter">
9 
+				<div id="topbanner">
10 
+					<img src="../logo96.png" height="96px" width="96px" alt="Typica logo" />
11 
+					<h1>Typica</h1>
12 
+					<h2>Data for Coffee Roasters</h2>
13 
+				</div>
14 
+				<div id="menu">
15 
+					<a class="tab" href="index.html">Project Home</a>
16 
+					<a class="tab" href="downloads.html" >Downloads</a>
17 
+					<a class="tab active" >Documentation</a>
18 
+					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19 
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20 
+				</div>
21 
+			</div>
22 
+			<div id="maintext">
23 
+				<h1>Appendix A.2: Hardware Compatibility Notes - National Instruments NI USB-9211A</h1>
24 
+				<p>NI USB-9211 is the model name for a National Instruments NI 9211 module paired with an NI USB-9162 Hi-Speed USB Carrier. National Instruments has many combinations of the NI 9211 module with other devices featuring very similar model names and different software compatability. Please check carefully.</p>
25 
+				<p>This hardware is known to work with Microsoft Windows. Typica can use <em>either</em> NI-DAQmx Base 3.6 <em>or</em> NI DAQmx 9.6.1 to communicate with this hardware on Microsoft Windows. <em>Please have only one of these installed. Installing both will result in failures.</em></p>
26 
+				<p>This hardware is known to work with Mac OS X. Typica requires that NI-DAQmx Base 3.6 is installed to use this hardware on Mac OS X.</p>
27 
+				<p>National Instruments claims that this hardware will work with Linux, however it may be difficult to make this work with most Linux distributions. There are minor differences in the way NI-DAQmx Base is loaded in Typica on Windows and Mac OS X and Typica may require minor modification to use this hardware on Linux. Confirmation that this works or a patch to make this work would be appreciated.</p>
28 
+			</div>
29 
+		</div>
30 
+	</body>
31 
+</html>

+ 28
- 0
docs/documentation/appendix-a.3.html View File 

@@ -0,0 +1,28 @@
1 
+<html>
2 
+	<head>
3 
+		<title>Typica - Data for Coffee Roasters</title>
4 
+		<link rel="stylesheet" type="text/css" href="../style.css">
5 
+	</head>
6 
+	<body>
7 
+		<div id="page">
8 
+			<div id="topmatter">
9 
+				<div id="topbanner">
10 
+					<img src="../logo96.png" height="96px" width="96px" alt="Typica logo" />
11 
+					<h1>Typica</h1>
12 
+					<h2>Data for Coffee Roasters</h2>
13 
+				</div>
14 
+				<div id="menu">
15 
+					<a class="tab" href="index.html">Project Home</a>
16 
+					<a class="tab" href="downloads.html" >Downloads</a>
17 
+					<a class="tab active" >Documentation</a>
18 
+					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19 
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20 
+				</div>
21 
+			</div>
22 
+			<div id="maintext">
23 
+				<h1>Appendix A.3: Hardware Compatibility Notes - National Instruments NI 9211 paired with NI cDAQ-9171</h1>
24 
+				<p>This combination of hardware is only known to work on Microsoft Windows and requires that NI DAQmx is installed. I do not have access to this hardware for testing purposes, but do have several reports that it works.</p>
25 
+			</div>
26 
+		</div>
27 
+	</body>
28 
+</html>

+ 28
- 0
docs/documentation/appendix-a.4.html View File 

@@ -0,0 +1,28 @@
1 
+<html>
2 
+	<head>
3 
+		<title>Typica - Data for Coffee Roasters</title>
4 
+		<link rel="stylesheet" type="text/css" href="../style.css">
5 
+	</head>
6 
+	<body>
7 
+		<div id="page">
8 
+			<div id="topmatter">
9 
+				<div id="topbanner">
10 
+					<img src="../logo96.png" height="96px" width="96px" alt="Typica logo" />
11 
+					<h1>Typica</h1>
12 
+					<h2>Data for Coffee Roasters</h2>
13 
+				</div>
14 
+				<div id="menu">
15 
+					<a class="tab" href="index.html">Project Home</a>
16 
+					<a class="tab" href="downloads.html" >Downloads</a>
17 
+					<a class="tab active" >Documentation</a>
18 
+					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19 
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20 
+				</div>
21 
+			</div>
22 
+			<div id="maintext">
23 
+				<h1>Appendix A.4: Hardware Compatibility Notes - National Instruments NI USB-TC01</h1>
24 
+				<p>This hardware only works on Microsoft Windows and requires that NI DAQmx is installed. While I have not personally experienced problems with this hardware, most of the reported issues that were ultimately determined to be due to faulty hardware or poor installation have involved this device.</p>
25 
+			</div>
26 
+		</div>
27 
+	</body>
28 
+</html>

+ 32
- 0
docs/documentation/appendix-a.5.html View File 

@@ -0,0 +1,32 @@
1 
+<html>
2 
+	<head>
3 
+		<title>Typica - Data for Coffee Roasters</title>
4 
+		<link rel="stylesheet" type="text/css" href="../style.css">
5 
+	</head>
6 
+	<body>
7 
+		<div id="page">
8 
+			<div id="topmatter">
9 
+				<div id="topbanner">
10 
+					<img src="../logo96.png" height="96px" width="96px" alt="Typica logo" />
11 
+					<h1>Typica</h1>
12 
+					<h2>Data for Coffee Roasters</h2>
13 
+				</div>
14 
+				<div id="menu">
15 
+					<a class="tab" href="index.html">Project Home</a>
16 
+					<a class="tab" href="downloads.html" >Downloads</a>
17 
+					<a class="tab active" >Documentation</a>
18 
+					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19 
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20 
+				</div>
21 
+			</div>
22 
+			<div id="maintext">
23 
+				<h1>Appendix A.5: Hardware Compatibility Notes - DATAQ DI-145</h1>
24 
+				<p>At present this hardware is only supported on Microsoft Windows and requires that the DATAQ SDK is installed. It will likely be supported on other platforms in the future, but purchasing hardware based on possible future compatibility is not recommended. Note that this device does not take thermocouple inputs directly and additional hardware may be required to effectively utilize this hardware. While measurements from this device can be mapped to temperature data, there are several characteristics of this device which make it the least desirable of the supported options for that sort of data. This device is better suited to logging control data of limited range and precision.</p>
25 
+
26 
+				<p>Some Diedrich roasters have included hardware appropriate for connecting to this device. An example is shown in the following video.</p>
27 
+
28 
+				<iframe width="640" height="360" src="https://www.youtube.com/embed/ZH7Dh5mM8LE" frameborder="0" allowfullscreen></iframe>
29 
+			</div>
30 
+		</div>
31 
+	</body>
32 
+</html>

+ 28
- 0
docs/documentation/appendix-a.6.html View File 

@@ -0,0 +1,28 @@
1 
+<html>
2 
+	<head>
3 
+		<title>Typica - Data for Coffee Roasters</title>
4 
+		<link rel="stylesheet" type="text/css" href="../style.css">
5 
+	</head>
6 
+	<body>
7 
+		<div id="page">
8 
+			<div id="topmatter">
9 
+				<div id="topbanner">
10 
+					<img src="../logo96.png" height="96px" width="96px" alt="Typica logo" />
11 
+					<h1>Typica</h1>
12 
+					<h2>Data for Coffee Roasters</h2>
13 
+				</div>
14 
+				<div id="menu">
15 
+					<a class="tab" href="index.html">Project Home</a>
16 
+					<a class="tab" href="downloads.html" >Downloads</a>
17 
+					<a class="tab active" >Documentation</a>
18 
+					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19 
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20 
+				</div>
21 
+			</div>
22 
+			<div id="maintext">
23 
+				<h1>Appendix A.6: Hardware Compatibility Notes - Modbus RTU Devices</h1>
24 
+				<p>While Modbus RTU devices are supported on all platforms, these are usually connected through an RS-485 to USB adapter. Please verify driver support for your adapter with platforms you intend to use. There are also several limitations in Typica's support of Modbus RTU devices. While these limitations are likely to be removed soon with a future version of Typica, at present only one device is supported per bus and only one process value and up to one set value per device is available. This is sufficient for basic logging of temperature data and allows limited control in some roasting system designs, but more complex configurations or devices dealing with non-temperature data monitoring and control are not yet supported.</p>
25 
+			</div>
26 
+		</div>
27 
+	</body>
28 
+</html>

+ 62
- 0
docs/documentation/faq.html View File 

@@ -0,0 +1,62 @@
1 
+<html>
2 
+    <head>
3 
+        <title>Typica - Data for Coffee Roasters</title>
4 
+        <link rel="stylesheet" type="text/css" href="../style.css">
5 
+    </head>
6 
+    <body>
7 
+        <div id="page">
8 
+            <div id="topmatter">
9 
+                <div id="topbanner">
10 
+                    <img src="../logo96.png" height="96px" width="96px" alt="Typica logo" />
11 
+                    <h1>Typica</h1>
12 
+                    <h2>Data for Coffee Roasters</h2>
13 
+                </div>
14 
+                <div id="menu">
15 
+                    <a class="tab" href="index.html">Project Home</a>
16 
+                    <a class="tab" href="downloads.html" >Downloads</a>
17 
+                    <a class="tab active" >Documentation</a>
18 
+                    <a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19 
+                    <a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20 
+                </div>
21 
+            </div>
22 
+            <div id="maintext">
23 
+                <h1>Tips, Tricks, and Frequently Asked Questions</h1>
24 
+
25 
+                <h2>What hardware does Typica work with?</h2>
26 
+                <p>See the <a href="http://www.randomfield.com/programs/typica/documentation/platforms.html#compatability">Hardware Compatability Table</a> to learn what hardware will work with Typica on which operating systems. If your device is not listed, Typica is not known to work with it. If you'd like to add support for additional hardware, patches are welcome. For new installations, the Phidgets 1048 is generally recommended.</p>
27 
+
28 
+                <h2>Does Typica work with my coffee roaster?</h2>
29 
+                <p>Almost certainly. If your roaster already has one or more thermocouples installed, it is possible to jump off of that to one of the supported pieces of data acquisition hardware. If you have an RTD, you might need to replace whatever that is connected to with something that can speak Modbus RTU. Home roasting machines are generally more difficult to connect and may require significant modification.</p>
30 
+                <p>The below video demonstrates connecting a roaster to a computer using a Diedrich SR-1 and a National Instruments NI USB 9211, but the process is very similar with most other commercial coffee roasters and other data acquisition hardware that takes thermocouple inputs.</p>
31 
+                <iframe width="640" height="360" src="https://www.youtube.com/embed/EXPjLgCoUWU" frameborder="0" allowfullscreen></iframe>
32 
+
33 
+                <h2>Can multiple instances of Typica connect to the same database?</h2>
34 
+                <p>Yes. You'll need to configure PostgreSQL to allow network connections (it does not by default) and if you're using multiple coffee roasters you'll want to make sure these are configured with different IDs in the database. If you are using a software based firewall on the computer running PostgreSQL you will also need to make sure incoming connections are allowed.</p>
35 
+
36 
+                <h2>When configuring rate of change calculations, what is the difference between scale time and cache time?</h2>
37 
+                <p>A rate of change is logically a fraction where the numerator is how much the value has changed and the denominator is the amount of time that change takes place over. Scale time is the number of seconds used for the denominator of this fraction. If you are already used to thinking about rate of change over a certain amount of time, you can continue to use that. Otherwise, matching what you normally have the table view set to show is recommended. By default, that would be 30 seconds.</p>
38 
+                <p>Measurement hardware is not perfect and presents data that is slightly noisy and of limited precision. Rate of change calculations can amplify that noise and make it difficult to use that information during the roast. Typica provides a way to smooth out that noise by presenting the slope of a linear regression of measurements taken in a given amount of time. Cache time is the number of seconds used for this. A smaller value will allow the rate to change more quickly while a larger value will be more resistant to noise. 10 seconds is a good starting point for this setting.</p>
39 
+                <p>A good overview of using rate of change calculations in Typica is presented in the following video. The start of the video is an overview of why this is useful. Starting at 2:55 is a demonstration of how this looks in Typica. At 10:07 there's a walkthrough of all of the configuration details for this feature.</p>
40 
+
41 
+                <iframe width="640" height="360" src="https://www.youtube.com/embed/km4GuMIxW70" frameborder="0" allowfullscreen></iframe>
42 
+
43 
+                <h2>How can I support further development of Typica?</h2>
44 
+                <p>Checks payable to Neal Wilson can be sent to</p>
45 
+                <p>Neal Wilson<br />
46 
+                C/O Wilson's Coffee &amp; Tea<br />
47 
+                3306 Washington Ave.<br />
48 
+                Racine, WI 53405<br />
49 
+                USA</p>
50 
+                <p>If you would prefer to use a credit card, it is possible to do this with the blue "$ Support" button on the right side of <a href="https://www.youtube.com/user/N3Roaster">the N3Roaster YouTube channel</a>.</p>
51 
+                <p>It is also possible to <a href="mailto:roaster@wilsonscoffee.com">hire me for training at your company</a>.</p>
52 
+
53 
+                <h2>Why can't I see the batch timer?</h2>
54 
+                <p>There are splitter handles between all of the indicators at the top of the logging window. If you move your cursor to the right of the rightmost visible indicator and click and drag to the left, that should become visible again. Several other elements of this window also have splitter handles that you can use to customize the size of different information displays.</p>
55 
+
56 
+                <h2>Can databases other than PostgreSQL be used with Typica?</h2>
57 
+                <p>Not currently. I'd like to add SQLite3 support in Typica 2.0 which would make it easier to support additional database managers.</p>
58 
+
59 
+            </div>
60 
+        </div>
61 
+    </body>
62 
+</html>

+ 4
- 0
docs/documentation/firsttime.html View File 

@@ -289,6 +289,10 @@
289 289
290 290 
 				<img src="images/countconfig.png" />
291 291
292 
+				<p>A good example of how a Counting Button can be used in profile development is shown in the following video. If you find this approach to coffee roasting interesting, the concepts are extended in the <a href="https://www.youtube.com/playlist?list=PLPTTFznZ65M-lSNokmiP2uByEoTZAg4oI">Roast Profile Development</a> video series.</p>
293 
+
294 
+				<iframe width="640" height="360" src="https://www.youtube.com/embed/sct2FWVkmDw" frameborder="0" allowfullscreen></iframe>
295 
+
292 296 
 				<p>Numeric Entry provides a way to provide notes with numeric data that cannot be
293 297 
 				logged automatically. Some roasters have fuel or air flow controls with a large number
294 298 
 				of numerically identified settings. Some people may want to occassionally note the

+ 12
- 8
docs/documentation/part1.html View File 

@@ -21,7 +21,8 @@
21 21 
 				</div>
22 22 
 			</div>
23 23 
 			<div id="maintext">
24 
-				<h1>Part 1: Basic Setup and Use</h1>
24 
+                            <h1>Part 1: Basic Setup and Use</h1>
25 
+                            <div class="toc">
25 26 
 				<ul>
26 27 
 					<li><a href="platforms.html">Supported Platforms and Hardware</a></li>
27 28 
 					<li><a href="requiredsoftware.html">Required Software</a></li>

@@ -33,20 +34,23 @@
33 34 
 							<li><a href="firsttime.html#configfile">Open Configuration File</a></li>
34 35 
 							<li><a href="firsttime.html#hardware">Configuring Typica for your Hardware</a></li>
35 36 
 						</ul>
36 
-						<li><a href="dataentry,html">Initial Data Entry</a></li>
37 
+						<li><a href="dataentry.html">Initial Data Entry</a></li>
37 38 
 						<ul>
38 
-							<li><a href="dataentry,html#green">Green Coffee Purchases</a></li>
39 
-							<li><a href="dataentry,html#roasted">Roasted Coffee Items</a></li>
40 
-							<li><a href="dataentry,html#inventory">An Initial Inventory</a></li>
41 
-							<li><a href="dataentry,html#profiles">Saving and Using Target Roast Profiles</a></li>
39 
+							<li><a href="dataentry.html#green">Green Coffee Purchases</a></li>
40 
+							<li><a href="dataentry.html#roasted">Roasted Coffee Items</a></li>
41 
+							<li><a href="dataentry.html#inventory">An Initial Inventory</a></li>
42 
+							<li><a href="dataentry.html#profiles">Saving and Using Target Roast Profiles</a></li>
42 43 
 						</ul>
43 44 
 					</ul>
44 
-					<li><a>Tips, Tricks, and Frequently Asked Questions</a></li>
45 
+					<li><a href="faq.html">Tips, Tricks, and Frequently Asked Questions</a></li>
45 46 
 				</ul>
46 
-				<p>This part of the documentation covers the things you should
47 
+                            </div>
48 
+                            <div class="ntoc">
49 
+                                <p>This part of the documentation covers the things you should
47 50 
 				know before starting to use Typica and the basics of getting
48 51 
 				everything set up for use. Some of the topics are covered in
49 52 
 				greater depth in Part 2.</p>
53 
+                            </div>
50 54 
 			</div>
51 55 
 		</div>
52 56 
 	</body>

+ 1
- 1
docs/documentation/part2.html View File 

@@ -36,7 +36,7 @@
36 36 
 					<li><a>Configure Roasters</a></li>
37 37 
 					<li><a href="windowreference/logging.html">The Logging View</a></li>
38 38 
 					<li><a>Purchase Green Coffee</a></li>
39 
-					<li><a>Manage Roasted Coffee Items</a></li>
39 
+					<li><a href="windowreference/manageroasted.html">Manage Roasted Coffee Items</a></li>
40 40 
 					<li><a>Update Inventory</a></li>
41 41 
 					<li><a>Cupping</a></li>
42 42 
 					<li><a>Import Target Roast Profiles</a></li>

+ 19
- 9
docs/documentation/platforms.html View File 

@@ -29,12 +29,9 @@
29 29 
 				<h2>Operating Systems</h2>
30 30 
 				<p>Precompiled builds of Typica are provided for Microsoft
31 31 
 				Windows and Mac OS X. The Microsoft Windows build has been
32 
-				tested as working on both Windows 7 and Windows 8. It might
33 
-				work on Windows XP or Windows Vista but this has not been
34 
-				tested.</p>
35 
-				<p>The Mac OS X build has been tested on Mac OS X 10.6 and 10.7.
36 
-				It might work on 10.4, 10.5, and 10.8 but this has not been
37 
-				tested. The build is also only for Macs with Intel processors.</p>
32 
+				tested as working on both Windows 7 and Windows 10. It might
33 
+				work on Windows XP, Windows Vista, or Windows 8 but this has not been tested.</p>
34 
+				<p>The Mac OS X build has been tested on Mac OS X 10.6 through 10.11. The build is also only for Macs with Intel processors. Note that at the time of this writing National Instruments hardware is known to not work starting with OS X 10.10 or later. If National Instruments starts advertising that a newer version of NI DAQmx Base works with current operating system releases and supported hardware, Typica will probably work with that, but there's nothing that anybody else can do about that other than choosing different hardware.</p>
38 35 
 				<p>Source code is provided which may be used to build Typica
39 36 
 				on Linux, PowerPC based Macs, and possibly other platforms,
40 37 
 				however instructions on doing this are beyond the scope of this

@@ -42,6 +39,7 @@
42 39
43 40 
 				<a name="hardware" />
44 41 
 				<h2>Data Acquisition Hardware</h2>
42 
+
45 43 
 				<p>On Microsoft Windows and Mac OS X, the National Instruments
46 44 
 				NI 9211 module is supported in either the
47 45 
 				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/13880">NI USB-9161</a>

@@ -70,7 +68,7 @@
70 68 
 				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/208177">NI USB-TC01</a>
71 69 
 				is also an option on
72 70 
 				this platform. This has been tested with
73 
-				<a href="http://joule.ni.com/nidu/cds/view/p/id/3622/lang/en">NI-DAQmx 9.6.1</a>.
71 
+				<a href="http://joule.ni.com/nidu/cds/view/p/id/3622/lang/en">NI-DAQmx 9.6.1</a>. A newer hardware revision has been released which no longer works with NI-DAQmx 9.6.1. If you encounter an error related to firmware being too new, try the latest version of NI-DAQmx.
74 72 
 				Note that NI-DAQmx should not be installed at the same time as NI-DAQmx Base 3.6
75 73 
 				however it is fine to have it installed at the same time as NI-DAQmx Base 2.2.</p>
76 74 
 				<p>On all platforms, devices which communicate using the Modbus

@@ -86,6 +84,7 @@
86 84 
 				install driver software before this adapter will work correctly.
87 85 
 				Consult the manuals for your hardware for more details.</p>
88 86
87 
+				<a name="compatability" />
89 88 
 				<h2>Hardware Compatability Table</h2>
90 89 
 				<p>The table below is a quick reference on what operating systems different hardware supported by Typica can work with. Please click on the device name and read the compatability notes <em>before</em> purchasing hardware with the intention of using it with Typica.</p>
91 90 
 				<table>

@@ -99,13 +98,13 @@
99 98 
 						<tr>
100 99 
 							<th><a href="appendix-a.1.html">National Instruments NI USB-9211</a></th>
101 100 
 							<td>yes</td>
102 
-							<td>yes</td>
101 
+							<td>only 10.9 or earlier</td>
103 102 
 							<td>maybe</td>
104 103 
 						</tr>
105 104 
 						<tr>
106 105 
 							<th><a href="appendix-a.2.html">National Instruments NI USB-9211A</a></th>
107 106 
 							<td>yes</td>
108 
-							<td>yes</td>
107 
+							<td>only 10.9 or earlier</td>
109 108 
 							<td>maybe</td>
110 109 
 						</tr>
111 110 
 						<tr>

@@ -132,8 +131,19 @@
132 131 
 							<td>yes</td>
133 132 
 							<td>yes</td>
134 133 
 						</tr>
134 
+						<tr>
135 
+                                                    <th>Phidgets 1048</th>
136 
+                                                    <td>yes</td>
137 
+                                                    <td>yes</td>
138 
+                                                    <td>yes</td>
139 
+                                                </tr>
135 140 
 					</tbody>
136 141 
 				</table>
142 
+
143 
+				<h2>Connecting Hardware</h2>
144 
+				<p>If you are using the Phidgets 1048 or National Instruments devices and your coffee roaster already has a thermocouple installed, you might find the following video helpful in connecting your existing thermocouples to your data acquisition hardware. The video uses a Diedrich SR-1 and a National Instruments NI USB-9211, but the same procedure works with a wide range of commercial roasting equipment and other data acquisition devices.</p>
145 
+
146 
+				<iframe width="640" height="360" src="https://www.youtube.com/embed/EXPjLgCoUWU" frameborder="0" allowfullscreen></iframe>
137 147 
 			</div>
138 148 
 		</div>
139 149 
 	</body>

+ 3
- 12
docs/documentation/requiredsoftware.html View File 

@@ -46,18 +46,9 @@
46 46 
 				There you can
47 47 
 				<a href="http://www.postgresql.org/download/">download</a> the
48 48 
 				appropriate binary package for the platform you intend to run
49 
-				the database on. Typica has been tested with versions of
50 
-				PostgreSQL up to 9.2, however the people behind PostgreSQL have
51 
-				a very good history of making new versions better than the old
52 
-				ones so the newest stable release is recommended for new
53 
-				installations. When installing PostgreSQL, please make note of
49 
+				the database on. Typica requires version 9.3 or later, however the people behind PostgreSQL have a very good history of making new versions better than the old one so the newest stable release is recommended for new installations. When installing PostgreSQL, please make note of
54 50 
 				the password that you choose for the postgres user as you will
55 
-				need this information later. Also ensure that PostgreSQL is set
56 
-				up to run on port 5432. Aside from these details, the defaults
57 
-				provided by the installer can be used so installation mainly
58 
-				consists of running the installer that you download and
59 
-				clicking the Next button several times until the installer is
60 
-				finished.</p>
51 
+				need this information later.</p>
61 52
62 53 
 				<p>If you do want to set up PostgreSQL for use over a network,
63 54 
 				you may find

@@ -104,7 +95,7 @@
104 95 
 				<h3>NI DAQmx Devices - Microsoft Windows Only</h3>
105 96
106 97 
 				<p>Certain hardware from National Instruments requires
107 
-				NI-DAQmx. Typica has been tested with version 9.6.1. See
98 
+				NI-DAQmx. Typica has been tested with version 9.6.1, however newer hardware revisions of some supported hardware requires a newer version. See
108 99 
 				<a href="platforms.html#hardware">Supported Platforms and Hardware</a>
109 100 
 				for more details.</p>
110 101

+ 5
- 1
docs/documentation/windowreference/logging.html View File 

@@ -194,7 +194,11 @@
194 194 
                 <h3>Reset Translation</h3>
195 195 
                 <p>If the roaster in use has been configured to use roast
196 196 
                 profile translation, this item can be used to reset any
197 
-                currently applied translation transformation in the graph.</p>
197 
+                currently applied translation transformation in the graph. The
198 
+                following video contains more information about the roast
199 
+                profile translation feature and why you might want to use it.</p>
200 
+
201 
+                <iframe width="640" height="360" src="https://www.youtube.com/embed/hS0SfzypyFQ" frameborder="0" allowfullscreen></iframe>
198 202
199 203 
             </div>
200 204 
         </div>

+ 56
- 0
docs/documentation/windowreference/manageroasted.html View File 

@@ -0,0 +1,56 @@
1 
+<html>
2 
+    <head>
3 
+        <title>Typica - Connecting to a database</title>
4 
+        <link rel="stylesheet" type="text/css" href="../../style.css">
5 
+    </head>
6 
+    <body>
7 
+        <div id="page">
8 
+            <div id="topmatter">
9 
+                <div id="topbanner">
10 
+                    <img src="../../logo96.png" height="96px" width="96px" alt="Typica logo" />
11 
+                    <h1>Typica</h1>
12 
+                    <h2>Data for Coffee Roasters</h2>
13 
+                </div>
14 
+                <div id="menu">
15 
+                    <a class="tab" href="../../index.html">Project Home</a>
16 
+                    <a class="tab" href="../../downloads.html" >Downloads</a>
17 
+                    <a class="tab active" >Documentation</a>
18 
+                    <a class="tab" href="../../screenshots.html" >Screenshots and Videos</a>
19 
+                    <a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20 
+                </div>
21 
+            </div>
22 
+            <div id="maintext">
23 
+                <h1>Manage Roasted Coffee Items</h1>
24 
+                <img src="manageroasted.png" />
25 
+
26 
+                <p>When using the New Batch window to roast coffee, there is a
27 
+                control to select which roasted coffee item you would like to
28 
+                roast. Manage Roasted Coffee Items allows you to control which
29 
+                items will appear in that list.</p>
30 
+
31 
+                <h2>Field descriptions</h2>
32 
+
33 
+                <h3>New Roasted Coffee</h3>
34 
+                <p>If you want a completely new roasted coffee item, you can
35 
+                type the name of the item in this field, click Add New Coffee,
36 
+                and this will create a new roasted coffee item and add it to
37 
+                the Current Items list.</p>
38 
+
39 
+                <h3>Current Items</h3>
40 
+                <p>This is a list of all of the items that will appear in the
41 
+                New Batch window. If you discontinue a roasted coffee item and
42 
+                would like that to no longer appear as an option in the New
43 
+                Batch window you can select the item and click Remove Item to
44 
+                move that item to the Discontinued Items list.</p>
45 
+
46 
+                <h3>Discontinued Items</h3>
47 
+                <p>This is a list of roasted coffee items which are not in the
48 
+                Current Items list. If you have previously discontinued an item
49 
+                and would like to bring that back as an option in the New Batch
50 
+                window, you can select the item from this list and click Restore
51 
+                Item.</p>
52 
+
53 
+            </div>
54 
+        </div>
55 
+    </body>
56 
+</html>

BIN
docs/documentation/windowreference/manageroasted.png View File


+ 2
- 1
docs/style.css View File 

@@ -88,4 +88,5 @@ h2 {
88 88 
 }
89 89 
 li {
90 90 
 	list-style-type: none;
91 
-}
91 
+}
92 
+

+ 3
- 0
web/output/index.html View File 

@@ -28,6 +28,9 @@ to set reminders based on production, a new batch log with search
28 28 
 and filter features, and more. This also marks the first release
29 29 
 that includes a translation of the program to another language.
30 30 
 People using a computer with German locale settings will see that.</p>
31 
+<p>The following video goes over some of the most useful changes
32 
+that were introduced in Typica 1.7 and how to use those.</p>
33 
+<iframe width="640" height="360" src="https://www.youtube.com/embed/na6_ny0PaIA" frameborder="0" allowfullscreen></iframe>
31 34 
 <h1>Data Acquisition</h1>
32 35 
 <p>Every batch of coffee you roast with Typica can be recorded for
33 36 
 future reference. A practically unlimited number of target roast

+ 3
- 3
web/src/pages/downloads.m4 View File 

@@ -2,11 +2,11 @@ define(`__PageType', `Downloads')
2 2
3 3 
 __PageStart
4 4
5 
-<p>The latest release of Typica is version 1.6.2, released February 11, 2014.
5 
+<p>The latest release of Typica is version 1.7, released January 24, 2016.
6 6 
 This is available for Microsoft Windows, and Intel/Mac OS X.</p>
7 7
8 
-<p><a href="download-mac-latest.html">Typica 1.6.2 for Intel/Mac OS X</a></p>
9 
-<p><a href="download-windows-latest.html">Typica 1.6.2 for Microsoft Windows</a></p>
8 
+<p><a href="download-mac-latest.html">Typica 1.7 for Intel/Mac OS X</a></p>
9 
+<p><a href="download-windows-latest.html">Typica 1.7 for Microsoft Windows</a></p>
10 10
11 11 
 <p>The latest source code can always be found on
12 12 
 <a href="https://github.com/N3Roaster/typica">GitHub</a>.</p>

+ 5
- 0
web/src/pages/index.m4 View File 

@@ -20,6 +20,11 @@ and filter features, and more. This also marks the first release
20 20 
 that includes a translation of the program to another language.
21 21 
 People using a computer with German locale settings will see that.</p>
22 22
23 
+<p>The following video goes over some of the most useful changes
24 
+that were introduced in Typica 1.7 and how to use those.</p>
25 
+
26 
+<iframe width="640" height="360" src="https://www.youtube.com/embed/na6_ny0PaIA" frameborder="0" allowfullscreen></iframe>
27 
+
23 28 
 <h1>Data Acquisition</h1>
24 29 
 <p>Every batch of coffee you roast with Typica can be recorded for
25 30 
 future reference. A practically unlimited number of target roast

Write Preview
Loading…
Cancel
Save