Skip to content

Commit 953ab4e

Browse files
committed
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 <matteo.golin@gmail.com>
1 parent 4030eb8 commit 953ab4e

File tree

1 file changed

+10
-0
lines changed
  • Documentation/components/drivers/character/analog/adc/ads1115

1 file changed

+10
-0
lines changed

Documentation/components/drivers/character/analog/adc/ads1115/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,3 +235,13 @@ of type uint16_t, which corresponds to the LOW_THRESH register value.
235235
236236
This command reads a value from a specific channel of the ADS1115. The argument passed should
237237
be a pointer to a struct adc_msg_s.
238+
239+
.. c:macro:: ANIOC_ADS1115_TRIGGER_CONVERSION
240+
241+
This command triggers an analog conversion on the ADS1115. The argument passed should be a pointer to a ``struct
242+
adc_msg_s``, where the member ``am_channel`` is initialized to the channel number the conversion should be started for.
243+
244+
.. c:macro:: ANIOC_ADS1115_READ_CHANNEL_NO_CONVERSION
245+
246+
This command reads the result of the last conversion on the ADS1115. The argument passed should be a pointer to a
247+
``struct adc_msg_s``, where the result of the conversion will be stored.

0 commit comments

Comments
 (0)