README

   1 Howdy do neighbor!
   2
   3 If you're reading this, then pour yourself a tasty beverage. The history of this was so that I could learn the basics of websockets, html js canvasas, integration with wordpress, and some python coding for rtlsdr bits. All the code contained within is basically what you would need to do in order to mimic what is live on http://sdr.ninja.
   4
   5 Firstly, lets get the licensing out of the way...
   6
   7 ###############################################################################
   8 # The MIT License (MIT)
   9 # Copyright (c) Russell Handorf
  10 # Other copyrights noted where code modification is located
  11 #
  12 # Permission is hereby granted, free of charge, to any person obtaining a copy
  13 # of this software and associated documentation files (the "Software"), to deal
  14 # in the Software without restriction, including without limitation the rights
  15 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16 # copies of the Software, and to permit persons to whom the Software is
  17 # furnished to do so, subject to the following conditions:
  18 #
  19 # The above copyright notice and this permission notice shall be included in
  20 # all copies or substantial portions of the Software.
  21 #
  22 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  25 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  28 # THE SOFTWARE.
  29 #
  30 ###############################################################################
  31
  32 In all cases for scripts, replace all instances of 'YOURSERVER' with your server's domainname, ip, or some other identifier. To make your life easier, just grep for this.
  33
  34 sdrninja-client
  35 -sdr.html : This is the HTML code for your web page to include the canvas
  36 -sdr.js : This is the JS that is called to connect to the websocket and render the canvas. This has a YOURSERVER config requirement.
  37 -sdrninja.init : This is an init.d script for making it an automagical process if you'd like. Copy the sdrninja dir into /etc/ to make that happen more easily
  38 -sdrninja/start.sh : This is the script that the init script calls
  39 -sdrninja/server.py : This is what creates the python websocket. You'll have some dependencies to install laddy!
  40 -sdrninja/logs : If you want logs, dump 'em here
  41
  42 sdrninja-server
  43 -client.py : A fairly modified script origionally written by Tavendo GmbH. I've added web socket handling, frequency range mapping, and a few other minor fixes to make this work. This is a great script to learn from for doing basif FFT in python. Tip of the hat to Tavendo GmbH!
  44 -radio_math.py/radio_math.pyc : Math dependencies for client.py. Tau for the win.
  45 -sdrninja.init : This is an init.d script for making it an automagical process if you'd like. Copy the sdrninja dir into /etc/ to make that happen more easily
  46 -logs : If you want logs, dump 'em here
  47