en:rules
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:rules [2019/02/10 14:45] – fluktuacia | en:rules [2023/02/03 00:14] (current) – [Sizes] kaklik | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | FIXME **This page is not fully translated, yet. Please help completing | + | FIXME **This page is not fully translated, yet. Please help complete |
====== Rules for designing new modules ====== | ====== Rules for designing new modules ====== | ||
- | This page serves as a wiki complement to an original article [[http://www.mlab.cz/ | + | This page serves as a wiki complement to an original article [[http://home.mlab.cz/ |
- | The module design itself uses a following [[en: | + | The module design itself uses the following [[en: |
===== Identification of modules ===== | ===== Identification of modules ===== | ||
- | Each modules | + | Each module |
- JTAGFT2232 - the name of the module, depicting the nature of the module (here probably a J-tag programmer with FTDI FT2232 chip). | - JTAGFT2232 - the name of the module, depicting the nature of the module (here probably a J-tag programmer with FTDI FT2232 chip). | ||
Line 15: | Line 15: | ||
- A - the module’s revision (in this case there were not corrections of any mistakes) | - A - the module’s revision (in this case there were not corrections of any mistakes) | ||
- | Furthermore there are modules with green non-soldering mask and white print and modules with white mask and green print. This kind of module identification was introduced by [[http:// | + | Furthermore, there are modules with green non-soldering mask and white print and modules with white mask and green print. This kind of module identification was introduced by [[http:// |
* **Green mask and white print** - a prototype module, often made only in one or few pieces serving as testing samples | * **Green mask and white print** - a prototype module, often made only in one or few pieces serving as testing samples | ||
- | * **White mask and black print** - a production version made in large quantities. Compared to the green version, it may contain tiny changes | + | * **White mask and black print** - a production version made in large quantities. Compared to the green version, it may contain tiny changes even if the module’s identification mark is identical. |
===== Creating a new module ===== | ===== Creating a new module ===== | ||
+ | |||
+ | ==== Using a GitHub template ==== | ||
+ | |||
+ | The probably simplest way how to make a new module structure is to create a new repository based on the [[https:// | ||
+ | |||
+ | The template repository should be used in [[https:// | ||
+ | |||
==== Using a mlabgen script ==== | ==== Using a mlabgen script ==== | ||
Line 40: | Line 47: | ||
==== Manual module creation ==== | ==== Manual module creation ==== | ||
- | If, for some reason, you are reluctant to use MLABgen for creation of the basic directory structure, it is necessary to comply with the following rules: | + | If for some reason, you are reluctant to use MLABgen for the creation of the basic directory structure, it is necessary to comply with the following rules: |
- | In the appropriate folder category we create a folder with the name of the new module using a format '' | + | In the appropriate folder category, we create a folder with the name of the new module using the format |
- | Inside the folder, we create the following directory structure (obligatory folders/ | + | |
Line 96: | Line 102: | ||
} | } | ||
- | You can find example of a correct filling by checking one of the already existing [[https:// | + | You can find an example of a correct filling by checking one of the already existing [[https:// |
===== Module power supply ===== | ===== Module power supply ===== | ||
Line 109: | Line 115: | ||
{{: | {{: | ||
- | **Power supply connectors are doubled in order to allow smyčkování napájení (??).** | + | **Power supply connectors are doubled in order to allow power looping** |
- | ==== Externí napájecí zdroje | + | ==== External power sources |
For power supply with higher powers, the FASTON connectors or WAGO256 terminal blocks are used. | For power supply with higher powers, the FASTON connectors or WAGO256 terminal blocks are used. | ||
Line 163: | Line 169: | ||
==== Sizes ==== | ==== Sizes ==== | ||
- | MLAB modules are designed in 10.16 mm raster (400 mils) and their sizes exceed 200 mils - 10 mils from the centres | + | MLAB modules are designed in 10.16 mm raster (400 mils) and their sizes exceed 200 mils - 10 mils from the centers |
- | An example of a module occupying 3 openings on the ALBASE: | + | An example of a module occupying 3 openings on the [[en: |
- | {{ :cs:modul.png?400 |}} | + | {{ :mlab_module_geometry_example.png?direct& |
- | | + | * Length of the edge: 4x10.16 - 0.254 -0.254 = 40.132 mm |
- | | + | * Screws’ pitch: 3x10.16 = 30.48 mm |
- | The distance of screw opening | + | * The distance of the screw hole center |
- | | + | * Screw hole diameter: 3 mm (MLAB footprint) |
==== Edge screws ==== | ==== Edge screws ==== | ||
Line 319: | Line 325: | ||
=== KiCAD === | === KiCAD === | ||
+ | QRcode pictures can be [[http:// | ||
- | Obrázky QRkódů se do KiCAD [[http:// | + | ===== Check list before production |
- | + | ||
- | ===== Check list před výrobou | + | |
- | - zkontrolovat velikost | + | - check if the encasements are right and of a good size |
- | - Velikost plosek u konektoru a soucastek skrz desku. | + | - check the size of connector’s spaces (??ploška) and sizes of components that go through the board |
- | - velikost der, krystaly ledky, hrebinky, propojky, specialni soucastky. | + | - check the sizes of holes, LED crystals, pins (hřebík?? |
- | - odmaskovani | + | - check the unmasking of (??) plošek |
- | - obrysy soucastek, oznaceni propojek. | + | - check the components’ outlines and labelling of jumpers (??) |
- | - popisky, napis www.mlab.cz | + | - check the labels and legends, www.mlab.cz |
- | - Zkontrolovat, | + | - check that the VIAs are not under letters and symbols |
- | - zkontrolovat | + | - check the QR code and PermaLink |
- | ===== Struktura repozitáře MLABu ===== | + | ===== MLAB repository structure===== |
- | * Projektová | + | * Project |
- | * Commit message - začátek velké písmeno, slova jako added, fixed, removed, started, finished... | + | * Commit message - begins with capital latter; uses words such as: added, fixed, removed, started, finished... |
- | ==== Jmenná konvence | + | ==== Name convention |
- | bez_diakritiky_a_specialnich_znaku_mezery_nahrazeny_podtrzitkem_pouze_mala_pismena_strucne_a_srozumitelne | + | withouth_diacritic_and_special_cases_spaces_are_replaced_by_an_underscore_lowercase_letters_only_briefly_and_comprehensibly |
- | ==== Adersářová struktura modulu | + | ==== |
MODUL01A/ | MODUL01A/ |
en/rules.1549809932.txt.gz · Last modified: 2019/02/10 14:45 by fluktuacia