Metadata-Version: 1.1
Name: pyrtlsdr
Version: 0.2.2
Summary: A Python wrapper for librtlsdr (a driver for Realtek RTL2832U based SDR's)
Home-page: https://github.com/roger-/pyrtlsdr
Author: roger
Author-email: UNKNOWN
License: GPLv3
Download-URL: https://github.com/roger-/pyrtlsdr
Description: |Build Status|
        
        Description
        ===========
        
        pyrtlsdr is a simple Python interface to devices supported by the
        RTL-SDR project, which turns certain USB DVB-T dongles employing the
        Realtek RTL2832U chipset into low-cost, general purpose software-defined
        radio receivers. It wraps many of the functions in the `librtlsdr
        library <http://sdr.osmocom.org/trac/wiki/rtl-sdr>`__ (including
        asynchronous read support), and also provides a more Pythonic API.
        
        Usage
        =====
        
        pyrtlsdr can be installed by downloading the source files and running
        ``python setup.py install``, or using
        `pip <http://www.pip-installer.org/en/latest/>`__ and
        ``pip install pyrtlsdr``.
        
        All functions in librtlsdr are accessible via librtlsdr.py and a
        Pythonic interface is available in rtlsdr.py (recommended). Some
        documentation can be found in docstrings in the latter file.
        
        Examples
        --------
        
        Simple way to read and print some samples:
        
        .. code:: python
        
            from rtlsdr import RtlSdr
        
            sdr = RtlSdr()
        
            # configure device
            sdr.sample_rate = 2.048e6  # Hz
            sdr.center_freq = 70e6     # Hz
            sdr.freq_correction = 60   # PPM
            sdr.gain = 'auto'
        
            print(sdr.read_samples(512))
        
        Plotting the PSD with matplotlib:
        
        .. code:: python
        
            from pylab import *
            from rtlsdr import *
        
            sdr = RtlSdr()
        
            # configure device
            sdr.sample_rate = 2.4e6
            sdr.center_freq = 95e6
            sdr.gain = 4
        
            samples = sdr.read_samples(256*1024)
        
            # use matplotlib to estimate and plot the PSD
            psd(samples, NFFT=1024, Fs=sdr.sample_rate/1e6, Fc=sdr.center_freq/1e6)
            xlabel('Frequency (MHz)')
            ylabel('Relative power (dB)')
        
            show()
        
        Resulting plot `here <http://i.imgur.com/hFhg8.png>`__.
        
        See the files 'demo\_waterfall.py' and 'test.py' for more examples.
        
        Experimental features
        ---------------------
        
        Two new submodules are available for testing: **rtlsdraio**, which adds
        native Python 3 asynchronous support (asyncio module), and **rtlsdrtcp**
        which adds a TCP server/client for accessing a device over the network.
        See the respective modules in the rtlsdr folder for more details and
        feel free to test and report any bugs!
        
        rtlsdraio
        ^^^^^^^^^
        
        Note that the rtlsdraio module is automatically imported and adds
        ``stream()`` and ``stop()`` methods to the normal ``RtlSdr`` class. It
        also requires the new ``async``/``await`` syntax introduced in Python
        3.5+.
        
        The syntax is basically:
        
        .. code:: python
        
            async def streaming():
             sdr = RtlSdr()
             
             async for samples in sdr.stream():
              # do something with samples
              # ...
              
              # to stop streaming:
              sdr.stop()
              
             # done
             sdr.close()
             
            asyncio.get_event_loop().run_until_complete(streaming())
        
        Dependencies
        ============
        
        -  Windows/Linux/OSX
        -  Python 2.7.x/3.3+
        -  librtlsdr (builds dated after 5/5/12)
        -  **Optional**: NumPy (wraps samples in a more convenient form)
        
        matplotlib is also useful for plotting data. The librtlsdr binaries
        (rtlsdr.dll in Windows and librtlsdr.so in Linux) should be in the
        pyrtlsdr directory, or a system path. Note that these binaries may have
        additional dependencies.
        
        Todo
        ====
        
        There are a few remaining functions in librtlsdr that haven't been
        wrapped yet. It's a simple process if there's an additional function you
        need to add support for, and please send a pull request if you'd like to
        share your changes.
        
        Troubleshooting
        ===============
        
        -  Some operating systems (Linux, OS X) seem to result in libusb buffer
           issues when performing small reads. Try reading 1024 (or higher
           powers of two) samples at a time if you have problems.
        
        -  If you're having librtlsdr import errors:
        -  **Windows**: Make sure all the librtlsdr DLL files (rtlsdr.dll and
           libusb-1.0.dll) are in your system path, or the same folder as this
           README file. Also make sure you have all of *their* dependencies
           (e.g. the Visual Studio runtime files). If rtl\_sdr.exe works, then
           you should be okay. Also note that you can't mix the 64 bit version
           of Python with 32 bit builds of librtlsdr, and vice versa.
        -  **Linux**: Make sure your LD\_LIBRARY\_PATH environment variable
           contains the directory where the librtlsdr.so.0 library is located.
           You can do this in a shell with (for example):
           ``export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib``. See
           `here <https://github.com/roger-/pyrtlsdr/issues/7>`__ for more
           details.
        
        License
        =======
        
        All of the code contained here is licensed by the GNU General Public
        License v3.
        
        Credit
        ======
        
        Credit to dbasden for his earlier wrapper
        `python-librtlsdr <https://github.com/dbasden/python-librtlsdr>`__ and
        all the contributers on GitHub.
        
        Copyright (C) 2013 by Roger https://github.com/roger-
        
        .. |Build Status| image:: https://travis-ci.org/roger-/pyrtlsdr.svg?branch=master
           :target: https://travis-ci.org/roger-/pyrtlsdr
        
Keywords: radio librtlsdr rtlsdr sdr
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Utilities
