https://github.com/rroemhild/micropython-ruuvitag

MicroPython scanner for RuuviTag
https://github.com/rroemhild/micropython-ruuvitag

Last synced: 11 days ago
JSON representation

MicroPython scanner for RuuviTag

• Host: GitHub
• URL: https://github.com/rroemhild/micropython-ruuvitag
• Owner: rroemhild
• License: mit
• Created: 2020-10-13T11:49:52.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-10-13T12:31:52.000Z (about 4 years ago)
• Last Synced: 2024-12-17T06:53:49.013Z (15 days ago)
• Language: Python
• Size: 7.81 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
============================

MicroPython RuuviTag Scanner

============================

Harvest data from `RuuviTag BLE Sensor Beacon `_ with MicroPython.

micropython-ruuvitag supports RuuviTag Data Format 3 (RAWv1) and 5 (RAWv2) only. See `RuuviTag Sensor protocols `_ for details.

The ruuvitag scanner for **Pycom devices** was transfered to a new repo `pycom-ruuvitag `_.

Installation

------------

Copy all files from the ``ruuvitag`` direcotory to the ``lib/ruuvitag`` directory on your device. Alternative you can use mpfshell to copy all files:

.. code-block:: shell

    mpfshell ttyUSB0 -s install.mpf

Example

-------

.. code-block:: python

    import time

    from ruuvitag import RuuviTag

    def cb(ruuvitag):

        print(ruuvitag)

    def run(ruuvi):

        try:

            while True:

                ruuvi.scan()

                time.sleep_ms(50000)

        except KeyboardInterrupt:

            ruuvi.stop()

    if __name__ == "__main__":

        ruuvi = RuuviTag()

        ruuvi._callback_handler = cb

        run(ruuvi)

Whitelist devices

-----------------

You can collect data from only the devices you want by define a whitelist with mac the devices addresses. Do not include ``:`` in the mac address. For example

.. code-block:: python

    whitelist = (b'aabbccddee21', b'aabbccddee42',)

    ruuvi = RuuviTag(whitelist=whitelist)

Blacklist persistence

---------------------

If the data from a Bluetooth device can not be decoded, the device get on a blacklist as long the MicroPython device is not resetted.

Named tuple formats

-------------------

Data Format 3 (RAWv1)

~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

    RuuviTagRAWv1 = namedtuple('RuuviTagRAWv1', (

        'mac',

        'rssi',

        'format',

        'humidity',

        'temperature',

        'pressure',

        'acceleration_x',

        'acceleration_y',

        'acceleration_z',

        'battery_voltage',

    ))

Data Format 5 (RAWv2)

~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

    RuuviTagRAWv2 = namedtuple('RuuviTagRAWv2', (

        'mac',

        'rssi',

        'format',

        'humidity',

        'temperature',

        'pressure',

        'acceleration_x',

        'acceleration_y',

        'acceleration_z',

        'battery_voltage',

        'power_info',

        'movement_counter',

        'measurement_sequence',

    ))