Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions docs/contributors/hophop/documents.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Documents in hophop
===================

Documents in hophop that can be useful to Opener are:

* `the glossary <https://github.com/ariel-os/hophop/blob/main/doc/glossary.md>`__,
merging relevant definitions from the ETSI specification
with terminology from IETF (relevant for key establishment in joining)
and occasionally own conventions (such as which terms to avoid due to potential for confusion)
and own terms (eg. describing Nordic's IPv6 workaround).

With some extra metadata on which term is relevant where,
this could migrate into Opener.

* `external documents <https://github.com/ariel-os/hophop/blob/main/doc/external.md>`__
lists and links relevant ETSI documents
and references relevant highlights.

* The `rest of the documentation <https://github.com/ariel-os/hophop/tree/main/doc>`__
includes pointers to obtaining and setting up then nRF9151 DECT firmware,
and includes the READMEs of `examples <https://github.com/ariel-os/hophop/tree/main/examples>`__
and `applications <https://github.com/ariel-os/hophop/tree/main/applications>`__.
13 changes: 13 additions & 0 deletions docs/contributors/hophop/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
hophop
======

The hophop project is developed as part of the Ariel OS organization,
available `on GitHub <https://github.com/ariel-os/hophop>`__,
and provided as a contribution to the Opener project.
It is written in Rust, and thus not directly applicable for code transfer,
but nonetheless exchanging tools, documentation,
and maybe integrating through C APIs at some time.

.. toctree::
documents
utilities
21 changes: 21 additions & 0 deletions docs/contributors/hophop/utilities.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Tools in hophop
===============

* The `RSSI demo <https://github.com/ariel-os/hophop/tree/main/examples#running-the-rssi-example>`__
contains all tools to continuously scan RSSI on a channel
(or to sweep multiple channels)
and to visualize the usage pattern in Python.

* The `ping example <https://github.com/ariel-os/hophop/tree/main/examples#running-the-ping-example>`__
is useful in debugging timing between transmission and reception on different transceivers.

* The `ts-103-636-numbers <https://crates.io/crates/ts-103-636-numbers>`__
and `ts-103-646-utils <https://crates.io/crates/ts-103-636-utils>`__ crates
encapsulate the mapping between names and numbers
in the various documents,
mostly around MAC IEs,
for decoding them and for debug output.

Even outside of the Rust implementation,
they can serve as a tool to generate code point lists,
reducing the number of times the standards' tables need to be copied into code.
1 change: 1 addition & 0 deletions docs/contributors/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ At this chapter we will collect all ideas of the contributors.
deveritec/index
codium/index
ostfalia/index
hophop/index

Loading