many updates to menu drives and documentation
[openmag.git] / doc / DUSIDatasheet.texi
blobeb14fc2d33ac145424a25de80c291fbcb5b3cd9a
1 \input texinfo @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename DUSIDatasheet.info
4 @settitle DUSIDatasheet
5 @c %**end of header
6 @c @title DUSI Datasheet
7 @c genindex description: characteristics and technical information
8 @center @titlefont{DUSI}
9 @center @image{imgs/dusi}
11 @ifnottex
12 @node Top
13 @top DUSIDatasheet
14 @end ifnottex
17 @menu
18 * Characteristics::
19 * Backlight:: 
20 * Battery::
21 * Parts::
22 * Components::
23 * DeviceData::
24 * Menu:: Menu
25 @end menu
27 @include DatasheetCharacteristics.texih
29 @node Backlight
30 @chapter Backlight
31 @center @titlefont{Backlight}
32 @multitable @columnfractions .6 .2 .2
33 @headitem  Parameter @tab Value @tab Unit
34 @item White Backlight Current @tab 8 @tab mA
35 @item Green Backlight Current @tab 4 @tab mA
36 @end multitable
38 Note:  On older DUSIv1 sometimes the backlight has issues because of the way the connector is placed.  Please email me for a free replacement if the backlight is not functioning.
40 @node Battery
41 @chapter Battery
42 @center @titlefont{Battery}
44 Battery charges from usb with a max of 100mA.
46 @multitable @columnfractions .6 .2 .2
47 @headitem  Parameter @tab Value @tab Unit
48 @item Battery Type @tab @code{3.6v lipo} @tab
49 @item Battery Capacity @tab 250 @tab mAH
50 @item Battery Charge Current @tab 100 @tab mA
51 @item Charge time @tab 4 @tab hours
52 @item Run time @tab >10@math{^1} @tab hours
53 @end multitable
55 1 decreases with age and backlight usage
57 @node Parts
58 @chapter Parts
59 @center @titlefont{Parts}
61 @itemize
62 @item 16key keypad
63 @item 132x64 lcd with green and white backlight
64 @item 70 series box with protective case (boxenclosures.com)
65 @item laser pointer
66 @item on/off switch
67 @item usb connector
68 @end itemize
70 @node Components
71 @chapter Components
73 @itemize
74 @item at90usb1287
75 @item sca3000-d01
76 @item ad7799
77 @item hmc1052
78 @item hmc1051z
79 @item irf7905 (x2)
80 @item max1811
81 @item fan2503S30
82 @item ra8816 lcd
83 @end itemize
85 Various capacitors resistors and connectors see schematic for details
87 @include DeviceDataIntro.texih
89 The DUSIv1 does not provide many accessors (it is stripped down from lack of flash memory)
91 @menu
92 * root:: root
93 * settings:: settings
94 * stats:: stats
95 * power:: power
96 * calc:: calc
97 * calibration:: calibration
98 * sensors:: sensors
99 * survey:: survey
100 @end menu
102 @include DeviceDataRoot.texih
104 @node settings
105 @section settings
107 @itemize @bullet
108 @include DeviceDataSettingsMag.texih
109 @item contrast -- the lcd contrast
110 @item reversevideo -- invert the lcd contents?
111 @item whitebacklight -- control the white backlight
112 @item greenbacklight -- control the green backlight
113 @end itemize
115 @include DeviceDataStats.texih
117 @node power
118 @section power
120 @itemize @bullet
121 @item battery
123 @itemize @bullet
124 @item voltage - the battery voltage
125 @item chargedvoltage - the voltage of the battery when it was last charged
126 @item dischargedvoltage - the voltage of the battery when it was last discharged
127 @item state - the current state of the battery
128 @end itemize
130 @item stillsleeptype - sleep type to use when the device is still
131 @item stillsleeptimeout - time the device must be still before sleeping
132 @item buttonidlesleeptype - sleep type to use when no buttons are pressed
133 @item buttonidletimeout - time the device must not have a button pressed before sleeping
134 @item wakeonmotion - if set to true, the device will wake on motion when it sleeps from being still.  It will not wake from motion from a button idle timeout.
135 @item lastsleeptype - the last type of sleep the device was in, used for debugging
136 @end itemize
138 Note: the device does not sleep when plugged in via USB.
140 The sleep types supported:
141 @itemize @bullet
142 @item none - sleep disabled
143 @item idle - sensors and processor stopped, device consumes about 15% of normal power.  Can wake up from the most different ways.
144 @item powersave - shutdown everything possible while still keeping the LCD and backlight on (if available)
145 @item powerdown - shutdown everything to lowest possible power consumption.  Uses about 0.5% of normal operating power.
146 @end itemize
148 Note: If wakeonmotion is set, because extra power is needed to be able to wake from motion, and the device sleeps from being still, the device will consume about 1.5% of normal operating power in powerdown mode rather than 0.5%.
150 @include DeviceDataCalc.texih
152 @include DeviceDataCalibration.texih
154 @include DeviceDataSensors.texih
156 @node survey
157 @section survey
158 The device can store various measurements
159 @itemize
160 @item stats - get for statistics about the measurements
161 @item measurements - get to dump all of the measurements
162 @item usebacksights - set to enable automatic backsights when surveying
163 @end itemize
166 @node Menu
167 @chapter Menu
169 The menu on the device is simple, press the key of the number letter or symbol which next to the word or icon you want to perform.  The main menu allows you to select a function for the device.  It is always possible to press 'D' repeatedly to eventually return to the Main Menu.  It is usually possible to press 'A' to read information about the current page.
171 @section Compass
172 The compass shows a 3d compass as well as other statistics.
174 @section Survey
176 The survey system allows you to take measurements of incline and azimuth using the laser.  These measurements may be recorded.  Typically there is enough storage for at least 500 shots.  It is also possible to enter attributes to go with each measurement (such as distance between survey points) but not required.
178 To make a measurement from the survey menu, hold '1' down and the laser will turn on, when you release it, a second later the laser will go off and the current reading is locked.
180 Once held, you can store the measurement with '2'.  If this should be a backsight for the last shot, press '3' to toggle to backsight mode.  If you want to enter distance LRUD, or other parameters, enter the attributes with '4' before storing.
182 Data required to store a shot, the minimum is 5 bytes for header, incline and azimuth, additional attributes add:
183 @itemize @bullet
184 @item 3 bytes  backsight incline and azimuth
185 @item 10 bytes - out of order stations penalty
186 @item 2 bytes - distance
187 @item 4 bytes - lrud
188 @end itemize
190 @multitable @columnfractions .2 .1 .1 .1 .1 .2
191 @headitem Name  To @tab Dist @tab Incline @tab Azimuth @tab LRUD @tab bytes
192 @item AFF-001 AFF-002 @tab - @tab +42.2 @tab 135.3 @tab @tab 15
193 @item AFF-002 AFF-003 @tab - @tab -26.7 @tab 167.4 @tab @tab 5
194 @item AFF-003 AFF-004 @tab 23.4 @tab +35.2 @tab 302.7 @tab @tab 7
195 @item AFF-003 AFF-005 @tab - @tab -42.1 @tab 253.9 @tab 1 1 2 3 @tab 19
196 @end multitable
199 The first measurement uses an extra 10 bytes because there is no measurement before it.  The fourth measurement uses 5 bytes normally, 4 more for lrud, and 10 more because the number is not sequential.
201 The measurements can be downloaded to a computer, or viewed on the device.
203 @section Pedometer
204 The pedometer uses a simple algorithm to detect steps by sensing verticle motion.  It counts steps with a given tolerance.
206 @section Gaussmeter
207 The gaussmeter allows you to measure magnetic fields in gauss.  There is support for absolute, relative and vector magnetometer modes.
209 @section Stats
210 View various statistics about the running program.
212 @section Calibration
213 Proper calibration is extremely important for accurate measurements.  The device can be re-calibrated at any time without any additional equipment.  The on-screen help system explains what each step of calibration does.
215 @section Settings
216 There are a few settings that can be modified on the device, there are far more settings that can be modified via the dataclient.
218 @section Plots
219 This mode allows you to plot the sensor data directly on the DUSI screen.  You may enter mathematical expressions using various sensor inputs as well.
221 @section Vector View
222 This mode simply displays vectors pointing in the direction of the accelerometer and magnetometer vectors.
224 @section Advanced Survey
225 This mode gives the user the ability to perform surveys in a linear state machine and gives error checking (FS/BS compare)
227 @section Calculator
228 This mode is simply a calculator.  It peforms basic expression parsing as well as reverse-polish notation.  Basic trig functions are supported.
230 @section Sphere Painter
231 This mode allows the user to draw arcs using the laser pointer, then view and rotate them in 3d on the screen.
233 @bye