|
1 | 1 | # Intorduction |
2 | 2 |
|
| 3 | +## Prerequisites |
3 | 4 |
|
| 5 | +### Rust Toolchain |
| 6 | + |
| 7 | +You will need to install the Rust toolchain. To do so, you can follow the instructions on the [Getting started](https://www.rust-lang.org/learn/get-started) page of the Rust Language website. |
| 8 | + |
| 9 | +:::info Windows Install Tips |
| 10 | +If you are using Windows, you may be prompted to install [Visual Studio C++ Build tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). If so, follow the instructions from the previous link. |
| 11 | + |
| 12 | +Even if Visual Studio is already on your machine, rustup will not verify if the required components are present. If you experience issues with the `rustup` installation on Windows, please follow [these instructions](https://rust-lang.github.io/rustup/installation/windows-msvc.html) to manually add the missing components. |
| 13 | +::: |
| 14 | + |
| 15 | +To verify that the installation, open a terminal and run `rustup --version`. If everything went well, you should see an output similar to this: |
| 16 | + |
| 17 | +```shell |
| 18 | +rustup 1.28.1 (f9edccde0 2025-03-05) |
| 19 | +info: This is the version for the rustup toolchain manager, not the rustc compiler. |
| 20 | +info: The currently active `rustc` version is `rustc 1.86.0 (05f9846f8 2025-03-31)` |
| 21 | +``` |
| 22 | + |
| 23 | +### `probe-rs` install |
| 24 | + |
| 25 | +This tool is an embedded debugging and target interaction toolkit. It enables its user to program and debug microcontrollers via a debug probe. |
| 26 | + |
| 27 | +The simplest installation method involves using the `cargo` packet manager: |
| 28 | + |
| 29 | +```shell |
| 30 | +cargo install probe-rs-tools --locked |
| 31 | +``` |
| 32 | + |
| 33 | +If you are using Linux, you will also need to add this [udev](https://probe.rs/files/69-probe-rs.rules) file in `/etc/udev/rules.d`. Then, run: |
| 34 | + |
| 35 | +```shell |
| 36 | +udevadm control --reload # to ensure the new rules are used. |
| 37 | +udevadm trigger # to ensure the new rules are applied to already added devices. |
| 38 | +``` |
| 39 | + |
| 40 | +### `arm-none-eabi` toolchain |
| 41 | + |
| 42 | +You will need to install the ARM toolchain in order to compile applications written in C. You can find the pre-built binary archives on the ARM [Downloads Page](https://developer.arm.com/downloads/-/gnu-rm). Alternatively, if you are on Linux, you can install it by running the following command in terminal: |
| 43 | + |
| 44 | +```shell |
| 45 | +sudo apt install gcc-arm-none-eabi |
| 46 | +``` |
| 47 | + |
| 48 | +### `tockloader` |
| 49 | + |
| 50 | +The `tockloader` tool is a useful and versatile tool for managing and installing applications on Tock. In order to install it, you will need to have Python installed. You can download the latest version of on the [official website](https://www.python.org/downloads/). You will also need to install `pipx`, following the [installation guide](https://pipx.pypa.io/stable/installation/). Then you can install it by running: |
| 51 | + |
| 52 | +```shell |
| 53 | +pipx install tockloader |
| 54 | +pipx ensurepath |
| 55 | +``` |
| 56 | + |
| 57 | +## CY8CPROTO-062-4343W board |
| 58 | + |
| 59 | +TODO: add board description and features |
| 60 | + |
| 61 | +## Tock OS |
| 62 | + |
| 63 | +TODO: add overview |
0 commit comments