Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lbussy committed Apr 1, 2021
1 parent 509ec6d commit dc0dc73
Show file tree
Hide file tree
Showing 19 changed files with 158 additions and 49 deletions.
22 changes: 21 additions & 1 deletion case/README.md
Expand Up @@ -2,4 +2,24 @@

# 3D Printed Cases

Within these folders are 3D models of cases which you may use in your own deployments.
Within these folders are 3D models of cases which you may use in your own deployments:

- **Main Boards:** Contains the top and bottom case halves for the main board. These have been tested in PLA and PETG. Additionally, there is a color-print enabled logo in the lid should you choose to take advantage of it. I recommend the following layers:
- 0.15mm layers
- 0.00 - 0.65: Main body color (I used white)
- 0.80 - 1.25: Dark border color (I used black)
- 1.40 - 1.85: Base color (I used silver)
- 2.00 - 2.60: Globe color (I used translucent red)
- 0.20mm layers
- 0.00 - 0.60: Main body color (I used white)
- 0.80 - 1.20: Dark border color (I used black)
- 1.40 - 1.80: Base color (I used silver)
- 2.00 - 2.60: Globe color (I used translucent red)

![Layer Configuration](https://github.com/lbussy/keg-cop/raw/master/case/readmain_20_layers.png)

![Layer Render](https://github.com/lbussy/keg-cop/raw/master/case/main_15_example.png)

- **Breakouts:**
- Daisy Chain:
- Temp Sensor:
Binary file added case/main_15_example.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added case/main_20_layers.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/networking/index.rst
Expand Up @@ -12,6 +12,10 @@ You may use any wireless-capable device to connect to the access point. However,

In your device settings, search for an available access point named "kegcop."

.. todo::

Change these images to current ones.

.. image:: 1_choose_ap.jpg
:scale: 25%
:align: center
Expand Down
31 changes: 7 additions & 24 deletions docs/pcbassembly/index.rst
Expand Up @@ -7,14 +7,6 @@ PCB Assembly

Add thumbnails of the various assembled PCBs somewhere here without leaving the page?

.. todo::

Check BOM to ensure it's correct

.. todo::

Change any DirtyPCB links to OshPark

Keg Cop runs on an ESP32 controller. To detect the information to be logged, you need to connect specific devices to the controller. I have provided a main circuit board design, as well as several breakouts for your use.

Assembly is not difficult, but it does require some basic soldering.
Expand Down Expand Up @@ -49,20 +41,11 @@ Printed Circuit Boards

This configuration will use the following three boards:

- \*\*\* `Main Board <https://dirtypcbs.com/store/designer/details/4818/6477/keg-cop-main-board>`_
- `Sensor board <https://dirtypcbs.com/store/designer/details/4818/6460/keg-cop-sensor-breakout>`_
- 3 x `Daisy Chain boards <https://dirtypcbs.com/store/designer/details/4818/6478/keg-cop-daisy-chain>`_

The links will take you to DirtyPCBs where I have uploaded the designs. When you purchase the boards there, you pay a small premium (10%), which goes into my account. I use that credit in the development of these and other projects. Anyone who has done development like this can tell you how many boards we go through, and the cost is not insignificant. You may take the files from GitHub and upload them yourself to avoid that small markup if you choose. If you *do* purchase them here, it's only fair I tell you about it, and what I will do with the credits.

These links will allow you to order boards in increments of ±10. Sometimes you might get 11, sometimes nine, it's cheap and from China, and that's how it works. Think of it as a lottery. If you end up with extras, I encourage you to share with others.
- `Main Board <https://oshpark.com/shared_projects/UQZn4ng4>`_
- `Sensor board <https://oshpark.com/shared_projects/MkSWgv0t>`_
- 3 x `Daisy Chain boards <https://oshpark.com/shared_projects/Zc4zPNjI>`_

(\*\*\*) - The main board is larger than the "standard" Dirty PCB size of 5x5cm. When you get to the ordering page, you MUST select 10x10, which has a slightly higher price. If you forget this, I think they may adjust the price afterward. For such low prices, it is proper to be upfront about things. On the same page, you may also select other than the default board color, which is red.

.. image:: size.png
:scale: 100%
:align: center
:alt: Board Size
The links will take you to OshPark where I have uploaded the designs. OshPark is not the cheapest, but they are the most consistent fab house I have dealt with. You're only talking the difference of a few dollars in your project between them and other fab houses. For my peace of mind, and for me to recommend them to you, I think it's worth it. You may take the files from GitHub and upload them yourself somewhere else to save money if you choose.

Components
================
Expand All @@ -74,7 +57,7 @@ For this configuration, we will use the following components:
- 2 x `0.1μF (1.0nF) Ceramic Capacitor (102) 2.54mm spacing <https://www.aliexpress.com/item/32868001945.html>`_ (C1, 3) (Note: The same link as below, select the proper item)
- 2 x `1.0μF Ceramic Capacitor (105) 2.54mm spacing <https://www.aliexpress.com/item/32868001945.html>`_ (C2, C4) (Note: The same link as above, select the proper item)
- \*1 x `DS18B20 PCB-mount sensor <https://www.aliexpress.com/item/1901263688.html>`_ (IC1) (Note: Multiple items on the page, be sure to select the proper item)
- 5 x `2.2kΩ 1/4W 5% Axial Resistor <https://www.aliexpress.com/item/32660635741.html>`_ (R1-R5) (Note: Multiple items on the page, be sure to select the proper item)
- 14 x `2.2kΩ 1/4W 5% Axial Resistor <https://www.aliexpress.com/item/32660635741.html>`_ (R1-R5) (Note: Multiple items on the page, be sure to select the proper item)
- 4 x `RJ45 8-pin 90° no shield PCM-mount jack <https://www.aliexpress.com/item/32736146888.html>`_
- 1 x `2-pin Straight Male Header <https://www.aliexpress.com/item/2040310671.html>`_ (POWER) (Note: More than enough in one lot for all three headers)
- \*1 x `3-pin Straight Male Header <https://www.aliexpress.com/item/2040310671.html>`_ (ROOM) (Note: More than enough in one lot for all three headers)
Expand All @@ -85,7 +68,7 @@ For this configuration, we will use the following components:
- 1 x `RJ45 8-pin 90° no shield PCM-mount jack <https://www.aliexpress.com/item/32736146888.html>`_
- 4 x `3-pin terminal block <https://www.aliexpress.com/item/32965348107.html>`_

**Daisy Chain Boards (multiply all numbers x 3 for three flowmeters):**
**Daisy Chain Boards (per flowmeter, multiply all numbers x 3 for three flowmeters):**

- 2 x `RJ45 8-pin 90° no shield PCM-mount jack <https://www.aliexpress.com/item/32736146888.html>`_
- 1 x `3-pin terminal block <https://www.aliexpress.com/item/32965348107.html>`_
Expand All @@ -103,7 +86,7 @@ I do not intend to provide a step-by-step on how to solder here. Still, I recomm

- Resistors - These are the shortest mounted components. Soldering the resistors to the board first is the least challenging. They are also some of the most heat-tolerant parts, so these grant you some experience to get you going.
- Capacitors - The next tallest components, these should go on next. They are also relatively tolerant of heat, so you can continue to refine your skills. Be sure to get them as close to the board as possible since having them stick up changes their intended impact on the circuit.
- DS18B20 Sensor - Now that you are sure of your skills, these sensors should be soldered next. Be careful not to overheat the devices, but they are not too sensitive.
- DS18B20 Sensor - Now that you are sure of your skills, this sensor should be soldered next if you use one. Be careful not to overheat the device, but they are not too sensitive.
- Pin headers and terminal blocks - These components are not vulnerable to the heat at all except for the plastic.
- RJ45 Jacks - These are the tallest items, and you should solder them on last.

Expand Down
Binary file not shown.
Binary file not shown.
12 changes: 0 additions & 12 deletions pcb/Breakouts/daisychain-screw/Keg Cop - Daisy Chain Listing.htm

This file was deleted.

Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 0 additions & 12 deletions pcb/Breakouts/sensors/Keg Cop - Sensor Listing.htm

This file was deleted.

Binary file modified pcb/Breakouts/sensors/Keg Cop - Sensors - Bottom.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pcb/Breakouts/sensors/Keg Cop - Sensors - Top.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions pcb/Main Boards/main/Keg Cop - Parts.csv
@@ -0,0 +1,28 @@
"Part";"Value";"Device";"Package";"Description";"ARROW_PART_NUMBER";"ARROW_PRICE-STOCK";"DESCRIPTION";"HEIGHT";"MANUFACTURER_NAME";"MANUFACTURER_PART_NUMBER";"MF";"MOUSER_PART_NUMBER";"MOUSER_PRICE-STOCK";"MPN";"OC_FARNELL";"OC_NEWARK";"POPULARITY";"PROD_ID";"VALUE";
"C1";"0.1μF";"CAP_CERAMIC_2.54";"CAP_PTH-2.54";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";
"C2";"1.0μF";"CAP_CERAMIC_2.54";"CAP_PTH-2.54";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";
"C3";"0.1μF";"CAP_CERAMIC_2.54";"CAP_PTH-2.54";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";
"C4";"1.0μF";"CAP_CERAMIC_2.54";"CAP_PTH-2.54";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";
"D32";"Lolin D32";"WEMOS-D32D32_NO_BATT";"D32_NO_BATT";"D32_REVERSE is a Reverse silkscreen for placing the Wemos D32 on the underside of the board";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";
"IC1";"DS18B20+";"DS18B20+";"TO-92";"DS18B20 prog thermometer 1-Wire, TO92";"DS18B20+";"";"DS18B20 prog thermometer 1-Wire, TO92";"mm";"Maxim Integrated";"DS18B20+";"";"700-DS18B20+";"https://www.mouser.co.uk/ProductDetail/Maxim-Integrated/DS18B20%2b?qs=7H2Jq%252ByxpJKegCKabDbglA%3D%3D";"";"";"";"";"";"";
"POWER";"2-PIN";"HDR-2";"HDR-2_VERT";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";
"R1";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R2";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R3";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R4";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R5";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R6";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R7";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R8";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R9";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R10";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R11";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R12";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R13";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"R14";"2.2kΩ";"RESISTORAXIAL-0.3";"AXIAL-0.3";"Generic Resistor Package";"";"";"";"";"";"";"";"";"";"";"";"";"";" ";" ";
"RELAY";"4-PIN";"MA04-1";"MA04-1";"PIN HEADER";"";"";"";"";"";"";"";"";"";"";"unknown";"unknown";"41";"";"";
"ROOM";"3-PIN";"HDR-3";"HDR-3_VERT";"PIN HEADER";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";
"X1";"RJ45-8X";"RJ45-8X";"RJ45-NO-SHIELD";"CORCOM Modular RJ Jacks No Shield";"";"";"";"";"";"";"";"";"";"RJ45-8X";"unknown";"16R6101";"0";"";"";
"X2";"RJ45-8X";"RJ45-8X";"RJ45-NO-SHIELD";"CORCOM Modular RJ Jacks No Shield";"";"";"";"";"";"";"";"";"";"RJ45-8X";"unknown";"16R6101";"0";"";"";
"X3";"RJ45-8X";"RJ45-8X";"RJ45-NO-SHIELD";"CORCOM Modular RJ Jacks No Shield";"";"";"";"";"";"";"";"";"";"RJ45-8X";"unknown";"16R6101";"0";"";"";
"X4";"RJ45-8X";"RJ45-8X";"RJ45-NO-SHIELD";"CORCOM Modular RJ Jacks No Shield";"";"";"";"";"";"";"";"";"";"RJ45-8X";"unknown";"16R6101";"0";"";"";

0 comments on commit dc0dc73

Please sign in to comment.