Explorar el Código

Add documentation.

Neal Wilson hace 11 años
padre
commit
27b1e0ce3f

+ 102
- 0
docs/documentation.html Ver fichero

@@ -0,0 +1,102 @@
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 class="tab" href="involvement.html" >Get Involved</a>
20
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
21
+				</div>
22
+			</div>
23
+			<div id="maintext">
24
+				<p>Typica documentation is currently a work in progress. Once
25
+				finished it will be divided into three parts. Part 1
26
+				details what hardware can be used with Typica, how to set up
27
+				supporting software, and how to get started using Typica.
28
+				Everybody setting up Typica for the first time should read at
29
+				least the Supported Platforms and Hardware section
30
+				<em>before</em> buying hardware they intend to use with this
31
+				software. People who have used Typica previously may still want
32
+				to skim this section and read Configuring Typica for your
33
+				Hardware in detail. The Tips, Tricks, and Frequently Asked
34
+				Questions section may also be particularly useful.</p>
35
+				<p>Part 2 covers every feature of Typica in detail. This can be
36
+				read at your leisure and contains information that can help you
37
+				use Typica more effectively. If you have a question about how a
38
+				particular feature works, this is the place to look.</p>
39
+				<p>Part 3 is material that most people will never need to look
40
+				at. It provides all of the documentation you might want to have
41
+				if you intend to customize Typica to add new features or if you
42
+				intend to write another program that is interoperable with
43
+				Typica. The chapter documenting the database may also be useful
44
+				for those who want to obtain information that Typica does not
45
+				expose in exactly the way you'd like.</p>
46
+				<ul>
47
+					<li><a href="documentation/part1.html">Part 1: Basic Setup and Use</a></li>
48
+					<ul>
49
+						<li><a href="documentation/platforms.html">Supported Platforms and Hardware</a></li>
50
+						<li><a href="documentation/requiredsoftware.html">Required Software</a></li>
51
+						<li><a>Initial Setup</a></li>
52
+						<ul>
53
+							<li><a href="documentation/firsttime.html">Running Typica for the First Time</a></li>
54
+							<ul>
55
+								<li><a href="documentation/firsttime.html#database">Database Connection</a></li>
56
+								<li><a href="documentation/firsttime.html#configfile">Open Configuration File</a></li>
57
+								<li><a href="documentation/firsttime.html#hardware">Configuring Typica for your Hardware</a></li>
58
+							</ul>
59
+							<li><a>Initial Data Entry</a></li>
60
+							<ul>
61
+								<li><a>Green Coffee Purchases</a></li>
62
+								<li><a>Roasted Coffee Items</a></li>
63
+								<li><a>An Initial Inventory</a></li>
64
+								<li><a>Saving and Using Target Roast Profiles</a></li>
65
+							</ul>
66
+						</ul>
67
+						<li><a>Tips, Tricks, and Frequently Asked Questions</a></li>
68
+					</ul>
69
+					<li><a>Part 2: Comprehensive Feature Documentation</a></li>
70
+					<ul>
71
+						<li><a>Database Connection Settings</a></li>
72
+						<li><a>Choosing Your Configuration</a></li>
73
+						<li><a>The Main Navigation Window</a></li>
74
+						<li><a>Configure Roasters</a></li>
75
+						<li><a>Roast Coffee</a></li>
76
+						<li><a>Purchase Green Coffee</a></li>
77
+						<li><a>Manage Roasted Coffee Items</a></li>
78
+						<li><a>Update Inventory</a></li>
79
+						<li><a>Batch Log</a></li>
80
+						<li><a>Cupping</a></li>
81
+						<li><a>Import Target Roast Profiles</a></li>
82
+						<li><a>Invoice List</a></li>
83
+						<li><a>Enter Green Coffee Sales</a></li>
84
+						<li><a>Reports</a></li>
85
+					</ul>
86
+					<li><a>Part 3: Interoperability Specifications</a></li>
87
+					<ul>
88
+						<li><a>File Format Documentation</a></li>
89
+						<li><a>Database Documentation</a></li>
90
+						<li><a>Configuration XML Documentation</a></li>
91
+						<li><a>Configuration Script Documentation</a></li>
92
+					</ul>
93
+				</ul>
94
+				<p>Until the relevant portions of the current documentation are
95
+				finished, some may wish to consult the documentation for earlier
96
+				versions of Typica. This includes the
97
+				<a href="userguide.html">old user guide</a> and
98
+				the <a href="windows.html">old Windows installation instructions</a>.
99
+			</div>
100
+		</div>
101
+	</body>
102
+</html>

