kristjank/TeraHz
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated documentation

Browse Source
This commit is contained in:
Kristjan Komlosi
2019-11-12 21:28:27 +01:00
parent ed0b21a496
commit 3e1a43c10f
2 changed files with 24 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/dependencies.md
View File

@@ -1,26 +1,24 @@
# Development-stable dependencies # 1.0.0-rc1 Dependencies
The current development version of TeraHz has been verified to work with: The 1.0.0-rc1 version of TeraHz is confirmed to work with:
- DietPi 6.26.3
- Raspbian Stretch (9) - Python 3.7.3
- Python 3.6.8 (built from source code and altinstall'd) - Pip 18.1
- Module versions (direct `pip3.6 list` output): - Following versions of pip3 packages:
``` ```
Package Version Click 7.0
--------------- --------- Flask 1.1.1
Click 7.0 gunicorn 20.0.0
Flask 1.0.3 itsdangerous 1.1.0
itsdangerous 1.1.0 Jinja2 2.10.3
Jinja2 2.10.1 MarkupSafe 1.1.1
MarkupSafe 1.1.1 numpy 1.17.4
numpy 1.16.4 pandas 0.25.3
pandas 0.24.2 pip 18.1
pip 18.1 pyserial 3.4
pyserial 3.4 python-dateutil 2.8.1
python-dateutil 2.8.0 pytz 2019.3
pytz 2019.1 setuptools 41.6.0
setuptools 40.6.2 six 1.13.0
six 1.12.0 smbus2 0.3.0
smbus 1.1.post2 Werkzeug 0.16.0
Werkzeug 0.15.4
``` ```

11
docs/electrical.md
View File

@@ -21,13 +21,9 @@ project when basic testing will be done.
GPIO can be routed to the PCB with a standard old IDE disk cable, and terminated GPIO can be routed to the PCB with a standard old IDE disk cable, and terminated
with another 40-pin connector at the PCB. Sensor breakouts should be mounted with another 40-pin connector at the PCB. Sensor breakouts should be mounted
<<<<<<< HEAD
through standard 0.1" connectors, male on the sensor breakout and female on the through standard 0.1" connectors, male on the sensor breakout and female on the
PCB. A shitty add-on header and a shitty add-on header v1.69bis can't hurt, either. PCB. A shitty add-on header and a shitty add-on header v1.69bis can't hurt, either.
=======
through standard 0.1" connectors, male on the sensor brakout and female on the
PCB. A shitty addon header and a shitty addon header v1.69bis can't hurt, either.
>>>>>>> fd1f07d40dace3e003e49377d4771de53f8bdeb8
## SMBus sensors ## SMBus sensors
SMBus is a well-defined version of the well-known I2C bus, widely used SMBus is a well-defined version of the well-known I2C bus, widely used
@@ -39,11 +35,8 @@ Pins are familiarly marked as SDA and SCL, the same as with classic I2C. They
connect to the SDA and SCL pins on the VEML6075 and APDS-9301 sensor. connect to the SDA and SCL pins on the VEML6075 and APDS-9301 sensor.
## UART sensor ## UART sensor
<<<<<<< HEAD
Spectral sensor attaches through the UART port on the Raspberry pi (see picture). Spectral sensor attaches through the UART port on the Raspberry pi (see picture).
=======
Spectrometry sensor attaches through the UART port on the Raspberry pi (see picture).
>>>>>>> fd1f07d40dace3e003e49377d4771de53f8bdeb8
The Tx and Rx lines must cross over, connecting the sensor's Tx line to the The Tx and Rx lines must cross over, connecting the sensor's Tx line to the
computer's Rx line and vice versa. computer's Rx line and vice versa.