diff --git a/docs/assets/images/logo_dark.svg b/docs/assets/images/logo_dark.svg new file mode 100644 index 0000000..b1d1de8 --- /dev/null +++ b/docs/assets/images/logo_dark.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/assets/images/logo_white.svg b/docs/assets/images/logo_white.svg new file mode 100644 index 0000000..b787e33 --- /dev/null +++ b/docs/assets/images/logo_white.svg @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/docs/assets/styles/nami.css b/docs/assets/styles/nami.css new file mode 100644 index 0000000..5748d26 --- /dev/null +++ b/docs/assets/styles/nami.css @@ -0,0 +1,88 @@ + +/* Jasny tryb (default) */ +:root > * { + /* Primary: granat NaMi */ + --md-primary-fg-color: #081f3e; + --md-primary-fg-color--light: #264a7a; + --md-primary-fg-color--dark: #040f1f; + + + --md-accent-fg-color: #081f3e; + + + /* Tło bazowe */ + --md-default-bg-color: #f9fafb; + + + --md-default-fg-color: #0c0c0c; + --md-default-fg-color--light: #081f3e; + --md-default-fg-color--dark: #020617; + + /* Główny kolor tekstu w treści */ + --md-typeset-color: var(--md-default-fg-color); + } + + /* Ciemny tryb – zachowujemy branding, ale tekst jest biały */ + [data-md-color-scheme="slate"] { + --md-primary-fg-color: #081f3e; + --md-primary-fg-color--light: #4a658a; + --md-primary-fg-color--dark: #020814; + + --md-accent-fg-color: #ff8a00; + --md-accent-fg-color--light: #ffb74d; + --md-accent-fg-color--dark: #ef6c00; + + /* Ciemne tło */ + --md-default-bg-color: #020814; + + /* Tekst jasny/biały */ + --md-default-fg-color: #ffffff; + --md-default-fg-color--light: #e5e7eb; + --md-default-fg-color--dark: #9ca3af; + + --md-typeset-color: var(--md-default-fg-color); + } + + /* Logo – rozmiar */ + .md-header__button.md-logo img { + height: 32px; + } + + /* W trybie ciemnym delikatnie rozjaśniamy logo przez invert, + dopóki nie podmienisz na wersję jasną SVG */ + [data-md-color-scheme="slate"] .md-header__button.md-logo img { + filter: invert(1); + } + + +/* Minimalistyczne linki do social media */ +.md-typeset a.social-link { + font-weight: 500; + text-decoration: none; + border-bottom: 1px solid transparent; + padding-bottom: 0.05rem; + margin-right: 1.5rem; + white-space: nowrap; + } + + .md-typeset a.social-link:last-of-type { + margin-right: 0; + } + + .md-typeset a.social-link:hover { + border-bottom-color: var(--md-accent-fg-color); + } + + + +/* Social buttons */ + +.md-typeset a.social-button { + margin-right: 0.5rem; + margin-top: 0.5rem; +} + +.md-typeset a.social-button svg { + vertical-align: middle; + margin-right: 0.35rem; +} diff --git a/docs/index.md b/docs/index.md index d0311a3..e4dbe18 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,59 @@ -# Welcome to NaMi Documentation +# **Cześć! 👋** -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +Witamy w otwartej dokumentacji technicznej +**Koła Naukowego NaMi – Nano i Mikroelektronika** na Politechnice Wrocławskiej. -## Commands +To miejsce, w którym zbieramy procesy, poradniki, instrukcje i opisy projektów +związanych z nanoelektroniką, mikroelektroniką oraz szeroko pojętym hardware’em. +Dokumentacja powstaje z myślą o usprawnieniu naszej pracy, dzieleniu się wiedzą +i ułatwieniu wejścia w projekty wszystkim nowym osobom. -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. +--- -## Project layout +## 👀 **Jesteś gościem?** - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +Zajrzyj tutaj: + +[Strona główna NaMi](https://nami.pwr.edu.pl/){ .md-button .md-button--primary } + + +## 🔗 **Obserwuj nas w social media** + +Chcesz wiedzieć, nad czym aktualnie pracujemy? +Zobacz nasze najnowsze projekty, relacje z wydarzeń i ogłoszenia: + +[ :fontawesome-brands-instagram: Instagram](https://www.instagram.com/nami.pwr/){ .md-button .md-button--outlined .social-button } +[ :fontawesome-brands-github: GitHub](https://github.com/KN-NaMi){ .md-button .md-button--outlined .social-button } +[ :fontawesome-brands-linkedin: LinkedIn](https://www.linkedin.com/company/kn-nami/){ .md-button .md-button--outlined .social-button } + +--- + +## 👨‍🎓 **Dla nowych członków NaMi** + +Ta dokumentacja pomoże Ci: + +- zrozumieć, jak pracujemy w Kole, +- wejść w projekty hardware’owe i elektroniczne, +- poznać narzędzia, procesy, standardy i konwencje, +- szybciej rozpocząć własne inicjatywy. + +--- + +## 📚 **Co znajdziesz w dokumentacji?** + +- instrukcje montażu i uruchamiania projektów hardwareʼowych +- materiały edukacyjne i techniczne przewodniki +- dobre praktyki i procesy pracy w NaMi +- spis projektów (aktualnych i archiwalnych) +- wiedzę, którą chcemy utrwalać i rozwijać jako organizacja + +--- + +## 🤝 **Kontakt i więcej informacji** + +Chcesz wiedzieć o nas więcej? +Aktualności, wydarzenia i rekrutacje znajdziesz tutaj: + +[➡ Strona NaMi: nami.pwr.edu.pl](https://nami.pwr.edu.pl/){ .md-button .md-button--primary } + + **Miłego korzystania z dokumentacji! ⚙️** diff --git a/docs/projekty/choinka/Schemat_montaz.png b/docs/projekty/choinka/Schemat_montaz.png new file mode 100644 index 0000000..4c97abf Binary files /dev/null and b/docs/projekty/choinka/Schemat_montaz.png differ diff --git a/docs/projekty/choinka/choinka_gif.gif b/docs/projekty/choinka/choinka_gif.gif new file mode 100644 index 0000000..dd200b6 Binary files /dev/null and b/docs/projekty/choinka/choinka_gif.gif differ diff --git a/docs/projekty/choinka/dioda.png b/docs/projekty/choinka/dioda.png new file mode 100644 index 0000000..9c4e300 Binary files /dev/null and b/docs/projekty/choinka/dioda.png differ diff --git a/docs/projekty/choinka/elementy_plytka.jpg b/docs/projekty/choinka/elementy_plytka.jpg new file mode 100644 index 0000000..065123f Binary files /dev/null and b/docs/projekty/choinka/elementy_plytka.jpg differ diff --git a/docs/projekty/choinka/elementy_w_zestawie.png b/docs/projekty/choinka/elementy_w_zestawie.png new file mode 100644 index 0000000..f3ecad6 Binary files /dev/null and b/docs/projekty/choinka/elementy_w_zestawie.png differ diff --git a/docs/projekty/choinka/image-1.png b/docs/projekty/choinka/image-1.png new file mode 100644 index 0000000..f8e9ea7 Binary files /dev/null and b/docs/projekty/choinka/image-1.png differ diff --git a/docs/projekty/choinka/image-2.png b/docs/projekty/choinka/image-2.png new file mode 100644 index 0000000..d389908 Binary files /dev/null and b/docs/projekty/choinka/image-2.png differ diff --git a/docs/projekty/choinka/image.png b/docs/projekty/choinka/image.png new file mode 100644 index 0000000..95d2229 Binary files /dev/null and b/docs/projekty/choinka/image.png differ diff --git a/docs/projekty/choinka/instrukcja.md b/docs/projekty/choinka/instrukcja.md new file mode 100644 index 0000000..7e50b43 --- /dev/null +++ b/docs/projekty/choinka/instrukcja.md @@ -0,0 +1,240 @@ +# **Choinka Świąteczna NaMi 🎄 - Instrukcja Montażu** + + +**Cześć! 👋 Miło Cię tu widzieć!** + +**Zapraszamy do odwiedzenia naszych mediów społecznościowych oraz strony internetowej po więcej projektów!** + +![Choinka gif](choinka_gif.gif) + +[ :fontawesome-brands-instagram: Instagram](https://www.instagram.com/nami.pwr/){ .md-button .md-button--outlined .social-button } +[ :fontawesome-brands-github: GitHub](https://github.com/KN-NaMi){ .md-button .md-button--outlined .social-button } +[ :fontawesome-brands-linkedin: LinkedIn](https://www.linkedin.com/company/kn-nami/){ .md-button .md-button--outlined .social-button } + + +Twoja obecność na tej stronie oznacza, że jesteś szczęśliwym posiadaczem naszego **zestawu DIY**. Poniższa instrukcja przeprowadzi Cię przez proces montażu naszej świątecznej płytki PCB. +Została przygotowana tak, aby była zrozumiała zarówno **dla początkujących, jak i osób, które mają już doświadczenie w montażu elektroniki**. + +**⏱️ Całość powinna zająć około 15-20 minut**. + + +**💡 Poziom trudności: 🟡🟡⚪⚪** + + +--- + +## 🧰 **Czego potrzebujesz do montażu?** + +- Lutownica +- Stop lutowniczy +- Topnik +- Obcinaczki do wyprowadzeń +- Opcjonalnie: pęseta, podkładka silikonowa do lutowania + +!!! info "Zasilanie" + Choinka zasilana jest **dwiema bateriami CR2032** - nie są dołączone do zestawu +--- + +## 📦 **Co znajduje się w zestawie?** + +- Nasza autorska płytka PCB w kształcie choinki +- Zestaw diod LED: + - 4x Czerwone + - 4x Żółte + - 4x Niebieskie +- 3x Tranzystor +- Zestaw rezystorów + - 2x Rezystor 470 Ω + - 1x Rezystor 10 kΩ + - 3x Rezystor 100 kΩ +- 3x Kondensator 10 μF +- Zmontowana podstawa zasilająca + +--- + +## 🛠️ **Montaż krok po kroku** + +### Jak montować układ elektroniczny? + + +Lutowanie to podstawowa technika łączenia elementów elektronicznych z płytką PCB. +Polega na stopieniu cyny, która dzięki zawartemu w niej topnikowi przylega do pola +lutowniczego oraz do wyprowadzenia elementu. Proces ten nazywa się **zwilżaniem** – +stopiona cyna „oblewa” metalową powierzchnię i tworzy przewodzące połączenie. + + +![Jak lutować?](image-2.png) +Grafika ze strony: + + +!!! warning "Bezpieczeństwo" + Podczas pracy końcówka lutownicy osiąga temperaturę 250–400°C. + Pracuj ostrożnie i odkładaj lutownicę na dedykowaną podstawkę. + + +Dobrze wykonane połączenie lutowane powinno: + +- **być gładkie i błyszczące**, +- **być lekko wklęsłe** (menisk wklęsły), +- obejmować zarówno pole lutownicze jak i wyprowadzenie, +- nie mieć nadmiaru cyny (tzw. kulki, mostki lub grudki). + + +Jeśli cyna nie chce „trzymać się” powierzchni – najczęściej winna jest brudna powierzchnia, tlenki na powierzchni +lub zbyt mała temperatura. W takich sytuacjach pomaga **topnik (flux)**, który usuwa +zanieczyszczenia, poprawiając jakość zwilżania. + +!!! tip "W jakiej kolejności montować elementy?" + Najlepiej zaczynać od **najmniejszych i najniższych elementów** + (rezystory → tranzystory → kondensatory → diody LED). + Dzięki temu lutowanie jest wygodne i elementy są stabilne. + + +### Sposób montażu elementów elektronicznych: + +![Rozmieszczenie elementów na płytce drukowanej](montaz_ele_elektr.png) + +!!! danger "Polaryzacja!" + Niektóre elementy mają **konkretną orientację montażową**, której nie można + odwrócić. **Błędne podłączenie elementów wymagających odpowiedniej polaryzacji, może skutkować uszkodzeniem elementu!** + + + +!!! step "Krok 1 – Przygotowanie elementów" + **Rozłóż wszystkie elementy na płaskim podłożu, porównaj z listą z zestawu.** + + ![Komponenty w zestawie](elementy_w_zestawie.png) + + **Zdjęcie potrzebnych elementów i płytki PCB** + ![Zdjęcie potrzebnych elemetów i płytki](elementy_plytka.jpg) + + + **Zapoznaj się z rozmieszczeniem elementów na płytce drukowanej:** + + ![Rozmieszczenie elementów na płytce drukowanej](Schemat_montaz.png) + + + +!!! step "Krok 2 – Rezystory" + Włóż odpowiednie rezystory w pola R1–R6, przylutuj zgodnie z powyższą instrukcją, obetnij końcówki. Polaryzacja w przypadku rezystorów nie jest istotna. + + !!! tip + Rezystory warto montować jako pierwsze — są najmniejsze gabarytowo i można łatwo je ustabilizować. + + + ![Montaż rezystorów](rezystor.png) + + +!!! step "Krok 3 – Tranzystory" + Zamontuj tranzystory w Q1–Q3 w analogiczny sposób. Obetnij końcówki. + + !!! danger "Zamontuj tranzystory odwrotnie względem obrysu na PCB " + Pomimo największych starań, czasmi w procesie projektowania elektroniki dochodzi do pomyłek - tak stało się w naszym przypadku i obrysy tranzystorów zostały naniesione odwrotnie na PCB! **Zamontuj tranzystory odwrotnie względem obrysu na PCB!** + + ![Montaż tranzystorów](tranzystor.png) + + +!!! step "Krok 4 – Kondensatory" + Umieść i przylutuj kondensatory w C1–C5, zwracając uwagę na polaryzację. Obetnij końcówki. + + !!! tip + Kondensatory elektrolityczne zawsze mają zaznaczoną na obudowie polaryzację (minus po stronie jednej z nóżek). + + ![Montaż kondesatorów](kondensator.png) + + +!!! step "Krok 5 – Diody LED" + Włóż diody według kolorów, pamiętając o dłuższej nóżce jako anodzie (+). Umieszczaj diody zgodnie z opisem kolorów na PCB. + + ![Montaż kondesatorów](dioda.png) + + + + + +!!! step "Krok 6 – Kontrola i uruchomienie" + Sprawdź jakość połączeń lutowanych, ponownie zweryfikuj polaryzację wszystkich elementów. Gdy wszystko jest połączone poprawnie, włóż płytkę w podstawę i sprawdź jej działanie. + + ![Choinka gif](choinka_gif.gif) + + +## 🔍 **Jak to działa? (sekcja dla ciekawych)** + +### Schemat elektroniczny + +![Schemat elektroniczny](schemat_elektroniczny.jpg) + +### Jak działa nasz multiwibrator astabilny? + +Zastosowany w układzie **trójfazowy multiwibrator astabilny** jest klasycznym +generatorem przebiegów prostokątnych opartym na tranzystorach bipolarnych NPN +(2N2222) oraz sprzężeniu pojemnościowym pomiędzy kolejnymi stopniami. +Każdy tranzystor (Q1, Q2, Q3) steruje oddzielną gałęzią diod LED poprzez +rezystory kolektorowe R2, R4 i R6. + +#### Praca tranzystorów i konfiguracja stopni + +Każdy stopień pracuje w konfiguracji **wspólnego emitera**, gdzie: + +- **emiter** jest połączony bezpośrednio z masą, +- **kolektor** poprzez rezystor obciążenia (4,7 kΩ–10 kΩ) zasila odpowiednie diody LED, +- **baza** sterowana jest poprzez rezystor polaryzujący 100 kΩ oraz impulsowo + przez kondensator sprzęgający pochodzący z poprzedniego stopnia. + +W stanie przewodzenia (nasycenia) tranzystor wymusza niski poziom napięcia na kolektorze, +co umożliwia przepływ prądu przez daną grupę LED. Po wyłączeniu tranzystora +napięcie kolektora wzrasta do poziomu zasilania, wygaszając diody. + +#### Sprzężenie między stopniami i generacja oscylacji + +Kondensatory **C1, C3 i C5 (10 µF)** pełnią funkcję sprzęgającą — łączą kolektor jednego +stopnia z bazą stopnia następnego. Tworzą razem z rezystorami polaryzującymi (100 kΩ) +układy RC odpowiedzialne za: + +- **opóźnienie czasowe przełączenia** (stała czasowa RC), +- **generację impulsu sterującego bazą kolejnego tranzystora**, +- **samowzbudną oscylację układu** bez konieczności stosowania zewnętrznego sygnału zegarowego. + +Mechanizm pracy jednego cyklu można opisać następująco: + +1. Załóżmy, że Q1 jest w stanie nasycenia — jego kolektor znajduje się blisko potencjału GND. +2. Kondensator C3 ładuje się zgodnie z równaniem dla obwodu RC, a baza Q2 utrzymywana jest poniżej progu przewodzenia. +3. W momencie rozładowania C3 napięcie bazy Q2 zaczyna rosnąć, aż tranzystor Q2 osiągnie próg przewodzenia i wejdzie w stan nasycenia. +4. Szybki wzrost napięcia na kolektorze Q1 (z LOW do HIGH) jest przeniesiony przez C3 jako impuls dodatni na bazę Q2, przyspieszając jego przełączenie. +5. Analogiczny proces zachodzi pomiędzy parami Q2→Q3 oraz Q3→Q1 poprzez kondensatory C5 i C1. + +W efekcie układ przechodzi **cyklicznie przez trzy stabilne stany chwilowe**, z których każdy odpowiada za zaświecenie jednej gałęzi LED. + +#### Kolejność przełączeń + +Drobne różnice parametrów tranzystorów, rezystorów i kondensatorów powodują, że po +włączeniu zasilania jeden ze stopni jako pierwszy osiąga warunki przewodzenia. +Od tego momentu mechanizm sprzężenia pojemnościowego wymusza następującą sekwencję, +czyli kolejno zapalają się: + +- diody czerwone, +- następnie żółte, +- na końcu niebieskie, + +a cały cykl powtarza się. + +## **❓ Rozwiązywanie problemów** + +**LED-y nie świecą** +– sprawdź poprawność polaryzacji diod +– sprawdź styki podstawy zasilającej + +**Tylko jedna strona miga** +– możliwy błąd przy tranzystorze lub kondensatorze w danym ramieniu multiwibratora + +**Choinka w ogóle się nie uruchamia** +– upewnij się, że baterie są nowe i poprawnie włożone + +--- + +## **🙌 Podziękowania** + +Projekt został zrealizowany przez członków **Koła Naukowego NaMi** +przy wsparciu **Wydziału Elektroniki, Fotoniki i Mikrosystemów (W12N)**. + +Miłego montowania! 🔧🎄 diff --git a/docs/projekty/choinka/kondensator.png b/docs/projekty/choinka/kondensator.png new file mode 100644 index 0000000..8c140a6 Binary files /dev/null and b/docs/projekty/choinka/kondensator.png differ diff --git a/docs/projekty/choinka/montaz_ele_elektr.png b/docs/projekty/choinka/montaz_ele_elektr.png new file mode 100644 index 0000000..5e846d7 Binary files /dev/null and b/docs/projekty/choinka/montaz_ele_elektr.png differ diff --git a/docs/projekty/choinka/rezystor.png b/docs/projekty/choinka/rezystor.png new file mode 100644 index 0000000..0f68a53 Binary files /dev/null and b/docs/projekty/choinka/rezystor.png differ diff --git a/docs/projekty/choinka/schemat_elektroniczny.jpg b/docs/projekty/choinka/schemat_elektroniczny.jpg new file mode 100644 index 0000000..e7999bb Binary files /dev/null and b/docs/projekty/choinka/schemat_elektroniczny.jpg differ diff --git a/docs/projekty/choinka/tranzystor.png b/docs/projekty/choinka/tranzystor.png new file mode 100644 index 0000000..ae31f96 Binary files /dev/null and b/docs/projekty/choinka/tranzystor.png differ diff --git a/mkdocs.yml b/mkdocs.yml index 04381ed..09b7673 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,3 +1,71 @@ -site_name: My Docs +site_name: KN NaMi +site_url: https://docs.nami.pwr.edu.pl + theme: - name: material \ No newline at end of file + name: material + language: pl + logo: assets/images/logo_white.svg + favicon: assets/images/logo_white.svg + palette: + # Jasny tryb + #- media: "(prefers-color-scheme: light)" + scheme: default + primary: custom # używamy własnych kolorów z CSS + accent: custom + #toggle: + #icon: material/weather-night + #name: Przełącz na tryb ciemny + + # Ciemny tryb + #- media: "(prefers-color-scheme: light)" + # scheme: slate + # primary: custom + # accent: custom + # toggle: + # icon: material/weather-sunny + # name: Przełącz na tryb jasny + + features: + - navigation.top + - navigation.footer + - navigation.indexes + - toc.integrate + - toc.follow + - search.suggest + - search.highlight + - content.code.copy + +nav: + - Strona główna: index.md + - Projekty: + - Choinka PCB: projekty/choinka/instrukcja.md + +plugins: + - search + +markdown_extensions: + - admonition + - footnotes + - toc: + permalink: true + - pymdownx.superfences + - pymdownx.details + - pymdownx.highlight + - pymdownx.emoji + - pymdownx.tabbed: + alternate_style: true + - attr_list + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/KN-NaMi + - icon: fontawesome/brands/instagram + link: https://www.instagram.com/nami.pwr/ + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/company/kn-nami/ +extra_css: + - assets/styles/nami.css