Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Update addressing & Title Info #223

Merged
merged 3 commits into from
Mar 17, 2024
Merged

Docs: Update addressing & Title Info #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d705b01
Add info regarding addressing
TMRh20 Mar 17, 2024
e02025f
Update Doxyfile
TMRh20 Mar 17, 2024
831e440
Comment vs uncomment
TMRh20 Mar 17, 2024
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
4 changes: 2 additions & 2 deletions docs/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/addressing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down