+ 306
- 0
docs/documentation/firsttime.html Ver fichero

@@ -0,0 +1,306 @@
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" href="../documentation.html" >Documentation</a>
18
+					<a class="tab" href="../screenshots.html" >Screenshots and Videos</a>
19
+					<a class="tab" href="../involvement.html" >Get Involved</a>
20
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
21
+				</div>
22
+			</div>
23
+			<div id="maintext">
24
+				<ul>
25
+					<li><a href="#database">Database Connection</a></li>
26
+					<li><a href="#configfile">Open Configuration File</a></li>
27
+					<li><a href="#hardware">Configuring Typica for your Hardware</a></li>
28
+				</ul>
29
+			
30
+				<h1>Running Typica for the First Time</h1>
31
+				
32
+				<p>After downloading Typica and extracting the contents of the .zip (Microsoft Windows) or
33
+				copying the contents of the .dmg (Mac OS X) to a more convenient location, you should have
34
+				a folder that contains three other folders. The <tt>source</tt> folder contains all of
35
+				the source code for Typica which you may use if you want to modify the software. This
36
+				folder also contains a file called <tt>typica.pdf</tt> which has complete documentation
37
+				of how Typica works (not how to use Typica). You do not need to read that to use Typica,
38
+				but you may still find it interesting. The contents of this folder are not required to
39
+				run Typica and may be deleted if you have no use for it. The <tt>configuration</tt> folder
40
+				contains an example configuration for Typica to use. These files can be modified to perform
41
+				extensive customization of Typica or to add or remove reports if you want to change how
42
+				Typica works, however most do not have a need to modify any of these files. Typica requires
43
+				that the contents of this directory exist for proper operation. The <tt>program</tt> folder
44
+				contains the Typica executable and its library dependencies. On Mac OS X this is instead
45
+				all collected in an .app bundle.</p>
46
+				
47
+				<p>Find either Typica.exe (Microsoft Windows) or Typica.app (Mac OS X) and double click
48
+				to open the program.</p>
49
+				
50
+				<img src="images/explorer.png" />
51
+				
52
+				<a name="database" />
53
+				<h2>Database Connection</h2>
54
+				
55
+				<img src="images/dbconnect.png" />
56
+				
57
+				<p>The first time you start Typica, you will be asked for the information needed to
58
+				connect to a database. If you have not installed PostgreSQL, you can click Cancel to
59
+				continue without connecting to a database. Note that doing so will result in Typica
60
+				having a very limited feature set. If you have installed PostgreSQL on the same
61
+				computer as Typica, the host name should be set to <tt>localhost</tt>. If PostgreSQL
62
+				is running on a different computer you will need to specify the IP address of that
63
+				computer.</p>
64
+				
65
+				<p>If you have set up a database for Typica to use, the name of that database
66
+				should be set as the database name, otherwise the PostgreSQL installer creates a
67
+				database named <tt>postgres</tt> which you can use.</p>
68
+				
69
+				<p>Similarly, if you have created a new database
70
+				user role for Typica, the user name and password that you chose for this should be
71
+				entered as the user name and password here. Otherwise, the PostgreSQL installer creates
72
+				a user named <tt>postgres</tt> with the password that you chose during the installation
73
+				process.</p>
74
+				
75
+				<p>Once all of this has been entered, click Connect.</p>
76
+				
77
+				<p>You only need to enter this information the first time you start Typica. It will
78
+				not prompt for this information in the future unless Typica fails to connect to the
79
+				database or unless you select a menu item that instructs Typica to forget the
80
+				connection settings.</p>
81
+				
82
+				<h3>Troubleshooting: What if it Doesn't Work?</h3>
83
+				
84
+				<p>The problem is <em>not</em> with Typica. If you are running PostgreSQL on the same
85
+				computer as you are running Typica, you have most likely typed something incorrectly.
86
+				You can use the SQL Shell (psql) to verify that your login information is correct. If
87
+				you can connect on port 5432, the same information used to connect with psql will also
88
+				be usable with Typica. Another possibility is that PostgreSQL is not currently running.
89
+				If you are running PostgreSQL on a different computer, make sure that the other computer
90
+				is turned on, that PostgreSQL is running, and that it is configured to accept connections
91
+				from the network.</p>
92
+				
93
+				<a name="configfile" />
94
+				<h2>Open Configuration File</h2>
95
+				
96
+				<p>Every time you open Typica, you will be asked to open a configuration file. Typica
97
+				comes with one example configuration file that meets most needs, however you can
98
+				create your own if you have special requirements. This documentation assumes that you
99
+				are using the provided example configuration.</p>
100
+				
101
+				<p>The first time you start Typica or when using a new version of Typica for the first
102
+				time, you may find that this prompt shows files in the wrong directory. Typica will show
103
+				files from the most recently used directory or if there isn't one, a platform dependent
104
+				default.</p>
105
+				
106
+				<img src="images/config1.png" />
107
+				
108
+				<p>This is a normal Open File window which works the same as when you select the Open
109
+				menu item in most programs. A number of controls are available to change to the correct
110
+				directory. You want to be in the <tt>configuration</tt> folder described previously.</p>
111
+				
112
+				<img src="images/config2.png" />
113
+				
114
+				<p>Once you are in the correct directory, select <tt>config.xml</tt> and click Open.</p>
115
+				
116
+				<img src="images/config3.png" />
117
+				
118
+				</p>The next window you see should look like this:</p>
119
+				
120
+				<img src="images/nav.png" />
121
+				
122
+				<h3>Troubleshooting: It Opened Internet Explorer and is showing me gobbledygook.</h3>
123
+				
124
+				<p>If this happens, you were not selecting the configuration file from within Typica.
125
+				Go back to Typica and try again. In particular, note the title bar of the window you
126
+				are in. See the screenshots above where it says "Open Configuration File". If your
127
+				window doesn't say that, you're not in Typica. You may think you are, but you're wrong.</p>
128
+				
129
+				<h3>Troubleshooting: I opened a file and nothing is happening.</h3>
130
+				
131
+				<p>Exit Typica and try again. You most likely selected the wrong file to open. Please
132
+				go back to the description of which file is required, read the instructions, and follow
133
+				them carefully.</p>
134
+				
135
+				<h3>Tip: Bypass the Configuration Prompt</h3>
136
+				
137
+				<p>Typica has a command line option available for specifying which configuration file
138
+				should be used. To do this, use -c and the path to the configuration you want to open.
139
+				This will prevent the configuration prompt from appearing. On Microsoft Windows, you
140
+				can do this by creating a shortcut. In Windows Explorer, go to the directory containing
141
+				Typica.exe. Right click and select "Create shortcut".</p>
142
+				
143
+				<img src="images/shortcut.png" />
144
+				
145
+				<p>Now right click the shortcut and select Properties.</p>
146
+				
147
+				<img src="images/properties.png" />
148
+				
149
+				<p>Find the field labeled Target. At the end of the line after the quotation mark, add
150
+				a space and <tt>-c ../configuration/config.xml</tt> and click OK. The portion of the
151
+				line that reads <tt>../configuration/config.xml</tt> is the path to your desired
152
+				configuration file relative to the directory with the program. You can also use an
153
+				absolute path to the file starting with <tt>C:\</tt> on Microsoft Windows or <tt>/</tt>
154
+				on other platforms.</p>
155
+				
156
+				<h3>Tip: Pin the Shortcut for Convenient Access</h3>
157
+				
158
+				<p>The shortcut created in the previous tip can be moved anywhere for convenient
159
+				access. You can right click that and find options to pin that to the task bar for
160
+				convenient single click access. On Windows 7 you can also pin that to the start menu
161
+				and on Windows 8 you can pin that to the start screen.</p>
162
+				
163
+				<a name="hardware" />
164
+				<h2>Configuring Typica for your Hardware</h2>
165
+				
166
+				<h3>Hardware</h3>
167
+				
168
+				<p>Once you've started Typica and selected your configuration file, you should see
169
+				the main navigation window. It looks like this:</p>
170
+				
171
+				<img src="images/nav.png" />
172
+				
173
+				<p>The first time you use Typica you will not have any coffee roasters configured
174
+				for use. This also applies for people who have used older versions of Typica and are
175
+				now upgrading to version 1.4 or later. To do this, click the Configure Roasters button.
176
+				This will bring up a new window with two panels. In the lower left you will see a
177
+				button labeled +. Click that to add your first coffee roaster.</p>
178
+				
179
+				<p>Now you will see an item in the left panel. You can double click on that to
180
+				rename it if you want. Whatever you name this is what will appear in the list in
181
+				the navigation window. Choose a name that you'll recognize as the particular machine
182
+				you'll be using.</p>
183
+				
184
+				<p>When you click on the roaster in the left panel you will see some details in the
185
+				right panel.</p>
186
+				
187
+				<img src="images/rconfig1.png" />
188
+				
189
+				<p>Next to "Machine ID for database" you should enter a number. This ID number will
190
+				be used to identify this roaster in the database and it will be associated with every
191
+				batch of coffee you roast. If you have used an older version of Typica, you can use
192
+				the same number that you had specified previously to maintain continuity. If you are
193
+				setting up Typica for the first time, just use 1 for your first roaster, 2 for your
194
+				second, and so on.</p>
195
+				
196
+				<p>You will also see three buttons: "Add Device", "Add Annotation Control", and
197
+				"Advanced Features". First we will want to use the Add Device button to specify the
198
+				data acquisition hardware you will use to connect this coffee roaster to your
199
+				computer.</p>
200
+				
201
+				<p>You should see up to three items in a menu when you click "Add Device". Select
202
+				the one matching the hardware that you intend to use. You will find a new item on
203
+				the left matching your selection.</p>
204
+				
205
+				<p>In the case of NI-DAQmx Base or NI-DAQmx, clicking the new item in the left panel
206
+				will change the right panel to display a single button: "Add Device". Click this to
207
+				see a list of supported hardware and click the item that matches the hardware you
208
+				have. In the case of NI-DAQmx, you can select "NI USB 9211A" for any supported USB
209
+				carrier containing a NI 9211 module. Whichever you choose, you will have a new item on
210
+				the left.</p>
211
+				
212
+				<p>If you instead selected "Modbus RTU Device", you will want to connect the hardware
213
+				to your computer before continuing. Once you click the new item in the left panel
214
+				Typica will attempt to detect any serial port on your computer and if your RS-485 to
215
+				USB serial adapter is not connected, it will not be shown. Click the item and you
216
+				will see all of the details for configuring Typica to use your Modbus RTU device.</p>
217
+				
218
+				<img src="images/modbusconfig.png" />
219
+				
220
+				<p>The appropriate settings here depend on settings that must be configured on the
221
+				Modbus RTU device and they depend on which device you have. You will require both
222
+				the operator manual and the communications manual for your device to determine the
223
+				correct settings for your hardware.</p>
224
+				
225
+				<p>If you selected NI DAQmx and then NI USB TC01, you will have an item on the
226
+				left representing that device. Clicking this will show three settings.</p>
227
+				
228
+				<img src="images/tc01config.png" />
229
+				
230
+				<p>The Device ID is how the National Instruments software identifies the device. In
231
+				the case of this hardware, this will be Dev<em>n</em> where <em>n</em> is some number.
232
+				This will most likely be <tt>Dev1</tt> but you can verify this in National Instrument's
233
+				Measurement & Automation Explorer. The Column Name indicates the name of the column
234
+				where measurements from this device will be placed in the table view of your roasting
235
+				data. A short, one word identifier is recommended for this. Note that certain advanced
236
+				features will require knowing a column name. The Thermocouple Type should match the type
237
+				of thermocouple you have in your roaster. If the wrong thermocouple type is specified,
238
+				your measurements will not be correct. Finally, if you double click this item on the
239
+				left, you can rename it. Whatever the item is named on the left is what will be displayed
240
+				on the indicator showing the most recent measurement. This can be a longer descriptive
241
+				name.</p>
242
+				
243
+				<p>In the case of NI 9211 based devices used either through NI DAQmx or NI DAQmx Base,
244
+				clicking the new item on the left will show a Device ID field and an Add Channel button.
245
+				If you are using NI DAQmx Base, this will be Dev<em>n</em> where <em>n</em> is a number
246
+				starting with 1 for the first connected device. If you only have one device, this will
247
+				be <tt>Dev1</tt>. If you are using NI DAQmx, some hardware will follow this convention
248
+				and some will not. You should check for the appropriate device ID in Measurement &
249
+				Automation Explorer. Ensure that you are looking at the item representing the device
250
+				itself and not just the chassis the device is plugged into. Once the Device ID is
251
+				specified, you can click Add Channel to add as many thermocouple channels as you have
252
+				connected to this device. With this hardware it is recommended that you do not connect
253
+				more than three thermocouples to a single device and these should be wired starting
254
+				from TC0.</p>
255
+				
256
+				<p>For each channel, you can double click the item on the left to change the text that
257
+				will appear in the indicator showing the most recent measurement. When you click on
258
+				these you will see on the right settings for Column Name and Thermocouple Type. The
259
+				Column Name will appear at the top of the table view in the column where measurements
260
+				from this channel are placed. A short one word name is recommended. This name should
261
+				be unique across all channels configured for a particular roaster. The thermocouple
262
+				type must match the type of the thermocouple connected on that channel. If it does not,
263
+				your measurements will not be correct.</p>
264
+				
265
+				<h3>Annotation Controls</h3>
266
+				
267
+				<p>If you click the item on the left representing your roaster, one of the available
268
+				buttons is "Add Annotation Control". Clicking this will provide three options:
269
+				"Annotation Button", "Counting Button", and "Numeric Entry". These controls can be
270
+				used to add annotations to your roasting data as you roast. If you don't want to do
271
+				this, you don't need to add any of these controls.</p>
272
+				
273
+				<p>An Annotation Button is used to make note of an event fixed at a particular moment
274
+				in time. If your roaster has a control with a small number of states, you can have a
275
+				different button for each state and when you activate that button it will place a
276
+				note at the most recent measurement. Some use this to note airflow control changes,
277
+				some prefer to note details such as the start of first crack. Clicking the item on the
278
+				left representing your annotation button will show two settings on the right. The
279
+				Button Text is the text that will appear on the button and the Annotation Text is the
280
+				text that will appear in the log when the button is activated. You can have any number
281
+				of these buttons, but it is recommended to keep the number small.</p>
282
+				
283
+				<p>A Counting Button is like an Annotation Button but you can have as part of the
284
+				annotation text a number corresponding to the number of times the button has been
285
+				clicked. This is useful when pulling several samples from a roast for roast profile
286
+				development as you will have a unique identifier for each sample you pull which you
287
+				can reference later when attempting to replicate your desired roast. It is recommended
288
+				that you only have one Counting Button.</p>
289
+				
290
+				<img src="images/countconfig.png" />
291
+				
292
+				<p>Numeric Entry provides a way to provide notes with numeric data that cannot be
293
+				logged automatically. Some roasters have fuel or air flow controls with a large number
294
+				of numerically identified settings. Some people may want to occassionally note the
295
+				reading from a manometer. This is the control to do that. Clicking the item representing
296
+				a Numeric Entry on the left will show several options allowing you to specify how the
297
+				field is identified on the screen, minimum and maximum values, and the number of places
298
+				after the decimal point to allow. All of these must be set to some value. Optionally you
299
+				can also specify prefix text and/or suffix text. The content of these fields will be
300
+				included in the annotation before or after the entered number. This can be used to make
301
+				clear which control adjustment is represented or the unit a measurement reading was
302
+				taken in.</p>
303
+			</div>
304
+		</div>
305
+	</body>
306
+</html>

