MLAB wiki

User Tools

Site Tools

Trace:
en:rules

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:rules [2019/02/09 15:19] – fluktuaciaen:rules [2023/02/03 00:14] (current) – [Sizes] kaklik
Line 1: Line 1:
-FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)//+FIXME **This page is not fully translated, yet. Please help complete the translation.**\\ //(remove this paragraph once the translation is finished)//
  
 ====== 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/Articles/HowTo/Rules/DOC/HTML/Rules.cs.html|Proposed rules and standard procedures]]. It also serves as a site for placing additional rules of module design, which are not dealt with in the article.+This page serves as a wiki complement to an original article [[http://home.mlab.cz/Articles/HowTo/Rules/DOC/HTML/Rules.cs.html|Proposed rules and standard procedures]]. It also serves as a site for placing additional rules of module design, which are not dealt with in the article.
  
-The module design itself uses a following [[en:tools|software tools]].+The module design itself uses the following [[en:tools|software tools]].
  
 ===== Identification of modules ===== ===== Identification of modules =====
  
-Each modules has to carry a unambiguous identification mark consisting of its name, version and module revision - e.g. [[cs:jtagft2232v|JTAGFT2232V02A]].+Each module has to carry an unambiguous identification mark consisting of its name, version, and module revision - e.g. [[cs:jtagft2232v|JTAGFT2232V02A]].
  
   - 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://www.ust.cz/|UST]] company, which produces modules for MLAB. The meaning of the above-mentioned colour identification is as follows:+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://www.ust.cz/|UST]] company, which produces modules for MLAB. The meaning of the above-mentioned colour identification is as follows:
  
  
   * **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 changes even if the module’s identification mark is identical.+  * **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://github.com/mlab-modules/MODUL01 | GitHub MLAB module template repository]].
 +
 +The template repository should be used in [[https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template | the standard GitHub way]].
 +
 ==== 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 ''NAMEVERREV’’. +In the appropriate folder category, we create a folder with the name of the new module using the format of ''NAMEVERREV''. Inside the folder, we create the following directory structure (obligatory folders/files are marked with an asterisk):
-Inside the folder, we create the following directory structure (obligatory folders/files are marked with an asterisk):+
  
  
Line 96: Line 102:
   }   }
  
