CubicSDR: The Manual

[cjcliffe]

Not the actual manual, but you may learn something :) This is the roadmap and progress for the CubicSDR manual, suggestions and contributions are welcome.

• [ ] Introduction
  • [x] Quick overview of SDR and what CubicSDR does
  • [x] Basic use cases
  • [ ] Example / tutorial / video links around the web
• [x] "Getting Started" with installation / build links.
  • [ ] Current status and description/credit for CubicSDR's dependencies
  • [ ] SoapySDR introduction
• [ ] SDR Device selection
  • [ ] Device properties
  • [ ] Starting device, sample rate control
• [ ] Main Application Window - functionality and usage
  • [x] Annotated image, main window layout description, general overview
  • [x] Explain hover tips and how to disable when no longer needed
  • [ ] Quick "cheat-sheet" table of available functions / keyboard commands with descriptions
  • [ ] Printable PDF download version
  • [ ] Menus
  • [ ] File
  • [ ] Settings
  • [ ] Sample Rate
  • [ ] Audio Sample Rate
  • [ ] Recording
  • [ ] Color Scheme
  • [ ] Rig Control
  • [ ] Display
  • [x] Main spectrum
  • [x] General
  • [x] Mouse commands
    • [x] Drag to change frequency
    • [x] Right-Drag to change "visual gain" scale
    • [x] Right-Click to reset "visual gain" scale
    • [x] Peak Hold button (or press 'P')
    • [x] Average speed control
    • [x] SHIFT + up / down arrow to change "visual gain"
  • [x] Modulation type selection
  • [x] Explain modulation types and their usage
    • [x] FM
    • [x] FMS
    • [x] AM
    • [x] LSB
    • [x] USB
    • [x] DSB
    • [x] I/Q
  • [x] Waterfall
  • [ ] General information (what is it / what does it do)
  • [x] Zoom Functionality
    • [x] Basic overview of Zoom in CubicSDR
    • [x] Explain what's going on, limitations and expectations
  • [x] Mouse Commands
    • [x] Lines-per-second rate control
    • [x] Clicking to add a modem (should the term be VFO?)
    • [x] Drag a modem
    • [x] Dragging modem bandwidth
    • [x] Mouse wheel to zoom
    • [ ] Right drag to zoom
  • [ ] Keyboard commands
    • [x] Holding SHIFT to add multiple modem instances
    • [ ] Explain duplication of active modem properties
    • [ ] Holding ALT to drag a range to create modem + set bandwidth
    • [x] Hovering and pressing 'M' to toggle mute
    • [x] Press 'S' to toggle solo mode
    • [x] Hovering and pressing 'D' to delete
    • [ ] Hovering and pressing 'E' to edit label
    • [x] Left/Right arrow to tune on waterfall
    • [x] Hold shift to tune quickly
    • [x] Up/Down arrow to zoom on waterfall
    • [x] Shift + Up/Down arrow to change "visual gain" scale
    • [ ] Center on hovered frequency or modem by pressing 'C'.
    • [x] Nudge modem by the snap frequency using '[' and ']'
    • [ ] Hold SHIFT to nudge at half the snap frequency
  • [x] Tuning bar
  • [x] General
  • [x] Frequency
  • [x] Bandwidth
  • [x] Center
  • [ ] Mouse commands
    • [x] Click upper/lower area to tune
    • [x] Drag digit left/right for variable tuning
    • [x] Mouse wheel to step digit
  • [x] Keyboard commands
    • [x] Hover and space to set frequency, bandwidth or center
    • [x] Holding shift to disable click-to-tune carry operation
  • [x] Demodulator controls and visuals
  • [x] General, explain how it's the active modem view
  • [x] Explain controls similar to waterfall/spectrum
  • [ ] Clicking the active demodulator in the upper left will bring it into view in the main waterfall
  • [x] Squelch
  • [x] Gain
  • [x] Mute button
  • [x] Solo mode button
  • [x] Delta lock button -- lock modem relative to center frequency (V)
  • [ ] Scope / Visuals
    • [ ] Scope
    • [ ] Spectrum
  • [ ] Color Themes
  • [ ] Sessions
  • [ ] Audio controls
• [ ] Advanced / specific use case features
  • [ ] Misc. features, tips, tricks
  • [ ] Using Manual Gain control
  • [ ] Using Rig control
  • [ ] Using SoapyAudio
  • [ ] Using SoapyRemote
  • [ ] Piping audio to other applications (VBCable, Soundflower, etc.)
  • [ ] Using JACK Audio for piping
  • [ ] Using PulseAudio routing / dummy input tools

[Dantali0n]

Do you want to use the github wiki as manual or did you have other ideas such as a external wiki maybe on the cubicsdr site?

[cjcliffe]

@Dantali0n hadn't decided yet; I was thinking of using the wiki as "development" mode to do it in markdown and possibly export the "stable" versions of each manual to the main website site in static format.

[NN4F]

Any Help you need to the manual let me know if I can help....

[cjcliffe]

@NN4F thanks! I'll hopefully start to fill in some content in the Wiki for the first 'alpha' and it would be great if you could help translate my developer speak and terminology to the amateur radio community terms as well to make sure everyone will understand (and vice-versa for me ;-) Expanding upon content and giving user experience examples once we get started would be welcome as well.

[NN4F]

Sure, count me in Charles....even though I'm a new user to Cubic and learning more day by day... :)

[vsboost]

Ill contribute for sure.

[cjcliffe]

@NN4F @vsboost thanks! I'll probably be working on the outline for a few iterations; feel free to comment or suggest any changes as I go.

[henrybehmann]

Hi Charles,

Please ignore my previous message.I have found the offset setting. All I was seeing in the menu selection was offset tune. I didn't see the first item in the menu. Sorry about that. I am getting olda nd this is what happens. I am looking forward to the manual so I can make use of all the features you have in this program. Now I will try for HF and see what I can catch.

I very much appreciate all the effort and dedication that went into CubicSDR. I like it better than the other SDR software I have tried. I look forward to saving frequencies from a list so I don't have to enter that every time I monitor a different station.

Thanks and cheers, Henry

[ghost]

There is a Hover Tips setting now which helps you finding the right keys in the right situation.

[cjcliffe]

Aye, added to the list -- 0.2.0 milestone is shrinking so I'll need to get a first draft ready for release soon :)

[theforcedk]

I like Read The docs for writing documentation (supports markdown) because it's very flexiable (and free).. you probably know it, but check out a Ruby doc page here: http://gallium.readthedocs.org/en/latest/ - more "inspiration" here: https://readthedocs.org/

[neilwillgettoit]

@cjcliffe so do you mind if I start making github wiki pages ?

[cjcliffe]

@neilwillgettoit that'd be ok with me -- I'm not 100% sure on the layout or format yet though; that's what #348 is going to help decide.

[Dantali0n]

I really like readthedocs and the way it looks, especially the way codeigniter did it https://www.codeigniter.com/user_guide/

[cjcliffe]

Yeah I think ReadTheDocs is looking like a good option; I'm going to start listing the choices over in #348