Skip to content

Commit 081fc36

Browse files
authored
typos, updated getting started (#4)
1 parent ec69f8c commit 081fc36

File tree

4 files changed

+20
-18
lines changed

4 files changed

+20
-18
lines changed

docs/images/hardware/overview.png

-1.34 KB
Loading

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ You would have all capabilities like PUP Packs, FlexDMD, etc.
9191
[![Watch the video](https://img.youtube.com/vi/MTMMOd1anZY/hqdefault.jpg)](https://youtu.be/MTMMOd1anZY)
9292
*Click the image to watch the video on YouTube.*
9393

94-
![Overview Pic](https://github.com/PPUC/.github/raw/main/profile/images/overview.png)
94+
![Overview pic](images/hardware/overview.png)
9595

9696
## Licence
9797

docs/ppuc/getting_started.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,37 +16,39 @@ protocol enhances the DOF protocol which is known from the virtual pinball world
1616

1717
## Get IO Boards
1818

19-
Dependeing on your decisions abouve, you you might need different IO boards and a different amount.
20-
The entire hardware is open source and you can order the boards from your prefered PCB manufacturer.
19+
Depending on your decisions above, you you might need different IO boards and a different amount.
20+
The entire hardware is open source and you can order the boards from your preferred PCB manufacturer.
2121
Gerber and BOM files are part of the repositories:
2222

2323
- [IO_16_8_1](https://github.com/PPUC/Hardware_IO_16_8_1)
2424
- [IO_16x8_matrix](https://github.com/PPUC/Hardware_IO_16x8_matrix)
2525
- [Out_8X10](https://github.com/PPUC/Hardware_Out_8x10)
2626
- [Opto_16](https://github.com/PPUC/Hardware_Opto_16)
2727

28-
## Flash the IO Board Firware
29-
30-
Download the latest firmware for your boards from https://github.com/PPUC/io-boards/releases/latest
31-
32-
Pres and hold the `Boot` button of your board and connect it to your computer via USB.
33-
Release the button after a removable mass storage device is detected by your computer.
34-
Copy the appropriate `uf2` file from the download above to that mass storage device.
35-
The board will automatically flash the firmware and reboot.
36-
Repeat that procedure for every board.
37-
3828
## Wiring the boards
3929

40-
todo:
41-
4230
- Power
4331
- RS485 bus
4432
- Coils
4533
- Switches
4634
- Lamps
4735
- Motors
4836

49-
todo: Explain the board addresses and BUS termination.
37+
For more details read the [hardware documentation](../ppuc_hardware/index.md).
38+
39+
## Flash the IO Board Firware
40+
41+
To bring "life" into the PPUC boards they need to get some software. All the boards gets the same firmware. Details about what they shall do and what they are connected to, are set by the config file which is generated by the config tool. This will be used to initialize the boards on start up.
42+
43+
The boards are distinguished by an address. This must be set by DIP switches on the board. Every board must have a different address.
44+
45+
Download the latest firmware for your boards from https://github.com/PPUC/io-boards/releases/latest
46+
47+
Press and hold the `Boot` button of your board and connect it to your computer via USB.
48+
Release the button after a removable mass storage device is detected by your computer.
49+
Copy the appropriate `uf2` file from the download above to that mass storage device.
50+
The board will automatically flash the firmware and reboot.
51+
Repeat that procedure for every board.
5052

5153
## "CPU"
5254

docs/ppuc_hardware/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ To get some sound to your ears several speakers are used with an amplifier that
6464
## Specific Hardware of the PPUC Project
6565
We designed some specific PCBs for PPUC project although they might be useful in other applications as well. Here is an overview what is available and what they can do. Fore more information there is a detailed description available for each PCB.
6666

67-
* [IO_16_8_1](./io_16_8_1/): most basic PCB, always needed. Uses for reading switches, driving solenoids and control one LED strip.
67+
* [IO_16_8_1](./io_16_8_1/): most basic PCB, always needed. Used for reading switches, driving solenoids and control one LED strip.
6868
* [IO_16x8_matrix](./io_16x8_matrix/): convenient if a switch matrix is used. Especially if the original cable harness shall be used. Can control a 16x8 switch matrix. Or use for 16 inputs and 8 outputs. Also can control one LED strip.
69-
* [Out_8x10](./out_8x10/): convenient if a lamp matrix is used. Especially if the original cable harness shall be used. Can control a 8x10 lamp matrix [^f1] (only LEDs, no incandescent light bulbs!). Or use for 8 high side outputs and 10 low side outputs. Also can control one LED strip.
69+
* [Out_8x10](./out_8x10/): convenient if a lamp matrix is used. Especially if the original cable harness shall be used. Can control a 8x10 lamp matrix (only LEDs, no incandescent light bulbs!). Or use for 8 high side outputs and 10 low side outputs. Also can control one LED strip.
7070
* [Opto_16](./opto_16/): used to directly attach optical switches like opto couplers or LED transmitter/receiver pairs.
7171

7272
The following table shows how many functions can be done with wich PCB. With that table you can estimate how many PCBs you need for your specific project. Just count the needed solenoids, flashers, lamps and switches. Take into account if you want to use controlled LED strips vs LED matrix vs direct LED drivers (mostly a mixture is used). Also think about direct switches vs switch matrix. And take into account if you have original opto boards from your pin or not.

0 commit comments

Comments
 (0)