Python wrapper for the Wirepas C Mesh API library

This commit implements a Python wrapper for the Wirepas C Mesh API
library, done using the Cython compiler: https://cython.org. Tested
with Cython v0.29.14. Build script is very rudimentary at this point.

Author: jy-wirepas

python/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include wirepas *.pyx *.pxd *.py *.c *.h

python/setup.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python3
+
+import sys
+import os
+import shutil
+from setuptools import Extension, setup
+from Cython.Distutils import build_ext as built_ext_cython
+from distutils.command.clean import clean
+
+# Package settings
+PACKAGE = "wirepas.mesh_api"
+DIST_NAME = PACKAGE.replace(".", "-").replace("_", "-")
+PACKAGE_DIR = PACKAGE.replace(".", "/")
+EXT_NAME = "_mesh_api"
+LIB_DIR = "../lib"
+
+# C static library name
+if sys.platform == "win32":
+    LIB_EXT = ".lib"
+else:
+    LIB_EXT = ".a"
+
+# Cython extension
+ext_1 = Extension(
+    PACKAGE + "." + EXT_NAME,
+    sources=[PACKAGE_DIR + "/" + EXT_NAME + ".pyx"],
+    include_dirs=[PACKAGE_DIR, LIB_DIR + "/api"],
+    extra_objects=[LIB_DIR + "/build/mesh_api_lib" + LIB_EXT],
+)
+
+
+# Custom "clean" command
+class clean_custom(clean):
+    def run(self):
+        # No need to run the original clean command: clean.run(self)
+
+        # Delete build directories
+        self._rmdir(PACKAGE_DIR + "/__pycache__")
+        self._rmdir(DIST_NAME.replace("-", "_") + ".egg-info")
+        self._rmdir("build")
+        self._rmdir("dist")
+
+        # Delete generated C file
+        self._rm(PACKAGE_DIR + "/" + EXT_NAME + ".c")
+
+    def _rmdir(self, dir):
+        try:
+            shutil.rmtree(dir)
+        except OSError:
+            pass
+
+    def _rm(self, file):
+        try:
+            os.remove(file)
+        except OSError:
+            pass
+
+
+# Main setup functionality
+setup(
+    name=DIST_NAME,
+    version="0.0",
+    author="Wirepas Ltd",
+    author_email="[email protected]",
+    description="Wirepas Mesh API for Python",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: MacOS :: MacOS X",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: POSIX :: Linux",
+        "Programming Language :: C",
+        "Programming Language :: Cython",
+        "Programming Language :: Python :: 3 :: Only",
+        "Topic :: Communications",
+    ],
+    url="https://github.com/wirepas/c-mesh-api",
+    packages=[PACKAGE],
+    ext_modules=[ext_1],
+    python_requires=">=3.4",
+    cmdclass={"build_ext": built_ext_cython, "clean": clean_custom},
+    zip_safe=False,
+)

python/testbench.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python3
+
+import sys
+import time
+
+import wirepas.mesh_api as wm
+
+c = wm.Connection(b"/dev/ttyACM0", 125000)
+
+try:
+    addr = "%d" % c.get_node_address()
+except wm.MeshAPIError:
+    addr = "<not set>"
+
+try:
+    nw_addr = c.get_network_address()
+    nw_addr = "%d (0x%06x)" % (nw_addr, nw_addr)
+except wm.MeshAPIError:
+    nw_addr = "<not set>"
+
+try:
+    nw_channel = "%d" % c.get_network_channel()
+except wm.MeshAPIError:
+    nw_channel = "<not set>"
+
+try:
+    role = "%s" % c.get_role()
+except wm.MeshAPIError:
+    role = "<not set>"
+
+auth_key_set = c.is_authentication_key_set() and "<set>" or "<not set>"
+cipher_key_set = c.is_cipher_key_set() and "<set>" or "<not set>"
+
+try:
+    diag_interval = c.get_app_config_data().interval
+except wm.MeshAPIError:
+    diag_interval = "<not set>"
+
+stack_status = c.get_stack_status()
+
+print("node address:        %s" % addr)
+print("network address:     %s" % nw_addr)
+print("network channel:     %s" % nw_channel)
+print("role:                %s" % role)
+print("authentication key:  %s" % auth_key_set)
+print("encryption key:      %s" % cipher_key_set)
+print("diagnostic interval: %s" % diag_interval)
+print("stack status:        %s" % stack_status)
+
+
+def app_config_data_callback(app_config_data):
+    sys.stdout.write(
+        "\nIn app_config_data_callback(app_config_data = %s)\n" % repr(app_config_data)
+    )
+    sys.stdout.flush()
+
+
+c.register_for_app_config_data(app_config_data_callback)
+
+
+def reception_callback(data):
+    sys.stdout.write("\nIn reception_callback(data = %s)\n" % repr(data))
+    sys.stdout.flush()
+
+
+for n in range(256):
+    c.register_for_data(n, reception_callback)
+
+
+def scan_callback(scan_ready):
+    sys.stdout.write("\nIn scan_callback(scan_ready = %s)\n" % repr(scan_ready))
+    sys.stdout.flush()
+
+
+c.register_for_scan_neighbors_done(scan_callback)
+
+
+def other_callback(*args, **kwargs):
+    sys.stdout.write("\nIn other_callback(%s, %s)\n" % (args, kwargs))
+    sys.stdout.flush()
+
+
+c.register_for_remote_status(other_callback)
+c.register_from_stack_status(other_callback)
+
+
+def wait():
+    while True:
+        time.sleep(1)
+        sys.stdout.write(".")
+        sys.stdout.flush()
+
+
+wait()

python/wirepas/mesh_api/__init__.py

@@ -0,0 +1 @@
+from ._mesh_api import *  # noqa