Skip to content

Commit 6af2829

Browse files
committed
add documentation
1 parent 07d8bc4 commit 6af2829

2 files changed

Lines changed: 33 additions & 62 deletions

File tree

README.md

Lines changed: 1 addition & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,4 @@
1-
# LEA_control_board
1+
# Dock board LCB-CDB-01 for the LEA control board
22

33
![](documentation/lcb_all_pcbs.png)
44

5-
The LEA-Control-Board (LCB) is a construction kit to provide power electronic converters with a control board.
6-
7-
The basic module is the control board itself. It contains a powerful dual-core processor, error latches and various predefined low-pass filters to respond to input signals. An XDS100v2 debugger is directly integrated on the board.
8-
9-
The docking board is suitable for initial operation. This contains various input options (switches, buttons, potentiometers) as well as LEDs for output.
10-
11-
The external hardware monitor is for viewing internal counter variables on the oscilloscope and is mainly used for troubleshooting the control board in the overall system (control board + power converter).
12-
13-
## Kicad Options
14-
### Symbol library and footprint libary
15-
The libraries are included by default. Open Kicad, load one of the projects and see the libraries:
16-
* `symbol editor` -> Search for `LEA_SymbolLibrary`
17-
* `footprint editor` -> Search for `LEA_FootprintLibrary`
18-
19-
### Set environment variable for 3D models:
20-
![](documentation/3d_model.png)
21-
In the main menu, first select "Preferences" and then "Configure Path".
22-
Replace the environment variable `MODEL_3D` with the current location of the 3D-models, e.g. `/path/LEA_control_board/hardware/KiCad_Library/Footprint_Library/3D_Model`.
23-
24-
Note: if you are using KiCAD6, and there is a variable `KICAD6_3DMODEL_DIR`, ignore this variable and add `MODEL_3D` as mentioned above.
25-
![](documentation/00_KiCAD_settings/3d_model_path_preferences.png)
26-
27-
# Software
28-
## Flash XDS100 Firmware to FTDI Chip:
29-
* Watch this [video](https://www.youtube.com/watch?v=vZaF5ckf3OQ) first
30-
* Download FT Prog [here](https://ftdichip.com/utilities/)
31-
* Load the configuration file for XDS100v2 programmer: `File` -> `Open template` -> [Modified template](/software/01_Control_boards/XDS100v2_UART.xml)
32-
* Right click on `Device: 0` -> right click -> `Apply Template` -> `Template: XDS100v2_UART.xml`
33-
* Flash file: `Programm Devices` -> `Program`
34-
35-
Note:
36-
It is very important to click on "Apply Template" as shown in the video. Otherwise the controller will not be programmed correctly!
37-
38-
Note:
39-
The modified file has the `Virtual COM Port` enabled to provide UART communication. This is not implemented as in the video. To enable this, see the figure.
40-
![](/software/01_Control_boards/virtual_com_port.png)
41-
42-
## Code Composer Studio: Settings for code from this repository
43-
For equal code indentations, perform the following steps:
44-
* `Window` -> `Preferences` -> `Show advanced settings`
45-
* `Window` -> `Preferences` -> `C/C++` -> `Code Style` -> `Formatter` -> `Edit ...` -> `Tab size: 2` -> `Apply` -> `OK` -> `Apply and Close`
46-
47-
## Code Composer Studio: Import software project and adapt it to your computer filepaths
48-
* `Project` -> `Import CCS Projects...` -> Choose your project to import
49-
* In `Select search-directory` browse to your project (e.g. `.../LEA_control_board/software/01_Control_boards/F28386D_GPIO/`
50-
* Press `Finish`
51-
52-
53-
54-
55-
# Manufacturing the LCB
56-
* Minimum PCB thickness is 2.3 mm due to the position-pin overlapping of J501/402 and J502/J403.
57-
* For automated placement, the position pin holes of the connectors J501/402/J502/J403 should be milled with a depth of minimum 1.3 mm.
58-
59-
![](/documentation/01_Control_boards/LCB-CCB-01/PCB_Manufacturing.png)
60-
61-
# MCU BGA soldering process
62-
* Remove all solder from MCU pad (smooth and flat surface).
63-
* Clean with PCB cleaner and remove all dust residues.
64-
* Apply a very thin layer of Flux on MCU pad.
65-
* Use the Rework station for the soldering the MCU chip.

documentation/Dock.csv

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
"Source:","/home/nikolasf/Dokumente/01_git/LEA_control_board/hardware/03_Shield_boards/LCB-CDB-001_Dock/Dock.kicad_sch"
2+
"Date:","Di 21 Mär 2023 13:10:45 CET"
3+
"Tool:","Eeschema (6.0.11)"
4+
"Generator:","/home/nikolasf/Dokumente/01_git/LEA_control_board/hardware/KiCad_Library/bom_csv.py"
5+
"Component Count:","151"
6+
"Ref","Qnty","Mouser","Value","Cmp name","Footprint"
7+
"ACCESSORY1, ","1","474-CAB-15424","ACCESSORY_USB_C_cable","ACCESSORY_USB_C_cable","","8.41","35 Auf Lager"
8+
"ACCESSORY2, ","1","485-4447","ACCESSORY_jumper_cable_set","ACCESSORY_jumper_cable_set","","9.35","973 Auf Lager"
9+
"ACCESSORY3, ACCESSORY4, ACCESSORY5, ACCESSORY6, ACCESSORY7, ACCESSORY8, ACCESSORY9, ACCESSORY10, ACCESSORY11, ACCESSORY12, ACCESSORY15, ACCESSORY16, ACCESSORY17, ACCESSORY18, ACCESSORY19, ","15","571-8815451","ACCESSORY_jumper","ACCESSORY_jumper","","0.216","185532 Auf Lager"
10+
"ACCESSORY13, ACCESSORY14, ","2","485-550 ","ACCESSORY_rubber_feet","ACCESSORY_rubber_feet","","0.893","167 Auf Lager"
11+
"C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, ","10","810-C1608X5R1H104K","100n","C_0603_100n_X5R_10P__50V","LEA_FootprintLibrary:C_0603","0.103","403494 Auf Lager"
12+
"C11, C13, C14, ","3","81-GRM188R61E106KA3D","10u","C_0603__10u_X5R_10P__25V","LEA_FootprintLibrary:C_0603","0.235","1331543 Auf Lager"
13+
"C12, ","1","810-CGA3E2X7R1H103K","10n","C_0603__10n_X7R_10P__50V","LEA_FootprintLibrary:C_0603","0.094","1511965 Auf Lager"
14+
"D1, D2, D3, D4, D5, D6, ","6","755-SML-P11MTT86R","LED_SML-P11MTT86R","LED_0402_G_1mA_SML-P11MTT86R","LEA_FootprintLibrary:LED_0402","0.404","238424 Auf Lager"
15+
"D7, D8, D9, D10, ","4","755-SML-P11UTT86R","LED_SML-P11UTT86R","LED_0402_R_1mA_SML-P11UTT86R","LEA_FootprintLibrary:LED_0402","0.404","121994 Auf Lager"
16+
"D11, D12, D13, D14, ","4","755-SML-P11YTT86R","LED_SML-P11YTT86R","LED_0402_Y_1mA_SML-P11YTT86R","LEA_FootprintLibrary:LED_0402","0.555","125716 Auf Lager"
17+
"D15, ","1","726-BAS3010A-03WE6","BAS3010A03WE6327HTSA1","D_SOD_1A0_BAS3010A03WE6327HTSA1","LEA_FootprintLibrary:SOD-323_Infineon","0.479","1215 Auf Lager"
18+
"J1, ","1","200-ERF507505.0LDVTR","LCB_connector_top","Conn_LCB_connector_top","LEA_FootprintLibrary:LCB_connector_top","10.01","462 Auf Lager"
19+
"J3, J4, J5, J6, J7, J8, J9, J10, J11, J12, J13, J14, J15, J16, J17, J18, J19, J20, J21, J22, J23, J24, J25, J26, J27, J28, J29, J30, J31, J32, J33, J34, J35, J36, J37, J38, J39, J40, J41, J42, J43, J44, J45, J46, J47, J48, J49, J50, J51, J52, J53, J54, J55, J56, J57, J58, ","56"," 855-M20-9990245","Conn_01x02","Conn_01x02","LEA_FootprintLibrary:PinHeader_1x02_P2.54mm_Vertical","0.179","36862 Auf Lager"
20+
"J59, ","1","640-USB4110-GF-A","USBC_GTC_USB4110-GF-A","USBC_GTC_USB4110-GF-A","LEA_FootprintLibrary:USB_C_GCT_USB4110-GF-A","1.26","35538 Auf Lager"
21+
"J60, J61, J62, J63, ","4"," 649-77313-118-60LF","Conn_02x30_Row_Letter_Last","Conn_02x30_Row_Letter_Last_2","LEA_FootprintLibrary:PinHeader_2x30_P2.54mm_Vertical","2.49","264 Auf Lager"
22+
"R1, R2, R3, R4, ","4","71-CRCW0603100KFKEAC","100k","R_0603_100k_THICK__1P__75V","LEA_FootprintLibrary:R_0603","0.094","475109 Auf Lager"
23+
"R5, R6, R7, R8, ","4","71-CRCW0603100RFKEAC","100R","R_0603_100R_THICK__1P__75V","LEA_FootprintLibrary:R_0603","0.094","898193 Auf Lager"
24+
"R9, R10, R11, R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R22, R23, ","15","71-CRCW0603680RFKEAC","R_0603_680R_THICK__1P__75V","R_0603_680R_THICK__1P__75V","LEA_FootprintLibrary:R_0603","0.094","157678 Auf Lager"
25+
"R24, ","1","71-CRCW04020000Z0EDC","0R","R_0402__0R0_THICK__1P__50V","LEA_FootprintLibrary:R_0402","0.094","8405105 Auf Lager"
26+
"R25, R26, ","2","","5k","R_0603","LEA_FootprintLibrary:R_0603","0","0"
27+
"RV1, RV2, RV3, RV4, ","4"," 652-PTV09A-4020FB103","10k","R_POT_Bourns_PTV09A-1","LEA_FootprintLibrary:Potentiometer_Bourns_PTV09A-1_Single_Vertical","0.902","3277 Auf Lager"
28+
"S1, S2, S3, S4, ","4","118-2MS1T1B1M2QES","SW_2MS1T1B1M2QES","SW_2MS1T1B1M2QES_2","LEA_FootprintLibrary:SW_2MS1T1B1M2QES","2.98","430 Auf Lager"
29+
"SW1, SW2, SW3, SW4, ","4","179-TS046643BK160SMT","SW_Push","SW_Push_1","LEA_FootprintLibrary:SW_Push","0.169","4647 Auf Lager"
30+
"U1, U2, ","2","863-MC74HC14ADG ","ST_6CH_CMOS_SOIC14_MC74HC14ADG","ST_6CH_CMOS_SOIC14_MC74HC14ADG","LEA_FootprintLibrary:SOIC-14","0.63","102610 Auf Lager"
31+
"U3, ","1","595-TPS73733DCQG4","TPS73733DCQ","TPS73733DCQ","LEA_FootprintLibrary:SOT-223-6_TI","1.83","7941 Auf Lager"
32+
"Gesamtpreis: ","84.158"

0 commit comments

Comments
 (0)