Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
reference:instrumentation:openlogger:reference-manual [2019/01/12 00:48]
Arthur Brown
reference:instrumentation:openlogger:reference-manual [2019/10/04 11:57] (current)
Vicentiu Neagoe [Features]
Line 1: Line 1:
-<WRAP center round todo 40%> 
-The OpenLogger reference manual is in progress. 
-</​WRAP>​ 
  
 ====== OpenLogger Reference Manual ====== ====== OpenLogger Reference Manual ======
Line 7: Line 4:
  
 {{Digilent Image Gallery ​ {{Digilent Image Gallery ​
-| image = {{ :​reference:​instrumentation:​OpenLogger:OpenLogger_1.png?direct |}} +| image = {{ :​reference:​instrumentation:​openlogger:openlogger-acrylics-use-600.png?​direct ​ |}} 
-| image = {{ :​reference:​instrumentation:​OpenLogger:OpenLogger_2.png?direct |}} +| image = {{ :​reference:​instrumentation:​openlogger:openlogger-acrylics-top-600.png?​direct ​ |}} 
-| image = {{ :​reference:​instrumentation:​OpenLogger:OpenLogger_3.png?direct |}}+| image = {{ :​reference:​instrumentation:​openlogger:openlogger-acrylics-bottom-600.png?​direct ​ |}} 
 +| image = {{ :​reference:​instrumentation:​openlogger:​openlogger-acrylics-rear-600.png?​direct ​ |}} 
 +| image = {{ :​reference:​instrumentation:​openlogger:​openlogger-use-600.png?​direct ​ |}} 
 +| image = {{ :​reference:​instrumentation:​openlogger:​screwterminaladapter_for_openlogger-use-600.png?direct |}}
 }} }}
  
Line 20: Line 20:
     * 8 Channels     * 8 Channels
     * 16-bit resolution per channel     * 16-bit resolution per channel
-    * 400 kS/s sample rate+    * 500 kS/s sample rate
     * 50 kHz of bandwidth at -3dB     * 50 kHz of bandwidth at -3dB
     * 1 MΩ of input impedance     * 1 MΩ of input impedance
     * ±10 V input voltage range     * ±10 V input voltage range
     * Maximum buffer size of 32640 samples per channel     * Maximum buffer size of 32640 samples per channel
-  * Arbitrary Waveform ​Generator+  * Function ​Generator
     * 1 Channel     * 1 Channel
     * Sine, triangle, sawtooth, square and DC outputs     * Sine, triangle, sawtooth, square and DC outputs
     * 10-bit resolution     * 10-bit resolution
-    * 10 MS/s sample rate+    * MS/s sample rate
     * 3 V pk2pk output with ±1.5 V offset     * 3 V pk2pk output with ±1.5 V offset
     * 10 mA output current     * 10 mA output current
Line 62: Line 62:
 |  9  |  DC2  |  DC Out 2  |  10  |  GND  |  Digital Ground ​ | |  9  |  DC2  |  DC Out 2  |  10  |  GND  |  Digital Ground ​ |
 |  11  |  DC1  |  DC Out 1  |  12  |  GND  |  Digital Ground ​ | |  11  |  DC1  |  DC Out 1  |  12  |  GND  |  Digital Ground ​ |
-|  13  |  AWG  |  ​Arbitrary Waveform ​Generator ​ |  14  |  GND  |  Digital Ground ​ |+|  13  |  AWG  |  ​Function ​Generator ​Output ​ ​| ​ 14  |  GND  |  Digital Ground ​ |
 |  15  |  Tin  |  Reserved ​ |  16  |  Tout  |  Reserved ​ | |  15  |  Tin  |  Reserved ​ |  16  |  Tout  |  Reserved ​ |
 |  17  |  RST  |  Button Reset  |  18  |  PROG  |  Button Program ​ | |  17  |  RST  |  Button Reset  |  18  |  PROG  |  Button Program ​ |