BIN
docs/documentation/images/config1.png Ver fichero


BIN
docs/documentation/images/config2.png Ver fichero


BIN
docs/documentation/images/config3.png Ver fichero


BIN
docs/documentation/images/countconfig.png Ver fichero


BIN
docs/documentation/images/dbconnect.png Ver fichero


BIN
docs/documentation/images/explorer.png Ver fichero


BIN
docs/documentation/images/modbusconfig.png Ver fichero


BIN
docs/documentation/images/nav.png Ver fichero


BIN
docs/documentation/images/properties.png Ver fichero


BIN
docs/documentation/images/rconfig1.png Ver fichero


BIN
docs/documentation/images/shortcut.png Ver fichero


BIN
docs/documentation/images/tc01config.png Ver fichero


+ 53
- 0
docs/documentation/part1.html Ver fichero

@@ -0,0 +1,53 @@
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" href="../documentation.html" >Documentation</a>
18
+					<a class="tab" href="../screenshots.html" >Screenshots and Videos</a>
19
+					<a class="tab" href="../involvement.html" >Get Involved</a>
20
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
21
+				</div>
22
+			</div>
23
+			<div id="maintext">
24
+				<h1>Part 1: Basic Setup and Use</h1>
25
+				<ul>
26
+					<li><a href="platforms.html">Supported Platforms and Hardware</a></li>
27
+					<li><a href="requiredsoftware.html">Required Software</a></li>
28
+					<li><a>Initial Setup</a></li>
29
+					<ul>
30
+						<li><a href="firsttime.html">Running Typica for the First Time</a></li>
31
+						<ul>
32
+							<li><a href="firsttime.html#database">Database Connection</a></li>
33
+							<li><a href="firsttime.html#configfile">Open Configuration File</a></li>
34
+							<li><a href="firsttime.html#hardware">Configuring Typica for your Hardware</a></li>
35
+						</ul>
36
+						<li><a>Initial Data Entry</a></li>
37
+						<ul>
38
+							<li><a>Green Coffee Purchases</a></li>
39
+							<li><a>Roasted Coffee Items</a></li>
40
+							<li><a>An Initial Inventory</a></li>
41
+							<li><a>Saving and Using Target Roast Profiles</a></li>
42
+						</ul>
43
+					</ul>
44
+					<li><a>Tips, Tricks, and Frequently Asked Questions</a></li>
45
+				</ul>
46
+				<p>This part of the documentation covers the things you should
47
+				know before starting to use Typica and the basics of getting
48
+				everything set up for use. Some of the topics are covered in
49
+				greater depth in Part 2.</p>
50
+			</div>
51
+		</div>
52
+	</body>
53
+</html>

