diff --git a/docs/Doxyfile b/docs/Doxyfile index 02946d61..ce5a7bd9 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -23,7 +23,7 @@ # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "Newly Optimized RF24Network Layer" +PROJECT_NAME = "Optimized RF24Network Layer" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -35,7 +35,7 @@ PROJECT_NUMBER = # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "2020 - Optimized RF24 Network Layer for NRF24L01 radios" +PROJECT_BRIEF = "2024 - Optimized RF24 Network Layer for NRF24L01 & NRF52x radios" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 diff --git a/docs/addressing.md b/docs/addressing.md index 83eb51ba..a9930ab6 100644 --- a/docs/addressing.md +++ b/docs/addressing.md @@ -27,6 +27,14 @@ subnets need to be created if using more than 6 nodes. In this case, the The above example is exactly how RF24Network manages the addresses, but they are represented in Octal format. +## Available Addresses + +RF24Network supports various configurations, but by default has multicast enabled. This means one additional pipe is taken up on each +node for multicasting. The master node will support 5 nodes (01 through 05) and 1 multicast address, while the nodes themselves will +support 4 nodes (01n to 04n etc), 1 multicast address and 1 parent pipe. Users can edit RF24Network_config.h and comment out +`#define RF24NetworkMulticast` as well. This allows the master to support 6 children, with nodes supporting 5 children each. +See the [Topology and Overview](md_docs_tuning.html) page for more info regarding topology. + ### Decimal, Octal and Binary | Decimal | Octal | Binary |