Skip to content

Commit 297440c

Browse files
mineshp-mechamineshp-mecha
authored
Merge pull request #6 from shoaibmerchant/remote-access
feat: Adds extentions and resources doc
2 parents f517b73 + faa3391 commit 297440c

File tree

19 files changed

+167
-45
lines changed

19 files changed

+167
-45
lines changed

‎docs/comet/advanced/serial-console/using-breakout-extension.mdx‎

Whitespace-only changes.

‎docs/comet/emulation/android.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,5 +109,4 @@ The purpose of this setup is to install and configure Waydroid for Android Syste
109109
</S>
110110

111111

112-
113112
This completes the setup for running Waydroid on Mecha Comet.

‎docs/comet/emulation/dosbox.mdx‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,11 @@ The purpose of this setup is to install and configure DOSBox for running DOS gam
9292
$ skyroads
9393
```
9494
</S.Code>
95+
<Video src="https://web-assets.mecha.so/developers-v1/comet/dosbox-demo.mp4">
96+
Your browser does not support the video tag.
97+
</Video>
9598
</S.Details>
9699
</S.Step>
97100
</S>
98101

99-
<Video src="https://web-assets.mecha.so/developers-v1/comet/dosbox-demo.mp4">
100-
Your browser does not support the video tag.
101-
</Video>
102-
103-
This completes the setup for running DOS games using DOSBox.
102+
This completes the setup for running DOS games using DOSBox.

‎docs/comet/extensions/gamepad.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Gamepad
3+
hide_table_of_contents: true
4+
---
5+
6+
## USB Connectivity via 40-Pin GPIO
7+
The 40 pogo pin on comet device includes USB pins as well, allowing for seamless integration with Human Interface Devices (HID), such as gamepads. This feature simplifies connectivity and enhances user experience when attaching peripheral devices.
8+
9+
The Comet Extension Gamepad is powered by the versatile **RP2040 microcontroller**, which provides a robust USB interface supporting both host and device modes. This makes it especially convenient for use with HID peripherals.
10+
11+
## Firmware Options
12+
- The gamepad operates with an Arduino-based firmware. You can access the firmware file [here](https://web-assets.mecha.so/developers-v1/comet/extensions/gamepad-arduino-firmware.rar).
13+
- Alternatively, you can flash your own custom firmware, whether it's written in **Arduino** or **Python**, to meet your specific requirements.
14+
15+
<img className="img-rounded" src="/assets/comet/extensions/gamepad.png" alt="Launch Terminal" style={{ maxWidth: '50%', height: 'auto' }} />
16+
17+
## Resources
18+
19+
- [Download CAD Files](https://web-assets.mecha.so/developers-v1/comet/extensions/OBJ_PCB_mecha-gamepad-extension_2025-02-25.zip), To open CAD files we can use any 3D design software like autodesk viewer on FreeCAD.
20+
- [Download PCB Design files](https://web-assets.mecha.so/developers-v1/comet/extensions/mecha-gamepad-extension-pcb.rar), To open PCB files we can use PCB design software like EasyEDA-standard.

‎docs/comet/extensions/io-breakout.mdx‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: IO Breakout
3+
hide_table_of_contents: true
4+
---
5+
6+
## Overview
7+
The IO Breakout device is equipped with **40 pogo pins**, allowing seamless connection to various extensions such as GPIOs, gamepads, and keyboards. To make these GPIO pins breadboard-friendly, the **GPIO Extension** is utilized.
8+
9+
## GPIO Extension Features
10+
1. **Breadboard-Friendly Interface**
11+
The GPIO Extension converts the 40 pogo pins into **2.54mm pitch female headers**, making it easier to connect using jumper wires for prototyping and experimentation.
12+
13+
2. **USB-to-UART Conversion**
14+
The GPIO Extension includes a **CP2102 USB-to-UART converter chip**, which facilitates the conversion of USB signals into UART signals, streamlining communication with your host system. to connect with your host system there is type C port on GPIO Extension.
15+
16+
<img className="img-rounded" src="/assets/comet/extensions/io-breakout.png" alt="Launch Terminal" style={{ maxWidth: '50%', height: 'auto' }} />
17+
18+
## Resources
19+
20+
- [Download CAD Files](https://web-assets.mecha.so/developers-v1/comet/extensions/OBJ_PCB_mecha-io-extension_2025-02-20.zip), To open CAD files we can use any 3D design software like autodesk viewer on FreeCAD.
21+
- [Download PCB Design files](https://web-assets.mecha.so/developers-v1/comet/extensions/mecha-io-extension-pcb.rar), To open PCB files we can use PCB design software like EasyEDA-standard.

‎docs/comet/intro.mdx‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
slug: /comet
3-
title: Mecha Comet Documentation
3+
title: Mecha Comet
44
hide_table_of_contents: true
55
description: Discover the Mecha Comet, learn how-to-use, understand its peripherals and find out how you can build and run applications.
66
pagination_next: null
@@ -32,8 +32,6 @@ import {
3232
CreditCard,
3333
} from "lucide-react";
3434

35-
# Mecha Comet
36-
3735
<Banner path="/assets/comet/comet-banner.png" title="Mecha Comet" />
3836
Discover the Mecha Comet, learn how-to-use, understand its peripherals and find out how you can build and run applications. The sections available within this documentation are shown below.
3937

‎docs/comet/resources/mechanical-files/extensions.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Extensions
3+
hide_table_of_contents: false
4+
---
5+
6+
import DownloadCard from "@site/components/DownloadCard";
7+
8+
<DownloadCard
9+
title="Gamepad"
10+
subtitle="Last updated 17th Jan, 2025"
11+
downloadLink="https://web-assets.mecha.so/developers-v1/comet/resources/mechanical-files/extensions/Gamepad.zip"
12+
/>
13+
14+
<DownloadCard
15+
title="IO Breakout"
16+
subtitle="Last updated 17th Jan, 2025"
17+
downloadLink="https://web-assets.mecha.so/developers-v1/comet/resources/mechanical-files/extensions/GPIO.zip"
18+
/>
19+
20+
<DownloadCard
21+
title="Keyboard"
22+
subtitle="Last updated 17th Jan, 2025"
23+
downloadLink="https://web-assets.mecha.so/developers-v1/comet/resources/mechanical-files/extensions/Keyboard.zip"
24+
/>

‎docs/comet/resources/mechanical-files/mecha-comet.mdx‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Mecha Comet
3+
hide_table_of_contents: false
4+
---
5+
6+
import DownloadCard from "@site/components/DownloadCard";
7+
8+
<DownloadCard
9+
title="Outer Housing"
10+
subtitle="Last updated 12th Oct, 2024"
11+
downloadLink="https://web-assets.mecha.so/developers-v1/comet/resources/mechanical-files/comet/outer_housing.zip"
12+
/>
13+
14+
{/* <DownloadCard
15+
title="Middle Tray"
16+
subtitle="Last updated 5th March, 2025"
17+
context="Next Revision"
18+
downloadLink="https://web-assets.mecha.so/developers-v1/comet/resources/mechanical-files/comet/back_cover.zip"
19+
/> */}
20+
21+
<DownloadCard
22+
title="Back Cover"
23+
subtitle="Last updated 12th Oct, 2024"
24+
context="Next Revision"
25+
downloadLink="https://web-assets.mecha.so/developers-v1/comet/resources/mechanical-files/comet/back_cover.zip"
26+
/>
27+
28+
<DownloadCard
29+
title="Front Lid"
30+
subtitle="Last updated 12th Oct, 2024"
31+
context="Next Revision"
32+
downloadLink="https://web-assets.mecha.so/developers-v1/comet/resources/mechanical-files/comet/top_lid.zip"
33+
/>
34+
35+
<DownloadCard
36+
title="Buttons"
37+
subtitle="Last updated 12th Oct, 2024"
38+
context="Next Revision"
39+
downloadLink="https://web-assets.mecha.so/developers-v1/comet/resources/mechanical-files/comet/power_and_user_button.zip"
40+
/>

‎docs/mechanix/intro.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
slug: /mechanix
3-
title: Mechanix OS Documentation
3+
title: Mechanix OS
44
hide_table_of_contents: true
55
description: Learn about Mecha Comet using tutorials, API reference, and developer guides.
66
pagination_next: null
@@ -23,6 +23,7 @@ import Chapters from "@site/components/Chapters";
2323
import { Icon32 } from "@site/components/Icons/icons";
2424
import SmallGrid from "@site/components/SmallGrid";
2525
import Tiles from "@site/components/Tiles";
26+
import Banner from "@site/components/Banner";
2627

2728
import {
2829
Tag,
@@ -33,17 +34,17 @@ import {
3334
CreditCard,
3435
} from "lucide-react";
3536

36-
37+
<Banner path="/assets/comet/mechanix-os.png" title="Mechanix OS" />
3738
Learn to develop applications using our own RUST based GUI library , MCTK, customization, and integration with the Mechanix ecosystem.
3839

3940
<SmallGrid>
4041

4142
[**Using the GUI**](mechanix/using-the-gui/mechanix-shell)
4243

43-
[**Functions**](mechanix/functions/wayland)
44-
4544
[**Installing Apps** ](mechanix/installing-apps/package-manager)
4645

4746
[**Services** ](mechanix/services/system/server)
4847

48+
[**Building the Image** ](comet/advanced/bootloader/building-uboot-from-source)
49+
4950
</SmallGrid>

‎docs/sidebars.js‎

Lines changed: 46 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -62,19 +62,19 @@ const sidebars = {
6262
label: "Working with IO",
6363
items: ["comet/working-with-io/pin-diagram"],
6464
},
65-
{
66-
type: "category",
67-
collapsed: false,
68-
label: "Machine Learning",
69-
items: [
70-
"comet/machine-learning/intro",
71-
"comet/machine-learning/running-tensorflow",
72-
"comet/machine-learning/installing-coral",
73-
"comet/machine-learning/on-device-llm",
74-
],
75-
},
76-
{
77-
type: "category",
65+
// {
66+
// type: "category",
67+
// collapsed: false,
68+
// label: "Machine Learning",
69+
// items: [
70+
// "comet/machine-learning/intro",
71+
// "comet/machine-learning/running-tensorflow",
72+
// "comet/machine-learning/installing-coral",
73+
// "comet/machine-learning/on-device-llm",
74+
// ],
75+
// },
76+
{
77+
type: "category",
7878
collapsed: false,
7979
label: "Networking",
8080
items: [
@@ -92,11 +92,31 @@ const sidebars = {
9292
"comet/emulation/android",
9393
],
9494
},
95+
{
96+
type: "category",
97+
collapsed: false,
98+
label: "Extensions",
99+
items: [
100+
"comet/extensions/io-breakout",
101+
"comet/extensions/gamepad",
102+
],
103+
},
95104
{
96105
type: "category",
97106
collapsed: false,
98107
label: "Resources",
99-
items: ["comet/resources/datasheets"],
108+
items: [
109+
"comet/resources/datasheets",
110+
{
111+
type: "category",
112+
collapsed: true,
113+
label: "Mechanical Files",
114+
items: [
115+
"comet/resources/mechanical-files/mecha-comet",
116+
"comet/resources/mechanical-files/extensions",
117+
],
118+
},
119+
],
100120
},
101121
{
102122
type: "category",
@@ -160,18 +180,18 @@ const sidebars = {
160180
"mechanix/using-the-gui/camera",
161181
],
162182
},
163-
{
164-
type: "category",
165-
label: "Functions",
166-
items: [
167-
"mechanix/functions/wayland",
168-
"mechanix/functions/network-manager",
169-
"mechanix/functions/bluetooth",
170-
"mechanix/functions/video",
171-
"mechanix/functions/audio",
172-
"mechanix/functions/key-store",
173-
],
174-
},
183+
// {
184+
// type: "category",
185+
// label: "Functions",
186+
// items: [
187+
// "mechanix/functions/wayland",
188+
// "mechanix/functions/network-manager",
189+
// "mechanix/functions/bluetooth",
190+
// "mechanix/functions/video",
191+
// "mechanix/functions/audio",
192+
// "mechanix/functions/key-store",
193+
// ],
194+
// },
175195
{
176196
type: "category",
177197
label: "Installing Apps",

0 commit comments

Comments
 (0)