+ 91
- 0
docs/documentation/platforms.html Ver fichero

@@ -0,0 +1,91 @@
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" href="../documentation.html" >Documentation</a>
18
+					<a class="tab" href="../screenshots.html" >Screenshots and Videos</a>
19
+					<a class="tab" href="../involvement.html" >Get Involved</a>
20
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
21
+				</div>
22
+			</div>
23
+			<div id="maintext">
24
+				<h1>Supported Platforms and Hardware</h1>
25
+				<p>This section details the hardware and software that Typica
26
+				has been tested with and what is known to work. Other
27
+				arrangements may work but have not been tested.</p>
28
+				
29
+				<h2>Operating Systems</h2>
30
+				<p>Precompiled builds of Typica are provided for Microsoft
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>
38
+				<p>Source code is provided which may be used to build Typica
39
+				on Linux, PowerPC based Macs, and possibly other platforms,
40
+				however instructions on doing this are beyond the scope of this
41
+				document.</p>
42
+				
43
+				<a name="hardware" />
44
+				<h2>Data Acquisition Hardware</h2>
45
+				<p>On Microsoft Windows and Mac OS X, the National Instruments
46
+				NI 9211 module is supported in either the
47
+				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/13880">NI USB-9161</a>
48
+				or
49
+				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/201881">NI USB-9162</a>
50
+				USB carrier using NI DAQmx Base supporting software which is
51
+				available for download from National Instruments. Note that the
52
+				different USB carriers require different versions of this software.
53
+				Using the 9161 carrier you will need
54
+				<a href="http://joule.ni.com/nidu/cds/view/p/id/428/lang/en">NI-DAQmx Base 2.1 on Mac OS X</a>
55
+				or
56
+				<a href="http://joule.ni.com/nidu/cds/view/p/id/424/lang/en">NI-DAQmx Base 2.2 on Microsoft Windows</a>.
57
+				Using the 9162 carrier, you will need
58
+				<a href="http://joule.ni.com/nidu/cds/view/p/id/3431/lang/en">NI DAQmx Base 3.6 on Mac OS X</a>
59
+				or
60
+				<a href="http://joule.ni.com/nidu/cds/view/p/id/3436/lang/en">NI DAQmx Base 3.6 on Microsoft Windows</a>.
61
+				Please check documentation
62
+				available from National Instruments regarding Linux support if you
63
+				intend to build Typica on Linux.</p>
64
+				<p>On <strong>Microsoft Windows only</strong> the National
65
+				Instruments NI 9211 module can be used with the
66
+				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/201881">NI USB-9162</a>
67
+				USB carrier or the
68
+				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/209887">NI cDAQ-9171</a>.
69
+				The
70
+				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/208177">NI USB-TC01</a>
71
+				is also an option on
72
+				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>.
74
+				Note that NI-DAQmx should not be installed at the same time as NI-DAQmx Base 3.6
75
+				however it is fine to have it installed at the same time as NI-DAQmx Base 2.2.</p>
76
+				<p>On all platforms, devices which communicate using the Modbus
77
+				RTU protocol can be used. Currently only one such device is
78
+				supported per bus and measurements must be delivered in scaled
79
+				integer representation. You will need the communications manual
80
+				for whichever device you choose in order to set up Typica. This
81
+				has been tested with the Fuji PXR4 PID controller, but most
82
+				similar devices with Modbus RTU support should also work. Typica
83
+				does not require any supporting software for this hardware,
84
+				however most of these devices use RS-485 for the physical connection
85
+				and you may need an RS-485 to USB adapter and you may need to
86
+				install driver software before this adapter will work correctly.
87
+				Consult the manuals for your hardware for more details.</p>
88
+			</div>
89
+		</div>
90
+	</body>
91
+</html>

