Skip to content

readthedocs_API_improvement #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2021
Merged

readthedocs_API_improvement #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion adafruit_tinylora/adafruit_tinylora.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: GPL-3.0-or-later

"""
`Adafruit_TinyLoRa`
`adafruit_tinylora`
====================================================
CircuitPython LoRaWAN implementation for use with
The Things Network.
Expand Down
2 changes: 1 addition & 1 deletion adafruit_tinylora/adafruit_tinylora_encryption.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: MIT

"""
`adafruit_tinylora_encryption.py`
`adafruit_tinylora_encryption`
======================================================
Required tinyLoRA Encryption Methods for AES and
Message Integrity checks.
Expand Down
2 changes: 1 addition & 1 deletion adafruit_tinylora/ttn_as.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: MIT

"""
`ttn_as.py`
`ttn_as`
======================================================
AS920 The Things Network Frequency Plans
* Author(s): Brent Rubell
Expand Down
2 changes: 1 addition & 1 deletion adafruit_tinylora/ttn_au.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: MIT

"""
`ttn_au.py`
`ttn_au`
======================================================
The Things Network Frequency Plans - AU915
* Author(s): Brent Rubell
Expand Down
2 changes: 1 addition & 1 deletion adafruit_tinylora/ttn_cn.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: MIT

"""
`ttn_cn.py`
`ttn_cn`
======================================================
The Things Network Frequency Plans - CN470
* Author(s): IAMLIUBO
Expand Down
2 changes: 1 addition & 1 deletion adafruit_tinylora/ttn_eu.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: MIT

"""
`ttn_eu.py`
`ttn_eu`
======================================================
The Things Network Frequency Plans - EU863
* Author(s): Brent Rubell
Expand Down
2 changes: 1 addition & 1 deletion adafruit_tinylora/ttn_usa.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: MIT

"""
`ttn_usa.py`
`ttn_usa`
======================================================
The Things Network Frequency Plans - US902
* Author(s): Brent Rubell
Expand Down
25 changes: 23 additions & 2 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,28 @@
.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
.. use this format as the module name: "adafruit_foo.foo"

TinyLoRa
========
.. automodule:: adafruit_tinylora
:members:
:member-order: bysource


.. automodule:: adafruit_tinylora.adafruit_tinylora
:members:

.. automodule:: adafruit_tinylora.adafruit_tinylora_encryption
:members:

.. automodule:: adafruit_tinylora.ttn_as
:members:

.. automodule:: adafruit_tinylora.ttn_au
:members:

.. automodule:: adafruit_tinylora.ttn_cn
:members:

.. automodule:: adafruit_tinylora.ttn_eu
:members:

.. automodule:: adafruit_tinylora.ttn_usa
:members:
18 changes: 18 additions & 0 deletions docs/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,21 @@ Ensure your device works with this simple test.
.. literalinclude:: ../examples/tinylora_simpletest.py
:caption: examples/tinylora_simpletest.py
:linenos:

Using TinyLora with a Sensor
----------------------------

Using TinyLoRa with a Si7021 Sensor

.. literalinclude:: ../examples/tinylora_simpletest_si7021.py
:caption: examples/tinylora_simpletest_si7021.py
:linenos:

Using a single Channel
----------------------

Ensure your device works with this simple test.

.. literalinclude:: ../examples/tinylora_simpletest_single_channel.py
:caption: examples/tinylora_simpletest_single_channel.py
:linenos: