Skip to content

Commit 6dc5313

Browse files
committed
Added ADC API docs, fixed UART module definition
1 parent 152678a commit 6dc5313

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/index.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ Example::
103103
ser.write("Hello World!")
104104
ser.close()
105105

106+
.. module:: Adafruit_BBIO.UART
107+
106108
.. function:: setup_uart(channel)
107109

108110
Set up and start the UART channel. This function will effectively export
@@ -117,6 +119,38 @@ Example::
117119

118120
Cleans up the UART.
119121

122+
:mod:`ADC` --- A/D Converter input interface
123+
--------------------------------------------
124+
125+
This module enables reading analog input values from the analog to digital
126+
converter (ADC) on the Beaglebone processor.
127+
128+
Example::
129+
130+
import Adafruit_BBIO.ADC as ADC
131+
132+
ADC.setup()
133+
134+
# The read method returns normalized values from 0 to 1.0
135+
value = ADC.read("P9_40")
136+
137+
# The read_raw returns non-normalized values
138+
value = ADC.read_raw("P9_40")
139+
140+
.. module:: Adafruit_BBIO.ADC
141+
142+
.. function:: setup_adc()
143+
144+
Setup and start the ADC hardware.
145+
146+
.. function:: setup_read()
147+
148+
Read the normalized 0-1.0 analog value for the channel.
149+
150+
.. function:: setup_read_raw()
151+
152+
Read the raw analog value for the channel.
153+
120154

121155
Indices and tables
122156
==================

0 commit comments

Comments
 (0)