-You can find example of a correct filling by checking one of the already existing [[https://github.com/MLAB-project/Modules/blob/master/sensors/ALTIMET01A/ALTIMET01A.json|module]].+You can find an example of a correct filling by checking one of the already existing [[https://github.com/MLAB-project/Modules/blob/master/sensors/ALTIMET01A/ALTIMET01A.json|module]].
  
 ===== Module power supply ===== ===== Module power supply =====
Line 109: Line 115:
 {{:low_power_connectors.png?direct&400|}}  {{:low_power_connectors.png?direct&400|}} 
  
-**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 of the corner holes. Each module is 10 mils smaller in size compared to the exact raster due to production tolerances (otherwise it might not be possible to fit two modules next to each other on a base board). To make it possible to fit modules next to each other, it is necessary to make each size smaller by 0.254 mm (10 mils). For mounting on the [[en:albase1521|ALBASE]], we use M3 screws of 12 mm in length - that is why it is necessary to have four 3 mm diameters openings on each PCB.+MLAB modules are designed in 10.16 mm raster (400 mils) and their sizes exceed 200 mils - 10 mils from the centers of the corner holes. Each module is 10 mils smaller in size than the exact raster due to production tolerances (otherwise it might not be possible to fit two modules next to each other on a baseboard). To make it possible to fit modules next to each other, it is necessary to make each size smaller by 0.254 mm (10 mils). For mounting on the [[en:albase1521|ALBASE]], we use M3 screws of 12 mm in length - that is why it is necessary to have four 3 mm diameter openings on each PCB.
  
-An example of a module occupying 3 openings on the ALBASE:+An example of a module occupying 3 openings on the [[en:albase1521|ALBASE]]:
  
-{{ :cs:modul.png?400 |}}+{{ :mlab_module_geometry_example.png?direct&600 |}}
  
  
-   Length of the edge = 4x10.16 - 0.254 -0.254 = 40.132 mm +   * Length of the edge: 4x10.16 - 0.254 -0.254 = 40.132 mm 
-   Screws’ pitch = 3x10.16 = 30.48 mm +   * Screws’ pitch: 3x10.16 = 30.48 mm 
-   The distance of screw opening from the base’s edge = 5.08 - 0.254 = 4.826 mm +   * The distance of the screw hole center from the base’s edge: 5.08 - 0.254 = 4.826 mm 
-   Screw opening’s diameter = 3 mm+   * Screw hole diameter: 3 mm (MLAB footprint)
  
 ==== Edge screws ==== ==== Edge screws ====
Line 264: Line 270:
 Modules’ indicator LEDs can be of SMD or LED 3 mm types. SMD diodes can be placed also on the bottom side of the board that is turned towards the base plate. In such case, it is recommended to design a hole of approximately 1 mm in diameter over the SMD LED, through which the LED will be visible. Modules’ indicator LEDs can be of SMD or LED 3 mm types. SMD diodes can be placed also on the bottom side of the board that is turned towards the base plate. In such case, it is recommended to design a hole of approximately 1 mm in diameter over the SMD LED, through which the LED will be visible.
  
-===== Text / Printing (?? Potisk) on modules =====+===== Text / Legend printing on modules =====
  
 Modules’ printings should respect a general typographical rules in order for it to be readable even after an application of screen printing. Modules’ printings should respect a general typographical rules in order for it to be readable even after an application of screen printing.
Line 270: Line 276:
 ==== Font ==== ==== Font ====
  
-One module can accommodate more font sizes (usually less than 3 is necessary). They are used in a following order: name of the module, printings (??), warnings, author’s id. Different sizes are of course used only in cases, when there is enough space on the module. Some modules have therefore only one font size - with respect to good readability and module’s size.+One module can accommodate more font sizes (usually less than 3 is necessary). They are used in a following order: name of the module, legend, warnings, author’s id. Different sizes are of course used only in cases, when there is enough space on the module. Some modules have therefore only one font size - with respect to a good readability and module’s size.
  
 === Alignment === === Alignment ===
  
-Same priority signals should have the same font size across the whole module. Size and a style of individual labels should also united in case of one connector.+Same priority signals should have the same font size across the whole module. Size and style of individual legends should also united in case of one connector.
  
  
-Popisky jednotlivých signálů na hřebínku se zarovnávají ke konektoru, aby byla minimalizována možnost řádkové chyby při zapojování.+Legend to individual signals on a pin should be aligned to connector in order to minimise a possibility of line error (?? Řádková chubs) when connecting.   
  
-=== Velikosti Písma ===+=== Font Sizes ===
  
-Nejčastější používané velikosti písma jsou:+Most commonly used font sizes are as follows:
  
-  Width 1,5 mm, Height 1,5mm, Thickness 0,3mm  - název modulu, důležité informace a popisky hřebínků +  Width 1.5 mm, Height 1.5mm, Thickness 0.3mm  - module name, important information and pins’ legends 
-  Width 1,3 mm, Height 1,3mm, Thickness 0,3mm  - popisky jednotlivých vývodů hřebínků+  Width 1.3 mm, Height 1.3mm, Thickness 0.3mm  - legend to an individual pin nails (??) popisky jednotlivých vývodů hřebínků
  
-Velikost písma menší než 1,3 mm je problematická a je třeba ji používat pouze v opodstatněných případech. +Font sizes smaller than 1.3 mm is problematic and it should only be use when there is a very good reason for it.
  
-Na některých malých modulech může vzniknout problém s délkou názvu modulu, v takovém případě se název modulu zalamuje u verze modulu, například: +Some small modules might have a problem with length of their names - in such cases, the module’s name are wrapped to the next line at module version, for example:
  
 {{:cs:isl2902001a_top_big.jpg?direct&300|}} {{:cs:isl2902001a_top_big.jpg?direct&300|}}
  
-ISL2902001A je celý název tohoto modulu, avšak ten není možné na modul umístit, proto je zalomen u verze jako ISL29020  a 01A.+ISL2902001A is the whole module’s name. However, it cannot be placed on the module, that is why it is wrapped at the point of module’s version - ISL29020 and 01A 
 + 
 +==== QR codes ====
  
-==== QR kódy ==== +All sufficiently large modules should have a QR code placed on them. It contains module’s identification and a link to a side with [[http://www.mlab.cz/PermaLink/|module's documentation permalink]]. QR is generated using a qrencode tool to <modul>/doc/img/<modul>_QRcode.png folder, for example: 
-Na všechny moduly které jsou dostatečně velké, aby na ně mohl být umístěn QR kód. Ten obsahuje identifikaci modulu a odkaz na stránku s [[http://www.mlab.cz/PermaLink/|permalinkem na dokumentaci modulu]]. QRkód generujeme nástrojem qrencode do složky <modul>/doc/img/<modul>_QRcode.png. např+
  
   qrencode -s 15 -l L "http://www.mlab.cz/" -o "MODUL01A_QRcode.png"   qrencode -s 15 -l L "http://www.mlab.cz/" -o "MODUL01A_QRcode.png"
  
-Pokud jste pro vytvoření modulu použili mlabgen, QRkód by měl být vytvořen při vytváření základní adresářové struktury.+If you have used mlabgen for module generation, QR code should already be created during the creation of the basic directory structure.
  
 <WRAP info round> <WRAP info round>
-Vhodnejší by pravděpodobně bylo použití [[http://www.qrcode.com/en/codes/microqr.html|micro QR kódů]]. Utilita qrencode je sice umí generovat. Např. "qrencode  --micro -v 4 -s 15 -l L "BATPOWER04C" -o "microQRcode.png"" ale ještě neexistuje vhodná čtečka do Androidu, která by je uměla číst.+It will probably be better to use [[http://www.qrcode.com/en/codes/microqr.html|micro QR codes]] - qrencode utility is able to generate them (e.g. "qrencode  --micro -v 4 -s 15 -l L "BATPOWER04C" -o "microQRcode.png””). However, it still does not exist a suitable reader for Android that will be able to recognise them.
 </WRAP> </WRAP>
  
Line 308: Line 315:
 === PADS === === PADS ===
  
-Miho pro potřeby generování kódu do potisku plošného spoje vytvořil [[http://www.mlab.cz/~miho/QR/index.php|generátor QR kódů]], který generuje grafiku ve formátu ASC (Původně určeno pro Mentor Graphics PADS) Velikost QR kódů na plošných spojích zatím není sjednocena. Při generování kódů je výchozí velikost pro většinu plošných spojů příliš velká. Momentálně se vhodné nastavení musí vyzkoušet vhodné počáteční nastavení je např. +In order to generate a code for PCB label, Miho created a [[http://www.mlab.cz/~miho/QR/index.php| QR codes generator]], which generates ASC formate graphics (originally intended for  Mentor Graphics PADS). 
 +Size of QR codes on PCBs is so far not unified. When generating codes, the default size is too large for most of PCBs. So far, an acceptable setting has to be tested , e.g.
  
   * PADS Size: 20   * PADS Size: 20
   * PADS Line Width: 2   * PADS Line Width: 2
  
-Vygenerovaný soubor je ve formě textu na spodní straně stránky. Text je tak nutné ručně vložit do souboru s příponou asc. Po importování vygenerovaného obrázku do potisku plošného spoje je následně třeba nastavit atribut "solid copper" aby motiv byl kompletně vyplněn barvou.+The generated file is found at the bottom of the side as a text. The text has to be manually inserted into a file with asc. suffix. After importing the generated picture into a PCB’s printing, its attribute has to be set as “solid copper” so that the motive will be entirely filled in with colour. 
  
 === KiCAD === === KiCAD ===
  
-Obrázky QRkódů se do KiCAD  [[http://www.re-innovation.co.uk/web12/index.php/en/blog-75/230-adding-logo-to-kicad|převedou]] stejně jako logo. +QRcode pictures can be  [[http://www.re-innovation.co.uk/web12/index.php/en/blog-75/230-adding-logo-to-kicad|added]] to KiCAD in the same way as logo.
  
-===== Check list před výrobou =====+===== Check list before production =====
  
-  - zkontrolovat velikost a spravnost pouzder +  - 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??), jumpers (?? Propojka) or other special components  
-  - odmaskovani plošek, propojky +  - check the unmasking of (??) plošek and jumpers (??)  
-  - 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 title 
-  - Zkontrolovat, ze nejsou prokovy pod pismeny a znaky +  - check that the VIAs are not under letters and symbols 
-  - zkontrolovat QR kod a PermaLink.+  - check the QR code and PermaLink
  
  
-===== Struktura repozitáře MLABu =====+===== MLAB repository structure=====
  
  
-  * Projektová metadata - json +  * Project metadata - json 
-  * 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 ====+====  Modules’ directory structure ====
  
   MODUL01A/   MODUL01A/
en/rules.1549725543.txt.gz · Last modified: 2019/02/09 15:19 by fluktuacia