decoders/ook/__init__.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2018 Steve R <steversig@virginmedia.com>
   5 ##
   6 ## This program is free software; you can redistribute it and/or modify
   7 ## it under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 2 of the License, or
   9 ## (at your option) any later version.
  10 ##
  11 ## This program is distributed in the hope that it will be useful,
  12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ## GNU General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 '''
  21 OOK decodes On-off keying based remote control protocols.
  22
  23 It is aimed at 433MHz but should also work with other common RC frequencies.
  24 The input can be captured directly from a transmitter (before the modulation
  25 stage) or demodulated by an RF receiver.
  26
  27 Over the air captured traces will be a lot noisier and will probably need the
  28 area of interest to be zoomed onto, then selected with the "Cursors" and the
  29 "Save Selected Range As" feature to be used to extract it from the noise.
  30
  31 There is a limited amount of pre-filtering and garbage removal built into the
  32 decoder which can sometimes extract signals directly from a larger over the air
  33 trace. It depends heavily on your environment.
  34 '''
  35
  36 from .pd import Decoder