Add documentation for power, LED and environmental modules#146
Merged
jtguggedal merged 4 commits intomainfrom Mar 28, 2025
Merged
Add documentation for power, LED and environmental modules#146jtguggedal merged 4 commits intomainfrom
jtguggedal merged 4 commits intomainfrom
Conversation
Mention that the button nubmer is sent as payload in message on BUTTON_CHAN. Signed-off-by: Jan Tore Guggedal <jantore.guggedal@nordicsemi.no>
Add environmental module documentation. Signed-off-by: Jan Tore Guggedal <jantore.guggedal@nordicsemi.no>
Add documentation for the LED module. Signed-off-by: Jan Tore Guggedal <jantore.guggedal@nordicsemi.no>
Add documentation for the power module. Signed-off-by: Jan Tore Guggedal <jantore.guggedal@nordicsemi.no>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request includes several documentation updates and code changes across multiple modules to improve clarity and functionality. The most important changes include detailed explanations of module functionalities, message structures, and configuration options.
Documentation updates:
docs/modules/environmental.md: Expanded the description of the Environmental module, including how it collects and communicates sensor data, message types, and configuration options.docs/modules/led.md: Enhanced the LED module documentation with details on message parameters, operation, and configuration options.docs/modules/power.md: Updated the Power module documentation to include functionality, message types, and configuration options.Code changes:
app/src/modules/environmental/environmental.c: Removed unusedbme68x_iaq.hheader file.app/src/modules/led/led.c: Removed an unnecessary blank line in thepwm_outfunction.These changes enhance the clarity and maintainability of the documentation and codebase.