1
-
2
1
Introduction
3
2
============
4
3
@@ -17,16 +16,38 @@ Introduction
17
16
Support for the ADS1x15 series of analog-to-digital converters. Available in 12-bit (ADS1015)
18
17
and 16-bit (ADS1115) versions.
19
18
20
- Dependencies
21
- =============
19
+ Installation & Dependencies
20
+ ===========================
21
+
22
22
This driver depends on:
23
23
24
24
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython >`_
25
25
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice >`_
26
26
27
27
Please ensure all dependencies are available on the CircuitPython filesystem.
28
- This is easily achieved by downloading
29
- `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle >`_.
28
+ This can be most easily achieved by downloading and installing
29
+ `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle >`_ on
30
+ your device.
31
+
32
+ Installing from PyPI
33
+ --------------------
34
+
35
+ On the Raspberry Pi, you can install the driver locally
36
+ `from PyPI <https://pypi.org/project/adafruit-circuitpython-ads1x15/ >`_. To
37
+ install system-wide, use:
38
+
39
+ .. code-block :: shell
40
+
41
+ sudo pip3 install adafruit-circuitpython-ads1x15
42
+
43
+ To install in a virtual environment in your current project:
44
+
45
+ .. code-block :: shell
46
+
47
+ mkdir project-name && cd project-name
48
+ python3 -m venv .env
49
+ source .env/bin/activate
50
+ pip3 install adafruit-circuitpython-ads1x15
30
51
31
52
Usage Example
32
53
=============
@@ -94,7 +115,7 @@ Then run the build:
94
115
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ads1x15 --library_location .
95
116
96
117
Sphinx documentation
97
- -----------------------
118
+ --------------------
98
119
99
120
Sphinx is used to build the documentation based on rST files and comments in the code. First,
100
121
install dependencies (feel free to reuse the virtual environment from above):
0 commit comments