https://github.com/adafruit/Adafruit_CircuitPython_TinyLoRa

Adafruit Tiny LoRa
https://github.com/adafruit/Adafruit_CircuitPython_TinyLoRa

hacktoberfest

Last synced: about 2 months ago
JSON representation

Adafruit Tiny LoRa

• Host: GitHub
• URL: https://github.com/adafruit/Adafruit_CircuitPython_TinyLoRa
• Owner: adafruit
• License: mit
• Created: 2018-11-28T22:11:44.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2023-12-09T17:53:38.000Z (9 months ago)
• Last Synced: 2024-07-18T05:30:51.847Z (2 months ago)
• Topics: hacktoberfest
• Language: Python
• Size: 5.53 MB
• Stars: 44
• Watchers: 25
• Forks: 44
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-lora - Adafruit Tiny LoRa - LoRaWAN/The Things Network, for CircuitPython (Libraries)

README

        
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 `_

* `Bus Device `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading `the Adafruit library and driver bundle `_.

Installing from PyPI

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

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from

PyPI `_. 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 `_.

Documentation

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

API documentation for this library can be found on `Read the Docs `_.

For information on building library documentation, please check out `this guide `_.

Contributing

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

Contributions are welcome! Please read our `Code of Conduct

`_

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).