{ "info": { "author": "Rafael R\u00f6mhild", "author_email": "rafael@roemhild.de", "bugtrack_url": null, "classifiers": [], "description": "============================\nMicroPython RuuviTag Scanner\n============================\n\n|pypi|\n\nHarvest data from `RuuviTag BLE Sensor Beacon `_ with MicroPython Bluetooth enabled micro controller like the `pycom `_ devices.\n\nmicropython-ruuvitag supports `Data Format 2, 3, 4 and 5 `_.\n\nThis package comes with a scanner and a tracker. The scanner scans for RuuviTags in a pre defined time and return the result. The tracker continuously scans for RuuviTags and call a callback for each tag found.\n\n\nInstallation\n------------\n\nThe easiest way to install the package is via ``upip``:\n\n>>> import upip\n>>> upip.install('micropython-ruuvitag')\n\nFor manual installation copy the ``ruuvitag`` directory with all files to your device ``lib`` directory.\n\nInstall with mpfshell\n~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: shell\n\n $ mpfshell ttyUSB0 -s install.mpf\n\n\nScanner\n-------\n\n``RuuviTagScanner`` scans for RuuviTags and decode the data format. The result is a list with named tuples.\n\nScan 10 seconds for RuuviTag sensors and print the result:\n\n.. code-block:: python\n\n from ruuvitag.scanner import RuuviTagScanner\n\n rts = RuuviTagScanner()\n\n for ruuvitag in rts.find_ruuvitags(timeout=10):\n print(ruuvitag)\n\n\nTracker\n-------\n\n``RuuviTagTracker`` scans for RuuviTags, decode the data format and call a callback with a named tuple if recieved data from tag.\n\n.. code-block:: python\n\n from ruuvitag.tracker import RuuviTagTracker\n\n def cb(ruuvitag):\n print(ruuvitag)\n\n rtt = RuuviTagTracker()\n rtt.track_ruuvitags(cb)\n\n\nWhitelist devices\n-----------------\n\nYou can collect data from only the devices you want by define a whitelist with mac addresses. Other Devices then will be ignored. Whitelists can be used with RuuviTagScanner and RuuviTagTracker.\n\n.. code-block:: python\n\n whitelist = (b'aa:bb:cc:dd:ee:21', b'aa:bb:cc:dd:ee:42',)\n rts = RuuviTagScanner(whitelist)\n\n\nBlacklist persistence\n---------------------\n\nIf the data from a Bluetooth device can not be decoded, the device get on a blacklist as long the MicroPython device is not resetted. For a persistent device blacklist the list should be saved and reloaded.\n\n>>> from ruuvitag import RuuviTagScanner\n>>> rts = RuuviTagScanner()\n>>> # add back blacklisted devices\n>>> rts.blacklist = [b'aa:bb:cc:dd:ee:21', b'aa:bb:cc:dd:ee:42']\n>>> # run a new scan\n>>> rts.find_ruuvitags(timeout=10)\n>>> # get blacklisted devices\n>>> rts.blacklist\n\n\nNamed tuple formats\n-------------------\n\nData Format 2 and 4 (Eddystone-URL)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n RuuviTagURL = namedtuple('RuuviTagURL', (\n 'mac',\n 'rssi',\n 'format',\n 'humidity',\n 'temperature',\n 'pressure',\n 'id',\n ))\n\nData Format 3 (RAWv1) and 5 (RAWv2)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n RuuviTagRAW = namedtuple('RuuviTagRAW', (\n 'mac',\n 'rssi',\n 'format',\n 'humidity',\n 'temperature',\n 'pressure',\n 'acceleration_x',\n 'acceleration_y',\n 'acceleration_z',\n 'battery_voltage',\n 'power_info',\n 'movement_counter',\n 'measurement_sequence',\n ))\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/micropython-ruuvitag.svg\n :target: https://pypi.python.org/pypi/micropython-ruuvitag/\n :alt: PyPi Status", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/rroemhild/micropython-ruuvitag/", "keywords": "", "license": "MIT", "maintainer": "Rafael R\u00f6mhild", "maintainer_email": "rafael@roemhild.de", "name": "micropython-ruuvitag", "package_url": "https://pypi.org/project/micropython-ruuvitag/", "platform": "", "project_url": "https://pypi.org/project/micropython-ruuvitag/", "project_urls": { "Homepage": "https://github.com/rroemhild/micropython-ruuvitag/" }, "release_url": "https://pypi.org/project/micropython-ruuvitag/0.6.0/", "requires_dist": null, "requires_python": "", "summary": "RuuviTag BLE Sensor Beacon scanner.", "version": "0.6.0" }, "last_serial": 5726785, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "bf46fc68460ae4865eac7fd2d9ad6c5c", "sha256": "c9de1f93e53013765a21e42b973518cdbf2be2186d0b860348287cdde4a43946" }, "downloads": -1, "filename": "micropython-ruuvitag-0.2.0.tar.gz", "has_sig": true, "md5_digest": "bf46fc68460ae4865eac7fd2d9ad6c5c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2041, "upload_time": "2018-01-12T17:46:36", "url": "https://files.pythonhosted.org/packages/1a/35/d58b30d12a5a09212d22cce59c2485b07fd8cbae89f3de05c35a761b404d/micropython-ruuvitag-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "3830dc8adf43deb3cdf1ecc7eb538079", "sha256": "f5b87c66fd256187a93d3f3666cc31b37359c9d11b85ad38b24f1005145d5504" }, "downloads": -1, "filename": "micropython-ruuvitag-0.3.0.tar.gz", "has_sig": true, "md5_digest": "3830dc8adf43deb3cdf1ecc7eb538079", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2737, "upload_time": "2018-01-13T13:07:55", "url": "https://files.pythonhosted.org/packages/1c/f4/23fa27c879b7931d469d3ff75d63763e18e1840f6150398b5a58a1627a46/micropython-ruuvitag-0.3.0.tar.gz" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "193c4313e9b16ec1f0969122d2698782", "sha256": "39593bcfbfa5c6f9c30aa602a806e9234a0e08c80e266e5d8e0cd233025ff834" }, "downloads": -1, "filename": "micropython-ruuvitag-0.4.1.tar.gz", "has_sig": true, "md5_digest": "193c4313e9b16ec1f0969122d2698782", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4023, "upload_time": "2018-03-05T22:13:42", "url": "https://files.pythonhosted.org/packages/ce/69/2a3cd75b9af98ba688c69a9784a044afc25ff35301b7d8520bb1c1d88685/micropython-ruuvitag-0.4.1.tar.gz" } ], "0.4.2": [ { "comment_text": "", "digests": { "md5": "46a174d8d619aeedc69b8542441c7cbb", "sha256": "751375754ca481c6dd82c87bb7fa9e59555731b3c893d205520e13196093f53c" }, "downloads": -1, "filename": "micropython-ruuvitag-0.4.2.tar.gz", "has_sig": true, "md5_digest": "46a174d8d619aeedc69b8542441c7cbb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4047, "upload_time": "2018-03-11T14:23:40", "url": "https://files.pythonhosted.org/packages/39/d4/99e8cefdd176632727ac8a35800360a5605bf131fbf5a4a034f138861273/micropython-ruuvitag-0.4.2.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "884f0670f8e6303064bcc033a3b324f5", "sha256": "0af96c587cb8ba2c0d1f2a4b7c9eae7b293f8d608a25dd335d4e141f46759c6e" }, "downloads": -1, "filename": "micropython-ruuvitag-0.5.0.tar.gz", "has_sig": true, "md5_digest": "884f0670f8e6303064bcc033a3b324f5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3988, "upload_time": "2018-03-18T16:47:13", "url": "https://files.pythonhosted.org/packages/4d/d8/ba76c69921b83935132de9e9e4df4702a778ec221af5d485fac0633b3832/micropython-ruuvitag-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "539a29e20a16303cad976b8636ee634e", "sha256": "1173530a83aa30d755f0d4c5c231fdaade8890cc7b6593aa885886ed06b70675" }, "downloads": -1, "filename": "micropython-ruuvitag-0.5.1.tar.gz", "has_sig": true, "md5_digest": "539a29e20a16303cad976b8636ee634e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4049, "upload_time": "2018-04-01T21:37:24", "url": "https://files.pythonhosted.org/packages/6a/a5/0bd68f132059c5bb14df7e17eae2eb1a0c7b4387c1da2992481ea6dd41a2/micropython-ruuvitag-0.5.1.tar.gz" } ], "0.5.2": [ { "comment_text": "", "digests": { "md5": "be46eb870c80781afd384cab231f4338", "sha256": "49f803e9c3f778708580cde6ffa1a8482a409f5e998624e5bb73112399b0cecf" }, "downloads": -1, "filename": "micropython-ruuvitag-0.5.2.tar.gz", "has_sig": true, "md5_digest": "be46eb870c80781afd384cab231f4338", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4061, "upload_time": "2018-05-29T21:05:28", "url": "https://files.pythonhosted.org/packages/87/6f/c0f0cf76bc8a9e356fbdb805adf4866ffef003b8215267c6618307219749/micropython-ruuvitag-0.5.2.tar.gz" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "dcdafb4fc259d3ee9fe1b4f0f6c7aed5", "sha256": "525ec6d71c47a1dba430b862973b61c25d559aa5e168eb1fd85d350405581336" }, "downloads": -1, "filename": "micropython-ruuvitag-0.6.0.tar.gz", "has_sig": true, "md5_digest": "dcdafb4fc259d3ee9fe1b4f0f6c7aed5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4143, "upload_time": "2019-08-25T11:36:56", "url": "https://files.pythonhosted.org/packages/04/6f/571cfbac3910317ebb474495e0f0ed9e09e3b893b1de83689b00f3a9e916/micropython-ruuvitag-0.6.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "dcdafb4fc259d3ee9fe1b4f0f6c7aed5", "sha256": "525ec6d71c47a1dba430b862973b61c25d559aa5e168eb1fd85d350405581336" }, "downloads": -1, "filename": "micropython-ruuvitag-0.6.0.tar.gz", "has_sig": true, "md5_digest": "dcdafb4fc259d3ee9fe1b4f0f6c7aed5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4143, "upload_time": "2019-08-25T11:36:56", "url": "https://files.pythonhosted.org/packages/04/6f/571cfbac3910317ebb474495e0f0ed9e09e3b893b1de83689b00f3a9e916/micropython-ruuvitag-0.6.0.tar.gz" } ] }