Add documentation

Create modul structure

.gitignore

@@ -114,4 +114,5 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-/test/lora.conf
+/test/
+/make.conf

.idea/dictionaries/akira.xml

@@ -0,0 +1,8 @@
+<component name="ProjectDictionaryState">
+  <dictionary name="akira">
+    <words>
+      <w>hweui</w>
+      <w>preprogrammed</w>
+    </words>
+  </dictionary>
+</component>

.idea/rn2483lora.iml

@@ -3,6 +3,7 @@
   <component name="NewModuleRootManager">
     <content url="file://$MODULE_DIR$">
       <sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/rn2483lora" isTestSource="false" />
       <excludeFolder url="file://$MODULE_DIR$/test" />
     </content>
     <orderEntry type="jdk" jdkName="Python 3.6" jdkType="Python SDK" />

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = rn2483lora
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,174 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# rn2483lora documentation build configuration file, created by
+# sphinx-quickstart on Sat Dec 28 22:47:27 2019.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
+
+from rn2483lora import __version__
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'rn2483lora'
+copyright = '2019, Sven Sager (NaruxDe)'
+author = 'Sven Sager (NaruxDe)'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = __version__
+# The full version, including alpha/beta/rc tags.
+# release = ''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'rn2483loradoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'rn2483lora.tex', 'rn2483lora Documentation',
+     'Sven Sager (NaruxDe)', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'rn2483lora', 'rn2483lora Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'rn2483lora', 'rn2483lora Documentation',
+     author, 'rn2483lora', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/index.rst

@@ -0,0 +1,20 @@
+.. rn2483lora documentation master file, created by
+   sphinx-quickstart on Sat Dec 28 22:47:27 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to rn2483lora's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/modules.rst

@@ -0,0 +1,7 @@
+rn2483lora
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   rn2483lora

docs/rn2483lora.rst

@@ -0,0 +1,30 @@
+rn2483lora package
+==================
+
+Submodules
+----------
+
+rn2483lora\.cli module
+----------------------
+
+.. automodule:: rn2483lora.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rn2483lora\.rn2483 module
+-------------------------
+
+.. automodule:: rn2483lora.rn2483
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: rn2483lora
+    :members:
+    :undoc-members:
+    :show-inheritance:

lora.conf

@@ -1,5 +1,6 @@
 [DEFAULT]
 port = /dev/ttyUSB0
+baud = 57600
 appskey =
 nwkskey =
 devaddr =

rn2483lora/__init__.py

@@ -1,5 +1,10 @@
 # -*- coding: utf-8 -*-
 """Module for LoRaWAN chip RN2483."""
+from rn2483 import RN2483
 __author__ = "Sven Sager"
 __copyright__ = "Copyright (C) 2019 Sven Sager"
-__license__ = "GPLv3"
+__license__ = "LGPLv3"
+__version__ = "0.1.0"
+__all__ = [
+    "RN2483",
+]

rn2483lora/cli.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+"""Command line for RN2483 LoRaWAN."""
+from rn2483 import RN2483
+
+__author__ = "Sven Sager"
+__copyright__ = "Copyright (C) 2019 Sven Sager"
+__license__ = "LGPLv3"
+
+if __name__ == '__main__':
+    from configparser import ConfigParser
+    from time import sleep
+
+    conf = ConfigParser()
+    conf.read("lora.conf")
+
+    root = RN2483(
+        conf.get("DEFAULT", "port"),
+        conf.get("DEFAULT", "baud", fallback=57600),
+    )
+
+    def first_init() -> None:
+        """Init our RN2483 after firmware startup."""
+
+        print(root.version)
+        print(root.hweui)
+
+        # Configuration: ["cmd", results]
+        cmd_list = [
+            ["mac reset 868", 1],
+
+            # Set TTN configurations form .conf file
+            ["mac set appskey {0}".format(conf.get("DEFAULT", "appskey")), 1],
+            ["mac set nwkskey {0}".format(conf.get("DEFAULT", "nwkskey")), 1],
+            ["mac set devaddr {0}".format(conf.get("DEFAULT", "devaddr")), 1],
+
+            ["mac join abp", 2],
+            ["mac set ar on", 1],
+        ]
+        for do_cmd in cmd_list:
+            print("<-", do_cmd[0])
+            print("->", root.send(do_cmd[0]))
+
+            # Get awaited extra results results
+            for i in range(do_cmd[1] - 1):
+                print("  ", root.get_result())
+
+    first_init()
+
+    # Command mode
+    while True:
+        results = 1
+
+        cmd_input = input("<- ")
+        if cmd_input == "exit":
+            break
+        elif cmd_input == "reset":
+            root.send("sys reset")
+            sleep(3)
+            first_init()
+            continue
+
+        # Functions to make live more easier
+        elif cmd_input.find("send ") > -1:
+            lst = cmd_input.split()
+            cmd_input = "mac tx uncnf {port} {bytes}".format(
+                port=lst[2] if len(lst) > 2 else 1,
+                bytes=lst[1] if len(lst) > 1 else "",
+            )
+            results = 2
+
+        # Always send command
+        if cmd_input:
+            print("->", root.send(cmd_input))
+
+        # Get awaited extra results results
+        for i in range(results - 1):
+            print("  ", root.get_result())
+
+    root.close()

