# vtty

**Repository Path**: lyworkspace/vtty

## Basic Information

- **Project Name**: vtty
- **Description**: 一种用于嵌入式系统（esp32，stm32）等平台的，类似于linux的控制台的功能模块。
A console-like function module for embedded systems (such as ESP32, STM32) platforms, similar to the Linux console.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2024-07-01
- **Last Updated**: 2025-04-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 仿linux命令行, 支持STM32和ESP32, 需要操作系统支持

## README

# VTTY Menual

## 简介

VTTY 是一个基于 Linux TTY 的虚拟终端模拟器，它能够模拟一个终端。

## 功能

## 安装

本功能单元需要```utools```库的相关支持，为其提供多线程、线程同步等功能。
安装方法```utools```：
```shell
git submodule add https://gitee.com/lyworkspace/vtty.git /lib/utools
```

```utools```配置文件```utools/utools_cfg.h```：
```c++
#ifndef __UTOOLS_USER_CFG_H__
#define __UTOOLS_USER_CFG_H__

#define UTOOLS_OS_TYPE UTOOLS_OS_TYPE_FREERTOS
#define UTOOLS_EMBEDDED_PLATFORM UTOOLS_EMBEDDED_PLATFORM_STM32 // 使用的嵌入式平台
#define UTOOLS_COLLAB_TASK_ENABLE 1 // 启用多线程

#endif // __UTOOLS_USER_CFG_H__
```

编译支持需要增加相关配置，内容如下：
```shell
; 具体的路径需要根据实际情况修改
-DUTOOLS_USER_CONFIG_H=\"../../../include/utools_usr_cfg.h\"
```