en:tools
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| en:tools [2019/02/15 15:55] – fluktuacia | en:tools [2023/02/02 22:39] (current) – update screenshot of design rules. 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 |
| ====== Software tools for MLAB kit development ====== | ====== Software tools for MLAB kit development ====== | ||
| - | This site deals with software tools necessary for MLAB kit development and design, for information about technical equipment see [[en: | + | This site deals with software tools necessary for MLAB kit development and design, for information about technical equipment, see [[en: |
| - | MLAB design and development | + | MLAB design and development |
| ===== Electronic CADs ===== | ===== Electronic CADs ===== | ||
| Line 17: | Line 17: | ||
| === Ubuntu installation === | === Ubuntu installation === | ||
| - | There are two options for KiCAD installation in linux - usually it is advised to use the PPA. | + | There are two options for KiCAD installation in Linux - usually, it is advised to use the PPA. |
| == PPA Repository == | == PPA Repository == | ||
| - | [[https:// | + | [[https:// |
| - | In order to download and install the most stable KiCAD version, enter following commands into a terminal: | + | In order to download and install the most stable KiCAD version, enter the following commands into a terminal: |
| sudo add-apt-repository --yes ppa: | sudo add-apt-repository --yes ppa: | ||
| Line 49: | Line 49: | ||
| == Libraries == | == Libraries == | ||
| - | * Standard libraries included directly in the programm | + | * Standard libraries included directly in the program |
| - | * [[https:// | + | * [[https:// |
| - | It is convenient to use as many parts of MLAB libraries (available at [[https:// | + | It is convenient to use as many parts of MLAB libraries (available at [[https:// |
| Libraries are added to KiCAD separately during schematics drawing and separately during PCB designing - the procedure is very similar in both cases. | Libraries are added to KiCAD separately during schematics drawing and separately during PCB designing - the procedure is very similar in both cases. | ||
| Line 70: | Line 70: | ||
| | | ||
| - | In case that a schematic contains variants of fitted components, the MFPN (?? Identifikace pole) has an additional serial number, for example “MFPN_1”, | + | In case a schematic contains variants of fitted components, the MFPN (?? Identifikace pole) has an additional serial number, for example, “MFPN_1”, |
| - | When using a following procedure, it is no longer necessary to manually create all fields for every individual component. | + | When using the following procedure, it is no longer necessary to manually create all fields for every individual component. |
| V menu '' | V menu '' | ||
| Line 98: | Line 98: | ||
| === Rules for design === | === Rules for design === | ||
| - | Before the beginning of PCB design, it is necessary to set up following rules. | + | Before the beginning of PCB design, it is necessary to set up the following rules. |
| - | If you are not using circuits with small pitch of pins, following parameters are good to follow: | + | If you are not using circuits with a small pitch of pins, the following parameters are good to follow: |
| - | {{ :cs:navrh_prav.jpg?600 |}} | + | {{ en:kicad:kicad_design_rules.png?600 |}} |
| - | {{ : | + | |
| === Layers === | === Layers === | ||
| Line 379: | Line 378: | ||
| The programme can be opened in the usual from dashboard or using command line. | The programme can be opened in the usual from dashboard or using command line. | ||
| - | Pro použití nejnovějších funkcí je vhodné použít denní kompilaci openscadu. | + | For the newest functions to be available use the daily Openscad compilation: |
| sudo apt-get install openscad-nightly | sudo apt-get install openscad-nightly | ||
| - | Tu lze pak spustit z příkazového řádku jako openscad-nightly, | + | It can be run from the command line like openscad-nightly, |
| <WRAP center round tip 80%> | <WRAP center round tip 80%> | ||
| - | Pro zobrazení náhledů vygenerovaných | + | To display the STL generated views in Nautilus, you can use [[https:// |
| </ | </ | ||
| - | === Styl psaní kódu (coding | + | === Coding |
| - | Je praktické dodržovat některá základní pravidla při vytváření modelů v openscadu. | + | It is practical to follow some basic coding style rules when creating models in opens cad. |
| - | * Názvy proměnných vytvářet v mezinárodním jazyce | + | * Use international language for the names of variables |
| - | * Příliš nezkracovat názvy proměnných | + | * Do not shorten the names of variables too much |
| - | * Proměnné a operátory oddělovat mezerami | + | * Separate the variables and operators by spaces |
| - | * Používat odsazení o 4 mezery | + | * Use 4 space indentation |
| | | ||
| - | === Použití editoru | + | === Using SublimeText |
| - | Editor integrovaný přímo do OpenSCADu není moc pohodlný pro užívání. Je proto vhodnější zdrojové kódy modelů editovat v editoru | + | The editor integrated directly into OpenSCAD is not very comfortable for use. Therefore we prefer to edit the source codes of models in [[https:// |
| - | Instalaci lze provést přes systém balíčků, který můžeme aktivovat volbou | + | The installation can be done through a system of packages that can be activated via |
| {{: | {{: | ||
| - | Otevřeme nástroj pro zacházení s balíčky volbou | + | Open the package control tool with |
| {{: | {{: | ||
| - | V nabídce zvolíme | + | In the menu choose |
| {{: | {{: | ||
| - | Do filtračního pole napíšeme "openscad" | + | Write “openscad" |
| {{: | {{: | ||
| - | Nyní je potřeba | + | Now it is necessary to close and re-open the SublimeText |
| - | Potom je možné nastavit, aby všechny soubory s příponou | + | Then it is possible change the setting so that all files with // |
| {{: | {{: | ||
| - | Při následujícím otevření | + | During the following opening of any .scad file, it will be automatically recognised as a OpenSCAD |
| - | ===== Generování a prohlížení výrobních dat ===== | + | ===== Generating and viewing production data===== |
| - | ==== Gerber data ==== | + | ==== Data gerber |
| - | Pro prohlížení vygenerovaných dat jsou vhodné nástroje: | + | To view the generated data, there are several tools available: |
| * [[http:// | * [[http:// | ||
| * [[http:// | * [[http:// | ||
| - | === Skládání | + | === Merging the gerber |
| - | Pro skládáni dat lze využít program | + | In order to merge your data, you can use gerbmerge |
| - | | + | |
| - | Nejdříve nainstalujeme závislosti. | + | First, we install dependencies. |
| sudo apt-get install python-simpleparse python-simpleparse-mxtexttools | sudo apt-get install python-simpleparse python-simpleparse-mxtexttools | ||
| - | Následně stáhneme | + | Next, we download |
| git clone https:// | git clone https:// | ||
| cd gerbmerge | cd gerbmerge | ||
| sudo python setup.py install | sudo python setup.py install | ||
| - | Aby gerbmerge | + | For gerbmerge |
| - | Pakud ale máme připravený konfigurační soubor např. // | + | |
| kaklik@popelnice: | kaklik@popelnice: | ||
| - | Program se pokusí nalézt optimální rozložení motivů na panelu podle zvolené konfigurace | + | The programme will try to find an optimal motives’ layout on panel according to a chosen configuration and it will generate merged files. |
| - | Příklad pro složení | + | An example for merging |
| - | Nejprve je potřeba se dostat do místa, kde jsou data setu: | + | First, it is necessary to get to the place with the set data: |
| MLAB@MLAB: | MLAB@MLAB: | ||
| - | Nastavení skládání setu je v souboru | + | Setting of set merging is found in the layout.cfg |
| - | Vygenerování takto připravených dat se provede následujícím příkazem: | + | |
| + | Generating such prepared data can be done using a following command: | ||
| ../ | ../ | ||
| | | ||
| == GerberTools == | == GerberTools == | ||
| - | [[https:// | + | [[https:// |
| - | ==== Gkódy pro 3D tisk ==== | + | ==== Gcodes for 3D print ==== |
| - | Technologická | + | Technological |
| - | === Instalace | + | === Slic3r |
| sudo apt-get install libextutils-cppguess-perl freeglut3-dev | sudo apt-get install libextutils-cppguess-perl freeglut3-dev | ||
| - | === Postup kompilace === | ||
| - | Z githubu se aktuálně používá master větev, která je kompromisem mezi stabilitou | + | === Compilation === |
| + | |||
| + | Currently, a Github’s master branch is used - it is a compromise between stability and the software’s possibilities. The compilation itself is done mostly according to instructions from README.md | ||
| - | ===== Programátorské nástroje | + | ===== Programming tools ===== |
| - | Na většinu programování softwaru se používá se v MLABu používá | + | Most of the software programming in MLAB uses Python |
| - | ==== Programovací | + | ==== Programming |
| - | Programovací prostředí v kterém je vytvářen zdrojový kód. Mezi uživateli jsou nejoblíbenější následující dvě volby. Jinak lze ale zdrojový kód psát v libovolném textovém editoru. | + | A programming environment where the source code is created. The most favourite among users are the following two option - however, the source code can be written in any text editor. |
| === Light Table === | === Light Table === | ||
| - | [[http:// | + | [[http:// |
| - | Jeho instalaci do systému provedeme stažením zkompilovaného balíku z stránky | + | |
| sudo mv LightTable / | sudo mv LightTable / | ||
| Line 496: | Line 495: | ||
| === Sublime text === | === Sublime text === | ||
| - | Multiplatformní placený | + | A Multiplatform paid editor |
| - | == Instalace v Ubuntu == | + | == Ubuntu |
| Line 504: | Line 503: | ||
| sudo apt-get update | sudo apt-get update | ||
| sudo apt-get install sublime-text-installer | sudo apt-get install sublime-text-installer | ||
| + | |||
| === Code:: | === Code:: | ||
| - | Jde o velmi rozřířený | + | A widely used editor. It’s advantage is that it runs under various platforms and thus can be used by Windows users as well. |
| [[http:// | [[http:// | ||
| Line 513: | Line 513: | ||
| | | ||
| - | ==== Embeded | + | ==== Embeded |
| - | Nástroje na programování jednotlivých typů mikrokontrolérů jsou většinou popsány v částech týkajících se programování u jednotlivých architektur: | + | Tools used for programming individual types of microcontrollers are mostly described in sections related to programming under different architectures. |
| === PIC === | === PIC === | ||
| Line 523: | Line 523: | ||
| === AVR === | === AVR === | ||
| * [[cs: | * [[cs: | ||
| - | ===== Správa verzí | + | ===== Version Control |
| Line 531: | Line 531: | ||
| ==== GitHub ==== | ==== GitHub ==== | ||
| - | Pro správu softwarového vývoje a dokumentace modulů používáme | + | [[https:// |
| === Linux === | === Linux === | ||
| - | Jako nejefektivnější uživatelské rozhraní pro git se osvědčil příkazový řádek s tím, že jeho efektivita je zde ještě markantnější než u SVN. | + | The most effective user interface for git seems to be the command line - here its efficiency is even more striking than in SVN. |
| - | == Nový uživatel | + | == New user == |
| - | Pro pohodlnou ptáci s git je efektivnější používat metodu klonování s SSH. Není při práci vyžadováno stále přihlašování. Komunikace je autentizována na základě privátního klíče. Pro každý počítač je potřeba vygenerovat unikátní klíč. | + | |
| - | - Je potřeba si založit uživatelský účet na https:// | + | For a comfortable work with git it is effective |
| - | - Následně je potřeba [[https:// | + | |
| - | | + | |
| - | - Pokud v návodu nefunguje správně uložení klíče do schránky, tak je možné daný klíč získat otevřením skrytého souboru | + | |
| - | - Tento postup stačí provést jen při prvním stahování na daném počítači. | + | |
| - | == Základní příkazy == | + | - You need to create a user account on https:// |
| + | - Next, you have to [[https:// | ||
| + | - The generated key has to be [[https:// | ||
| + | - If the addition of the key into clipboard (?? Schránka) does not work properly, it is possible to obtain the key via opening a hidden file and then copying the key manually. ‘’cat ~/ | ||
| + | - This procedure only has to be done during the first download to a given computer. | ||
| - | == Klonování repozitáře : == | + | == Basic commands |
| - | - Nejprve je potřeba vybrat místo, kde má být repozitář v počítači uložen | + | == Cloning |
| - | - Příklad bude ukázán na repozitáři kicad-mlab: https:// | + | |
| - | - Na dané stránce si stáhneme potřebnou cestu k repozitáři. Webové tlačítko "Clone or download" | + | |
| - | - Je potřeba si přepnout cestu pro "Clone with SSH", na místo "Clone with HTTPS" | + | |
| - | - Pro náš případ cesta vypadá takto: git@github.com: | + | |
| - | - Nyní stačí v příkazové řádce zadat příkaz: | + | |
| + | - First, you have to choose a place on your computer, where the repository will be saved and at that place, open the command line | ||
| + | - As an example, we will use kicad-mlab repository: https:// | ||
| + | - From the page, download the path to the repository - web button "Clone or download" | ||
| + | - It is necessary to switch the path to "Clone with SSH" in stead of "Clone with HTTPS”. | ||
| + | - In our case, the path is as follows: git@github.com: | ||
| + | - Run the following command in the command line: | ||
| git clone git@github.com: | git clone git@github.com: | ||
| - | - Následně můžeme být vyzváni k zadání hesla, které jsme si zvolili při generování | + | - You may be asked to provide a password you have chosen during the SSH key generation |
| - | == Stažení aktuální verze: | + | == Downloading the current version |
| - | - V místě uložení repozitáře je potřeba zadat v příkazové řádce následující příkaz: | + | - In the folder with the saved repository, run the following command in the command line: |
| git pull | git pull | ||
| - | == Zjištění stavu aktuálnosti repozitáře | + | == Finding out whether the repository is up-to-date |
| git status | git status | ||
| - | Tento příkaz vypíše u jakých souborů došlo ke změně, nebo které byli přidány jako nové. | + | This command lists all the files that have been changed or added as new. |
| - | == Přidání nového souboru, složky | + | == Adding new file or folder |
| - | git add název_souboru | + | git add file_name |
| | | ||
| - | Po označení celé cesty z výpisu | + | After marking (?? Označit) the whole path from the command list of commands (?? výpis |
| - | Pro přidání | + | For submitting (?? Adding, |
| - | == Vytvoření commitu | + | == Creating a commit |
| - | git commit -m "Popis provedené změny" | + | git commit -m “Description of the change" |
| - | Po tomto příkazu je commit | + | After running the above-mentioned command, the commit |
| - | == Upload | + | == Upload |
| git push | git push | ||
| | | ||
| - | Pro ověření, zda veškeré úkony proběhly v pořádku je dobré se podívat na výstup příkazu: | + | It is helpful to list the output of the following command, to see if all the operation were done correctly. |
| git status | git status | ||
| - | Ve výpisu by neměly být žádné položky, které jsme chtěli nahrát. | + | The list should not contain any items that we wanted to upload. |
| | | ||
| - | == Změna velikosti lokálního repozitáře | + | == Changing the size of the local repository |
| - | Git si ve výchozím nastavení stahuje celý repozitář včetně veškeré historie úprav. Toto lze zamezit při stahování repozitáře pomocí parametru | + | In its default setting, |
| git clone < | git clone < | ||
| - | Pokuď toto chcete aplikovat na existující kopii repozitáře, | + | If you want to apply it onto an existing copy of the repository, you can use the following approach: |
| git fetch --depth 2 | git fetch --depth 2 | ||
| git reflog expire --expire=all --all | git reflog expire --expire=all --all | ||
| git gc --prune=all | git gc --prune=all | ||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| === Windows === | === Windows === | ||
| - | [[https:// | + | [[https:// |
| + | Under Windows | ||
| - | ===== Dokumentace vývoje | + | ===== Documentation |
| - | ==== Textová dokumentace | + | ==== Text documentation |
| - | Veškeré textové dokumenty jsou v MLABu kódovány v UTF-8 někteří uživatelé ale požívají na editaci souborů windows a výsledkem je nekompatibilní soubor, který je třeba překódovat. | + | All MLAB text documents are UTF-8 coded. Some users however use Windows for editing files which may result in an incompatible file, which needs to be re-coded. |
| - | Převod kódování textových souborů. | + | Converting the coding of text files. |
| iconv -f WINDOWS-1250 -t UTF-8 zprava.txt | iconv -f WINDOWS-1250 -t UTF-8 zprava.txt | ||
| Line 636: | Line 631: | ||
| === Dokuwiki === | === Dokuwiki === | ||
| - | Dokuwiki | + | Dokuwiki |
| - | == Offline | + | == Offline |
| - | Podstatné ale je, že je možné tuto dokumentaci editovat i offline, což se hodí zejména při cestování. | + | Documentation can be edited offline, which is a very useful feature that one can use e.g. during traveling. |
| - | K tomu je potřeba si na svém notebooku zprovoznit lokální instanci | + | For offline editing to work, it is necessary to create a local wiki instance on your notebook. It can be done following a [[https:// |
| + | |||
| + | Data between both wiki instances are synchronised with [[https:// | ||
| === LaTeX === | === LaTeX === | ||
| - | LaTeX je je systém pro sazbu profesionálních dokumentů. V složce | + | LaTeX is a document preparation system with typesetting program for formatting its output. There is a template for LaTeX in templates |
| - | + | When writing documentation in Ubuntu, following packages are used: | |
| - | V případě psaní dokumentace v Ubuntu | + | |
| sudo apt-get install texmaker texlive-lang-czechslovak | sudo apt-get install texmaker texlive-lang-czechslovak | ||
| - | | ||
| - | Po jejich istalaci je možné psát a editovat MLAB dokumenty napsané v [[http:// | ||
| - | === Dokuwiki | + | After their installation it is possible to write and edit MLAB documents written in [[http:// |
| + | |||
| + | === Dokuwiki | ||
| - | Poslední dobou je poměrně častým dokumentačním problémem převod dokumentace postupně vznikající na wiki do formální podoby dokumentu. Přímé přepisování není příliš efektivní. Proto je vhodnější využít programové nástroje jako například | + | Lately, a quite common documentation problem that occurs is a conversion of documentation that is being added on wiki to a formal type of documents. Direct rewriting is not very efficient. It is better to use software tools such as [[http:// |
| - | Webová verze Pandoc | + | A web version of Pandoc |
| sudo apt-get install pandoc | sudo apt-get install pandoc | ||
| | | ||
| - | Převod pak můžeme realizovat příkazem: | + | The conversion itself can be run with a following command: |
| pandoc -f html -s -t latex temp_doc.html | pandoc -f html -s -t latex temp_doc.html | ||
| | | ||
| - | Převedený dokument se nám pak vypíše do příkazové řádky, odkud jej pak stačí zkopírovat do Latexového editoru. | + | Converted document will be printed into the command line, from which it can be simply copied into a Latex editor. |
| + | [[http:// | ||
| - | [[http:// | + | ==== Image documentation |
| - | + | ||
| - | ==== Obrázková dokumentace | + | |
| === Dia === | === Dia === | ||
| - | Program dia slouží na tvorbu diagramů a blokových schémat. | + | A Did software can create diagrams and block diagrams. |
| === Fritzing === | === Fritzing === | ||
| - | Je snaha použít fritzing pro tvorbu dokumentace zapojení jednotlivých modulů v konstrukcích. Zatím však Fritzing | + | There are efforts to use Fritzing |
| === Prezi === | === Prezi === | ||
| - | Je nástroj na tvorbu veřejných prezentací projektů. | + | A tool for creating a public presentations of projects. |
| === ImageMagick | === ImageMagick | ||
| - | [[http:// | + | [[http:// |
| - | ===== Kontrola kvality | + | ===== Quality control |
| - | Pro zkontrolování celkové kvality dokumentace návrhů slouží | + | To control the overall quality of design documentation, |
| - | Tento přehled lze řadit podle různých kriterií. Například | + | The overview can be sorted according to different criteria, e.g.: |
| - | * https:// | + | * https:// |
| - | * https:// | + | * https:// |
| - | * https:// | + | * https:// |
| - | Každý modul má přiřazenou známku kvality. Aktuálně se hodnotí kvalita fotografie podle následujících kritérií | + | Every module has a quality mark assigned. Currently, a quality of photography is rated according to following criteria: |
| - | * 0 - žádná fotografie | + | * 0 - no photo |
| - | * 25 - render | + | * 25 - render |
| - | * 50 - nekvalitní fotografie např. z telefonu | + | * 50 - photo of low quality - e.g. taken on mobile phone |
| - | * 100 - profesionální fotografie z [[cs: | + | * 100 - a professional photo taken using a [[cs: |
| - | ===== Organizace vývoje | + | ===== Organisation of development |
| ==== Redmine ==== | ==== Redmine ==== | ||
| - | Je nástroj pro vytváření úkolů a dělbu práce na projektech. Jeho instance[[http:// | + | A tool for creating tasks and division of labour on projects. Its instance [[http:// |
| - | ====== | + | ====== |
| - | ===== Interaktivní výpočetní nástroje | + | ===== Interactive computational tools ===== |
| ==== Jupyter notebook ==== | ==== Jupyter notebook ==== | ||
| - | Jupyter | + | Jupyter |
| - | === Instalace | + | === Intallation |
| - | Postupujeme podle doporučení | + | Proceed according to recommendations in [[https:// |
| sudo pip install notebook | sudo pip install notebook | ||
| | | ||
| - | Spuštění se naopak provede | + | To run the software |
| jupyter notebook | jupyter notebook | ||
| - | Kde si pak zvolíme námi použitý | + | Where we chose the kernel. |
| | | ||
| ===== gnuradio ===== | ===== gnuradio ===== | ||
| - | [[http:// | + | [[http:// |
| - | ====== | + | ====== |
| ===== Nec2++ ===== | ===== Nec2++ ===== | ||
| - | [[http:// | + | [[http:// |
| ==== QAntenna ==== | ==== QAntenna ==== | ||
| Line 753: | Line 746: | ||
| [[http:// | [[http:// | ||
| - | === Kompilace | + | === Compilation |
| sudo apt-get install qtbase5-dev qttools5-dev | sudo apt-get install qtbase5-dev qttools5-dev | ||
en/tools.1550246127.txt.gz · Last modified: 2019/02/15 15:55 by fluktuacia