+ 124
- 0
docs/documentation/requiredsoftware.html Ver fichero

@@ -0,0 +1,124 @@
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" href="../documentation.html" >Documentation</a>
18
+					<a class="tab" href="../screenshots.html" >Screenshots and Videos</a>
19
+					<a class="tab" href="../involvement.html" >Get Involved</a>
20
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
21
+				</div>
22
+			</div>
23
+			<div id="maintext">
24
+				<h1>Required Software</h1>
25
+				<p>Typica can benefit from certain supporting software and some
26
+				hardware requires software for communicating with that hardware.</p>
27
+				
28
+				<h2>PostgreSQL</h2>
29
+				<p>Most of the features of Typica use a PostgreSQL database.
30
+				This is where the data on all of the batches of coffee you
31
+				roast will be saved, where inventory data will be saved, and
32
+				it is the source of all data used in reports. While it is
33
+				possible to use Typica without PostgreSQL, the usable feature
34
+				set will be highly limited.</p>
35
+				
36
+				<p>The easiest way to set this up is to install PostgreSQL on
37
+				the same computer that will be running Typica, however there
38
+				are some advantages to running the database on a different
39
+				machine on the network. That requires some additional work to
40
+				set up PostgreSQL to accept connections from other computers on
41
+				your network, but this allows multiple computers to run Typica
42
+				and access the same data.</p>
43
+				
44
+				<p>PostgreSQL can be obtained from
45
+				<a href="http://www.postgresql.org">www.postgresql.org</a>.
46
+				There you can
47
+				<a href="http://www.postgresql.org/download/">download</a> the
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
54
+				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>
61
+				
62
+				<p>If you do want to set up PostgreSQL for use over a network,
63
+				you may find
64
+				<a href="http://www.postgresql.org/docs/9.2/static/auth-pg-hba-conf.html">
65
+				this section</a> of the documentation helpful.
66
+				<a href="http://appliedcoffeetechnology.tumblr.com/post/14056767756">
67
+				This blog post</a> may also be useful.</p>
68
+				
69
+				<p>Once you are finished installing and setting up PostgreSQL,
70
+				you may want to restart your computer and verify that the PostgreSQL
71
+				starts on boot.</p>
72
+				
73
+				<h3>Optional: Setting up a Database and User Role</h3>
74
+				
75
+				<p>The PostgreSQL installer will set up a user role called
76
+				<tt>postgres</tt> and a database called <postgres>. The
77
+				<tt>postgres</tt> user has full access to all features of the
78
+				database and Typica does not require that. If you are using
79
+				PostgreSQL for other purposes you may also want to give Typica
80
+				its own database to avoid potential conflicts with other
81
+				applications. Typica will use whatever database and user you
82
+				specify the first time you start the program. Details on how to
83
+				do this are in the
84
+				<a href="http://www.postgresql.org/docs/9.2/static/index.html">
85
+				PostgreSQL documentation</a>.
86
+				
87
+				<h2>Hardware Communications Software</h2>
88
+				
89
+				<p>The software that you need to communicate with your data
90
+				acquisition hardware depends on what hardware you intend to use.</p>
91
+				
92
+				<h3>Software for Modbus RTU device support</h3>
93
+				
94
+				<p>No additional software is strictly required for devices that
95
+				communicate using the Modbus RTU protocol. Most of these devices
96
+				are connected with RS-485, which is not a standard you are likely
97
+				to find built into your computer so you will most likely need
98
+				an adapter that allows you to connect the bus to your computer
99
+				through a USB connection. Your computer should see this adapter
100
+				as an ordinary serial port, however you may need to install
101
+				driver software for the adapter you choose. Ensure that the
102
+				adapter is supported on whatever platform you intend to use.</p>
103
+				
104
+				<h3>NI DAQmx Devices - Microsoft Windows Only</h3>
105
+				
106
+				<p>Certain hardware from National Instruments requires
107
+				NI-DAQmx. Typica has been tested with version 9.6.1. See
108
+				<a href="platforms.html#hardware">Supported Platforms and Hardware</a>
109
+				for more details.</p>
110
+				
111
+				<h3>NI DAQmx Base Devices</h3>
112
+				
113
+				<p>Certain hardware from National Instruments requires NI-DAQmx Base.
114
+				The version you will need depends on the hardware you have. See
115
+				<a href="platforms.html#hardware">Supported Platforms and Hardware</a>
116
+				for more details.</p>
117
+				
118
+				<h2>Typica</h2>
119
+				
120
+				<p>You will also need to download Typica to be able to use Typica.</p>
121
+			</div>
122
+		</div>
123
+	</body>
124
+</html>

