[
  {
    "path": ".gitignore",
    "content": ".idea\ndist\n*.egg-info\n*.pyc\n"
  },
  {
    "path": "LICENSE.txt",
    "content": "Copyright (c) 2016 Suat Özgür, Micha LaQua\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n    * Redistributions of source code must retain the above copyright\n      notice, this list of conditions and the following disclaimer.\n    * Redistributions in binary form must reproduce the above copyright\n      notice, this list of conditions and the following disclaimer in the\n      documentation and/or other materials provided with the distribution.\n    * Neither the name of the author nor the\n      names of its contributors may be used to endorse or promote products\n      derived from this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY\nDIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\nLOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\nON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n"
  },
  {
    "path": "MANIFEST.in",
    "content": "include README.rst\ninclude LICENCE.txt\n"
  },
  {
    "path": "README.rst",
    "content": "rpi-rf\n======\n\nIntroduction\n------------\n\nPython module for sending and receiving 433/315MHz LPD/SRD signals with generic low-cost GPIO RF modules on a Raspberry Pi.\n\nProtocol and base logic ported ported from `rc-switch`_.\n\nSupported hardware\n------------------\n\nMost generic 433/315MHz capable modules (cost: ~2€) connected via GPIO to a Raspberry Pi.\n\n.. figure:: http://i.imgur.com/vG89UP9.jpg\n   :alt: 433modules\n\nCompatibility\n-------------\n\nGeneric RF outlets and most 433/315MHz switches (cost: ~15€/3pcs).\n\n.. figure:: http://i.imgur.com/WVRxvWe.jpg\n   :alt: rfoutlet\n\n\nChipsets:\n\n* SC5262 / SC5272\n* HX2262 / HX2272\n* PT2262 / PT2272\n* EV1527 / RT1527 / FP1527 / HS1527\n\nFor a full list of compatible devices and chipsets see the `rc-switch Wiki`_\n\nDependencies\n------------\n\n::\n\n    RPi.GPIO\n\nInstallation\n------------\n\nOn your Raspberry Pi, install the *rpi_rf* module via pip.\n\nPython 3::\n\n    # apt-get install python3-pip\n    # pip3 install rpi-rf\n\nWiring diagram (example)\n------------------------\n\nRaspberry Pi 1/2(B+)::\n\n                       RPI GPIO HEADER\n                  ____________\n                 |        ____|__\n                 |       |    |  |\n                 |     01|  . x  |02\n                 |       |  . x__|________       RX\n                 |       |  . x__|______  |   ________\n                 |       |  . .  |      | |  |        |\n       TX        |   ____|__x .  |      | |__|VCC     |\n     _______     |  |  __|__x .  |      |    |        |\n    |       |    |  | |  |  x____|______|____|DATA    |\n    |    GND|____|__| |  |  . .  |      |    |        |\n    |       |    |    |  |  . .  |      |    |DATA    |\n    |    VCC|____|    |  |  . .  |      |    |        |\n    |       |         |  |  . .  |      |____|GND     |\n    |   DATA|_________|  |  . .  |           |________|\n    |_______|            |  . .  |\n                         |  . .  |\n                         |  . .  |\n                         |  . .  |\n                         |  . .  |\n                         |  . .  |\n                         |  . .  |\n                       39|  . .  |40\n                         |_______|\n\n    TX:\n       GND > PIN 09 (GND)\n       VCC > PIN 02 (5V)\n      DATA > PIN 11 (GPIO17)\n\n    RX:\n       VCC > PIN 04 (5V)\n      DATA > PIN 13 (GPIO27)\n       GND > PIN 06 (GND)\n\nUsage\n-----\n\nSee `scripts`_ (`rpi-rf_send`_, `rpi-rf_receive`_) which are also shipped as cmdline tools.\n\nOpen Source\n-----------\n\n* The code is licensed under the `BSD Licence`_\n* The project source code is hosted on `GitHub`_\n* Please use `GitHub issues`_ to submit bugs and report issues\n\n.. _rc-switch: https://github.com/sui77/rc-switch\n.. _rc-switch Wiki: https://github.com/sui77/rc-switch/wiki\n.. _BSD Licence: http://www.linfo.org/bsdlicense.html\n.. _GitHub: https://github.com/milaq/rpi-rf\n.. _GitHub issues: https://github.com/milaq/rpi-rf/issues\n.. _scripts: https://github.com/milaq/rpi-rf/blob/master/scripts\n.. _rpi-rf_send: https://github.com/milaq/rpi-rf/blob/master/scripts/rpi-rf_send\n.. _rpi-rf_receive: https://github.com/milaq/rpi-rf/blob/master/scripts/rpi-rf_receive\n"
  },
  {
    "path": "rpi_rf/__init__.py",
    "content": "from __future__ import absolute_import\nfrom .rpi_rf import RFDevice\n\n\n__version__ = '0.9.7'\n"
  },
  {
    "path": "rpi_rf/rpi_rf.py",
    "content": "\"\"\"\nSending and receiving 433/315Mhz signals with low-cost GPIO RF Modules on a Raspberry Pi.\n\"\"\"\n\nimport logging\nimport time\nfrom collections import namedtuple\n\nfrom RPi import GPIO\n\nMAX_CHANGES = 67\n\n_LOGGER = logging.getLogger(__name__)\n\nProtocol = namedtuple('Protocol',\n                      ['pulselength',\n                       'sync_high', 'sync_low',\n                       'zero_high', 'zero_low',\n                       'one_high', 'one_low'])\nPROTOCOLS = (None,\n             Protocol(350, 1, 31, 1, 3, 3, 1),\n             Protocol(650, 1, 10, 1, 2, 2, 1),\n             Protocol(100, 30, 71, 4, 11, 9, 6),\n             Protocol(380, 1, 6, 1, 3, 3, 1),\n             Protocol(500, 6, 14, 1, 2, 2, 1),\n             Protocol(200, 1, 10, 1, 5, 1, 1))\n\n\nclass RFDevice:\n    \"\"\"Representation of a GPIO RF device.\"\"\"\n\n    # pylint: disable=too-many-instance-attributes,too-many-arguments\n    def __init__(self, gpio,\n                 tx_proto=1, tx_pulselength=None, tx_repeat=10, tx_length=24, rx_tolerance=80):\n        \"\"\"Initialize the RF device.\"\"\"\n        self.gpio = gpio\n        self.tx_enabled = False\n        self.tx_proto = tx_proto\n        if tx_pulselength:\n            self.tx_pulselength = tx_pulselength\n        else:\n            self.tx_pulselength = PROTOCOLS[tx_proto].pulselength\n        self.tx_repeat = tx_repeat\n        self.tx_length = tx_length\n        self.rx_enabled = False\n        self.rx_tolerance = rx_tolerance\n        # internal values\n        self._rx_timings = [0] * (MAX_CHANGES + 1)\n        self._rx_last_timestamp = 0\n        self._rx_change_count = 0\n        self._rx_repeat_count = 0\n        # successful RX values\n        self.rx_code = None\n        self.rx_code_timestamp = None\n        self.rx_proto = None\n        self.rx_bitlength = None\n        self.rx_pulselength = None\n\n        GPIO.setmode(GPIO.BCM)\n        _LOGGER.debug(\"Using GPIO \" + str(gpio))\n\n    def cleanup(self):\n        \"\"\"Disable TX and RX and clean up GPIO.\"\"\"\n        if self.tx_enabled:\n            self.disable_tx()\n        if self.rx_enabled:\n            self.disable_rx()\n        _LOGGER.debug(\"Cleanup\")\n        GPIO.cleanup()\n\n    def enable_tx(self):\n        \"\"\"Enable TX, set up GPIO.\"\"\"\n        if self.rx_enabled:\n            _LOGGER.error(\"RX is enabled, not enabling TX\")\n            return False\n        if not self.tx_enabled:\n            self.tx_enabled = True\n            GPIO.setup(self.gpio, GPIO.OUT)\n            _LOGGER.debug(\"TX enabled\")\n        return True\n\n    def disable_tx(self):\n        \"\"\"Disable TX, reset GPIO.\"\"\"\n        if self.tx_enabled:\n            # set up GPIO pin as input for safety\n            GPIO.setup(self.gpio, GPIO.IN)\n            self.tx_enabled = False\n            _LOGGER.debug(\"TX disabled\")\n        return True\n\n    def tx_code(self, code, tx_proto=None, tx_pulselength=None, tx_length=None):\n        \"\"\"\n        Send a decimal code.\n\n        Optionally set protocol, pulselength and code length.\n        When none given reset to default protocol, default pulselength and set code length to 24 bits.\n        \"\"\"\n        if tx_proto:\n            self.tx_proto = tx_proto\n        else:\n            self.tx_proto = 1\n        if tx_pulselength:\n            self.tx_pulselength = tx_pulselength\n        elif not self.tx_pulselength:\n            self.tx_pulselength = PROTOCOLS[self.tx_proto].pulselength\n        if tx_length:\n            self.tx_length = tx_length\n        elif self.tx_proto == 6:\n            self.tx_length = 32\n        elif (code > 16777216):\n            self.tx_length = 32\n        else:\n            self.tx_length = 24\n        rawcode = format(code, '#0{}b'.format(self.tx_length + 2))[2:]\n        if self.tx_proto == 6:\n            nexacode = \"\"\n            for b in rawcode:\n                if b == '0':\n                    nexacode = nexacode + \"01\"\n                if b == '1':\n                    nexacode = nexacode + \"10\"\n            rawcode = nexacode\n            self.tx_length = 64\n        _LOGGER.debug(\"TX code: \" + str(code))\n        return self.tx_bin(rawcode)\n\n    def tx_bin(self, rawcode):\n        \"\"\"Send a binary code.\"\"\"\n        _LOGGER.debug(\"TX bin: \" + str(rawcode))\n        for _ in range(0, self.tx_repeat):\n            if self.tx_proto == 6:\n                if not self.tx_sync():\n                    return False\n            for byte in range(0, self.tx_length):\n                if rawcode[byte] == '0':\n                    if not self.tx_l0():\n                        return False\n                else:\n                    if not self.tx_l1():\n                        return False\n            if not self.tx_sync():\n                return False\n\n        return True\n\n    def tx_l0(self):\n        \"\"\"Send a '0' bit.\"\"\"\n        if not 0 < self.tx_proto < len(PROTOCOLS):\n            _LOGGER.error(\"Unknown TX protocol\")\n            return False\n        return self.tx_waveform(PROTOCOLS[self.tx_proto].zero_high,\n                                PROTOCOLS[self.tx_proto].zero_low)\n\n    def tx_l1(self):\n        \"\"\"Send a '1' bit.\"\"\"\n        if not 0 < self.tx_proto < len(PROTOCOLS):\n            _LOGGER.error(\"Unknown TX protocol\")\n            return False\n        return self.tx_waveform(PROTOCOLS[self.tx_proto].one_high,\n                                PROTOCOLS[self.tx_proto].one_low)\n\n    def tx_sync(self):\n        \"\"\"Send a sync.\"\"\"\n        if not 0 < self.tx_proto < len(PROTOCOLS):\n            _LOGGER.error(\"Unknown TX protocol\")\n            return False\n        return self.tx_waveform(PROTOCOLS[self.tx_proto].sync_high,\n                                PROTOCOLS[self.tx_proto].sync_low)\n\n    def tx_waveform(self, highpulses, lowpulses):\n        \"\"\"Send basic waveform.\"\"\"\n        if not self.tx_enabled:\n            _LOGGER.error(\"TX is not enabled, not sending data\")\n            return False\n        GPIO.output(self.gpio, GPIO.HIGH)\n        self._sleep((highpulses * self.tx_pulselength) / 1000000)\n        GPIO.output(self.gpio, GPIO.LOW)\n        self._sleep((lowpulses * self.tx_pulselength) / 1000000)\n        return True\n\n    def enable_rx(self):\n        \"\"\"Enable RX, set up GPIO and add event detection.\"\"\"\n        if self.tx_enabled:\n            _LOGGER.error(\"TX is enabled, not enabling RX\")\n            return False\n        if not self.rx_enabled:\n            self.rx_enabled = True\n            GPIO.setup(self.gpio, GPIO.IN)\n            GPIO.add_event_detect(self.gpio, GPIO.BOTH)\n            GPIO.add_event_callback(self.gpio, self.rx_callback)\n            _LOGGER.debug(\"RX enabled\")\n        return True\n\n    def disable_rx(self):\n        \"\"\"Disable RX, remove GPIO event detection.\"\"\"\n        if self.rx_enabled:\n            GPIO.remove_event_detect(self.gpio)\n            self.rx_enabled = False\n            _LOGGER.debug(\"RX disabled\")\n        return True\n\n    # pylint: disable=unused-argument\n    def rx_callback(self, gpio):\n        \"\"\"RX callback for GPIO event detection. Handle basic signal detection.\"\"\"\n        timestamp = int(time.perf_counter() * 1000000)\n        duration = timestamp - self._rx_last_timestamp\n\n        if duration > 5000:\n            if abs(duration - self._rx_timings[0]) < 200:\n                self._rx_repeat_count += 1\n                self._rx_change_count -= 1\n                if self._rx_repeat_count == 2:\n                    for pnum in range(1, len(PROTOCOLS)):\n                        if self._rx_waveform(pnum, self._rx_change_count, timestamp):\n                            _LOGGER.debug(\"RX code \" + str(self.rx_code))\n                            break\n                    self._rx_repeat_count = 0\n            self._rx_change_count = 0\n\n        if self._rx_change_count >= MAX_CHANGES:\n            self._rx_change_count = 0\n            self._rx_repeat_count = 0\n        self._rx_timings[self._rx_change_count] = duration\n        self._rx_change_count += 1\n        self._rx_last_timestamp = timestamp\n\n    def _rx_waveform(self, pnum, change_count, timestamp):\n        \"\"\"Detect waveform and format code.\"\"\"\n        code = 0\n        delay = int(self._rx_timings[0] / PROTOCOLS[pnum].sync_low)\n        delay_tolerance = delay * self.rx_tolerance / 100\n\n        for i in range(1, change_count, 2):\n            if (abs(self._rx_timings[i] - delay * PROTOCOLS[pnum].zero_high) < delay_tolerance and\n                abs(self._rx_timings[i+1] - delay * PROTOCOLS[pnum].zero_low) < delay_tolerance):\n                code <<= 1\n            elif (abs(self._rx_timings[i] - delay * PROTOCOLS[pnum].one_high) < delay_tolerance and\n                  abs(self._rx_timings[i+1] - delay * PROTOCOLS[pnum].one_low) < delay_tolerance):\n                code <<= 1\n                code |= 1\n            else:\n                return False\n\n        if self._rx_change_count > 6 and code != 0:\n            self.rx_code = code\n            self.rx_code_timestamp = timestamp\n            self.rx_bitlength = int(change_count / 2)\n            self.rx_pulselength = delay\n            self.rx_proto = pnum\n            return True\n\n        return False\n           \n    def _sleep(self, delay):      \n        _delay = delay / 100\n        end = time.time() + delay - _delay\n        while time.time() < end:\n            time.sleep(_delay)\n"
  },
  {
    "path": "scripts/rpi-rf_receive",
    "content": "#!/usr/bin/env python3\n\nimport argparse\nimport signal\nimport sys\nimport time\nimport logging\n\nfrom rpi_rf import RFDevice\n\nrfdevice = None\n\n# pylint: disable=unused-argument\ndef exithandler(signal, frame):\n    rfdevice.cleanup()\n    sys.exit(0)\n\nlogging.basicConfig(level=logging.INFO, datefmt='%Y-%m-%d %H:%M:%S',\n                    format='%(asctime)-15s - [%(levelname)s] %(module)s: %(message)s', )\n\nparser = argparse.ArgumentParser(description='Receives a decimal code via a 433/315MHz GPIO device')\nparser.add_argument('-g', dest='gpio', type=int, default=27,\n                    help=\"GPIO pin (Default: 27)\")\nargs = parser.parse_args()\n\nsignal.signal(signal.SIGINT, exithandler)\nrfdevice = RFDevice(args.gpio)\nrfdevice.enable_rx()\ntimestamp = None\nlogging.info(\"Listening for codes on GPIO \" + str(args.gpio))\nwhile True:\n    if rfdevice.rx_code_timestamp != timestamp:\n        timestamp = rfdevice.rx_code_timestamp\n        logging.info(str(rfdevice.rx_code) +\n                     \" [pulselength \" + str(rfdevice.rx_pulselength) +\n                     \", protocol \" + str(rfdevice.rx_proto) + \"]\")\n    time.sleep(0.01)\nrfdevice.cleanup()\n"
  },
  {
    "path": "scripts/rpi-rf_send",
    "content": "#!/usr/bin/env python3\n\nimport argparse\nimport logging\n\nfrom rpi_rf import RFDevice\n\nlogging.basicConfig(level=logging.INFO, datefmt='%Y-%m-%d %H:%M:%S',\n                    format='%(asctime)-15s - [%(levelname)s] %(module)s: %(message)s',)\n\nparser = argparse.ArgumentParser(description='Sends a decimal code via a 433/315MHz GPIO device')\nparser.add_argument('code', metavar='CODE', type=int,\n                    help=\"Decimal code to send\")\nparser.add_argument('-g', dest='gpio', type=int, default=17,\n                    help=\"GPIO pin (Default: 17)\")\nparser.add_argument('-p', dest='pulselength', type=int, default=None,\n                    help=\"Pulselength (Default: 350)\")\nparser.add_argument('-t', dest='protocol', type=int, default=None,\n                    help=\"Protocol (Default: 1)\")\nparser.add_argument('-l', dest='length', type=int, default=None,\n                    help=\"Codelength (Default: 24)\")\nparser.add_argument('-r', dest='repeat', type=int, default=10,\n                    help=\"Repeat cycles (Default: 10)\")\nargs = parser.parse_args()\n\nrfdevice = RFDevice(args.gpio)\nrfdevice.enable_tx()\nrfdevice.tx_repeat = args.repeat\n\nif args.protocol:\n    protocol = args.protocol\nelse:\n    protocol = \"default\"\nif args.pulselength:\n    pulselength = args.pulselength\nelse:\n    pulselength = \"default\"\nif args.length:\n    length = args.length\nelse:\n    length = \"default\"\n\nlogging.info(str(args.code) +\n             \" [protocol: \" + str(protocol) +\n             \", pulselength: \" + str(pulselength) +\n             \", length: \" + str(length) +\n             \", repeat: \" + str(rfdevice.tx_repeat) + \"]\")\n\nrfdevice.tx_code(args.code, args.protocol, args.pulselength, args.length)\nrfdevice.cleanup()\n"
  },
  {
    "path": "setup.py",
    "content": "from setuptools import setup, find_packages\nfrom os import path\n\nhere = path.abspath(path.dirname(__file__))\n\nwith open(path.join(here, 'README.rst'), encoding='utf-8') as f:\n    long_description = f.read()\n\nsetup(\n    name='rpi-rf',\n    version='0.9.7',\n    author='Micha LaQua',\n    author_email='micha.laqua@gmail.com',\n    description='Sending and receiving 433/315MHz signals with low-cost GPIO RF modules on a Raspberry Pi',\n    long_description=long_description,\n    url='https://github.com/milaq/rpi-rf',\n    license='BSD',\n    classifiers=[\n        'Development Status :: 4 - Beta',\n        'Intended Audience :: Developers',\n        'Topic :: Software Development :: Build Tools',\n        'License :: OSI Approved :: BSD License',\n        'Programming Language :: Python :: 3',\n        'Operating System :: POSIX :: Linux',\n        'Topic :: Software Development :: Libraries :: Python Modules'\n    ],\n    keywords=[\n        'rpi',\n        'raspberry',\n        'raspberry pi',\n        'rf',\n        'gpio',\n        'radio',\n        '433',\n        '433mhz',\n        '315',\n        '315mhz'\n    ],\n    install_requires=['RPi.GPIO'],\n    scripts=['scripts/rpi-rf_send', 'scripts/rpi-rf_receive'],\n    packages=find_packages(exclude=['contrib', 'docs', 'tests'])\n)\n"
  }
]