doc: nrf-bm: lib: add documentation for sensor simulator library #424
Conversation
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
github-actions
bot
added
changelog-entry-required
eivindj-nordic
force-pushed
the
doc_sensorsim
branch
from
4d111fb to
a9190cc
Compare
|
You can find the documentation preview for this PR here. |
doc/nrf-bm/libraries/sensorsim.rst
Outdated
| Initialization | ||
| ============== | ||
|
|
||
| A sensor simulator instance is initialized by calling the :c:func:`sensorsim_init` function, providing a configuration for the minimal, maximum and start value plus the increment between each measurement. |
There was a problem hiding this comment.
Suggested change
| A sensor simulator instance is initialized by calling the :c:func:`sensorsim_init` function, providing a configuration for the minimal, maximum and start value plus the increment between each measurement. | |
| A sensor simulator instance is initialized by calling the :c:func:`sensorsim_init` function, providing a configuration for the minimal, maximum, and start value, plus the increment between each measurement. |
eivindj-nordic
force-pushed
the
doc_sensorsim
branch
from
a9190cc to
516c3f9
Compare
anhmolt
reviewed
Oct 13, 2025
doc/nrf-bm/libraries/sensorsim.rst
Outdated
| ***************** | ||
|
|
||
| | Header file: :file:`include/sensorsim.h` | ||
| | Source files: :file:`lib/bsensorsim/` |
There was a problem hiding this comment.
Suggested change
| | Source files: :file:`lib/bsensorsim/` | |
| | Source files: :file:`lib/sensorsim/` |
doc/nrf-bm/api/api.rst
Outdated
Comment on lines
128
to
132
| Sensor data simulator library | ||
| ============================= | ||
|
|
||
| .. _api_sensorsim: | ||
|
|
There was a problem hiding this comment.
Suggested change
| Sensor data simulator library | |
| ============================= | |
| .. _api_sensorsim: | |
| .. _api_sensorsim: | |
| Sensor data simulator library | |
| ============================= |
eivindj-nordic
force-pushed
the
doc_sensorsim
branch
from
516c3f9 to
2c8df69
Compare
lemrey
approved these changes
Oct 17, 2025
eivindj-nordic
force-pushed
the
doc_sensorsim
branch
from
2c8df69 to
7e88d42
Compare
Add documentation for sensor simulator library. Signed-off-by: Eivind Jølsgard <[email protected]>
eivindj-nordic
force-pushed
the
doc_sensorsim
branch
from
7e88d42 to
4fc7f44
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Add documentation for sensor simulator library.