Skip to content

Commit d25a21d

Browse files
authored
docs: Improve documentation (#3)
* Improve and seperate * Add schematic and board pic * Update README.md * Add front panel io schematic
1 parent 60d0ab5 commit d25a21d

File tree

8 files changed

+377
-25
lines changed

8 files changed

+377
-25
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.drawio.bkp

README.md

Lines changed: 4 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,11 @@
11
# Arduino Remote Switch
22

3-
Remote switch to turn on, off or reset PC.
3+
Remote switch to turn on, off, reset or kill PC via a web interface.
4+
5+
This project is based on a Arduino with a ethernet shield and a small daugtherboard to connect to PC headers by decoupling the two circuits with optocouplers. The power for the Arduino is sourced from the PC's motherboard USB header. The switch interface is hosted on the ethernet shield as a website and can be accessed from anywhere on the network via a webbrowser.
46

57
![Web interface](./web.png)
68

79
## Getting started
810

9-
### Hardware
10-
11-
- Arduino Uno
12-
- Arduino Ethernet Shield
13-
- Ethernet cable
14-
- Micro SD card
15-
- Wires
16-
// TODO how many wires?
17-
18-
### Software
19-
20-
- Arduino IDE
21-
22-
### Steps
23-
24-
> **Disclaimer:** Follow these instruction at your own risk.
25-
26-
1. Format SD card to FAT16.
27-
2. Store website (content of `web/src/`) on SD card.
28-
3. Put SD card into ethernet shield.
29-
4. Upload server program `server.ino` to Arduino via Arduino IDE.
30-
5. Turn off Arduino and PC and detach from power.
31-
6. Wire cables between your PC and Arduino like following:
32-
TODO Picture wiring of schematic
11+
Check [what is needed](./docs/ToolsAndMaterials.md) and follow the [build instructions](./docs/BuildInstructions.md) to build this project.

docs/Assets/daughterboard.png

253 KB
Loading

docs/Assets/frontpanelIO.png

51.2 KB
Loading

docs/Assets/schematic.drawio

Lines changed: 303 additions & 0 deletions
Large diffs are not rendered by default.

docs/Assets/schematic.png

51.1 KB
Loading

docs/BuildInstructions.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Build instructions
2+
3+
> **Disclaimer:** Follow these instruction at your own risk.
4+
>
5+
> Also check your motherboard's manual for the available headers, since these might differ.
6+
7+
## Soldering and board installation
8+
9+
![Schematic](./Assets/schematic.png)
10+
11+
1. Cut PCB to the right size if neccessary.
12+
2. Drill two mounting holes into PCB to fit the board at the end of the case.
13+
3. Solder the componentes onto PCB (daughterboard).
14+
4. Screw Arduino with shield and spacers into case (saw spacers to the right length in neccessary).
15+
5. Install daughterboard.
16+
6. Wire daughterboard to Arduino.
17+
18+
![Daughterboard](./Assets/daughterboard.png)
19+
20+
## Installing software
21+
22+
1. Format SD card to FAT16 with [SDcard formatter (recommended)](https://www.sdcard.org/downloads/formatter/)
23+
2. Store website (content of `web/src/`) on SD card.
24+
3. Put SD card into ethernet shield.
25+
4. Connect Arduino to a powerd on PC via USB and the shield to a router via ethernet.
26+
5. Open router configuration, set a static IP range and choose a free IP address.
27+
6. Set the IP address in the `server.ino` file and save.
28+
7. Open Arduino IDE and upload `server.ino` to Arduino.
29+
8. Test if the website can be reached by typing the IP into the webbrowser.
30+
9. Unplug all the cables from the Arduino for the next steps.
31+
32+
## Installing into PC
33+
34+
1. Turn off Arduino and PC and detach from power.
35+
2. Install USB internal header on the PC's motherboard. See your motherboard manual for a free USB header.
36+
3. Wire cables between your PC and Arduino like following and close the case.
37+
4. Connect Arduino to the USB header.
38+
5. Connect the shield to ethernet to router.
39+
6. Restore power to PC again. Arduino should turn on.
40+
7. Open webbrowser on phone to open the website and turn on PC by pressing the power on button.
41+
8. PC should start.
42+
43+
![Front panel IO](./Assets/frontpanelIO.png)

docs/ToolsAndMaterials.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Tools and materials
2+
3+
## Materials
4+
5+
These are all the materials needed to rebuild the project:
6+
7+
- Arduino Uno
8+
- Arduino Ethernet Shield
9+
- USB-B to USB-A cable (to power Arduino)
10+
- USB internal motherboard header to USB-A (to power Arduino from inside the the PC case)
11+
- Ethernet cable
12+
- Micro SD card (to store website)
13+
- Set of Dupont cables 100mm and 300mm
14+
- 16x pin headers for dupont cables
15+
- 3x PC817 optocoplers
16+
- Resistors (1x 200 Ohm, 2x 330 Ohm, 1x 1 kOhm)
17+
- PCB 30mm x 55mm
18+
- KKSB Arduino Case for Arduino UNO and Arduino Mega
19+
- 4x M2.5 x 14mm hexagonal nylon spacers (to screw Arduino with shield to case)
20+
21+
## Tools
22+
23+
- Soldering iron and solder
24+
- Drill (for mounting holes on PCB)
25+
- Thin wood saw (to shorten the nylon spacers)
26+
- Screwdriver

0 commit comments

Comments
 (0)