rn2483lora/rn2483.py

@@ -7,7 +7,7 @@ from serial import Serial
 
 __author__ = "Sven Sager"
 __copyright__ = "Copyright (C) 2019 Sven Sager"
-__license__ = "GPLv3"
+__license__ = "LGPLv3"
 
 
 class RN2483:
@@ -83,71 +83,22 @@ class RN2483:
         if get_result:
             return self.get_result(timeout)
 
+    @property
+    def hweui(self):
+        """
+        Reads the preprogrammed EUI node address.
 
-if __name__ == '__main__':
-    from configparser import ConfigParser
-    from time import sleep
+        This command reads the preprogrammed EUI node address from the RN2483
+        module. The value returned by this command is a globally unique number
+        provided by Microchip.
+        :return: Preprogrammed EUI node address
+        """
+        return self.send("sys get hweui", True)
 
-    conf = ConfigParser()
-    conf.read("lora.conf")
-
-    root = RN2483(conf.get("DEFAULT", "port"))
-
-    def first_init() -> None:
-        """Init our RN2483 after firmware startup."""
-
-        # Configuration: ["cmd", results]
-        cmd_list = [
-            ["sys get ver", 1],
-            ["mac reset 868", 1],
-            ["sys get hweui", 1],
-
-            # Set TTN configurations form .conf file
-            ["mac set appskey {0}".format(conf.get("DEFAULT", "appskey")), 1],
-            ["mac set nwkskey {0}".format(conf.get("DEFAULT", "nwkskey")), 1],
-            ["mac set devaddr {0}".format(conf.get("DEFAULT", "devaddr")), 1],
-
-            ["mac join abp", 2],
-            ["mac set ar on", 1],
-        ]
-        for do_cmd in cmd_list:
-            print("<-", do_cmd[0])
-            print("->", root.send(do_cmd[0]))
-
-            # Get awaited extra results results
-            for i in range(do_cmd[1] - 1):
-                print("  ", root.get_result())
-
-    first_init()
-
-    # Command mode
-    while True:
-        results = 1
-
-        cmd_input = input("<- ")
-        if cmd_input == "exit":
-            break
-        elif cmd_input == "reset":
-            root.send("sys reset")
-            sleep(3)
-            first_init()
-            continue
-
-        # Functions to make live more easier
-        elif cmd_input.find("send ") > -1:
-            lst = cmd_input.split()
-            cmd_input = "mac tx uncnf {port} {bytes}".format(
-                port=lst[2] if len(lst) > 2 else 1,
-                bytes=lst[1] if len(lst) > 1 else "",
-            )
-            results = 2
-
-        # Always send command
-        if cmd_input:
-            print("->", root.send(cmd_input))
-
-        # Get awaited extra results results
-        for i in range(results - 1):
-            print("  ", root.get_result())
-
-    root.close()
+    @property
+    def version(self) -> str:
+        """
+        Get information on hardware platform, firmware version, release date.
+        :return: RN2483 X.Y.Z MMM DD YYYY HH:MM:SS
+        """
+        return self.send("sys get ver", True)

setup.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+"""Setup for rn2482lora module."""
+from setuptools import setup
+
+__author__ = "Sven Sager"
+__copyright__ = "Copyright (C) 2019 Sven Sager"
+__license__ = "LGPLv3"
+
+setup(
+    version='0.1.0',
+
+    packages=['rn2483lora'],
+    python_requires="~=3.4",
+    install_requires=["pyserial"],
+    keywords="lora network lorawan iot",
+
+    # Additional meta-data
+    name='rn2483lora',
+    author='Sven Sager',
+    author_email='akira@narux.de',
+    maintainer="Sven Sager",
+    maintainer_email="akira@narux.de",
+    url='https://narux.de',
+    description='Wraper module for microchips LoRaWAN chip RN2483',
+    long_description="Add LoRaWAN capabilities to your python program. This module will help you "
+                     "to use the RN2483 chip of microchips. It will manage the serial communication "
+                     "and send data over LoRaWAN.",
+    download_url="",
+    classifiers=[
+        "Development Status :: 1 - Planning",
+        # "Development Status :: 2 - Pre-Alpha",
+        # "Development Status :: 3 - Alpha",
+        # "Development Status :: 4 - Beta",
+        # "Development Status :: 5 - Production/Stable",
+        "Environment :: Console",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3 :: Only",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "Topic :: System :: Networking",
+    ],
+    license='LGPLv3',
+)