Add new FPV documentation, fix images and add edit link

IhsenBouallegue · IhsenBouallegue · commit 0d093f315eb4 · 2024-01-15T20:45:48.000+01:00
diff --git a/astro.config.mjs b/astro.config.mjs
@@ -84,7 +84,6 @@ export default defineConfig({
         {
           label: "Development",
           items: [
-            // Placeholder for API Documentation
             {
               label: "Contribution Guidelines",
               link: "/development/contribution-guidelines/",
@@ -99,7 +98,6 @@ export default defineConfig({
           label: "Resources",
           items: [
             { label: "Frequently Asked Questions", link: "/resources/faq/" },
-            // Placeholder for Community Forum link
             { label: "Useful Links", link: "/resources/useful-links/" },
           ],
         },
diff --git a/src/assets/houston.webp b/src/assets/houston.webp
diff --git a/src/content/docs/development/contribution-guidelines.md b/src/content/docs/development/contribution-guidelines.md
@@ -1,11 +1,5 @@
 ---
 title: Example Guide
-description: A guide in my new Starlight docs site.
+description: Example
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
-
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/getting-started/configuration.md b/src/content/docs/getting-started/configuration.md
@@ -3,10 +3,3 @@ title: Basic Configuration
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
-
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
-  > Something somethinfg
diff --git a/src/content/docs/getting-started/introduction.md b/src/content/docs/getting-started/introduction.md
@@ -11,8 +11,8 @@ The essence of OpenIPC lies in its community-driven approach. By leveraging the
 
 ### Explore More About OpenIPC:
 
-- **Getting Started**: Embark on your OpenIPC journey and understand the basics of installation and configuration in our comprehensive [Getting Started Guide](/openipc-docs/getting-started/quick-start/).
-- **Diverse Use Cases**: Discover the versatility of OpenIPC across different scenarios in our detailed Use Cases section, which includes specialized guides for [FPV setups](/openipc-docs/use-cases/fpv/quick-start), [home automation](/openipc-docs/use-cases/home-automation/quick-start) configurations, and [video surveillance](/openipc-docs/use-cases/video-surveillance/quick-start) applications.
-- **Hardware Compatibility**: Learn about the supported devices and how to maximize their potential with OpenIPC in the [Hardware Compatibility]/openipc-docs(/hardware/supported-devices/) guide.
+- **Getting Started**: Embark on your OpenIPC journey and understand the basics of installation and configuration in our comprehensive [Getting Started Guide](/getting-started/quick-start/).
+- **Diverse Use Cases**: Discover the versatility of OpenIPC across different scenarios in our detailed Use Cases section, which includes specialized guides for [FPV setups](/use-cases/fpv/quick-start), [home automation](/use-cases/home-automation/quick-start) configurations, and [video surveillance](/use-cases/video-surveillance/quick-start) applications.
+- **Hardware Compatibility**: Learn about the supported devices and how to maximize their potential with OpenIPC in the [Hardware Compatibility](/hardware/supported-devices/) guide.
 
 Join the OpenIPC movement and be part of a community that's reshaping the world of camera technology. With OpenIPC, the possibilities are endless, and the future is open.
diff --git a/src/content/docs/getting-started/quick-start.md b/src/content/docs/getting-started/quick-start.md
@@ -3,9 +3,4 @@ title: Quick Start
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
 
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/hardware/flashing-firmware.md b/src/content/docs/hardware/flashing-firmware.md
@@ -3,9 +3,4 @@ title: Example Guide
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
 
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/hardware/supported-devices.md b/src/content/docs/hardware/supported-devices.md
@@ -3,9 +3,3 @@ title: Example Guide
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
-
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/hardware/troubleshooting.md b/src/content/docs/hardware/troubleshooting.md
@@ -3,9 +3,3 @@ title: Example Guide
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
-
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx
@@ -8,11 +8,11 @@ hero:
     file: ../../assets/logo/OpenIPC__OPENIPC_logo_vertical_white.svg
   actions:
     - text: Getting Started Guide
-      link: /openipc-docs/getting-started/quick-start/
+      link: /getting-started/quick-start/
       icon: right-arrow
       variant: primary
     - text: Explore Use Cases
-      link: /openipc-docs/use-cases/fpv/quick-start/
+      link: /use-cases/fpv/quick-start/
       icon: right-arrow
       variant: secondary
 ---
@@ -23,12 +23,12 @@ import { Card, CardGrid } from "@astrojs/starlight/components";
 
 <CardGrid stagger>
   <Card title="Explore Hardware Compatibility" icon="camera">
-    Check [the Hardware section](/openipc-docs/hardware/supported-devices/). for
+    Check [the Hardware section](/hardware/supported-devices/). for
     compatible devices and setup instructions.
   </Card>
   <Card title="Configure Your Camera" icon="gear">
     Navigate to [the Software
-    section](/openipc-docs/software/software-overview/). for software settings
+    section](/software/software-overview/). for software settings
     and customizations.
   </Card>
   <Card title="Join the Community" icon="group">
@@ -37,6 +37,6 @@ import { Card, CardGrid } from "@astrojs/starlight/components";
   </Card>
   <Card title="Contribute to OpenIPC" icon="heart">
     Find out how you can contribute to the project in [the OpenIPC Contribution
-    Guide](/openipc-docs/development/contribution-guidelines/).
+    Guide](/development/contribution-guidelines/).
   </Card>
 </CardGrid>
diff --git a/src/content/docs/reference/example.md b/src/content/docs/reference/example.md
@@ -3,9 +3,5 @@ title: Example Reference
 description: A reference page in my new Starlight docs site.
 ---
 
-Reference pages are ideal for outlining how things work in terse and clear terms.
-Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
 
-## Further reading
 
-- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework
diff --git a/src/content/docs/resources/faq.md b/src/content/docs/resources/faq.md
@@ -3,9 +3,4 @@ title: Example Guide
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
 
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/resources/useful-links.md b/src/content/docs/resources/useful-links.md
@@ -3,9 +3,3 @@ title: Example Guide
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
-
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/software/configuration-details.md b/src/content/docs/software/configuration-details.md
@@ -3,9 +3,3 @@ title: Example Guide
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
-
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/software/firmware-updates.md b/src/content/docs/software/firmware-updates.md
@@ -3,9 +3,4 @@ title: Example Guide
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
 
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/software/software-overview.md b/src/content/docs/software/software-overview.md
@@ -3,9 +3,3 @@ title: Example Guide
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
-
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/use-cases/fpv/cameras.md b/src/content/docs/use-cases/fpv/cameras.md
@@ -0,0 +1,4 @@
+---
+title: Compatible Cameras
+description: How to choose a camera for your OpenIPC FPV system
+---
diff --git a/src/content/docs/use-cases/fpv/nvr-groundstation.md b/src/content/docs/use-cases/fpv/nvr-groundstation.md
@@ -0,0 +1,33 @@
+---
+title: GroundStation on NVR
+description: How to make an NVR Board work with OpenIPC 
+---
+
+
+## Upgrade from original HI3536DV100 NVR board firmware to OpenIPC FPV firmware
+
+- Install [PUTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) and [TFTP](https://pjo2.github.io/tftpd64/) server
+- Download actual [image](https://openipc.org/cameras/vendors/hisilicon/socs/hi3536dv100/download_full_image?flash_size=16&flash_type=nor&fw_release=fpv) for NVR from OpenIPC site
+- Upload this image to your TFTP server
+- Turn off NVR power, connect USB adapter to your NVR UART, specify which COM port on your PC
+- Go to U-Boot with quick press Ctrl+C at power on
+- Execute a set of commands each line separately
+
+```
+## Сhanging the ip address of the NVR board and the ip address of your TFTP server
+setenv ipaddr 192.168.1.10; setenv serverip 192.168.1.254
+mw.b 0x82000000 0xff 0x1000000
+tftp 0x82000000 openipc-hi3536dv100-fpv-16mb.bin
+sf probe 0; sf lock 0;
+sf erase 0x0 0x1000000; sf write 0x82000000 0x0 0x1000000
+reset
+```
+
+## The result
+
+![](/src/assets/images/fpv-nvr-hi3536dv100-openipc-ready.webp)
+
+## Buy a device
+
+- [https://www.aliexpress.com/item/1005004023376532.html](https://www.aliexpress.com/item/1005004023376532.html)
+- [https://www.aliexpress.com/item/1005002358182146.html](https://www.aliexpress.com/item/1005002358182146.html)
diff --git a/src/content/docs/use-cases/fpv/quick-start.md b/src/content/docs/use-cases/fpv/quick-start.md
@@ -21,27 +21,26 @@ This guide is designed to provide a detailed walkthrough for setting up an FPV (
 ## Hardware Requirements
 
 - **Camera**: An SSC338 based board with a Sony IMX415 sensor was used for this guide.
-  ![Camera](/images/sbs-Camera.jpg)
-
+  ![Camera](/src/assets/images/sbs-Camera.jpg)
   - [Camera Purchase Link](https://www.aliexpress.com/item/1005004350557805.html)
 
 - **Groundstation**: An Nvr board is recommended for its popularity and cost-effectiveness.
-  ![Nvr Board](/images/sbs-Nvr.JPG)
+  ![Nvr Board](/src/assets/images/sbs-Nvr.JPG)
 
   - [Nvr Board Purchase Link](https://www.aliexpress.com/item/1005004023376532.html)
 
 - **WiFi Adapters**: RTL8812AU modules are a good choice.
-  ![Wifi board](/images/sbs-wifi.png)
+  ![Wifi board](/src/assets/images/sbs-wifi.png)
 
   - [WiFi Adapter Purchase Link](https://www.aliexpress.com/item/1005005638445796.html)
 
 - **BECs**: These are used for voltage regulation.
-  ![BECs](/images/sbs-BECS.jpg)
+  ![BECs](/src/assets/images/sbs-BECS.jpg)
 
   - [BECs Purchase Link](https://www.ebay.co.uk/itm/254153188189)
 
 - **FTDI Adapter**: Essential for the flashing process.
-  ![FTDI Adapter](/images/sbs-ftdi.jpg)
+  ![FTDI Adapter](/src/assets/images/sbs-ftdi.jpg)
 
   - [FTDI Adapter Purchase Link](https://www.ebay.co.uk/itm/203581591537?hash=item2f66688ff1)
 
@@ -52,7 +51,7 @@ This guide is designed to provide a detailed walkthrough for setting up an FPV (
 #### Step 1.1: Flashing the Camera
 
 - **Connection Points**: Identify the UART connection points on the camera board.
-  ![Camera Pin out](/images/sbs-Camera-Pinout.jpg)
+  ![Camera Pin out](/src/assets/images/sbs-Camera-Pinout.jpg)
 - **Using FTDI Adapter**: Connect the camera to the FTDI adapter for console access.
 - **Flashing Process**: Use console commands to flash the OpenIPC firmware onto the camera.
 
diff --git a/src/content/docs/use-cases/fpv/ubuntu-groundstation.md b/src/content/docs/use-cases/fpv/ubuntu-groundstation.md
@@ -0,0 +1,77 @@
+---
+title: GroundStation on Ubuntu 22.04
+description: A guide designed to provide a detailed walkthrough for setting up the groundstation on Ubuntu
+---
+
+Video version: - [OpenIPC - Prepare GroundStation: Ubuntu + QGroundControl](https://www.youtube.com/watch?v=JMtRAsOm0Dc)
+
+## Prepare
+```
+sudo apt update
+```
+```
+sudo apt install dkms git python3-all-dev net-tools virtualenv fakeroot debhelper python3-twisted
+sudo apt install dkms git python3-all-dev net-tools virtualenv fakeroot debhelper python3-twisted
+ libpcap-dev python3-pyroute2 python3-future python3-configparser python3-all libsodium-dev
+```
+
+## Libsodium
+```
+git clone https://github.com/jedisct1/libsodium --branch stable
+cd libsodium
+./configure
+make && make check
+sudo make install
+```
+
+## Wifi card driver
+```
+git clone -b v5.2.20 https://github.com/svpcom/rtl8812au.git
+cd rtl8812au/
+sudo ./dkms-install.sh
+```
+
+## WFB-NG
+```
+git clone -b stable https://github.com/svpcom/wfb-ng.git
+cd wfb-ng
+sudo ./scripts/install_gs.sh wlan0
+```
+
+## Channel configuration
+```
+vi /etc/wifibroadcast.cfg
+```
+
+## Start WFB CLI
+```
+wfb-cli gs
+```
+######GS IS READY FOR USE######
+
+## Start, stop, restart service
+```
+systemctl status wifibroadcast@gs
+systemctl stop wifibroadcast@gs
+systemctl start wifibroadcast@gs
+```
+
+## Qground control manual
+
+- https://docs.qgroundcontrol.com/master/en/getting_started/download_and_install.html
+
+## Get last logs from service
+```
+journalctl -xu wifibroadcast@gs -n 100
+```
+
+## Useful commands
+```
+nmcli
+ifconfig
+iwconfig
+
+```
+
+
+
diff --git a/src/content/docs/use-cases/home-automation/quick-start.md b/src/content/docs/use-cases/home-automation/quick-start.md
@@ -3,9 +3,4 @@ title: Quick Start
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
 
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/src/content/docs/use-cases/video-surveillance/quick-start.md b/src/content/docs/use-cases/video-surveillance/quick-start.md
@@ -3,9 +3,3 @@ title: Quick Start
 description: A guide in my new Starlight docs site.
 ---
 
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
-Writing a good guide requires thinking about what your users are trying to do.
-
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
