diff --git a/docs/contributors/hophop/documents.rst b/docs/contributors/hophop/documents.rst new file mode 100644 index 0000000..4d1639a --- /dev/null +++ b/docs/contributors/hophop/documents.rst @@ -0,0 +1,22 @@ +Documents in hophop +=================== + +Documents in hophop that can be useful to Opener are: + +* `the glossary `__, + 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 `__ + lists and links relevant ETSI documents + and references relevant highlights. + +* The `rest of the documentation `__ + includes pointers to obtaining and setting up then nRF9151 DECT firmware, + and includes the READMEs of `examples `__ + and `applications `__. diff --git a/docs/contributors/hophop/index.rst b/docs/contributors/hophop/index.rst new file mode 100644 index 0000000..a6ee1c8 --- /dev/null +++ b/docs/contributors/hophop/index.rst @@ -0,0 +1,13 @@ +hophop +====== + +The hophop project is developed as part of the Ariel OS organization, +available `on GitHub `__, +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 diff --git a/docs/contributors/hophop/utilities.rst b/docs/contributors/hophop/utilities.rst new file mode 100644 index 0000000..b8addbb --- /dev/null +++ b/docs/contributors/hophop/utilities.rst @@ -0,0 +1,21 @@ +Tools in hophop +=============== + +* The `RSSI demo `__ + 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 `__ + is useful in debugging timing between transmission and reception on different transceivers. + +* The `ts-103-636-numbers `__ + and `ts-103-646-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. diff --git a/docs/contributors/index.rst b/docs/contributors/index.rst index bba5b32..6505412 100644 --- a/docs/contributors/index.rst +++ b/docs/contributors/index.rst @@ -9,4 +9,5 @@ At this chapter we will collect all ideas of the contributors. deveritec/index codium/index ostfalia/index + hophop/index