Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions doc/nrf-bm/api/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ Record Access Control Point
:inner:
:members:

.. _api_sensorsim:

Sensor data simulator library
=============================

Expand Down
44 changes: 44 additions & 0 deletions doc/nrf-bm/libraries/sensorsim.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
.. _lib_sensorsim:

Sensor Simulator
################

.. contents::
:local:
:depth: 2

The sensor simulator library provides functionality for simulating sensor data for testing and development purposes.

It currently supports simulating data using a triangular waveform.

Configuration
*************

The library is enabled using the Kconfig system.
Set the :kconfig:option:`CONFIG_SENSORSIM` Kconfig option to enable the library.

Initialization
==============

To initialize a sensor simulator instance, use the :c:func:`sensorsim_init` function.
The function requires providing a configuration for the minimal, maximum, and starting values, as well as the increment between each measurement.

For details on the configuration parameters, see the :c:struct:`sensorsim_cfg` structure.

Usage
*****

After initialization, you can call the :c:func:`sensorsim_measure` function to generate measurements based on a triangular waveform.

Dependencies
************

This library does not have any dependencies.

API documentation
*****************

| Header file: :file:`include/bm/sensorsim.h`
| Source files: :file:`lib/sensorsim/`

:ref:`Sensor data simulator library API reference <api_sensorsim>`
2 changes: 1 addition & 1 deletion doc/nrf-bm/release_notes/release_notes_changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ No changes since the latest nRF Connect SDK Bare Metal release.
Documentation
=============

No changes since the latest nRF Connect SDK Bare Metal release.
* Added documentation for the :ref:`lib_sensorsim` library.