You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by li...@apache.org on 2025/07/14 14:22:41 UTC
(nuttx) 02/02: docs/ads1115: Add trigger commands to documentation
This is an automated email from the ASF dual-hosted git repository.
linguini pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 953ab4e2879d97d53a4aa1b36ad7932046d48373
Author: Matteo Golin <ma...@gmail.com>
AuthorDate: Fri Jul 11 15:53:18 2025 -0400
docs/ads1115: Add trigger commands to documentation
Updates the ADS1115 documentation with information about the two new
commands for triggering conversion and reading the result.
Signed-off-by: Matteo Golin <ma...@gmail.com>
---
.../components/drivers/character/analog/adc/ads1115/index.rst | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/Documentation/components/drivers/character/analog/adc/ads1115/index.rst b/Documentation/components/drivers/character/analog/adc/ads1115/index.rst
index 7b741b70291..b50f33e92dd 100644
--- a/Documentation/components/drivers/character/analog/adc/ads1115/index.rst
+++ b/Documentation/components/drivers/character/analog/adc/ads1115/index.rst
@@ -235,3 +235,13 @@ of type uint16_t, which corresponds to the LOW_THRESH register value.
This command reads a value from a specific channel of the ADS1115. The argument passed should
be a pointer to a struct adc_msg_s.
+
+.. c:macro:: ANIOC_ADS1115_TRIGGER_CONVERSION
+
+This command triggers an analog conversion on the ADS1115. The argument passed should be a pointer to a ``struct
+adc_msg_s``, where the member ``am_channel`` is initialized to the channel number the conversion should be started for.
+
+.. c:macro:: ANIOC_ADS1115_READ_CHANNEL_NO_CONVERSION
+
+This command reads the result of the last conversion on the ADS1115. The argument passed should be a pointer to a
+``struct adc_msg_s``, where the result of the conversion will be stored.