|
@@ -0,0 +1,202 @@
|
|
1
|
+<html>
|
|
2
|
+ <head>
|
|
3
|
+ <title>Typica - The Logging View</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>The Logging View</h1>
|
|
24
|
+ <p>The appearance of the logging view depends on how the selected
|
|
25
|
+ roaster was configured, but there are a few main areas where
|
|
26
|
+ different interface items are located.</p>
|
|
27
|
+
|
|
28
|
+ <img src="logging.png"/>
|
|
29
|
+
|
|
30
|
+ <p>The window title will change to reflect a loaded target roast
|
|
31
|
+ profile and can provide the name of the coffee being roasted.</p>
|
|
32
|
+
|
|
33
|
+ <p>The menu bar provides access to a number of operations such
|
|
34
|
+ as saving or loading data on disk, entering new batch information,
|
|
35
|
+ clearing recorded data, changing how data is displayed, and more.
|
|
36
|
+ Note that on a Mac the menu bar will be at the top of the screen
|
|
37
|
+ and not within the window as is normal on that platform.</p>
|
|
38
|
+
|
|
39
|
+ <p>Continuing down the window is the indicator panel. This is
|
|
40
|
+ where current temperature indicators, rate of change information,
|
|
41
|
+ and timers will be displayed. The number, type, and order of
|
|
42
|
+ indicators depends on the roaster configuration. There are
|
|
43
|
+ splitter handles between each indicator which can be used to
|
|
44
|
+ control the width of each indicator. The last indicator should
|
|
45
|
+ always be the batch timer. If you don't see this, there should
|
|
46
|
+ be a splitter handle to the right of the last visible indicator
|
|
47
|
+ which can be dragged left to reveal additional indicators. A
|
|
48
|
+ splitter handle at the bottom can be used to control the height
|
|
49
|
+ of all indicators.</p>
|
|
50
|
+
|
|
51
|
+ <p>Next is a row of buttons. At minimum this will include buttons
|
|
52
|
+ for starting and stopping the batch, but a number of other
|
|
53
|
+ controls for inserting notes in the log can also be configured
|
|
54
|
+ to appear here. Under these buttons is another splitter handle
|
|
55
|
+ that can be used to control the height of to table and graph
|
|
56
|
+ below.</p>
|
|
57
|
+
|
|
58
|
+ <p>Below this and on the left is a table view showing times,
|
|
59
|
+ temperatures, and notes for both a target profile if one is
|
|
60
|
+ loaded and the current batch if one is being recorded.</p>
|
|
61
|
+
|
|
62
|
+ <p>To the right of the table view is a graph showing both
|
|
63
|
+ loaded target profiles, if any, and current batch data.</p>
|
|
64
|
+
|
|
65
|
+ <h2>Buttons</h2>
|
|
66
|
+
|
|
67
|
+ <h3>Start Batch</h3>
|
|
68
|
+ <p>This button starts recording roasting data. If the New Batch
|
|
69
|
+ or New Sample Batch windows were used, the roasting data can be
|
|
70
|
+ associated with a batch in the database. Clicking this will
|
|
71
|
+ also start the batch timer from 00:00, start any other timers
|
|
72
|
+ that have been configured to start from the start of the batch,
|
|
73
|
+ and create any annotations that have been configured for entry
|
|
74
|
+ at the start of the batch if any.</p>
|
|
75
|
+
|
|
76
|
+ <h3>Stop Batch</h3>
|
|
77
|
+ <p>This button stops the batch timer, stops recording roasting
|
|
78
|
+ data, and if the New Batch or New Sample Batch windows were
|
|
79
|
+ used, the window with data associated with the finished batch
|
|
80
|
+ will be raised.</p>
|
|
81
|
+
|
|
82
|
+ <h3>Additional Buttons</h3>
|
|
83
|
+ <p>Additional buttons and controls will appear if these have
|
|
84
|
+ been configured.</p>
|
|
85
|
+
|
|
86
|
+ <h2>The File Menu</h2>
|
|
87
|
+
|
|
88
|
+ <img src="loggingfile.png" />
|
|
89
|
+
|
|
90
|
+ <h3>Open...</h3>
|
|
91
|
+ <p>This can be used to load roasting data previously saved to
|
|
92
|
+ disk. This is mainly useful when receiving roasting data that
|
|
93
|
+ has been shared from another roaster. In normal use it is much
|
|
94
|
+ better to use information saved to the database instead of
|
|
95
|
+ managing files manually.</p>
|
|
96
|
+
|
|
97
|
+ <h3>Save...</h3>
|
|
98
|
+ <p>This can be used to save roasting data to disk. This is
|
|
99
|
+ mainly useful to share roasting data with another person using
|
|
100
|
+ Typica. For other uses it is much better to use the New Batch
|
|
101
|
+ and New Sample Batch windows to have roasting data saved to the
|
|
102
|
+ database.</p>
|
|
103
|
+
|
|
104
|
+ <h3>Print...</h3>
|
|
105
|
+ <p>This can be used to print roasting data. The print window
|
|
106
|
+ will appear, allowing the information printed to be
|
|
107
|
+ customized.</p>
|
|
108
|
+
|
|
109
|
+ <h3>Export CSV...</h3>
|
|
110
|
+ <p>This can be used to export roasting data as a CSV file which
|
|
111
|
+ can be opened in all popular spreadsheet applications or used
|
|
112
|
+ with a wide variety of other tools. If this is something that
|
|
113
|
+ you frequently require, it may be a good idea to reach out to
|
|
114
|
+ the author with your use case and see if there is a way to do
|
|
115
|
+ what you want within Typica or if Typica should be extended to
|
|
116
|
+ support your use case.</p>
|
|
117
|
+
|
|
118
|
+ <h3>Export XHTML+SVG</h3>
|
|
119
|
+ <p>This can be used to produce the same information that can be
|
|
120
|
+ printed, but produces that as an XHTML+SVG document.</p>
|
|
121
|
+
|
|
122
|
+ <h3>Quit</h3>
|
|
123
|
+ <p>On some platforms this might be called Exit and on the Mac
|
|
124
|
+ this will be moved under the Typica menu. It is used to quit
|
|
125
|
+ Typica.</p>
|
|
126
|
+
|
|
127
|
+ <h2>The Batch Menu</h2>
|
|
128
|
+
|
|
129
|
+ <img src="loggingbatch.png" />
|
|
130
|
+
|
|
131
|
+ <h3>New Batch...</h3>
|
|
132
|
+ <p>This is the preferred way to enter the details of a
|
|
133
|
+ production roast such that recorded roasting data can be
|
|
134
|
+ associated with a batch and green coffee inventory can be
|
|
135
|
+ adjusted. Selecting this will open the New Batch window.</p>
|
|
136
|
+
|
|
137
|
+ <h3>New Sample Batch...</h3>
|
|
138
|
+ <p>When roasting a green coffee not in inventory such as
|
|
139
|
+ pre-purchase samples, you can use this menu item to open the
|
|
140
|
+ New Sample Batch window and associate the roasting data with
|
|
141
|
+ additional information about the coffee.</p>
|
|
142
|
+
|
|
143
|
+ <h3>Load Additional Profiles...</h3>
|
|
144
|
+ <p>If you do not have a target roast profile for the roasted
|
|
145
|
+ coffee item you are producing but have a batch that you would
|
|
146
|
+ like to have available for reference previously saved in the
|
|
147
|
+ database, you can use this menu item to load that information
|
|
148
|
+ as a target roast profile.</p>
|
|
149
|
+
|
|
150
|
+ <h2>The Log Menu</h2>
|
|
151
|
+
|
|
152
|
+ <img src="logginglog.png" />
|
|
153
|
+
|
|
154
|
+ <h3>Display Celsius</h3>
|
|
155
|
+ <p>This menu item can be used to change displayed temperature
|
|
156
|
+ measurements to Celsius.</p>
|
|
157
|
+
|
|
158
|
+ <h3>Display Fahrenheit</h3>
|
|
159
|
+ <p>This menu item can be used to change displayed temperature
|
|
160
|
+ measurements to Fahrenheit.</p>
|
|
161
|
+
|
|
162
|
+ <h3>New Sample Parameters</h3>
|
|
163
|
+ <p>If a Counting Button has been configured, this menu item
|
|
164
|
+ will be available to change the annotation text or reset the
|
|
165
|
+ number used in annotations when that button is activated.</p>
|
|
166
|
+
|
|
167
|
+ <h3>Clear Log</h3>
|
|
168
|
+ <p>This menu item removes all information currently visible in
|
|
169
|
+ the table and graph views.</p>
|
|
170
|
+
|
|
171
|
+ <h3>Millisecond View</h3>
|
|
172
|
+ <h3>1 Second View</h3>
|
|
173
|
+ <h3>5 Second View</h3>
|
|
174
|
+ <h3>10 Second View</h3>
|
|
175
|
+ <h3>15 Second View</h3>
|
|
176
|
+ <h3>30 Second View</h3>
|
|
177
|
+ <h3>1 Minute View</h3>
|
|
178
|
+
|
|
179
|
+ <p>These items affect the table view. The millisecond view will
|
|
180
|
+ show every measurement in the table while the other views will
|
|
181
|
+ limit the entries shown to one per indicated interval with the
|
|
182
|
+ exception of times associated with an annotation which will
|
|
183
|
+ always be shown regardless of the selected view.</p>
|
|
184
|
+
|
|
185
|
+ <h3>Manual Entry</h3>
|
|
186
|
+ <p>This can be used for entering roasting data collected when
|
|
187
|
+ not connected to a roaster. The utility of this feature is
|
|
188
|
+ somewhat limited and generally not worth using.</p>
|
|
189
|
+
|
|
190
|
+ <h2> The Graph Menu</h2>
|
|
191
|
+
|
|
192
|
+ <img src="logginggraph.png" />
|
|
193
|
+
|
|
194
|
+ <h3>Reset Translation</h3>
|
|
195
|
+ <p>If the roaster in use has been configured to use roast
|
|
196
|
+ profile translation, this item can be used to reset any
|
|
197
|
+ currently applied translation transformation in the graph.</p>
|
|
198
|
+
|
|
199
|
+ </div>
|
|
200
|
+ </div>
|
|
201
|
+ </body>
|
|
202
|
+</html>
|