Merge branch 'main' of https://github.com/Maxwell456/docs

Author: Maxwell456

astro.config.mjs

@@ -28,7 +28,12 @@ export default defineConfig({
 			sidebar: [
 				{
 					label: "Getting Started",
+					collapsed: true,
 					items: [
+					    {
+					        label: "Homepage",
+					        link: "/getting-started/homepage",
+					    },
 						{
 							label: "About the Project",
 							link: "/getting-started/introduction/",
@@ -46,23 +51,28 @@ export default defineConfig({
 				},
 				{
 					label: "Use Cases",
+					collapsed: true,
 					items: [
 						{
 							label: "FPV (First Person View)",
+							collapsed: true,
 							autogenerate: {
+							collapsed: true,
 								directory: "/use-cases/fpv",
 							},
 							badge: { text: "WIP", variant: "caution" },
 						},
 						{
 							label: "Home Automation",
+							collapsed: true,
 							autogenerate: {
 								directory: "/use-cases/home-automation",
 							},
 							badge: { text: "WIP", variant: "caution" },
 						},
 						{
 							label: "Video Surveillance",
+							collapsed: true,
 							autogenerate: {
 								directory: "/use-cases/video-surveillance",
 							},
@@ -72,20 +82,24 @@ export default defineConfig({
 				},
 				{
 					label: "Hardware",
+					collapsed: true,
 					badge: { text: "WIP", variant: "caution" },
 					autogenerate: {
+					collapsed: true,
 						directory: "/hardware",
 					},
 				},
 				{
 					label: "Software",
+					collapsed: true,
 					badge: { text: "WIP", variant: "caution" },
 					autogenerate: {
 						directory: "/software",
 					},
 				},
 				{
 					label: "Development",
+					collapsed: true,
 					items: [
 						{
 							label: "Contribution Guidelines",
@@ -105,6 +119,7 @@ export default defineConfig({
 				},
 				{
 					label: "Resources",
+					collapsed: true,
 					items: [
 						{
 							label: "Frequently Asked Questions",
@@ -120,7 +135,9 @@ export default defineConfig({
 				},
 				{
 					label: "Reference",
+					collapsed: true,
 					autogenerate: {
+					collapsed: true,
 						directory: "reference",
 					},
 					badge: { text: "WIP", variant: "caution" },
@@ -132,5 +149,8 @@ export default defineConfig({
 			],
 		}),
 		tailwind({ applyBaseStyles: false }),
-	]
+	],
+	redirects: {
+    "/": "/getting-started/homepage",
+  }
 });

src/assets/images/bl-m8731bu3-bottom.png

@@ -0,0 +1,7 @@
+---
+title: "Known OpenIPC applications"
+description: "Known OpenIPC applications list"
+---
+import ThemeImage from '/src/components/ThemeImage.astro'
+
+FPV, CCTV, Home Automation.

src/assets/images/bl-m8731bu3-pinout-light.png

@@ -0,0 +1,29 @@
+---
+title: Welcome to OpenIPC Documentation
+description: Start your journey with OpenIPC for advanced camera firmware solutions.
+
+---
+
+
+import { Card, CardGrid } from "@astrojs/starlight/components";
+
+## Next Steps in Your OpenIPC Adventure
+
+<CardGrid stagger>
+  <Card title="Explore Hardware Compatibility" icon="camera">
+    Check [the Hardware section](/hardware/hardware-page/). for compatible
+    devices and setup instructions.
+  </Card>
+  <Card title="Configure Your Camera" icon="gear">
+    Navigate to [the Software section](/software/software-page/). for
+    software settings and customizations.
+  </Card>
+  <Card title="Join the Community" icon="group">
+    Connect with other users in the OpenIPC community for support and
+    collaboration.
+  </Card>
+  <Card title="Contribute to OpenIPC" icon="heart">
+    Find out how you can contribute to the project in [the OpenIPC Contribution
+    Guide](/development/contribution-guidelines/).
+  </Card>
+</CardGrid>

src/assets/images/bl-m8731bu3-top.png

@@ -13,21 +13,48 @@ Check our Roadmap, highlighting achievements and upcoming plans on our journey.
       {
         title: "Milestone 2",
         description: "",
-        date: "date to be announced",
+        date: "to be announced",
         goals: [
           "Open IPC Goggles v1 release",
         ]
-      },{
-        title: "Milestone 1.5",
+      },
+      {
+        title: "Milestone 1.7",
         description: "",
-        date: "date to be announced",
+        date: "to be announced",
+        reached: false,
+        goals: [
+          "Evolution AIO unit release",
+        ]
+      },
+      {
+        title: "Milestone 1.6",
+        description: "OpenIPC Bonnet",
+        date: "2025-04",
+        reached: true,
         goals: [
-          "Thinker unit release",
+          "2× 8812AU modules, in-house design",
+          "USB-to-USB connector",
+          "2× additional USB ports available alongside the two modules",
+          "IMU and Voltage sensor",
+          "5-way position switch and a push button",
+        ]
+      },
+      {
+        title: "Milestone 1.5",
+        description: "Thinker unit release",
+        date: "2025-01",
+        reached: true,
+        goals: [
+          "SoC SSC338Q",
+          "Size 25x25mm",
+          "Weight 8.8 gr",
+          "Power supply 2-6S",
         ]
       },
       {
         title: "Milestone 1.2",
-        description: "This is the second milestone.",
+        description: "",
         date: "2024-12",
         goals: [
           "Adaptive Link",
@@ -38,10 +65,10 @@ Check our Roadmap, highlighting achievements and upcoming plans on our journey.
         description: "",
         date: "2024-11",
         reached: false,
-         goals: [
+        goals: [
           "Binding by QR code",
-          "Configuration of camera and WiFi boadcast through on screen display menu",
-          ]
+          "Configuration of camera and WiFi broadcast through on screen display menu",
+        ]
       },
       {
         title: "Milestone 1",
@@ -50,15 +77,14 @@ Check our Roadmap, highlighting achievements and upcoming plans on our journey.
         reached: true,
         goals: [
           "Added Majestic sighup support for Ingenic devices",
-          "Added h265 support for rtmp",
-          "Added rtmp reconnect option",
+          "Added h265 support for RTMP",
+          "Added RTMP reconnect option",
           "Added support for Sigmastar register info scan",
-          "Fixed several rtmp authentication problems",
+          "Fixed several RTMP authentication problems",
           "Fixed a problem with rotation on a few Sigmastar sensor drivers",
-          "Removed Ingenic software based day/night detection",
+          "Removed Ingenic software-based day/night detection",
         ]
       },
     ]}
   />
-
 </div>

src/assets/images/bl-r8812af1-bottom-dark.png

@@ -13,41 +13,41 @@ But you don't need to worry. This guide will help you easily recover or unbrick
 
 3. Install the driver first.
 
-   ![RuncamVRX2](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/RuncamVRX2.jpg)
+   ![RuncamVRX2](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-vrx-badflash2.jpg)
 
 4. Open config file in RKDevtool_Release_v2.93 folder
 
 5. Change Selected=1 to Selected=2. The app is now English.
 
-   ![RuncamVRX3](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/RuncamVRX3.jpg)
+   ![RuncamVRX3](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-vrx-badflash3.jpg)
 
 6. There might be some random things here. Right click in the window and click “Clear items”.
 
-   ![RuncamVRX4](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/RuncamVRX4.jpg)
+   ![RuncamVRX4](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-vrx-badflash4.jpg)
 
 7. Make sure the name is “loader”. Then click here:
 
-   ![RuncamVRX5](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/RuncamVRX5.jpg)
+   ![RuncamVRX5](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-vrx-badflash5.jpg)
 
 8. You need this file. Download here: https://dl.radxa.com/rock3/images/loader/rock-3a/
 
-    ![RuncamVRX6](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/RuncamVRX6.jpg)
+    ![RuncamVRX6](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-vrx-badflash6.jpg)
 
 9. Right click add item.
 
-     ![RuncamVRX7](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/RuncamVRX7.jpg)
+     ![RuncamVRX7](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-vrx-badflash7.jpg)
 
 10. Find your image. Double click storage and select EMMC. Make sure both items are ticked and write by address is ticked.
 
-    ![RuncamVRX8](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/RuncamVRX8.jpg)
+    ![RuncamVRX8](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-vrx-badflash8.jpg)
 
 11. Put your VRX in bootloader mode. On the bottom there is a small button you can press with a pin next to the HDMI port. Hold it in, power up the VRX, wait 2 seconds and release. The VRX should be in bootloader mode and you can connect it to PC via the Type C port. It should say this:
 
-    ![RuncamVRX9](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/RuncamVRX9.jpg)
+    ![RuncamVRX9](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-vrx-badflash9.jpg)
 
 12. Press run and wait.
 
-    ![RuncamVRX10](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/RuncamVRX10.jpg)
+    ![RuncamVRX10](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-vrx-badflash10.jpg)
 
 14. After a while it should say “Download complete”. Then you can power everything down and then restart the VRX.
 

src/assets/images/bl-r8812af1-bottom-light.png

@@ -0,0 +1,7 @@
+---
+title: "Hardware section"
+description: "Software section starter page"
+---
+import ThemeImage from '/src/components/ThemeImage.astro'
+
+In this section you can find documentation about hardware side of OpenIPC.

src/assets/images/bl-r8812af1-top.png

@@ -0,0 +1,7 @@
+---
+title: "Software section"
+description: "Software section starter page"
+---
+import ThemeImage from '/src/components/ThemeImage.astro'
+
+In this section you can find documentation about software side of OpenIPC.

src/assets/images/rtl8812au-wifilink-g-adapter.png

@@ -0,0 +1,40 @@
+---
+title: "RTL873xBU"
+description: "RTL873xBU documentation page for OpenIPC wiki"
+---
+import ThemeImage from '/src/components/ThemeImage.astro'
+
+RTL8731BU and RTL8733BU are very small WiFi chips, so RTL873xBU-based net cards are really small, because of that they are extremely popular for tinywhoops. But RTL873xBU-based net cards **AREN'T SUITABLE FOR LONG RANGE AND RX USE**. 5MHz, 10MHz, 20MHz, 40MHz modes are supported.
+:::caution
+40MHz mode supported by driver, **your** net card might not support this mode. Please contact seller before buying net card. Please add your net card to list of RTL873xBU-based NICs below.
+:::
+:::caution
+If you don't receive image after switching on 40MHz mode, please read this [article](/use-cases/fpv/unbrick-eu-bu/) to fix your issue.
+:::
+
+
+## BL-M8731BU3
+
+### Layout
+Top
+![image](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/bl-m8731bu3-top.png)
+Bottom
+![image](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/bl-m8731bu3-bottom.png)
+
+### Pinout
+![image](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/bl-m8731bu3-pinout-light.png)
+| Pin number  | Function        |
+|:-----------:|:---------------:|
+| 1           | GND             |
+| 2           | NC              |
+| 3           | VDD 3.3V        |
+| 4           | DM-             |
+| 5           | DP+             |
+| 6           | GND             |
+### Specifications
+| Host interface      | USB 2.0  |
+|:-------------------:|:--------:|
+| Power Supply        | DC 3.3V                        |
+| Antenna connection  | IPEX                           |
+| Power output        | ≤17dBm(≤50mW)@5G   ≤21dBm(≤125mW)@2.4G          |
+| Supported modes     | 5MHz, 10MHz, 20MHz, 40MHz                    |

src/assets/images/RuncamVRX1.jpg renamed to src/assets/images/runcam-vrx-badflash1.jpg

@@ -0,0 +1,47 @@
+---
+title: "RTL8812AU"
+description: "RTL8812AU documentation page for OpenIPC wiki"
+---
+import ThemeImage from '/src/components/ThemeImage.astro'
+
+The RTL8812AU is an old, expensive, but proven WiFi chip that can be found in a lot of network cards. AU based NICs have exceptional community support so that 5Mhz, 10MHz, 20MHz and 40MHz can receive and transmit! So AU based equipment can achieve exceptional bitrates, as for example on 21-04-2025 52Mbps was achieved in total (36Mbps video).  On this page you can find information about known WiFi adapters with this chip.
+
+## BL-R8812AF1
+LB-LINK BL-R8812AF1 is small size, low power net card. It is very popular choice for toothpick builds. This net card can be found on EMAX Wyvern Link VTX Alpha 100mW.
+![image](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/bl-r8812af1-top.png)
+<ThemeImage
+  lightSrc="https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/bl-r8812af1-bottom-light.png"
+  darkSrc="https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/bl-r8812af1-bottom-dark.png"
+  alt="WiFi adapter image"
+/>
+### Pinout
+| Pin number  | Function        |
+|:-----------:|:---------------:|
+| 1           | PDN             |
+| 2           | VDD(3.3V)       |
+| 3           | DM-             |
+| 4           | DP+             |
+| 5           | GND             |
+| 6           | LED             |
+
+### Specifications
+| Host interface      | USB 2.0  |
+|:-------------------:|:--------:|
+| Power Supply        | DC 3.3V +-10%                  |
+| Antenna connection  | IPEX x2                        |
+| Power output        | ≤20dBm(≤100mW)                 |
+| Supported modes     | 5MHz, 10MHz, 20MHz, 40MHz      |
+
+## WiFiLink-G set net card
+
+This is net card that you can get when buying WiFiLink-G set. It is low power so it is popular for Android GS use.
+
+![image](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/rtl8812au-wifilink-g-adapter.png)
+### Specifications
+| Host interface      | USB 3.0  |
+|:-------------------:|:--------:|
+| Power Supply        | DC 5V                          |
+| Antenna connection  | RP-SMA x2                      |
+| Power output        | NA                             |
+| Supported modes     | 5MHz, 10MHz, 20MHz, 40MHz      |
+