Browse Source

Add FAQ to documentation

Neal Wilson 8 years ago
parent
commit
ed10c78118

+ 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>

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

@@ -0,0 +1,59 @@
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
+                
40
+                <h2>How can I support further development of Typica?</h2>
41
+                <p>Checks payable to Neal Wilson can be sent to</p>
42
+                <p>Neal Wilson<br />
43
+                C/O Wilson's Coffee &amp; Tea<br />
44
+                3306 Washington Ave.<br />
45
+                Racine, WI 53405<br />
46
+                USA</p>
47
+                <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>
48
+                <p>It is also possible to <a href="mailto:roaster@wilsonscoffee.com">hire me for training at your company</a>.</p>
49
+                
50
+                <h2>Why can't I see the batch timer?</h2>
51
+                <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>
52
+                
53
+                <h2>Can databases other than PostgreSQL be used with Typica?</h2>
54
+                <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>
55
+
56
+            </div>
57
+        </div>
58
+    </body>
59
+</html>

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

@@ -41,7 +41,7 @@
41 41
 							<li><a href="dataentry.html#profiles">Saving and Using Target Roast Profiles</a></li>
42 42
 						</ul>
43 43
 					</ul>
44
-					<li><a>Tips, Tricks, and Frequently Asked Questions</a></li>
44
+					<li><a href="faq.html">Tips, Tricks, and Frequently Asked Questions</a></li>
45 45
 				</ul>
46 46
 				<p>This part of the documentation covers the things you should
47 47
 				know before starting to use Typica and the basics of getting

+ 1
- 0
docs/documentation/platforms.html View File

@@ -87,6 +87,7 @@
87 87
 				install driver software before this adapter will work correctly.
88 88
 				Consult the manuals for your hardware for more details.</p>
89 89
 				
90
+				<a name="compatability" />
90 91
 				<h2>Hardware Compatability Table</h2>
91 92
 				<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>
92 93
 				<table>

Loading…
Cancel
Save