swarmit 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

dotbot-firmware/doc/sphinx/conf.py

@@ -0,0 +1,191 @@
+# Configuration file for the Sphinx documentation builder.
+
+import glob
+import os
+import shutil
+import subprocess
+import sys
+
+
+project = 'DotBot-firmware'
+copyright = '2023, Inria'
+author = 'Alexandre Abadie'
+
+# -- General configuration ----------------------------------------------------
+extensions = [
+    'breathe',
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.inheritance_diagram",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+]
+
+language = "en"
+tls_verify = False
+templates_path = ['_templates']
+exclude_patterns = ["_build"]
+nitpick_ignore_regex = [
+    (r'c:.*', r'[u]*int\d{1,2}_t'),     # ignore int8_t, uint8_t, ...
+    (r'c:.*', r'NRF_.*'),               # ignore NRF_ macros
+    (r'c:.*', r'[s]*size_t'),           # ignore size_t and ssize_t 
+    (r'c:.*', r'[U]*INT\d{1,2}_MAX'),   # ignore INT8_MAX, UINT8_MAX, ...
+]
+
+# -- Options for breathe ------------------------------------------------------
+breathe_projects = {"DotBot-firmware": "../doxygen/xml/"}
+breathe_default_project = "DotBot-firmware"
+breathe_show_include = False
+breathe_domain_by_extension = {
+    "h" : "c",
+}
+
+myst_enable_extensions = ["html_image"]
+
+# -- Options for HTML output --------------------------------------------------
+html_theme = "pydata_sphinx_theme"
+html_sourcelink_suffix = ""
+html_static_path = ["_static"]
+
+# Define the json_url for our version switcher.
+json_url = "https://dotbot-firmware.readthedocs.io/en/latest/_static/switcher.json"
+rtd_version = os.environ.get("READTHEDOCS_VERSION")
+rtd_version_type = os.environ.get("READTHEDOCS_VERSION_TYPE")
+rtd_git_identifier = os.environ.get("READTHEDOCS_GIT_IDENTIFIER")
+# If READTHEDOCS_VERSION doesn't exist, we're not on RTD
+# If it is an integer, we're in a PR build and the version isn't correct.
+# If it's "latest" → change to "dev" (that's what we want the switcher to call it)
+if not rtd_version or rtd_version.isdigit() or rtd_version == "latest":
+    rtd_version = "dev"
+    json_url = "_static/switcher.json"
+elif rtd_version == "stable":
+    rtd_version = f"{rtd_git_identifier}"
+elif rtd_version_type == "tag":
+    rtd_version = f"{rtd_git_identifier}"
+
+html_theme_options = {
+    "external_links": [
+        {
+            "url": "https://github.com/DotBots/PyDotBot",
+            "name": "PyDotBot",
+            "attributes": {
+               "target" : "_blank",
+               "rel" : "noopener me",
+            },
+        },
+        {
+            "url": "https://github.com/DotBots/DotBot-hardware",
+            "name": "DotBot hardware",
+            "attributes": {
+               "target" : "_blank",
+               "rel" : "noopener me",
+            },
+        },
+    ],
+    "icon_links": [
+         {
+            "name": "GitHub",
+            "url": "https://github.com/DotBots/DotBot-firmware",
+            "icon": "fa-brands fa-github",
+        },
+    ],
+    "header_links_before_dropdown": 4,
+    "logo": {
+        "text": "DotBot firmware",
+    },
+    "navbar_align": "left",
+    "navbar_center": ["version-switcher", "navbar-nav"],
+    "switcher": {
+        "json_url": json_url,
+        "version_match": rtd_version,
+    },
+    "footer_start": ["copyright"],
+    "footer_center": ["sphinx-version"],
+}
+
+# -- Options for autosummary/autodoc output -----------------------------------
+autosummary_generate = True
+autodoc_typehints = "description"
+autodoc_member_order = "groupwise"
+
+# Hook for building doxygen documentation -------------------------------------
+
+def run_doxygen(app):
+    """Run the doxygen make command."""
+    doxygen_path = "../doxygen"
+    try:
+        retcode = subprocess.call(f"make -C {doxygen_path}", shell=True)
+        if retcode < 0:
+            sys.stderr.write(f"doxygen terminated by signal {-retcode}")
+    except OSError as e:
+        sys.stderr.write(f"doxygen execution failed: {e}")
+
+# Hook for generating linked README.md files --------------------------------------------
+
+README_INCLUDE_TEMPLATE = """```{{include}} {path_to_readme}
+:relative-images:
+:relative-docs: ../../
+```
+"""
+
+def generate_readme(app, prefix, dest):
+    projects_dir = os.path.join(app.srcdir, "../../projects/")
+    projects = [os.path.basename(project) for project in glob.glob(f"{projects_dir}/{prefix}*")]
+    output_dir = os.path.join(app.srcdir, dest)
+    if not os.path.exists(output_dir):
+        os.makedirs(output_dir, exist_ok=True)
+    for project in projects:
+        with open(os.path.join(output_dir, f"{project}.md"), "w") as f:
+            f.write(README_INCLUDE_TEMPLATE.format(path_to_readme=f"../../../projects/{project}/README.md"))
+
+
+def generate_projects_readme(app):
+    for prefix, dest in [("01", "_examples"), ("03app", "_projects")]:
+        generate_readme(app, prefix, dest)
+
+
+API_INCLUDE_TEMPLATE = """{title}
+=================================
+
+.. doxygengroup:: {module}
+.. doxygenfile:: {header}
+
+"""
+EXCLUDE_MODULES = [
+    "board_config",
+    "soft_ed25519",
+    "soft_edsign",
+    "soft_f25519",
+    "soft_fprime",
+    "soft_sha256",
+    "soft_sha512",
+]
+
+
+def generate_api_files(app):
+    output_dir = os.path.join(app.srcdir, "_api")
+    if not os.path.exists(output_dir):
+        os.makedirs(output_dir, exist_ok=True)
+    for module in ["bsp", "crypto", "drv"]:
+        module_dir = os.path.join(app.srcdir, f"../../{module}/")
+        submodules = [os.path.basename(project).split(".")[0] for project in glob.glob(f"{module_dir}/*.h")]
+        submodules = [module for module in submodules if module not in EXCLUDE_MODULES]
+        for submodule in submodules:
+            with open(os.path.join(output_dir, f"{module}_{submodule}.rst"), "w") as f:
+                f.write(
+                    API_INCLUDE_TEMPLATE.format(
+                        title=f"{submodule.capitalize()}",
+                        module=f"{module}_{submodule}",
+                        header=f"{module}/{submodule}.h"
+                    )
+                )
+
+
+def setup(app):
+    """Add hook for building doxygen documentation."""
+    app.connect("builder-inited", run_doxygen)
+    app.connect("builder-inited", generate_api_files)
+    app.connect("builder-inited", generate_projects_readme)

{swarmit-0.1.0.dist-info → swarmit-0.3.0.dist-info}/METADATA

@@ -1,11 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: swarmit
-Version: 0.1.0
+Version: 0.3.0
 Summary: Run Your Own Robot Swarm Testbed.
 Project-URL: Homepage, https://github.com/DotBots/swarmit
 Project-URL: Bug Tracker, https://github.com/DotBots/swarmit/issues
 Author-email: Alexandre Abadie <alexandre.abadie@inria.fr>
 License: BSD
+License-File: AUTHORS
 License-File: LICENSE
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: MacOS
@@ -15,7 +16,8 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.7
 Requires-Dist: click==8.1.7
 Requires-Dist: cryptography==43.0.1
-Requires-Dist: pydotbot==0.21.2
+Requires-Dist: paho-mqtt>=2.1.0
+Requires-Dist: pydotbot==0.22.0
 Requires-Dist: pyserial==3.5
 Requires-Dist: rich==13.8.1
 Requires-Dist: structlog==24.4.0
@@ -50,12 +52,32 @@ and [bootloader.emProject](device/bootloader/bootloader.emProject) in SES
 
 The device is now ready.
 
+### Gateway
+
+The communication between the computer and the swarm devices is performed via a
+gateway board connected via USB to the computer.
+The gateway board is a Nordic nRF53840DK.
+
+The firmware to run on the gateway can also be compiled and flash using SES.
+The SES project to open is located at [gateway.emProject](gateway/gateway.emProject).
+
+After flashing the gateway firmware, LED1 on the DK should blink fast during 1s.
+
 ### Python CLI script
 
 The Python CLI script provides commands for flashing, starting and stopping user
 code on the device, as well as monitoring and checking the status of devices
 in the swarm.
 
+The Python CLI script connects via a virtual COM port to the gateway connected to
+the computer.
+
+The Python CLI script is available on PyPI. Install it using:
+
+```
+pip install swarmit
+```
+
 Default usage:
 
 ```

swarmit-0.3.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+dotbot-firmware/doc/sphinx/conf.py,sha256=uQJVglqE9HoqMXJf5nbmCVCLSSGbqfiSr5ZQbE7HsLk,6211
+testbed/cli/main.py,sha256=FjGbeRkEKT48drOT79Tphfotl23lFV3RgNS_92fsnT4,10741
+testbed/swarmit/__init__.py,sha256=VrXpHDu3erkzwl_WXrqINBm9xWkcyUy53IQOj042dOs,22
+testbed/swarmit/adapter.py,sha256=jX3SJ_Z-cOqERa2Oh-KerzY-5eY6FFicbufGyDPapME,2899
+testbed/swarmit/controller.py,sha256=o0rXvLC-9gyizlz73kr4Q2YQ3Tk5dd5cCAxaoBShh04,21451
+testbed/swarmit/protocol.py,sha256=JOXUAGDBY2bI9exw7UMivtjm9a8hi0081_1s4haHx-4,8477
+swarmit-0.3.0.dist-info/METADATA,sha256=-9rqDCAmXS7WwCVOquKYvDcjJCo8YpY7OX9QQz7tSAY,3324
+swarmit-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+swarmit-0.3.0.dist-info/entry_points.txt,sha256=R6BGQe6I1FcI5B2jo7Dr-Gh6-Rjn1Ykx3uAGuV5rVTo,50
+swarmit-0.3.0.dist-info/licenses/AUTHORS,sha256=o2cH3J5JkbZssK_1zYj0m8PHiGiILV0lySR6_hoWKK0,45
+swarmit-0.3.0.dist-info/licenses/LICENSE,sha256=j97C1uBc5chpQWi4bv_2SrqExuvKaJK2Ch6L2LFkoc4,1492
+swarmit-0.3.0.dist-info/RECORD,,

{swarmit-0.1.0.dist-info → swarmit-0.3.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

swarmit-0.3.0.dist-info/licenses/AUTHORS

@@ -0,0 +1 @@
+Alexandre Abadie <alexandre.abadie@inria.fr>