en:rules
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
en:rules [2019/02/02 15:23] – fluktuacia | en:rules [2022/03/08 21:58] – [Manual module creation] kaklik | ||
---|---|---|---|
Line 21: | Line 21: | ||
* **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 changes even if the module’s identification mark is identical. | ||
- | ===== Establishing | + | ===== Creating |
==== Using a mlabgen script ==== | ==== Using a mlabgen script ==== | ||
Line 35: | Line 35: | ||
Using the '' | Using the '' | ||
- | Next step is to edit the metadata file ‘’< | + | Next step is to edit the metadata file '' |
Commit log should be completed with an information that a new module has been added together with its purpose. Further documentation should be already created during the module development. It is therefore useful to create a module’s wiki page here, shorty after the commit of the new module. Creating a page can be done by opening a wiki page from the [[https:// | Commit log should be completed with an information that a new module has been added together with its purpose. Further documentation should be already created during the module development. It is therefore useful to create a module’s wiki page here, shorty after the commit of the new module. Creating a page can be done by opening a wiki page from the [[https:// | ||
- | Do commit logu je vhodné napsat popis toho, že je přidáván nový modul s nějakým určením. Další dokumentace by měla být vytvářena již během vývoje modulu. Je proto dobré hned po commitu nového modulu založit stránku na této wiki. To lze nejlépe udělat otevřením wiki stránky ze stránky modulu [[https:// | + | ==== Manual module creation ==== |
+ | 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: | ||
- | ==== Ruční vytvoření modulu ==== | + | In the appropriate folder category, we create a folder with the name of the new module using the format |
- | Pokud z nějakých důvodů nechcete používat MLABgen pro vytvoření základní adresářové struktury, při zakládání nového modulu je potřeba dodržet následující pravidla. | + | |
- | + | ||
- | V odpovídající složce kategorie vytvoříme složku s názvem nového modulu ve formátu | + | |
- | Uvnitř složky modulu by měla být vytvořena následující adresářová struktura. Povinné soubory/složky jsou označeny hvězdičkou | + | |
+ | '' | ||
< | < | ||
├── doc* | ├── doc* | ||
Line 75: | Line 73: | ||
├── < | ├── < | ||
└── sw | └── sw | ||
- | └── < | + | └── < |
- | Soubor | + | The file ''< |
{ | { | ||
Line 83: | Line 81: | ||
" | " | ||
" | " | ||
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
" | " | ||
" | " | ||
" | " | ||
- | " | + | " |
" | " | ||
- | " | + | " |
" | " | ||
" | " | ||
} | } | ||
- | Se správným vyplněním se můžete inspirovat například u nějakého existujícího | + | You can find an example of a correct filling by checking one of the already existing |
- | ===== Napájení modulů | + | ===== Module power supply |
- | Podrobnější příklady konektorů a vysvětlení jejich použití je na stránce | + | You can find more detailed examples of connectors and an explanation of their use at |
- | ==== Konfigurace konektorů | + | ==== MLAB connectors configuration |
+ | Power supply connectors for low currents have two configurations (??) which are implemented using .. (??) | ||
Napájecí konektory pro nízké proudy mají dvě konfigurace a jsou realizovány lámacími hřebínky s roztečí 2,54mm | Napájecí konektory pro nízké proudy mají dvě konfigurace a jsou realizovány lámacími hřebínky s roztečí 2,54mm | ||
{{: | {{: | ||
- | **Napájecí konektory jsou zdvojené, aby bylo umožněno | + | **Power supply connectors are doubled in order to allow smyčkování napájení |
==== Externí napájecí zdroje ==== | ==== Externí napájecí zdroje ==== | ||
- | Na silové napájení s vyššími výkony se používají konektory FASTON, nebo svorkovnice | + | For power supply with higher powers, the FASTON connectors or WAGO256 |
{{ : | {{ : | ||
- | Na plošném spoji jsou ale vždy otvory na svorkovnici | + | There are always openings for WAGO256 |
+ | === Cylindrical power supply connector === | ||
- | === Válcový napájecí konektor | + | === Power supply +5V from USB === |
- | === Napájení +5V z USB === | + | It is always a good practice to include a safety current PTC fuse into the USB power supply in case of modules powered from USB that are able to further distribute the power so that the HOST system is not overloaded. |
- | Je dobrým zvykem u modulu napájeného z USB, který může napájení dále distribuovat zařadit do USB napájení ochrannou proudovou PTC pojistku zaručující, | + | === High voltage === |
+ | For high voltage distribution (>250V DC) to modules, there are special high-voltage connectors [[http:// | ||
- | === Vysoké napětí === | + | {{: |
- | Pro rozvod vysokého napětí k modulům (>250V DC) se používají speciální vysokonapěťové konektory [[http:// | + | Due to usually very good insulating parameters of coaxial cables, it is possible to use coaxial cable RG58 for construction of high-voltage distributions. |
- | + | ||
- | {{: | + | |
- | + | ||
- | Vzhledem k běžně velmi dobrým izolačním vlastnostem koaxiálních kabelů je možné použít pro výrobu vysokonapěťových rozvodů i koaxiální kabel RG58. | + | |
| | ||
- | ===== Ochranné prvky na modulech | + | ===== Safety features |
- | ==== Schéma modulu | + | ==== Module schema |
- | Správně nakreslené schéma | + | A properly drawn schema |
- | - Spoje se musí co nejméně křížit | + | - Connections cross each other as little as possible |
- | - Signály vedou zleva doprava. | + | - Signals are led from left to right. |
- | - Kladné napájení vede ze shora dolu, záporné zespoda nahoru. | + | - Positive power supply is led from top to the bottom, negative from bottom to the top. |
- | - Spoj nesmí křížit žádný nápis. | + | - A connection cannot cross any text / inscription |
- | - Blokovací kondenzátory se kladným pólem připojují do místa které blokují. | + | - Decoupling capacitors are connected with their positive pole to the place they should decouple |
- | - na jednom spoji musí být minimální množství spojovacích bodů (není například vhodné kreslit vedle sebe dva T uzly ale lepší je nakreslit jeden uzel +). | + | - One connection has to contain a minimal amount of connecting points |
- | - Hodnoty součástek musí mít jednotnou jmennou konvenci využívající plný název fyzikální veličiny tj. nF, pF atd. | + | - Components’ values must have a common name convention using full names of the physical quantities - e.g. nF, pF etc. |
- | Specifikem schémat MLABu pak je, že hřebínky jsou vždy ve dvojici ale ve schématu se pro přehlednost uvádí, jako jedna součástka. (vyžaduje | + | A specific feature of MLAB schemes is, that the nails are always in pair, but to keep the scheme intelligible, they are shown as one component (in some cases it requires using own libraries, but on the other hand, schemes are much more intelligible). |
+ | ==== Safety resistors ==== | ||
- | ==== Ochranné odpory ==== | + | We advice to use safety serial resistors on inputs of some of our modules (e.g. sensors or often modules working at 3.3V) - they will increase the resistance to extreme preload. Size of such resistors is usually within range 10 Ohm to 1 kOhm, with respect to the IO pin’s current requirements. |
- | Na vstupech některých modulů, jako jsou například čidla (nebo často moduly pracující na 3,3V) je vhodné umístit ochranné sériové odpory, které zvýší odolnost vůči externímu přepětí. Velikost těchto odporů se obvykle volí v rozsahu 10 Ohm až 1kOhm, podle předpokládaného potřebného proudu IO pinem. | + | ==== Safety diodes ==== |
+ | Almost all the present MLAB modules contain a safety antiparallel diode on the power supply input, serving as a protection against polarity reversal. It short-circuits the power supply in case of connecting the power voltage of incorrect polarity. In order to function correctly, the diode requires power supplies with current limit. | ||
- | ==== Ochranné diody ==== | + | Therefore it is not recommended to power supply the modules directly from accumulators, |
- | Prakticky všechny | + | ===== Module geometry ===== |
- | Proto není vhodné napájení modulů realizovat přímo z akumulátorů, | + | ==== Sizes ==== |
- | ===== Geometrie modulů ===== | + | MLAB modules are designed in 10.16 mm raster |
- | + | ||
- | ==== Rozměr ==== | + | |
- | + | ||
- | Moduly jsou navrženy v rastru | + | |
- | + | ||
- | Názorný příklad pro modul zabírající 3 otvory na ALBASE: | + | |
+ | An example of a module occupying 3 openings on the ALBASE: | ||
{{ : | {{ : | ||
- | Délka hrany = 4x10,16 - 0,254 -0,254 = 40,132 mm | + | Length of the edge = 4x10.16 - 0.254 -0.254 = 40.132 mm |
- | Rozteč šroubů | + | Screws’ pitch = 3x10.16 = 30.48 mm |
- | Vzdálenost otvoru na šroub od okraje desky = 5,08 - 0,254 = 4,826 mm | + | The distance of screw opening from the base’s edge = 5.08 - 0.254 = 4.826 mm |
- | Průměr otvoru na šroub | + | Screw opening’s diameter |
- | ==== Rohové šrouby | + | ==== Edge screws |
- | Šrouby musí mít okolo sebe dostatečný prostor pro utažení dvou kontra-matic, které v modulu drží šroub | + | Screws need to have a sufficiently large space around them in order to fasten two contra-nuts that are holding |
- | Matice se u modulů používají proto, protože dvě matice umožňují využít efektu | + | Nuts are used thanks to the fact that two nuts make it possible to use a |
+ | ==== Layout (PCB design) ==== | ||
+ | **Limits of production possibilities: | ||
+ | Minimal trace width (?? Cesta) 0.1 mm | ||
+ | Minimal insulating space 0.1 mm | ||
- | ==== Layout | + | Conductive traces |
- | **Mezní možnosti výroby: | + | The traces are furthermore design to minimise the possibility of modules’ emissions - this usually means to minimise the area of knots (?? Smyček), especially in case of boards with alternating currents of high amplitude (e.g. inverters) or in case of outputs of logical circuits of CMOS and TTL types. |
- | Min. tloušťka cesty 0,1 mm | + | |
- | Min. izolační mezera 0,1 mm | + | |
+ | In case of two-layer PCBs we prefer to use the upper side of the module (the one away from the base board) as a ground potential (??). If necessary, it is possible to have a low-voltage power supply led also in this side. However, it is quite crucial to avoid leading data or high-frequency signals in the top layer (again, due to possibility of emissions and reduction in the signal integrity). | ||
- | Vedení plošných spojů a jejich rozměry jsou vždy volené tak, aby byla v co největší míře umožněna i amatérská výroba a osazení plošného spoje. | + | Modules should have all of the four screws connected with the same potential, even in cases when the module is not using the base board’s ground (if there are not any special construction requirements that would make such practice impossible. An exception is for example [[en: |
- | Spoje jsou dále vedeny tak, aby se co nejvíce minimalizovala možnost vyzařování modulu, což znamená minimální plochy smyček zvláště u spojů, které vedou střídavé proudy s velkou amplitudou, typicky měniče ale třeba i výstupy logických obvodů typu CMOS a TTL. | + | === Components’ encasements === |
- | U dvouvrstvých plošných spojů je preferováno užití horní strany modulu (odvrácené od základové desky) jako zemního potenciálu. V nutných případech je ale možné na této straně vést i nízkovýkonové napájení. Je ale nutné se v horní vrstvě vyvarovat vedení datových a vysokofrekvenčních signálů (opět kvůli možnosti vyzařování a snížení integrity signálu). | + | The preferred encasements for components are those from [[https:// |
- | Moduly by měly mít všechny čtyři šrouby spojené stejným potenciálem a to pokud možno i v případě, kdy modul nepoužívá zem základové desky (Pokud to zvláštní konstrukční požadavky modulu nevylučují. Vy jímka je například [[cs:eth]]) tato praxe opět pomáhá snížit vyzařování modulu, zvláště u vícevrstvých plošných spojů. | + | The preferred size of SMD casing is currently 0805 series. |
- | === Pouzdra součástek | + | === Components’ placement |
- | Preferovaná pouzdra součástek jsou z našich [[https:// | + | SMD components are placed only at one side of the board - the one turned towards the base board, if possible (B.Cu layer). A reason for this placement is a greater toughness of the construction, |
- | Proferovaná velikost SMD pouzder je aktuálně řada 0805. | + | === Layers === |
+ | F.Cu - top copper (copper layer on the components’ side) (??) | ||
+ | B.Cu - bottom copper (copper layer on the traces side ?? měděná vrstva ze strany spojů) | ||
+ | F.SilkS - silkscreen (components’ side) | ||
+ | B.SilkS - silkscreen (traces’ side ??) potisk strana spojů | ||
+ | F.Mask - soldermask (components’ side) | ||
+ | B.Mask - soldermask (traces’ side ??) maska strana spojů | ||
+ | Edge.Cuts - board outline | ||
+ | F.Fab - fabrication layer (components’ side) potisk pro osazování strana součástek | ||
+ | B.Fab - fabrication layer (potisk pro osazování strana spojů | ||
- | === Rozmisteni soucastek === | ||
- | SMD součástky se umisťují výhradně na jednu stranu desky. Ideálně na stranu přivrácenou k základové desce (vrstva B.Cu). Důvodem je větší odolnost konstrukce, nižší vyzařování a ulehčení osazení v reflow peci. | ||
+ | When designing a two-layer PCB, one layer is reserved for grounding and power supply - this layer will be set up as a " | ||
- | === Vrstvy | + | === VIAs === |
- | F.Cu - měděná vrstva ze strany součástek | + | **For usual traces** |
- | B.Cu - měděná vrstva ze strany spojů | + | 0.8 mm VIA’s diameter and 0.4 mm diameter for drilling |
- | F.SilkS - potisk součástek | + | |
- | B.SilkS - potisk strana spojů | + | |
- | F.Mask - maska strana součástek | + | |
- | B.Mask - maska strana spojů | + | |
- | Edge.Cuts - obrys desky | + | |
- | F.Fab - potisk pro osazování strana součástek | + | |
- | B.Fab - potisk pro osazování strana spojů | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | Pri navrhu dvouvrstveho plosneho spoje, je jedna vrstva se vyhrazena pro zem a napajeni. Tato vrstva se | + | |
- | pak nastaví jako " | + | |
- | napájení. To umožní automaticky ukončovat tyto spoje prokovem do této | + | |
- | vrstvy. | + | |
- | protoze v takovem případě se spoj špatně edituje. | + | |
- | + | ||
- | + | ||
- | === Prokovy === | + | |
- | + | ||
- | **Pro běžné cesty** | + | |
- | 0,8 mm průměr prokovu a 0,4 mm průměr vrtání | + | |
| | ||
- | Pro silové cesty je potřeba zvětšit rozměry prokovu, dle přenášených proudů, nebo zvýšit jejich počet. | + | For power traces, the dimensions of VIAs have to be enlarged depending on the currents, or their number have to be increased. |
| | ||
| | ||
- | **Mez výroby** | + | **Limits of production** |
- | | + | |
| | ||
V případech kde to není nutné nenavrhujeme na této mezi. Prodražuje cenu PCB. | V případech kde to není nutné nenavrhujeme na této mezi. Prodražuje cenu PCB. | ||
- | |||
Texty v potisku modulu nesmí překrývat prokovy. (Jinak dojde k nečitelnosti potisku v místě prokovu) | Texty v potisku modulu nesmí překrývat prokovy. (Jinak dojde k nečitelnosti potisku v místě prokovu) | ||
- | ==== Konstrukční části | + | ==== Construction parts ==== |
- | Na moduly kde zbývá volné místo na plošném spoje je možné umístit plošky pro rezervní součástky, obvykle rezistory, nebo kondenzátory v pouzdru 0805. Při vkládání součástek, je vhodné použít dvojitý | + | When a module has some free space left of a PCB, it is possible to place a spaces for backup components (usually resistors or condensers in 0850 encasement). During components fitting, it is recommended to use double |
=== LED === | === LED === | ||
- | Indikační LED jsou na modulech ideálně navrhovány tak, aby svítily skrz plošný spoj na od základní desky odvrácenou stranu. Toho je dosaženo vsazením | + | Modules’ indicator LEDs are preferably designed in a way that they shine through the PCB onto the side turned away from the base board. It can be achieved by placing a LED into a hole in a PCB - such kind of mounting is called “reverse mount” and there exist [[http:// |
- | Klasické | + | Classic |
- | === Krystaly | + | === Crystals |
- | Pro krystaly v modulech | + | As a basic case for crystals in MLAB modules, we have chosen |
- | {{: | + | {{: |
- | Pro moduly, kde lze předpokládat občasnou výměnu krystalu za krystal s jinou frekvencí se na modulech osazuje speciální držák krystalu, do kterého je možné po zkrácení nožiček krystal pohodlně zasunout | + | In case of modules, where we assume occasional exchanges of crystals for crystals with other frequencies, we fit them with a special crystal holder. After shortening the legs, crystals can be comfortably inserted into the holder and thus replaced by another crystal any time. |
- | {{: | + | {{: |
- | === Rezervní pozice pro součástky | + | === Backup positions for components |
- | Indikační LED mohou na modulech být v provedení | + | 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. |
- | ===== Potisk na modulech | + | ===== Text / Legend printing on modules |
- | Potisk na modulech by měl respektovat obecná typografická pravidla. Je to důležité hlavně z hlediska nutnosti zachovat čitelnost potisku i po aplikaci sítotiskem. | + | Modules’ printings should respect a general typographical rules in order for it to be readable even after an application of screen printing. |
- | ==== Písmo | + | ==== Font ==== |
- | Na jednom modulu se může vyskytovat více velikostí písma, | + | 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. |
- | === Zarovnání | + | === Alignment |
- | Signály se stejnou prioritou by měly mít na celém modulu jednotnou velikost písma. Taktéž by měla být sjednocena velikost a styl jednotlivých popisků u jednoho konektoru. | + | 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í. | ||
- | === Velikosti Písma === | + | 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. |
- | Nejčastější používané velikosti písma jsou: | + | === Font Sizes === |
- | Width 1,5 mm, Height 1,5mm, Thickness 0,3mm - název modulu, důležité informace a popisky hřebínků | + | Most commonly used font sizes are as follows: |
- | Width 1,3 mm, Height 1,3mm, Thickness 0,3mm - 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. | + | 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 - legend to an individual pin nails (??) popisky jednotlivých vývodů hřebínků | ||
- | 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: | + | Font sizes smaller than 1.3 mm is problematic and it should only be use when there is a very good reason for it. |
+ | |||
+ | 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: | ||
{{: | {{: | ||
- | ISL2902001A | + | ISL2902001A |
+ | |||
+ | ==== 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:// |
- | 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 | + | |
qrencode -s 15 -l L " | qrencode -s 15 -l L " | ||
- | Pokud jste pro vytvoření modulu použili | + | If you have used mlabgen |
<WRAP info round> | <WRAP info round> | ||
- | Vhodnejší by pravděpodobně bylo použití | + | It will probably be better to use [[http:// |
</ | </ | ||
Line 324: | Line 308: | ||
=== PADS === | === PADS === | ||
- | Miho pro potřeby generování kódu do potisku plošného spoje vytvořil | + | In order to generate a code for PCB label, |
+ | 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 | + | 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 | + | QRcode pictures can be |
- | ===== Check list před výrobou | + | ===== Check list before production |
- | - 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.txt · Last modified: 2023/02/03 00:14 by kaklik