adafruit-circuitpython-tinylora


Nameadafruit-circuitpython-tinylora JSON
Version 2.2.18 PyPI version JSON
download
home_page
SummaryCircuitPython library for LoRaWAN and The Things Network.
upload_time2023-12-09 17:54:10
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit lorawan thethingsnetwork hardware micropython circuitpython
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-busdevice typing_extensions
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

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

**WARNING: This library is not compatible with The Things Network v3 stack. Since TTN has fully migrated to v3, this library is not longer able to communicate with TTN.**


LoRaWAN/The Things Network V2, for CircuitPython.

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

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

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

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-tinylora/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-tinylora

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-tinylora

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-tinylora

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

Usage is described in the `learn guide for this library <https://learn.adafruit.com/using-lorawan-and-the-things-network-with-circuitpython>`_.

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

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

License
=======

This library was written by ClemensRiederer. We've converted it to work with Adafruit CircuitPython and made
changes so it works with the Raspberry Pi and Adafruit Feather M0/M4. We've added examples for using this library
to transmit data and sensor data to The Things Network.

This open source code is licensed under the LGPL license (see LICENSE for details).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-tinylora",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,lorawan,thethingsnetwork,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/8f/23/e3880d255d51c622d1ae503a18d3be90ed532f407bb177a3289431ad6be4/adafruit-circuitpython-tinylora-2.2.18.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/circuitpython-tinylora/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/tinylora/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_TinyLoRa/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_TinyLoRa/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\n**WARNING: This library is not compatible with The Things Network v3 stack. Since TTN has fully migrated to v3, this library is not longer able to communicate with TTN.**\n\n\nLoRaWAN/The Things Network V2, for CircuitPython.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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-tinylora/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-tinylora\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-tinylora\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-tinylora\n\nUsage Example\n=============\n\nUsage is described in the `learn guide for this library <https://learn.adafruit.com/using-lorawan-and-the-things-network-with-circuitpython>`_.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/tinylora/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_TinyLoRa/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nLicense\n=======\n\nThis library was written by ClemensRiederer. We've converted it to work with Adafruit CircuitPython and made\nchanges so it works with the Raspberry Pi and Adafruit Feather M0/M4. We've added examples for using this library\nto transmit data and sensor data to The Things Network.\n\nThis open source code is licensed under the LGPL license (see LICENSE for details).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for LoRaWAN and The Things Network.",
    "version": "2.2.18",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_TinyLoRa"
    },
    "split_keywords": [
        "adafruit",
        "lorawan",
        "thethingsnetwork",
        "hardware",
        "micropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd8c4a00c5ffaf4fff6c60114fd20b477fd4ebcf137d5ff2300c8c1a890f756d",
                "md5": "f4d698d4c2a0975d4b74e82b218dc83b",
                "sha256": "a16da1aa28b818e9312bfcadf2009b0cb0bcdd53fa1728906a548411757cb407"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_tinylora-2.2.18-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f4d698d4c2a0975d4b74e82b218dc83b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 14644,
            "upload_time": "2023-12-09T17:54:08",
            "upload_time_iso_8601": "2023-12-09T17:54:08.252770Z",
            "url": "https://files.pythonhosted.org/packages/dd/8c/4a00c5ffaf4fff6c60114fd20b477fd4ebcf137d5ff2300c8c1a890f756d/adafruit_circuitpython_tinylora-2.2.18-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8f23e3880d255d51c622d1ae503a18d3be90ed532f407bb177a3289431ad6be4",
                "md5": "27f84308a2ea873850e6f9ec7ecb13ed",
                "sha256": "c7c878f7fad42c9a97432b1a4ff75f85480b537c49aa1150e0b9b4f9ea648ac4"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-tinylora-2.2.18.tar.gz",
            "has_sig": false,
            "md5_digest": "27f84308a2ea873850e6f9ec7ecb13ed",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 44686,
            "upload_time": "2023-12-09T17:54:10",
            "upload_time_iso_8601": "2023-12-09T17:54:10.845798Z",
            "url": "https://files.pythonhosted.org/packages/8f/23/e3880d255d51c622d1ae503a18d3be90ed532f407bb177a3289431ad6be4/adafruit-circuitpython-tinylora-2.2.18.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 17:54:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_TinyLoRa",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-busdevice",
            "specs": []
        },
        {
            "name": "typing_extensions",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-tinylora"
}
        
Elapsed time: 0.26993s