diff --git a/CAD/.gitkeep b/CAD/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/Firmware/.gitkeep b/Firmware/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/Journal archive/assets/.gitkeep b/Journal archive/assets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/Journal archive/journal.md b/Journal archive/journal.md new file mode 100644 index 0000000..bfe8e61 --- /dev/null +++ b/Journal archive/journal.md @@ -0,0 +1,3 @@ +You can find the original Journal at [Scrap Book](https://scrapbook.hackclub.com/pi.plug) + +--- diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..972a11b --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Piyal Saha + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/PCB/.gitkeep b/PCB/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index a9e9ac0..9054463 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,56 @@ # pi.plug -A custom designed smart plug, my first IoT project + +meet pi.plug, my first IoT project, all thanks to the nice peeps at Hack Club! pi.plug is a custom designed smart plug that lets you control your devices remotely over Wi-Fi, schedule power on/off, and monitor energy usage. + +--- +# Features + +1. Remote control over Wi-Fi +2. Scheduled power on/off +3. Energy usage monitoring +4. Status LED indicator + +## BOM + +1. Seeed XIAO ESP32C3 +2. Hi-Link HLK-PM01 (AC-DC 5V power module) +3. Relay module 1x +4. Current sensor (ACS712) 1x +5. Status LED 1x +6. 3D printed enclosure +7. PCB + +## Fusion 360 + +### 1. Assembled + +| Top | Side | +| :-----: | :------: | +| *(coming soon)* | *(coming soon)* | + +### 2. Enclosure + +| Top | Side | +| :-----: | :------: | +| *(coming soon)* | *(coming soon)* | + +--- +## KiCAD + +| Schematic | +| :-------: | +| *(coming soon)* | +| PCB | +| *(coming soon)* | + +--- +# Softwares Used + +* KiCAD -> PCB Design +* Fusion 360 -> Enclosure design +* MicroPython -> Firmware + +--- +# Bibliography + +> This project would not have been possible without the help of the amazing people of the internet and the Hack Club community. diff --git a/assets/.gitkeep b/assets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/production/.gitkeep b/production/.gitkeep new file mode 100644 index 0000000..e69de29