File Source: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
No edit summary
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Reads raw data values in binary format from the specified file. This file can be a file that was captured using a [[File Sink]] block, generated with a computer program or saved from an audio editor such as Audacity (using suitable RAW format options).  
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]]. This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
 
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


; Param 1 (''R'')
; File (''R'')
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
: Filename of binary file.
 
; Output Type
: Because a binary file does not store information about what type of data is in it, we have to tell GNU Radio the format.
 
; Repeat (''R'')
: Whether or not to repeat the signal, once the end of the file is reached
 
; Add Begin Tag (''R'')
: Tag to add to the first sample of the stream.
 
; Offset
: Begin this many samples/items into file


; Param 2
; Length
: blah blah blah
: Produce only this number of items (offset, offset+len)


== Example Flowgraph ==
== Example Flowgraph ==

Revision as of 04:35, 20 July 2019

Reads raw data values in binary format from the specified file. This file can be a file that was captured using a File Sink block, generated with a computer program or saved from an audio editor such as Audacity (using suitable RAW format options).

Parameters

(R): Run-time adjustable

File (R)
Filename of binary file.
Output Type
Because a binary file does not store information about what type of data is in it, we have to tell GNU Radio the format.
Repeat (R)
Whether or not to repeat the signal, once the end of the file is reached
Add Begin Tag (R)
Tag to add to the first sample of the stream.
Offset
Begin this many samples/items into file
Length
Produce only this number of items (offset, offset+len)

Example Flowgraph

Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.

Source Files

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO
Retrieved from "https://wiki.gnuradio.org/index.php?title=File_Source&oldid=5404"