Skip to content

Commit

Permalink
Updated README with parts
Browse files Browse the repository at this point in the history
  • Loading branch information
mepland committed Nov 26, 2023
1 parent 0e31c06 commit fa19502
Showing 1 changed file with 33 additions and 23 deletions.
56 changes: 33 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ I decided to use my data science and electronics skills to record
the time series of my apartment's hot water pressure with the goal of forecasting future availability,
and hence `chance_of_showers` was born!

<div align="center">
<video src="https://github.com/mepland/chance_of_showers/assets/4729931/f3b94d00-fa40-4b0b-8b95-1105d11e7acd"></video>
</div>

## Hardware

### Bill of Materials
Expand All @@ -54,25 +58,35 @@ With suitable alterations, the project could definitely be carried out with a wi
sensors, single board computers or microcontrollers, plumbing supplies, etc.

#### Electronics
- [Raspberry Pi 4 Model B 2 GB](https://www.raspberrypi.com/products/raspberry-pi-4-model-b) with USB C power supply and microSDHC card
- [MCP3008 8-Channel 10-Bit ADC With SPI Interface](https://www.digikey.com/en/products/detail/microchip-technology/MCP3008-I-P/319422)
- [DFRobot Gravity Water Pressure Sensor SEN0257](https://wiki.dfrobot.com/Gravity__Water_Pressure_Sensor_SKU__SEN0257)
- [YWBL-WH Water Flow Hall Effect Sensor Switch](https://www.amazon.com/Interface-Electromagnetic-Flowmeter-Industrial-Accessory/dp/B08B1NG4FZ)
- Breadboard and Dupont jumper wires

#### Plumbing
- [1/2" 3 Way Tee Connector](https://www.amazon.com/Stainless-Diverter-Movable-Flexible-Connector/dp/B07ZZYWP2F)
- [B1F09 Faucet Connector, Braided Stainless Steel - 3/8 Female Compression Thread x 1/2 F.I.P. Thread](https://www.amazon.com/gp/product/B000BQWNP8)
- [NPT Thread Pipe Fitting Converter - 3/8" Male to 1/2" Female and 1/2" Male to 3/8" Female](https://www.amazon.com/gp/product/B07LD3GN4X/ref=ppx_od_dt_b_asin_title_s01)
- [1/2" NPT Male x 1/2" G Thread (BSP) Female Adapter](https://www.amazon.com/gp/product/B09QBVBDZW) TODO check this is the final one used
- PTFE (Teflon) Thread Seal Tape
- [Raspberry Pi 4 Model B 2 GB](https://www.raspberrypi.com/products/raspberry-pi-4-model-b)
- [USB C Power Supply](https://www.raspberrypi.com/products/type-c-power-supply)
- [Micro SD Card](https://www.amazon.com/gp/product/B09TQS634Y)
- [8-Channel 10-Bit ADC with SPI Interface - MCP3008](https://www.digikey.com/en/products/detail/microchip-technology/MCP3008-I-P/319422)
- [DFRobot Gravity Water Pressure Sensor - SEN0257](https://wiki.dfrobot.com/Gravity__Water_Pressure_Sensor_SKU__SEN0257)
- [Water Flow Hall Effect Sensor Switch - YWBL-WH](https://www.amazon.com/Interface-Electromagnetic-Flowmeter-Industrial-Accessory/dp/B08B1NG4FZ)
- [1 kΩ and 10 kΩ Resistors](https://www.amazon.com/gp/product/B072BL2VX1)
- 830 Point Breadboard and Dupont Jumper Wires - [Included in GPIO Kit](https://www.amazon.com/gp/product/B08B4SHS18)

#### Plumbing
- [1/2" NPT 3 Way Tee Connector](https://www.amazon.com/Stainless-Diverter-Movable-Flexible-Connector/dp/B07ZZYWP2F)
- [Faucet Connector Hose, 3/8" Female Compression Thread to 1/2" Female NPT Thread - B1F09](https://www.amazon.com/gp/product/B000BQWNP8)
- [Adapter, 3/8" Male NPT to 1/2" Female NPT](https://www.amazon.com/gp/product/B07LD3GN4X/ref=ppx_od_dt_b_asin_title_s01)
- [Adapter, 1/2" Male NPT to G1/4" Female - ADT-N12M-G14F](https://koolance.com/threading-adapter-npt-1-2-male-to-g-1-4-female-adt-n12m-g14f)
- [PTFE (Teflon) Thread Seal Tape](https://www.amazon.com/DOPKUSS-Plumbers-Sealant-Waterproof-Inches/dp/B095YCMHNX)

#### Optional Components
TODO
- [LCD]()
- [GPIO extension cable](https://www.amazon.com/gp/product/B08B4SHS18)
- [heat sink](), [fan](), and [screws]()
- [baseplate]()
- [I2C OLED Display](https://www.amazon.com/dp/B01MRR4LVE)
- [Geekworm Baseplate](https://www.amazon.com/gp/product/B07WCBXFD3)
- Wiring
- [GPIO Extension Cable Kit](https://www.amazon.com/gp/product/B08B4SHS18)
- [Breadboard Jumper Wires](https://www.amazon.com/gp/product/B07CJYSL2T)
- [Clip to Dupont Jumper Wires](https://www.amazon.com/gp/product/B08M5GNY47)
- Cooling
- [Heatsink - Geekworm P165-B](https://www.amazon.com/gp/product/B08N5VZN8R)
- [Fan - Noctua NF-A4x20 5V PWM 4-Pin 40x20mm](https://www.amazon.com/gp/product/B071FNHVXN)
- [2x20 Pin Header Kit](https://www.amazon.com/gp/product/B08GC18NMK) to clear heatsink
- One [M3 Screw](https://www.amazon.com/gp/product/B01I74TTWU) to attach fan to heatsink
- Four [M2.5 Screws](https://www.amazon.com/HELIFOUNER-Screws-Washers-Kit-Threaded/dp/B0BKSGC86F) to attach heatsink to Pi and baseplate

## Data Acquisition (DAQ)

Expand All @@ -88,17 +102,13 @@ source daq/start_daq
### Opening the Web Dashboard
If `daq: {display_web: true}` is set in [`config.yaml`](config.yaml),
the local IP address and port of the dashboard will be logged on DAQ startup.
Open this link in your browser to see the live dashboard, as demonstrated below:

<div align="center">
<video src="https://github.com/mepland/chance_of_showers/assets/4729931/f3b94d00-fa40-4b0b-8b95-1105d11e7acd"></video>
</div>
Open this link in your browser to see the live dashboard, as shown in the introduction.

### Setting up cron Jobs
Jobs to restart the DAQ on boot and every 30 minutes,
as well as send heartbeat API calls - see below,
are provided in the [`cron_jobs.txt`](daq/cron_jobs.txt) file.
Note that loading this file with `crontab` will overwrite any current cron jobs,
Note that loading this file with `crontab` will overwrite **any** current cron jobs,
so check your existing settings first with `crontab -l`!
```bash
crontab -l
Expand Down

0 comments on commit fa19502

Please sign in to comment.