Line 90: Line 90:
 |  **R**  |  RST  |  Button Reset  |  **P**  |  PROG  |  Button Program ​ | |  **R**  |  RST  |  Button Reset  |  **P**  |  PROG  |  Button Program ​ |
 |  **TI** ​ |  Tin  |  Reserved ​ |  **TO** ​ |  Tout  |  Reserved ​ | |  **TI** ​ |  Tin  |  Reserved ​ |  **TO** ​ |  Tout  |  Reserved ​ |
-|  **W1** ​ |  AWG  |  ​Arbitrary Waveform ​Generator ​ |  **↓** ​ |  GND  |  Digital Ground ​ |+|  **W1** ​ |  AWG  |  ​Function ​Generator ​Output ​ ​| ​ **↓** ​ |  GND  |  Digital Ground ​ |
 |  **V1** ​ |  DC1  |  DC Out 1  |  **↓** ​ |  GND  |  Digital Ground ​ | |  **V1** ​ |  DC1  |  DC Out 1  |  **↓** ​ |  GND  |  Digital Ground ​ |
 |  **V2** ​ |  DC2  |  DC Out 2  |  **↓** ​ |  GND  |  Digital Ground ​ | |  **V2** ​ |  DC2  |  DC Out 2  |  **↓** ​ |  GND  |  Digital Ground ​ |
Line 103: Line 103:
  
 {{ :​reference:​instrumentation:​OpenLogger:​OpenLogger-walk-around.jpg?​700 |Walk Around the OpenLogger (click to enlarge)}} {{ :​reference:​instrumentation:​OpenLogger:​OpenLogger-walk-around.jpg?​700 |Walk Around the OpenLogger (click to enlarge)}}
 +
 +====== Software Support ======
 +
 +The [[:​reference:​software:​digilent-agent:​start:​|Digilent Agent]] and [[:​reference:​software:​waveforms-live:​start:​|WaveForms Live]] are used to configure and communicate with the OpenLogger, as well as for viewing captured data. More information can be found on their respective Resource Centers, linked above, as well as the [[:​reference:​instrumentation:​openlogger:​start:​|OpenLogger Resource Center]].
 +
 +<WRAP round important 660px>
 +===Important!===
 +The OpenLogger can only be used with Windows operating systems.
 +</​WRAP>​
  
 ====== Analog Inputs ====== ====== Analog Inputs ======