+ 18
- 0
docs/logo.svg Ver fichero

@@ -0,0 +1,18 @@
1
+<?xml version="1.0" standalone="yes"?>
2
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
3
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewbox="0 0 512 512" width="512px" height="512px">
4
+	<title>Typica application icon</title>
5
+	<defs>
6
+		<radialGradient id="orangeradial" gradientUnits="userSpaceOnUse" cx="288" cy="288" r="320" fx="320" fy="320" spreadMethod="pad">
7
+			<stop offset="0%" stop-color="orangered" />
8
+			<stop offset="100%" stop-color="white" />
9
+		</radialGradient>
10
+		<radialGradient id="flame" gradientUnits="userSpaceOnUse" cx="192" cy="320" r="224" fx="224" fy="352" spreadmethod="pad">
11
+			<stop offset="65%" stop-color="royalblue" />
12
+			<stop offset="100%" stop-color="aliceblue" />
13
+		</radialGradient>
14
+	</defs>
15
+	<path d="M416 32 L416 480 L32 480 L32 480 L32 96 A64 64 0 0 1 96 32 Z" stroke="orangered" stroke-width="1" fill="url(#orangeradial)" />
16
+	<path d="M32 384 L160 128 L480 288 L384 480 L32 480 Z" stroke="orangered" stroke-width="1" fill="aliceblue" />
17
+	<path d="M64 352 C64 448 352 448 352 352 Q352 320 288 256 C224 192 224 160 288 96 C192 96 64 288 64 352" stroke="royalblue" fill="url(#flame)" stroke-width="1" />
18
+</svg>

