Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble-beacon/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ble_beacon/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Beacon/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Beacon/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
BLE Location Beacon for CircuitPython
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>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-ble-beacon/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ble-beacon
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ble-beacon
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-ble-beacon
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_ble_beacon
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See the ``examples/`` folder for more usage examples.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ble-beacon/en/latest/>`_.
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>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/tekktrik/Adafruit_CircuitPython_BLE_Beacon/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-ble-beacon",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,ble-beacon,ble,beacon,location,proximity,distance,ibeacon",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/03/32/1936b18a6a97beb1e481e6953b113c5fc3928d9282846a2df8d6b5fca94d/adafruit-circuitpython-ble-beacon-1.0.5.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble-beacon/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ble_beacon/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Beacon/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Beacon/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nBLE Location Beacon for CircuitPython\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_\n\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-ble-beacon/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ble-beacon\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ble-beacon\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install adafruit-circuitpython-ble-beacon\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_ble_beacon\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee the ``examples/`` folder for more usage examples.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ble-beacon/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/tekktrik/Adafruit_CircuitPython_BLE_Beacon/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BLE Location Beacon for CircuitPython",
"version": "1.0.5",
"project_urls": {
"Homepage": "https://github.com/tekktrik/Adafruit_CircuitPython_BLE_Beacon"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"ble-beacon",
"ble",
"beacon",
"location",
"proximity",
"distance",
"ibeacon"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce57505b1cf1b58fbd4e124443ce614275d0615635df85378c26f13bba25c84a",
"md5": "0040dec490a80d1e7276612ac61b8825",
"sha256": "9561b578503c576cbc5f4eb0c85494b392f6f6043f411cf80e761e0789ba2e40"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ble_beacon-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0040dec490a80d1e7276612ac61b8825",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5328,
"upload_time": "2024-02-26T17:30:51",
"upload_time_iso_8601": "2024-02-26T17:30:51.886816Z",
"url": "https://files.pythonhosted.org/packages/ce/57/505b1cf1b58fbd4e124443ce614275d0615635df85378c26f13bba25c84a/adafruit_circuitpython_ble_beacon-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "03321936b18a6a97beb1e481e6953b113c5fc3928d9282846a2df8d6b5fca94d",
"md5": "9025a854d71cd0cddb195877edccd778",
"sha256": "a4f5e05563b73d477f97e215603e0ff6b3fcbbfa2b707922d3fac68d75bc9814"
},
"downloads": -1,
"filename": "adafruit-circuitpython-ble-beacon-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "9025a854d71cd0cddb195877edccd778",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26626,
"upload_time": "2024-02-26T17:30:53",
"upload_time_iso_8601": "2024-02-26T17:30:53.807000Z",
"url": "https://files.pythonhosted.org/packages/03/32/1936b18a6a97beb1e481e6953b113c5fc3928d9282846a2df8d6b5fca94d/adafruit-circuitpython-ble-beacon-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 17:30:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tekktrik",
"github_project": "Adafruit_CircuitPython_BLE_Beacon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ble-beacon"
}
JSON
