Skip to content

Commit f0652e9

Browse files
Adityya-KAdityya-K
committed
Formatting changes
1 parent aa3ebf9 commit f0652e9

File tree

7 files changed

+103
-6
lines changed

7 files changed

+103
-6
lines changed

docs/src/content/docs/getting-started/build-examples.md renamed to docs/src/content/docs/getting-started/build-examples.mdx

File renamed without changes.

docs/src/content/docs/getting-started/build-gs.md renamed to docs/src/content/docs/getting-started/build-gs.mdx

File renamed without changes.

docs/src/content/docs/getting-started/build-obc.md renamed to docs/src/content/docs/getting-started/build-obc.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22
title: Building for the OBC
33
description: On how to build for the board
44
---
5+
import { Steps } from '@astrojs/starlight/components';
6+
57
The following is a simple guide for building the app for the OBC and flashing.
68

79
## Compiling for the OBC
10+
<Steps>
811
1. From the root directory you can run the following commands
912
```shell
1013
mkdir -p build_arm && cd build_arm
@@ -22,11 +25,13 @@ The following is a simple guide for building the app for the OBC and flashing.
2225
:::caution
2326
Make sure to specify the `-DBOARD_TYPE=` option to avoid any unwanted behavior
2427
:::
28+
</Steps>
2529

2630
## Flashing to the OBC
2731
There are two main ways to flash to the OBC: **using the bootloader** or **using UniFlash**. UniFlash is the more common way so let's go over that first.
2832

2933
### Flashing via UniFlash
34+
<Steps>
3035
1. When you open UniFlash you should be greeted with the following screen...
3136

3237
![UniFlash on startup](../../../assets/docs_images/uniflash.png)
@@ -42,13 +47,15 @@ There are two main ways to flash to the OBC: **using the bootloader** or **using
4247
:::note
4348
UniFlash may get stuck sometimes and throw errors. In such cases, navigate to session on the top red bar and start a new session. You will have to reconfigure UniFlash but it should start working again.
4449
:::
50+
</Steps>
4551

4652
### Accessing UART
4753
This is an important skill everyone should know just for debugging. We will go through the process for Windows and Linux.
4854

4955
#### Base setup
5056
Both Linux and Windows have a program called `puTTY` available to download. `puTTY` is a great program to detect serial activity on ports so make sure you download this before proceeding!
5157

58+
<Steps>
5259
1. Download and open `puTTY`. You should be greeted with the following screen...
5360

5461
![puTTY on startup](../../../assets/docs_images/putty.png)
@@ -59,26 +66,32 @@ Both Linux and Windows have a program called `puTTY` available to download. `puT
5966
3. You can set the speed to `115200` which is the baud rate at the time of writing this tutorial (August, 2025). Update this rate if the baud rate of the board is increased!
6067
4. If you know how to detect what USB port is connected to UART you can type that USB port into the `Serial line` field in `puTTY`. If you need help, read through the following sections!
6168
5. You can then press the `Open` button and there should be a black screen that starts printing out text sent by the board!
69+
</Steps>
6270

6371
#### Finding USB port on Linux
6472
On Linux the port name will be in the form of `/dev/tty*`. For example the port could be named `/dev/ttyACM0` or `/dev/ttyUSB0`. To find the port connected to the board do the following...
73+
<Steps>
6574
1. Open up a terminal without the board connected and type in the following command that will list out all file paths starting with `/dev/tty`
6675
```shell
6776
ls /dev/tty*
6877
```
6978
2. Now connect the board and repeat the same command.
7079
3. Look for differences in outputs between running the command before and after connecting the board. The `/dev/tty` file path that gets added the second time around is the port that your board is connected on!
7180
4. You can type the name of the port you have determined to be going to the board in the `Serial line` field in `puTTY`. If you are using JTAG and have to connect two USBs to your Linux system, you will have to experiment and see which port outputs logs on puTTY.
81+
</Steps>
7282

7383
#### Finding USB port on Windows
7484
On Windows the port name will be in the form of `COMXX` with `XX` denoting numbers. For example possible port names are `COM1`, `COM12`, etc. To find the port connected to the board do the following...
85+
<Steps>
7586
1. Open `Device Manager` and you should be greeted with the following (the image is taken off the web so your window may look a bit different)...
7687
![Device Manager Windows](../../../assets/docs_images/device-manager.webp)
7788
2. Under `Ports` try to find the COM port labelled with `UART` somewhere in it's name. Once you have found it that is the COM port you will be using in `puTTY`.
89+
</Steps>
7890

