jepler/Adafruit_CircuitPython_BLE_Heart_Rate
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
31 commits 1 branch 6 tags 124 KiB
Python 100%
Find a file
Kattni 4ea3ba8f22
Merge pull request #8 from dhalbert/doc-and-pypi 
hack fix for namedtuple doc
2020-05-04 16:36:34 -04:00
.github/workflows build.yml: add black formatting check 2020-04-07 16:04:24 -05:00
docs Black reformatting with Python 3 target. 2020-04-09 16:34:08 -04:00
examples Ran black, updated to pylint 2.x 2020-03-15 17:25:16 -04:00
.gitignore Initial version 2020-01-27 22:47:58 -05:00
.pylintrc update pylintrc for black 2020-03-08 19:11:26 -05:00
.readthedocs.yml Initial version 2020-01-27 22:47:58 -05:00
adafruit_ble_heart_rate.py def creating buffer until required and MTU known 2020-04-30 00:22:43 -04:00
CODE_OF_CONDUCT.md update code of coduct: discord moderation contact section 2020-03-15 18:31:36 -05:00
LICENSE Initial version 2020-01-27 22:47:58 -05:00
README.rst sphinx fixes 2020-01-27 23:45:50 -05:00
requirements.txt Initial version 2020-01-27 22:47:58 -05:00
setup.py def creating buffer until required and MTU known 2020-04-30 00:22:43 -04:00

README.rst 

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble_heart_rate/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/ble_heart_rate/en/latest/
    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://discord.gg/nBQh6qu
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Heart_Rate/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Heart_Rate/actions
    :alt: Build Status

BLE Heart Rate Service


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.

Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
   as a standard element. Stay tuned for PyPI availability!

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-ble_heart_rate/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-ble-heart-rate

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-ble-heart-rate

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .env
    source .env/bin/activate
    pip3 install adafruit-circuitpython-ble-heart-rate

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_BLE_Heart_Rate/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Documentation
=============

For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.