User talk:Duggabe: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
(28 intermediate revisions by the same user not shown)
Line 1: Line 1:
This is for notes on GR documentation.
== "Recycle Bin": content we no longer link to that we may eventually just delete ==
<hr>


01/14:<br>
* [[Guided_Tutorial_GNU_Radio_in_Python|Programming GNU Radio in Python]]
I think Guided_Tutorial_GNU_Radio_in_C++ can be used now for the Writing blocks in C++ (for 3.7)
* [[TutorialsRemoteGUI|Remote GRC Operations]] - needs updating!
* [[UsingVim|Using VIM plugins for GNU Radio development]]
* [[TutorialsQTGUI|QTGUI Tutorial]] - A tutorial on how to develop Python GNU Radio applications.
* [[Guided_Tutorial_Extras_Sample_Rates#E2.3._A_Note_on_Resampling]] - covered by Understanding sample rate
* [[TutorialsCoreConcepts|Core concepts of GNU Radio applications]] - content used in other pages
* [[TutorialsWritePythonApplications|WritePythonApplications]] - content used in other pages
* [[OutOfTreeModulesConfig|Tutorial on how to configure OOT packages to find and link against GNU Radio]] - for 3.7; also, most of the content is covered in Writing blocks in C++
* [[TutorialPythonFunctions|Writing a Python Function for GRC]] - for 3.7; content used in other pages; it doesn't work as written!
* [[TutorialsDebugging|How to debug your applications]] - not well written; would need major rework and update


see Cyrille and my discussion on Slack #docs on Wednesday 1/15 about Writing the XML file for a block (for 3.7)
== QT GUI Block Docs Status ==


01/17:<br>
These 3.9 GUI Widgets do not have doc pages:
I added a gnuradio-companion error msg in https://wiki.gnuradio.org/index.php/InstallingGR#To_install_system_wide


01/19
* App Background
* https://wiki.gnuradio.org/index.php/Guided_Tutorial_GNU_Radio_in_C%2B%2B
* Az-El Plot
* gr-tutorial notes for 3.8
* Compass
*
* Dial
*   these are the places I found where 3.7 and 3.8 are different.
* Dial Gauge
* Digital Number Control
* Distance Radar
* Fast Auto-Correlator Sink
* Graphic Item
* Graphic Overlay Sample Source
* LED Indicator
* Level Gauge
* Msg CheckBox
* Msg Push Button
* Toggle Button
* Toggle Switch


<pre>
== Notes from GRCon20 Docs breakout ==
~ $ gr_modtool newmod tutorial
* document msg ports
Creating out-of-tree module in ./gr-tutorial...
* we need a list of blocks without params or example flowgraphs
Done.
* "How can I know which blocks to assemble to do X application"
Use 'gr_modtool add' to add a new block to this currently empty module.
* "I want to do X processing, Is there a block already that does it, and if so, what's its name?"
</pre>


<pre>
== Notes from GRCon20 HamRadio breakout ==
~/gr-tutorial $ ls
* Thoughts on forming a GNU Radio Amateur Radio monthly meeting group
apps  cmake  CMakeLists.txt  docs  examples  grc  include  lib  MANIFEST.md  python  swig
** use BigBlueButton or Zoom
</pre>
** have a host / moderator present a topic with a demonstration
 
** limit to one hour (especially if BigBlueButton)
<pre>
** a time on the weekend might be better - something like 20:00 UTC?
~/gr-tutorial $ gr_modtool add my_qpsk_demod_cb
** Barry Duggan will push out a news entry on the gnuradio.org homepage as soon as a kickoff seems feasible :) Marcus will help "as much as I can"
GNU Radio module name identified: tutorial
** possibly start a GR Ham Radio mailing list like discuss-gnuradio
('sink', 'source', 'sync', 'decimator', 'interpolator', 'general', 'tagged_stream', 'hier', 'noblock')
* start a Ham Radio wiki page
Enter block type: general
** poor SSB always gets the short shrift. -> tutorial on SSB
Language (python/cpp): cpp
** list of starter RF components for HF
Language: C++
** It would be way cool to demonstrate bad signals in simulation, so that we can recognize them when we see them on air, and not be the ones doing bad things on the air ourselves.
Block/code identifier: my_qpsk_demod_cb
Please specify the copyright holder: gnuradio.org
Enter valid argument list, including default arguments:
bool gray_code
Add Python QA code? [Y/n] Y
Add C++ QA code? [y/N] N
Adding file 'lib/my_qpsk_demod_cb_impl.h'...
Adding file 'lib/my_qpsk_demod_cb_impl.cc'...
Adding file 'include/tutorial/my_qpsk_demod_cb.h'...
Editing swig/tutorial_swig.i...
Adding file 'python/qa_my_qpsk_demod_cb.py'...
Editing python/CMakeLists.txt...
Adding file 'grc/tutorial_my_qpsk_demod_cb.block.yml'...
Editing grc/CMakeLists.txt...
</pre>
 
* and, of course, we need the YAML file instead of the XML file

Revision as of 18:30, 21 September 2020

"Recycle Bin": content we no longer link to that we may eventually just delete

QT GUI Block Docs Status

These 3.9 GUI Widgets do not have doc pages:

  • App Background
  • Az-El Plot
  • Compass
  • Dial
  • Dial Gauge
  • Digital Number Control
  • Distance Radar
  • Fast Auto-Correlator Sink
  • Graphic Item
  • Graphic Overlay Sample Source
  • LED Indicator
  • Level Gauge
  • Msg CheckBox
  • Msg Push Button
  • Toggle Button
  • Toggle Switch

Notes from GRCon20 Docs breakout

  • document msg ports
  • we need a list of blocks without params or example flowgraphs
  • "How can I know which blocks to assemble to do X application"
  • "I want to do X processing, Is there a block already that does it, and if so, what's its name?"

Notes from GRCon20 HamRadio breakout

  • Thoughts on forming a GNU Radio Amateur Radio monthly meeting group
    • use BigBlueButton or Zoom
    • have a host / moderator present a topic with a demonstration
    • limit to one hour (especially if BigBlueButton)
    • a time on the weekend might be better - something like 20:00 UTC?
    • Barry Duggan will push out a news entry on the gnuradio.org homepage as soon as a kickoff seems feasible :) Marcus will help "as much as I can"
    • possibly start a GR Ham Radio mailing list like discuss-gnuradio
  • start a Ham Radio wiki page
    • poor SSB always gets the short shrift. -> tutorial on SSB
    • list of starter RF components for HF
    • It would be way cool to demonstrate bad signals in simulation, so that we can recognize them when we see them on air, and not be the ones doing bad things on the air ourselves.
Retrieved from "https://wiki.gnuradio.org/index.php?title=User_talk:Duggabe&oldid=7566"