adafruit / adafruit/Adafruit_CircuitPython_RFM9x
missing documentation on CircutPython website
- Dominant language
- Python
- Stars
- 76
- Forks
- 53
- PR merge metrics
- No merged PRs in 30d
Description
On the CircutPython website https://docs.circuitpython.org/projects/rfm9x/en/latest/api.html#adafruit_rfm9x.RFM9x.last_rssi there are a few missing functions and there definition's; low_datarate_optimize() (not listed or defined the use case),
radiohead(),
enable_address_filter(),
fsk_node_address() (what is the difference from node() ?)
fsk_broadcast_address(),
rfm.encryption_key(),
rfm9xfsk.RFM9xFSK() (FSK is not defined or explained in any capacity),
rfm.payload_ready(),
spreading_factor() (it dose not say when or how you can use sf 6, I know you can only use it in implicit header mode but that's only because I read the data sheet),
I believe there are more commands not listed in the docs or there sintax have changed, it would be beneficial to go through the examples here in the GitHub and compare them to what's on the circutpython docs to make sure that there accurate, I am new to this module and have relatively little experience although I do have a project that I am currently working on, but it is hard to understand the changes that have been made post December of 24 because there is limited docs (that I can find) for witch commands were changed and how.
I think all the examples shown no longer work due to changes in the way you reference the module when first setting up the radio as an example;
https://github.com/adafruit/Adafruit_CircuitPython_RFM/blob/8f0b80e279201b24d204a57042e97c70b6229f56/examples/rfm_simpletest.py#L35 this line is different between the GitHub docs and CircutPython docs
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the API documentation page for RFM9x and the linked examples/rfm_simpletest.py example, then compare the documented API and module setup against the repository examples. Inventory the missing functions and changed references, documenting their definitions, use cases, and differences where stated by the issue. Done means the relevant API entries and examples are consistent and explain the requested behavior, including FSK and spreading-factor usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100