adafruit-circuitpython-ble-broadcastnet


Nameadafruit-circuitpython-ble-broadcastnet JSON
Version 0.12.9 PyPI version JSON
download
home_page
SummaryBasic IOT over BLE advertisements.
upload_time2023-09-25 15:57:35
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython ble_broadcastnet iot ble
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-ble
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble_broadcastnet/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/ble_broadcastnet/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_BroadcastNet/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet/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

Basic IOT over BLE advertisements.


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:: Only the bridge examples work on Raspberry Pi because Blinka `_bleio` doesn't support
    advertising, only scanning.

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-ble-broadcastnet

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-ble-broadcastnet

To install in a virtual environment in your current project:

.. code-block:: shell

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

Usage Example
=============

Add a secrets.py file and then run ``ble_broadcastnet_blinka_bridge.py``.

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

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ble_broadcastnet/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/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-ble-broadcastnet",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,ble_broadcastnet,IOT,BLE",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/4b/bd/8673a9d51da3a68b847f2dfe12fdb14849be1655a06ab9f33f58e5261c13/adafruit-circuitpython-ble-broadcastnet-0.12.9.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble_broadcastnet/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/ble_broadcastnet/en/latest/\n    :alt: Documentation Status\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.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet/actions\n    :alt: Build Status\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\nBasic IOT over BLE advertisements.\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>`_.\n\nInstalling from PyPI\n=====================\n.. note:: Only the bridge examples work on Raspberry Pi because Blinka `_bleio` doesn't support\n    advertising, only scanning.\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_broadcastnet/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-ble-broadcastnet\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-broadcastnet\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 .venv/bin/activate\n    pip3 install adafruit-circuitpython-ble-broadcastnet\n\nUsage Example\n=============\n\nAdd a secrets.py file and then run ``ble_broadcastnet_blinka_bridge.py``.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ble_broadcastnet/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Basic IOT over BLE advertisements.",
    "version": "0.12.9",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet"
    },
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "ble_broadcastnet",
        "iot",
        "ble"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aea823415b12371c3a95e1d3e8b433edcd0cc87e19271fd782008819b149ae9e",
                "md5": "0b64cd5e65cfc4c1c6c96fdc13717772",
                "sha256": "80853b66da2a9488243f22420e3bcf76af50ecae40fbacfb5c563d240600393d"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_ble_broadcastnet-0.12.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0b64cd5e65cfc4c1c6c96fdc13717772",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6090,
            "upload_time": "2023-09-25T15:57:33",
            "upload_time_iso_8601": "2023-09-25T15:57:33.673727Z",
            "url": "https://files.pythonhosted.org/packages/ae/a8/23415b12371c3a95e1d3e8b433edcd0cc87e19271fd782008819b149ae9e/adafruit_circuitpython_ble_broadcastnet-0.12.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4bbd8673a9d51da3a68b847f2dfe12fdb14849be1655a06ab9f33f58e5261c13",
                "md5": "031c1e61418694b5105c55374308714f",
                "sha256": "3830f5b5010099b407cd162403dfb3fe2fe32ac637042faa0f5f6e8ada59f214"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-ble-broadcastnet-0.12.9.tar.gz",
            "has_sig": false,
            "md5_digest": "031c1e61418694b5105c55374308714f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 30899,
            "upload_time": "2023-09-25T15:57:35",
            "upload_time_iso_8601": "2023-09-25T15:57:35.104660Z",
            "url": "https://files.pythonhosted.org/packages/4b/bd/8673a9d51da3a68b847f2dfe12fdb14849be1655a06ab9f33f58e5261c13/adafruit-circuitpython-ble-broadcastnet-0.12.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-25 15:57:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_BLE_BroadcastNet",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-ble",
            "specs": [
                [
                    ">=",
                    "8.0.0"
                ]
            ]
        }
    ],
    "lcname": "adafruit-circuitpython-ble-broadcastnet"
}
        
Elapsed time: 0.15300s