-Analog inputs provide ways to measure real analog data from external systems. OpenLogger has 8 single-ended analog inputs with their own recommended ground pin. Each input is designed to accept a voltage range of -10 V to +10 V (with protection up to ±30 V and has 16 bits of resolution and a bandwidth of 50 kHz. OpenLogger can then log all data onto the local SD card at 400 kS/s, stream and/or log data over USB at 200 kS/s, or stream and/or log data over WiFi at 10 kS/S.+Analog inputs provide ways to measure real analog data from external systems. OpenLogger has 8 single-ended analog inputs with their own recommended ground pin. Each input is designed to accept a voltage range of -10 V to +10 V (with protection up to ±30 V and has 16 bits of resolution and a bandwidth of 50 kHz. OpenLogger can then log all data onto the local SD card at 500 kS/s, stream and/or log data over USB at 500 kS/s, or stream and/or log data over WiFi at 10 kS/S.
  
 The analog inputs has the following features: The analog inputs has the following features:
Line 128: Line 137:
 Information on how to use the OpenLogger'​s Analog Inputs can be found in the OpenLogger'​s [[:​learn:​instrumentation:​tutorials:​openlogger:​datalogger|Data Logger]] tutorial. Information on how to use the OpenLogger'​s Analog Inputs can be found in the OpenLogger'​s [[:​learn:​instrumentation:​tutorials:​openlogger:​datalogger|Data Logger]] tutorial.
  
-<WRAP center round todo 40%> +{{ :​reference:​instrumentation:​openlogger:​logging_in_process.png?​500 |Logging in action}}
-WIP; no screenshot available +
-</​WRAP>​+
  
 ======= Function Generator ====== ======= Function Generator ======
-Function ​The OpenLogger has a single channel ​10 MS/s, 10-bit function generator. An R2R resistor ladder with 1% resistors is used in place of a DAC. /* Due to the nature of resistor ladders, it is possible to have a missing code for steps larger than 3 mV or encounter propagation delays, most notably when switching between the values of 0x1FF and 0x200. The channel uses 10 IO pins on the PIC32MZ to generate the output through the resistor ladder and a DMA channel that is shared with the Logic Analyzer at the highest priority level to transfer data and a PWM output to control the offset voltage level. */ +The OpenLogger has a single channel ​MS/s, 10-bit function generator. An R2R resistor ladder with 1% resistors is used in place of a DAC. /* Due to the nature of resistor ladders, it is possible to have a missing code for steps larger than 3 mV or encounter propagation delays, most notably when switching between the values of 0x1FF and 0x200. The channel uses 10 IO pins on the PIC32MZ to generate the output through the resistor ladder and a DMA channel that is shared with the Logic Analyzer at the highest priority level to transfer data and a PWM output to control the offset voltage level. */
  
 The function generator supports: The function generator supports:
Line 152: Line 158:
 Information on how to use the OpenLogger'​s Digital I/O can be found in the OpenLogger'​s [[:​learn:​instrumentation:​tutorials:​openlogger:​gpio-logic-analyzer|Digital I/O]] tutorial. Information on how to use the OpenLogger'​s Digital I/O can be found in the OpenLogger'​s [[:​learn:​instrumentation:​tutorials:​openlogger:​gpio-logic-analyzer|Digital I/O]] tutorial.
  
-<WRAP center round todo 40%> +{{ :​reference:​instrumentation:​openlogger:​digitalIO_OutputsSetHighandLow.png?​500 |Set outputs to be high or low}}
-WIP; no screenshot available +
-</​WRAP>​+
  
  
Line 216: Line 220:
  
  
-    * Blue Off - Device is booting and not ready to use. +    * Orange On - Device is booting and not ready to use. 
-    * Green Flashing - Device is booted and ready to use but Wifi is not connected+    * Green Flashing - Device is booted and ready to usebut not logging
-    * Blue Solid - Device is booted and ready to use and Wifi is connected+    * Green Solid - Device is logging ​to the RAM buffer ​and streaming ​is currently available. 
-      * The three other LEDs blink the last octet of the OpenLogger'​s IP Address. +    * Green and Orange Solid - Device is both logging and streaming. 
-    * Red Solid - Calibration or acquisition in progress. +    * Green Solid and Orange Flashing - Device is streaming to the RAM buffer, but logging to the SD card or through Wifi has stopped 
-    * All user LEDs Solid - An error has occurred. Reboot the OpenLogger. +      * For the SD card, this usually indicates there is no more space on the SD card 
-    * When connected to a Wifi network the 3 user LEDs display the last octet of the OpenLogger'​s IP address by blinking the number of times corresponding to that digit of the last octet in decimal. ​ For example an OpenLogger with an IP address ending in '​123'​ would blink LD1 once, LD2 twice and LD3 three times. ​/* {{ :​reference:​instrumentation:​OpenLogger:​OpenLogger-ip-address-indicator.png?​nolink&​400 |}}*/+    * Red Solid - One of the internal buffers was overrun 
 +      * Filling the SD card does not cause an overrun condition 
 +    * Red Flashing - Warning that the device is falling behind with keeping the buffers cleared 
 +    * Blue Solid - Reserved for WiFi (not yet implemented) 
 +    * Red blinking and Orange Solid - Device firmware updating ​ 
 +    * All user LEDs Solid - An error has occurred. Reboot the OpenLogger ​and report the error on the [[https://​forum.digilentinc.com/​forum/​30-waveforms-live-openscope-mz-and-openlogger/​|Digilent Forum]]
 + 
 +/*When connected to a Wifi network the 3 user LEDs display the last octet of the OpenLogger'​s IP address by blinking the number of times corresponding to that digit of the last octet in decimal. ​ For example an OpenLogger with an IP address ending in '​123'​ would blink LD1 once, LD2 twice and LD3 three times. ​ {{ :​reference:​instrumentation:​OpenLogger:​OpenLogger-ip-address-indicator.png?​nolink&​400 |}}*/
  
 {{tag>​openlogger doc}} {{tag>​openlogger doc}}