# rtt_rs

**Repository Path**: vitors/rtt_rs

## Basic Information

- **Project Name**: rtt_rs
- **Description**: rust system lib for rt-thread
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 9
- **Forks**: 2
- **Created**: 2021-01-28
- **Last Updated**: 2023-04-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RTT-RS

### 简介：

为 **rt-thread / rt-smart** 提供的 **rust** 支持层，提供了线程及线程同步，文件系统和网络功能



### rt-thread 使用说明：

1. 新建一个 lib 工程 crate ，并依赖此库。

2. 指定库的类型

   ```
   [lib]
   name = "app"
   crate-type = ["staticlib"]
   ```

3. 添加相应的标头，编译成 libxxx.a 库

   ```rust
   #![no_std]
   
   use rtt_rs::*;
   
   // 指定入口函数
   entry!(main);
   
   fn main() {}
   ```

4. 在 rt-thread 中的 main 中运行库的入口函数 rust_main

   ```c
   int main(void)
   {
       // 你也可以选择新建一个线程来执行 rust_main
       // main 函数在　rtt　中一般也是以一个线程的方式执行，但是可能栈空间满足不了你的需求
       int8_t ret = rust_main();
       return 0;
   }
   ```

5. 添加相应的库到 rt-thread 中并完成编译。



### rt-smart 使用说明：

 1. 复制 rt-smart 文件夹中的 json 文件到你的工程根目录，将json文件内的linker脚本的路径进行相应的修改

 2. 依赖 rtt_rs 库：

    ```toml
    [dependencies.rtt_rs]
    version = "0.2.3"
    path = "../../rtt_rs/"
    default-features = false
    features = ["rt-smart"]
    ```

 3. 对 main 文件进行一些修饰：

    ```rust
    #![no_std]
    #![no_main]
    
    use rtt_rs::print;
    
    // 引出　main　函数提供给 crt
    #[no_mangle]
    pub extern "C" fn main(){
        print!("hello word");
    }
    ```

　4. 使用 rt-smart 文件夹中的 build.sh 文件进行构建。