7991
### Working with USB on WSL (`usbipd`)
8092
Unfortunately Windows does not pass-through USB ports by default to WSL. Thus, we have to use a utility called `usbipd` to handle USB device pass-through in WSL. The following are the steps needed to attach/detach USB devices from WSL.
8193

94+
<Steps>
8295
1. Open a `PowerShell` window. Within the window type the following command to find the bus-id of the USB device that you want to attach.
8396

8497
```shell title="PowerShell"
@@ -100,9 +113,11 @@ Unfortunately Windows does not pass-through USB ports by default to WSL. Thus, w
100113
```shell title="PowerShell"
101114
usbipd detach --busid 1-1
102115
```
116+
</Steps>
103117

104118

105119
### Flashing via the bootloader
120+
<Steps>
106121
1. Use UniFlash to flash the `OBC-bl.out` file, ensuring you have built it for the correct board using the right argument for the `-DBOARD_TYPE=` option.
107122
2. From the root directory activate the python virtual environment with the following command
108123

@@ -125,3 +140,4 @@ Unfortunately Windows does not pass-through USB ports by default to WSL. Thus, w
125140
The bootloader sends messages through the UART port so if the first string that the script displays is not 'Erase Successful' or the script is takes more than 1 second to start, re-run the script. Hopefully this is addressed in the future!
126141
:::
127142
5. Wait for the script to flash and the board should jump to app within 2 seconds of when flashing is completed. If not check the error that is being logged to UART and try again!
143+
</Steps>

‎docs/src/content/docs/getting-started/file-structure.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎docs/src/content/docs/getting-started/file-structure.mdx‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: The file structure explained
3+
description: How Orbital organizes files in their repository.
4+
---
5+
import { FileTree } from '@astrojs/starlight/components';
6+
7+
UW Orbital's Firmware Repository is quite large. As a result the previous leads have constantly refactored it to where it is now. So let's go through it! This write-up will only provide a brief overview. Consult other places in the documentation for more detailed explanations.
8+
9+
## General File Structure
10+
The following describes the general file structure of the repository
11+
<FileTree>
12+
- .github Github files
13+
- ...
14+
- cmake Custom CMake files
15+
- ...
16+
- gs Ground station files
17+
- backend Ground station backend
18+
- ...
19+
- frontend Ground station frontends for MCC and ARO
20+
- ...
21+
- hil Hardware-in-loop folder
22+
- ...
23+
- interfaces Any code used to interface from satellite to ground station
24+
- ...
25+
- libs Any of the C libraries used throughout the codebase
26+
- cserialport C serial port lib
27+
- ...
28+
- gnc_code GNC code
29+
- ...
30+
- libcorrect Forward Error Correction + Reed Solomon lib
31+
- ...
32+
- posix_freertos FreeRTOS lib
33+
- ...
34+
- tiny_aes AES128 encryption lib
35+
- ...
36+
- obc
37+
- app
38+
- drivers Board drivers
39+
- ...
40+
- hal Hardware Abstraction Layer
41+
- ...
42+
- modules FreeRTOS tasks
43+
- ...
44+
- reliance_edge File system
45+
- ...
46+
- rtos Scheduler configuration
47+
- ...
48+
- sys Core app utils
49+
- ...
50+
- tools
51+
- interface_debug_tool Basic OBC tests with app
52+
- ...
53+
- bl
54+
- F021_Flash_API API for writing to board's flash memory
55+
- ...
56+
- hal Hardware Abstraction Layer
57+
- ...
58+
- include All the bootloader header files
59+
- ...
60+
- source All the bootloader source files
61+
- ...
62+
- examples Barebones applications to test functionality
63+
- ...
64+
- shared Any functionality shared between the app and the bootloader
65+
- ...
66+
- tools Tools used to communicate to the board
67+
- python Any python files used to create the tools
68+
- ...
69+
- python_test Testing for all the ground station python code
70+
- ...
71+
- scripts Scripts that help build the project
72+
- ...
73+
- test Testing for all the interfaces
74+
- ...
75+
</FileTree>

‎docs/src/content/docs/getting-started/index.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Getting started
3+
description: Welcome to the Orbital Docs
4+
sidebar:
5+
badge: WIP
6+
---
7+
import { Badge } from '@astrojs/starlight/components';
8+
9+
Welcome to the Orbital Docs!
10+
11+
<Badge text="Work in Progress" size="large" />

‎docs/src/content/docs/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ hero:
88
file: ../../assets/icon.png
99
actions:
1010
- text: Docs
11-
link: getting-started/build-obc/
11+
link: getting-started
1212
icon: right-arrow
1313
- text: Visit our site
1414
link: https://www.uworbital.com/

0 commit comments

Comments
 (0)