BIN
docs/logo96.png Ver fichero


+ 91
- 0
docs/style.css Ver fichero

@@ -0,0 +1,91 @@
1
+.active {
2
+	background-attachment: scroll;
3
+	background-clip: border-box;
4
+	background-color: rgb(255,255,255);
5
+	background-image: none;
6
+	background-origin: padding-box;
7
+	border-bottom-color: rgb(0,0,0);
8
+	border-bottom-style: none;
9
+	border-bottom-width: 0px;
10
+	border-left-color: rgb(107,144,218);
11
+	border-left-style: solid;
12
+	border-left-width: 1px;
13
+	border-right-color: rgb(107,144,218);
14
+	border-right-width: 1px;
15
+	border-right-style: solid;
16
+	border-top-color: rgb(107,144,218);
17
+	border-top-width: 2px;
18
+	border-top-style: solid;
19
+	color: rgb(0,0,0);
20
+	margin-left: 0px;
21
+	margin-right: 5px;
22
+	margin-top: 0px;
23
+	margin-bottom: -1px;
24
+	padding-bottom: 6px;
25
+	padding-left: 9px;
26
+	padding-right: 9px;
27
+	padding-top: 5px;
28
+	text-decoration: none;
29
+	white-space: nowrap;
30
+}
31
+.tab {
32
+	color: rgb(0,0,204);
33
+	margin-bottom: 6px;
34
+	margin-left:  10px;
35
+	margin-right: 15px;
36
+	margin-top: 5px;
37
+	padding-top: 5px;
38
+	white-space: nowrap;
39
+	text-decoration: none;
40
+}
41
+#menu {
42
+	background-color: rgb(235,239,249);
43
+	border-bottom-color: rgb(107,144,218);
44
+	border-bottom-style: solid;
45
+	border-bottom-width: 1px;
46
+	padding-bottom: 5px;
47
+	padding-left: 5px;
48
+	padding-right: 10px;
49
+	padding-top: 5px;
50
+	white-space: nowrap;
51
+	background-clip: border-box;
52
+}
53
+body {
54
+	background-color: rgb(235,239,249);
55
+}
56
+#page {
57
+	background-color: rgb(255,255,255);
58
+}
59
+h1 {
60
+	font-size: 24px;
61
+}
62
+#topbanner {
63
+	background-color: rgb(235,239,249);
64
+	height: 96px;
65
+	margin-bottom: 2px;
66
+}
67
+#topbanner img {
68
+	float: left;
69
+}
70
+#topbanner h1 {
71
+	padding-top: 20px;
72
+	padding-bottom: 0px;
73
+	margin-bottom: 0px;
74
+}
75
+h2 {
76
+	font-size: 20px;
77
+	padding-top: 0px;
78
+	padding-bottom: 0px;
79
+	margin-top: 0px;
80
+}
81
+#topmatter {
82
+	background-color: rgb(235,239,249);
83
+}
84
+#maintext {
85
+	margin-left: 10px;
86
+	margin-right: 10px;
87
+	padding-bottom: 10px;
88
+}
89
+li {
90
+	list-style-type: none;
91
+}

Loading…
Cancelar
Guardar