Row: Include fix
[pulseview.git] / manual / overview.txt
blobbfd87f854d19f9b0e0c2ce9725e11d6d66ef21a5
1 [[overview,Overview]]
2 == Overview
4 PulseView is a graphical frontend for the libsigrok and libsigrokdecode libraries, permitting
5 access to a wide range of devices and protocol decoders to let you record, analyze, process
6 and export analog and logic data. It is part of the sigrok suite, just like the libraries that
7 it makes use of.
9 The sigrok suite needs some kind of hardware to interface to the signals you want to examine.
10 We found that most people are currently using logic analyzers based on the http://www.cypress.com/products/ez-usb-fx2lp[Cypress FX2 microcontroller].
11 With http://sigrok.org/wiki/Fx2lafw[fx2lafw], sigrok's open source runtime firmware, any device
12 containing an FX2 can become a powerful streaming logic analyzer.
13 A variety of compatible low cost chinese made logic analyzer products are available for as little
14 as $5. These can easily be found by searching for _24MHz Logic Analyzer_. There are also barebone
15 Cypress FX2 boards such as the Lcsoft Mini Board, which can usually be found by searching for
16 _Cypress FX2 Board_ or similar.
18 In addition, a good set of https://sigrok.org/wiki/Probe_comparison[quality probe hooks] is recommended.
20 Aside from FX2-based logic analyzers, sigrok also supports FX2-based oscilloscopes such as the
21 https://sigrok.org/wiki/Hantek_6022BE[Hantek 6022BE], non-FX2 devices like the
22 https://sigrok.org/wiki/Openbench_Logic_Sniffer[Openbench Logic Sniffer] or devices that make use
23 of the SCPI protocol, as all reasonably modern oscilloscopes do (Rigol DS1054z, LeCroy WaveRunner,
24 Yokogawa DLM and similar).
26 Please be aware however, that PulseView currently only supports devices that can either work as an
27 https://sigrok.org/wiki/Supported_hardware#Oscilloscopes[oscilloscope],
28 a https://sigrok.org/wiki/Supported_hardware#Logic_analyzers[logic analyzer] or
29 a https://sigrok.org/wiki/Supported_hardware#Mixed-signal_devices[mixed-signal device]. This
30 means that multimeters in particular are currently only usable with either https://sigrok.org/wiki/Sigrok-cli[sigrok-cli]
31 or https://sigrok.org/wiki/Sigrok-meter[sigrok-meter].
33 image::pv_after_startup.png[]
35 The PulseView user interface is geared towards navigation and analysis of captured waveforms, so
36 the most space is by default used up by the main trace view. From here, you can access the most
37 often used features.
39 Before we dive deeper into how to accomplish things, let's make PulseView available on your
40 system first.