Skip to content

Commit 4efed66

Browse files
committed
Added bootloader flashing doc
1 parent ec0ded9 commit 4efed66

File tree

3 files changed

+30
-11
lines changed

3 files changed

+30
-11
lines changed

docs/astro.config.mjs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,16 @@ export default defineConfig({
1414
expressiveCode: {
1515
themes: ['github-light-high-contrast', 'tokyo-night'],
1616
removeUnusedThemes: true,
17+
styleOverrides: {
18+
// You can also override styles
19+
borderRadius: '0.5rem',
20+
borderColor: ['gray', 'black'],
21+
frames: {
22+
terminalTitlebarBackground: ['#414868', 'lightGray'],
23+
terminalTitlebarBorderBottomColor: ['gray', 'black'],
24+
terminalTitlebarDotsOpacity: '0.5',
25+
}
26+
},
1727
},
1828
title: 'UW Orbital',
1929
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/UWOrbital/OBC-firmware' }],

docs/src/content/docs/getting-started/build-obc.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,25 @@ There are two main ways to flash to the OBC: **using the bootloader** or **using
3939
:::note
4040
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 get working again.
4141
:::
42+
43+
### Accessing UART
44+
This is an important type of confi
4245
### Flashing Via the Bootloader (WIP)
43-
1. Use UniFlash to flash the `OBC-bl.out` file, ensuring you have built it for the correct board.
46+
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.
47+
2. From the root directory activate the python virtual environment with the following command
4448
49+
```shell
50+
source venv/bin/activate
51+
```
52+
3. Navigate to the `obc/tools/python/` directory from root...
53+
```shell
54+
cd obc/tools/python/
55+
```
56+
4. Run the app `app_update.py` script specifying a usb port and the absolute file path. The following is an example for linux.
57+
```shell
58+
python3 app_update.py /dev/ttyS0 ~/Desktop/dev/OBC-firmware/build_arm/OBC-firmware.bin
59+
```
60+
:::note
61+
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.
62+
:::
63+
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!

docs/src/styles/custom.css

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -552,16 +552,6 @@
552552
border-inline-start-width: 1px;
553553
}
554554

555-
.expressive-code {
556-
.has-title {
557-
--ec-uiPadBlk: 0.375rem;
558-
}
559-
560-
.frame.is-terminal .header {
561-
border-bottom: 1px solid var(--sl-rapide-ui-border-color);
562-
background-color: var(--sl-color-blue-low)
563-
}
564-
}
565555
}
566556

567557
/**

0 commit comments

Comments
 (0)