[pulseview.git] / manual / import_export.txt

== Data Import/Export

In order to facilitate versatile use of the sigrok suite, libsigrok allows users to import
and export data from files in various formats - some of them as generic as possible, others
very specific. For a list and details, make sure to check https://sigrok.org/wiki/Input_output_formats[the wiki].

=== Import

The first step to importing data from a file is to know what format the data in the file is
encoded in. There are common, not-so-common and outright exotic ways to represent data and sigrok
tries to suit as many needs as it can. To see which formats your version of PulseView supports,
just click on the small arrow next to the _Open_ button:

image::pv_import.png[]

After choosing the format that you want to use, PulseView will ask for the file name to open.
Once you picked the file, you may be asked to specify the details of the format, if the input
module requires them.

For example, the VCD import will ask you for these:

* Compress idle periods: Compress idle periods longer than the specified value (default 0)
* Downsampling factor: Downsample, i.e. divide the samplerate by the specified factor (default 1)
* Number of logic channels: The number of (logic) channels in the data (default 0)
* Skip samples until timestamp: Skip samples until the specified timestamp; < 0: Skip until first timestamp listed; 0: Don't skip (default -1)

The detailed description of each item can also be seen when clicking on the help icon on the right
or hovering your mouse over it. A click on _OK_ then loads the data from the selected file and you
can work with it.

=== Export

Export works just the same as the import: clicking on the small arrow next to the _Save_ button
brings up the export menu. Simply choose the format you want to use and proceed.
Commit	Line	Data
1894027b SA	1	== Data Import/Export
	2
	3	In order to facilitate versatile use of the sigrok suite, libsigrok allows users to import
	4	and export data from files in various formats - some of them as generic as possible, others
	5	very specific. For a list and details, make sure to check https://sigrok.org/wiki/Input_output_formats[the wiki].
	6
	7	=== Import
	8
	9	The first step to importing data from a file is to know what format the data in the file is
	10	encoded in. There are common, not-so-common and outright exotic ways to represent data and sigrok
	11	tries to suit as many needs as it can. To see which formats your version of PulseView supports,
	12	just click on the small arrow next to the _Open_ button:
	13
	14	image::pv_import.png[]
	15
	16	After choosing the format that you want to use, PulseView will ask for the file name to open.
	17	Once you picked the file, you may be asked to specify the details of the format, if the input
	18	module requires them.
	19
	20	For example, the VCD import will ask you for these:
	21
	22	* Compress idle periods: Compress idle periods longer than the specified value (default 0)
	23	* Downsampling factor: Downsample, i.e. divide the samplerate by the specified factor (default 1)
	24	* Number of logic channels: The number of (logic) channels in the data (default 0)
	25	* Skip samples until timestamp: Skip samples until the specified timestamp; < 0: Skip until first timestamp listed; 0: Don't skip (default -1)
	26
4e2195c8 SA	27	The detailed description of each item can also be seen when clicking on the help icon on the right
	28	or hovering your mouse over it. A click on _OK_ then loads the data from the selected file and you
	29	can work with it.
1894027b SA	30
	31	=== Export
	32
	33	Export works just the same as the import: clicking on the small arrow next to the _Save_ button
	34	brings up the export menu. Simply choose the format you want to use and proceed.