Add separate Docs section, move motor and sensors docs, add wifi and …

…socket docs
RoboticsBrno · Jul 10, 2024 · a6fe024 · a6fe024
1 parent 0131360
commit a6fe024
Show file tree

Hide file tree

Showing 19 changed files with 101 additions and 4 deletions.
diff --git a/docs/robot/docs/assets/add-wifi-network.png b/docs/robot/docs/assets/add-wifi-network.png
diff --git a/docs/robot/docs/assets/config-wifi-btn.png b/docs/robot/docs/assets/config-wifi-btn.png
diff --git a/docs/robot/docs/assets/disable-wifi.png b/docs/robot/docs/assets/disable-wifi.png
diff --git a/docs/robot/docs/assets/display-wifi-config.png b/docs/robot/docs/assets/display-wifi-config.png
diff --git a/docs/robot/docs/assets/input-ip.png b/docs/robot/docs/assets/input-ip.png
diff --git a/docs/robot/docs/assets/input-password.png b/docs/robot/docs/assets/input-password.png
diff --git a/docs/robot/docs/assets/input-ssid.png b/docs/robot/docs/assets/input-ssid.png
diff --git a/docs/robot/docs/assets/ip-address.png b/docs/robot/docs/assets/ip-address.png
diff --git a/docs/robot/docs/assets/open-port.png b/docs/robot/docs/assets/open-port.png
diff --git a/docs/robot/docs/assets/select-socket.png b/docs/robot/docs/assets/select-socket.png
diff --git a/docs/robot/docs/assets/wifi-added.png b/docs/robot/docs/assets/wifi-added.png
diff --git a/docs/robot/docs/assets/wifi-ap-mode.png b/docs/robot/docs/assets/wifi-ap-mode.png
diff --git a/docs/robot/docs/assets/wifi-station-mode.png b/docs/robot/docs/assets/wifi-station-mode.png
diff --git a/docs/robot/docs/index.md b/docs/robot/docs/index.md
@@ -0,0 +1,3 @@
+# Docs - Robůtek
+
+V této sekci najdete dokumentaci k programování a ovládáni Robůtka a jeho částí.
diff --git a/docs/robot/motors/index.md → docs/robot/docs/motors.md b/docs/robot/motors/index.md → docs/robot/docs/motors.md
diff --git a/docs/robot/sens/index.md → docs/robot/docs/sens.md b/docs/robot/sens/index.md → docs/robot/docs/sens.md
diff --git a/docs/robot/docs/socket.md b/docs/robot/docs/socket.md
@@ -0,0 +1,18 @@
+# Docs - Bezdrátové programování
+
+Robůtka můžeme monitoroovat a programovat bezdrátově.
+
+## Připojení k Robůtkovi
+
+1. Klikneme na tlačítko vybírání portu (někdy zůstane předvyplněný z minula)<br>
+![](assets/open-port.png) <br>
+
+2. Vybereme `Socket` (úplně dole)<br>
+![](assets/select-socket.png) <br>
+
+3. Zadáme IP adresu ([získání IP adresy](../wifi/#zjištení-ip-adresy)) <br>
+![](assets/input-ip.png) <br>
+
+4. Poté můžeme bezdrátově programovat jako kdyby byl Robůtek připojený kabelem.
+
+    !!! warning "Někdy bůže nastat chyba. Pokud nastane, stačí zmáčknout `Ctrl+C` a zkusit to znovu."
diff --git a/docs/robot/docs/wifi.md b/docs/robot/docs/wifi.md
@@ -0,0 +1,74 @@
+# Docs - WiFi
+
+K Robůtkovi se můžeme připojit i bezdrátově pomocí WiFi. K tomu ale potřebujeme aby se Robůtek buď [připojil k existující síti](#pripojeni-k-existujici-siti) nebo [vytvořil novou síť](#vytvoreni-nove-site).
+
+## Připojení k existující síti
+
+1. Klikneme na tlačítko `Config WiFi` na dolní liště. Zde budeme dělat všechno nastavení WiFi. <br>
+![](assets/config-wifi-btn.png) <br>
+
+2. Vybereme možnost `Add WiFi network`.
+![](assets/add-wifi-network.png) <br>
+
+3. A zadáme název sítě (SSID)
+![](assets/input-ssid.png) <br>
+
+    !!! note "Co dělat když název sítě má v sobě mezeru"
+        - Pokud název sítě má v sobě mezeru, musíme ho vložit do uvozovek, například `"Hele mezera"`.
+
+4. Dole v terminále se nám zobrazí místo na zadání hesla.
+![](assets/input-password.png) <br>
+
+5. Po zadání hesla be se nám zobrazí správa že vše proběhlo v pořádku.
+![](assets/wifi-added.png) <br>
+
+6. Poté musíme znovu kliknout na tlačítko `Config WiFi` a vybrat možnost `Set WiFI to Station mode (connect to WiFi)`.
+![](assets/wifi-station-mode.png) <br>
+
+## Vytvoření nové sítě
+
+1. Klikneme na tlačítko `Config WiFi` na dolní liště. Zde budeme dělat všechno nastavení WiFi. <br>
+![](assets/config-wifi-btn.png) <br>
+
+2. Vybereme možnost `Set WiFi to AP mode (create a hotspot)`.
+![](assets/add-wifi-network.png) <br>
+
+3. A zadáme název sítě (SSID)
+![](assets/input-ssid.png) <br>
+
+    !!! note "Co dělat když název sítě má v sobě mezeru"
+        - Pokud název sítě má v sobě mezeru, musíme ho vložit do uvozovek, například `"Hele mezera"`.
+
+4. Dole v terminále se nám zobrazí místo na zadání hesla.
+![](assets/input-password.png) <br>
+
+## Vypnutí WiFi
+
+1. Klikneme na tlačítko `Config WiFi` na dolní liště. <br>
+![](assets/config-wifi-btn.png) <br>
+
+2. Vybereme možnost `Disable WiFi`.
+![](assets/disable-wifi.png) <br>
+
+## Zjištení IP adresy
+
+1. Klikneme na tlačítko `Config WiFi` na dolní liště. <br>
+![](assets/config-wifi-btn.png) <br>
+
+2.  Vybereme možnost `Display current WiFI config`.<br>
+![](assets/display-wifi-config.png) <br>
+
+3. A v terminále se zobrazí IP adresa (Nějakou dobu trvá než se Robůtek připojí k sítí, takže je možné že to bude chvíly trvat) <br>
+![](assets/ip-address.png) <br>
+
+Nebo v kódu můžete získat IP adresu pomocí funkce `getIP()`:
+
+```ts
+import * as wifi from "wifi";
+
+console.log(wifi.)
+```
+
+## Připojení k síti
+
+1.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -148,11 +148,13 @@ nav:
       - robot/project_sumo/index.md
       - robot/project_line/index.md
       - robot/project_maze/index.md
-      - robot/motors/index.md
-      - robot/sens/index.md
-      - robot/sim/index.md
-      - robot/vl53/index.md
   - Příslušenství robota:
       - robotAccessories/ledStrip.md
       - robotAccessories/button.md
       - robotAccessories/tof.md
+  - Dokumentace:
+      - robot/docs/index.md
+      - robot/docs/wifi.md
+      - robot/docs/socket.md
+      - robot/docs/motors.md
+      - robot/docs/sens.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Docs - Robůtek

		V této sekci najdete dokumentaci k programování a ovládáni Robůtka a jeho částí.