locker98/kam-alarm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme and BOM

Browse Source
This commit is contained in:
locker98 2024-07-27 12:01:03 -04:00
parent 43d4bd71e1
commit 2fd7aa9bf2
2 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md Normal file → Executable file
View File

@ -1 +1,28 @@
# KAM Alarm
![Image of KAM alarms](docs/Images/Image 1.jpg)
The KAM Alarm system was born out of a need for efficient communication between the sound room and kids ministry at our church. The goal was to enable seamless updates on service progression, attendance counts, and worker presence.
**Key Features**
- Wireless connectivity using ESP32 boards that store WiFi credentials persistently across resets
- Create an access point (AP) if no WiFi is available; connect to it with your phone or device
- Once connected to a network, login to set the remote IP address, which enables connection to another KAM Alarm devices
**How It Works**
1. Connect your device to the KAM Alarm's AP or existing WiFi network.
2. Log in and configure the remote IP address, linking the two devices.
3. Use the system to send updates on service progression, attendance counts, and worker presence between the sound room and kids ministry.
**Technical Details**
- Two ESP32 boards connect via WiFi to each other
- Sends GET requests to different URLs for data exchange
**Get Started**
Check out our [documentation](docs/documentation.md) for a detailed list of components used in this project.
Check out our [BOM](docs/BOM.md) for a list of the parts used and the total cost.

6
docs/BOM.md
View File

@ -1,4 +1,4 @@
Here is a list of all the materials that were used in this project along with the quantity and cost. Here is a list of all the materials that were used in this project along with the quantity and cost. If you do not have any magnets they can be removed from the build with out affecting anything except not having the case magnet to the wall or metal objects. You can use different colors for each button to help make the buttons easier to remember.
| Item | SKU | Count | cost | Link | | Item | SKU | Count | cost | Link |
@ -9,5 +9,7 @@ Here is a list of all the materials that were used in this project along with th
| OLED Screen | 0.91 Inch OLED Module | 2 | 2.97 | https://www.aliexpress.us/item/3256805967573053.html | | OLED Screen | 0.91 Inch OLED Module | 2 | 2.97 | https://www.aliexpress.us/item/3256805967573053.html |
| PCB | JLC PCB | 5 | 3.75 | https://jlcpcb.com | | PCB | JLC PCB | 5 | 3.75 | https://jlcpcb.com |
| Magnets | # 1/4" x 1/2" Rare Earth Round Magnet - 8 Count | 8 | 14.23 | https://www.menards.com/main/hardware/fasteners-connectors/specialty-fasteners/magnets/magcraft-reg-rare-earth-round-magnets/nsn0641/p-1565073052971-c-19644.htm | | Magnets | # 1/4" x 1/2" Rare Earth Round Magnet - 8 Count | 8 | 14.23 | https://www.menards.com/main/hardware/fasteners-connectors/specialty-fasteners/magnets/magcraft-reg-rare-earth-round-magnets/nsn0641/p-1565073052971-c-19644.htm |
| Bolts | M2.5 X 16mm | 8 | 8.11 | https://www.aliexpress.us/item/3256801289903040.html |
| Inserts | M2.5(OD 3.5mm) length 4mm | 8 | 1.74 | https://www.aliexpress.us/item/3256803396040989.html |
| 3D print | PLA | | | | | 3D print | PLA | | | |
| Total | | | 26.42 | | | Total | | | 36.42 | |