You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ BreadboardOS is built on top of FreeRTOS, enabling fast integration of new funct
25
25
26
26
The central component of BBOS is the fantastic [microshell](https://microshell.pl/) project, which provides CLI functionality. Currently, a [fork](https://github.com/mcknly/microshell) of microshell is used, which includes some additional customization. The CLI implementation is organized into POSIX-style folders/files providing a recognizable user-interface for interacting with MCU hardware.
27
27
28
-
As of the first release, BBOS is implemented on a single MCU platform - the Raspberry Pi RP2040 (Pico, Pico W, etc). However, the project has been structured such that all hardware-specific code resides in a single directory, with a header file providing HAL functionality. The platform was built with porting in mind.
28
+
As of the v0.3 release, BBOS is implemented on a single MCU family - the Raspberry Pi RP2xxx (Pico, Pico W, Pico2, etc). However, the project has been structured such that all hardware-specific code resides in a single directory, with a header file providing HAL functionality. The platform was built with porting in mind.
29
29
30
30
### _Notable Features_
31
31
@@ -35,6 +35,7 @@ As of the first release, BBOS is implemented on a single MCU platform - the Rasp
- Interacting with chip I/O and serial buses directly from command line
37
37
- Watchdog service for system failsafe recovery
38
+
- Command history using arrows or ctrl-a/ctrl-z
38
39
39
40
### _Demo_
40
41
@@ -58,6 +59,8 @@ Ensure that the environment variables `$FREERTOS_KERNEL_PATH` and `$PICO_SDK_PAT
58
59
59
60
It is suggested to add these commands to the user's `~/.profile`, `~/.bashrc`, etc depending on the system.
60
61
62
+
**NOTE for RP2350**: As of 10/2024, official FreeRTOS has not yet merged in support for RP2350. Rasberry Pi's [fork](https://github.com/raspberrypi/FreeRTOS-Kernel) must be used. Further, there is a [bug](https://forums.raspberrypi.com/viewtopic.php?p=2253073#p2253073) in the Pico SDK, use the `develop` branch to incorporate the fix. Hopefully these changes will be merged upstream soon.
63
+
61
64
### Setting up BreadboardOS
62
65
63
66
- Clone the repository: `git clone https://github.com/mcknly/breadboard-os.git`
@@ -76,10 +79,10 @@ set(PROJ_VER "0.0")
76
79
set(CLI_IFACE 0)
77
80
78
81
# MCU PLATFORM - set the MCU platform being used (i.e. the subdir in 'hardware/')
79
-
set(PLATFORM rp2040)
82
+
set(PLATFORM rp2xxx)
80
83
81
-
# BOARD - set the board being used (i.e. 'pico', 'pico_w', etc)
82
-
set(BOARD pico)
84
+
# BOARD - set the board being used (platform-specific prebuild.cmake contains more information about boards)
85
+
set(BOARD pico2)
83
86
```
84
87
85
88
Using CLI over USB requires no additional hardware; using CLI over UART will require a USB-UART adapter (i.e. FTDI FT232 or SiLabs CP2102). Using CLI/UART enables some additional early boot status prints.
0 commit comments