Skip to main content

CircuitPython library for LoRaWAN and The Things Network.

Project description

Introduction

Documentation Status Discord Build Status

LoRaWAN/The Things Network, for CircuitPython.

Dependencies

This driver depends on:

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:

pip3 install adafruit-circuitpython-tinylora

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

sudo pip3 install adafruit-circuitpython-tinylora

To install in a virtual environment in your current project:

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

Usage Example

Usage is described in the learn guide for this library.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you’ll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tinylora --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-tinylora-1.0.5.tar.gz (26.7 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-tinylora-1.0.5.tar.gz.

File metadata

  • Download URL: adafruit-circuitpython-tinylora-1.0.5.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3

File hashes

Hashes for adafruit-circuitpython-tinylora-1.0.5.tar.gz
Algorithm Hash digest
SHA256 a0a86aecc60fd8a3ad76262be30464a742aacb1390ad264de28e5ffa83fa21fb
MD5 54ec0110c725b12c5ca7a7d90f1c6ef8
BLAKE2b-256 f4426eba0b2098037c3d06e1534f436a8180a3a4256f4585048dccd0d98e3b64

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page