Repository Cleanup

.editorconfig

@@ -0,0 +1,11 @@
+
+root = true
+
+[*]
+insert_final_newline = true
+end_of_line = lf
+charset = utf-8
+
+[*.{md,py}]
+indent_style = space
+indent_size = 4

Documentation/API.md

@@ -0,0 +1,71 @@
+
+# API
+
+<br>
+
+## Import
+
+The module can be imported with:
+
+```python
+from PiScope import Plotter
+```
+
+<br>
+<br>
+
+## Plotter
+
+Create a **Oscilloscope** / **XY Plotter** instance with:
+
+```python
+plotter = Plotter()
+```
+
+<br>
+<br>
+
+## Setup
+***`plotter.setup(channels)`***
+
+Setup the channels of the breakout board used for oscilloscope / XY Plotter.
+
+<br>
+
+### Channels 
+
+**Type :** `List / Array`
+
+The list of channels to listen to.
+
+<br>
+
+##### Oscilloscope
+
+In this configuration, `channels` is a list with `1` element <br>
+representing the active channel on which to listen.
+
+```python
+plotter.setup([ <Channel> ])
+```
+
+<br>
+
+##### XY Plotter
+
+In this configuration, `channels` is a list with `2` elements <br>
+representing the active channels on which to listen. 
+
+```python
+plotter.setup([ <X-Channel> , <Y-Channel> ])
+```
+
+<br>
+<br>
+
+## Plot
+***`plotter.plot()`***
+
+Plots the analog values on the **Oscilloscope** / **XY Plotter**.
+
+<br>

Documentation/Boards/ADS1015.md

@@ -0,0 +1,55 @@
+
+# ADS1015
+
+*Interfacing the ADS1015 with Raspberry Pi*
+
+<br>
+<br>
+
+## Instructions
+
+1. Connect the **Adafruit ADS1015** to your **Raspberry Pi**
+
+	**I2C Address :** `0x48`
+
+	| Breakout <br> Board | Pi |
+	|:-------------------:|:---:|
+	| `GND` | `GND` |
+	| `5V` | `5V` |
+	| `SDA` | `SDA` |
+	| `SCL` | `SCL` |
+	| `ADDR` | `GND` |
+
+    <br>
+
+2. Check the devices connected to the I2C bus
+
+ 	```sh
+	i2cdetect -y 1
+	```
+
+	*The ADS1015 should be listed.*
+
+<br>
+<br>
+
+## Documentation
+
+For more information on interfacing, <br>
+check out the **Adafruit** documentation.
+
+- [Raspberry Pi & Python]
+
+- [Configuring I2C]
+
+- [ADC Breakouts]
+
+
+<br>
+
+
+<!----------------------------------------------------------------------------->
+
+[Raspberry Pi & Python]: https://github.com/adafruit/Adafruit-Raspberry-Pi-Python-Code
+[Configuring I2C]: https://learn.adafruit.com/adafruits-raspberry-pi-lesson-4-gpio-setup/configuring-i2c
+[ADC Breakouts]: https://learn.adafruit.com/adafruit-4-channel-adc-breakouts/

Documentation/Setup.md

@@ -0,0 +1,57 @@
+
+# Setup
+
+<br>
+
+## Hardware
+
+1. Raspberry Pi B / B+ / 2
+
+2. **[A Supported Breakout Board][Boards]**
+
+<br>
+<br>
+
+## Software
+
+1.  **[Python]**
+
+    *Version `2.7`*
+
+    <br>
+
+2.  **Python Modules**
+
+    - [`numpy`][Pip Numpy]
+
+    - [`matplotlib`][Pip Matplot]
+
+    - [`scipy`][Pip Scipy]
+
+    - [`tkinter`][Tkinter]
+
+    <br>
+
+    These modules can be installed with:
+
+    ```sh
+    pip install     \
+        matplotlib  \
+        numpy       \
+        scipy
+    ```
+
+<br>
+
+
+<!----------------------------------------------------------------------------->
+
+[Boards]: Boards/
+
+[Python]: https://www.python.org/
+
+[Pip Numpy]: https://pypi.org/project/numpy/
+[Pip Matplot]: https://pypi.org/project/matplotlib/
+[Pip Scipy]: https://pypi.org/project/scipy/
+
+[Tkinter]: https://docs.python.org/3/library/tkinter.html#module-tkinter

Documentation/Test.md

@@ -0,0 +1,46 @@
+
+# Dry Test
+
+For testing purposes and in case you do not <br>
+own a **Raspberry Pi** / **Breakout Board**, you <br>
+can use the following test script.
+
+It should work on both **Linux** and **Windows**.
+
+<br>
+<br>
+
+## Test Script
+
+Use [`example_drytest.py`][Test] available with the repository.
+
+```sh
+python example_drytest.py
+```
+
+<br>
+<br>
+
+## Example results
+
+<br>
+
+### Oscilloscope
+
+![Result Oscilloscope]
+
+<br>
+
+### XY Plotter
+
+![Result XYPlotter]
+
+<br>
+
+
+<!----------------------------------------------------------------------------->
+
+[Result Oscilloscope]: ../Resources/Oscilloscope.png
+[Result XYPlotter]: ../Resources/XYPlotter.png
+
+[Test]: ../Source/example_drytest.py

Documentation/Usage.md

@@ -0,0 +1,83 @@
+
+# Usage
+
+<br>
+
+## Oscilloscope
+
+<br>
+
+To turn your Raspberry Pi into an **Oscilloscope** <br>
+using this library, just clone the repository and <br>
+use the following code:
+
+```python
+from PiScope import Plotter
+
+plotter = Plotter()
+
+# Here, the channel used 
+# on ADS1015 is channel 0
+
+plotter.setup([ 0 ]) 
+
+plotter.plot()
+```
+
+<br>
+
+### OR
+
+<br>
+<br>
+
+Use [`example_oscilloscope.py`][Example Oscilloscope] with:
+
+```sh
+python example_oscilloscope.py
+```
+
+<br>
+<br>
+
+## XY Plotter
+
+<br>
+
+To turn your Raspberry Pi into an **XY Plotter** <br>
+using this library, just clone the repository <br>
+and use the following code:
+
+```python
+from PiScope import Plotter
+
+plotter = Plotter()
+
+# Here, the channels used on A
+# DS1015 are channel 0 (X) 
+# and channel 1 (Y).
+
+plotter.setup([ 0 , 1 ]) 
+
+plotter.plot()
+```
+
+<br>
+
+## OR
+
+<br>
+<br>
+
+Use [`example_xyplotter.py`][Example XYPlotter] with:
+
+```sh
+python example_xyplotter.py
+```
+<br>
+
+
+<!----------------------------------------------------------------------------->
+
+[Example Oscilloscope]: ../Source/example_oscilloscope.py
+[Example XYPlotter]: ../Source/example_xyplotter.py