Skip to content

Commit

Permalink
Add sub-warehouse description
Browse files Browse the repository at this point in the history
  • Loading branch information
tanghao-xiaomi committed Dec 18, 2024
1 parent ddd11f6 commit 428b393
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 2 deletions.
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
# Frameworks Introduction
# Frameworks Overview

\[ English | [简体中文](README_zh-cn.md) \]

This project is organized in a way that the top-level repository (super repository) manages multiple sub-repositories. In this way, different parts of the code base can be better managed and maintained while ensuring the independence and flexibility of each sub-repository. The sub-repository starts with the `frameworks` field.
This project adopts a super repository structure to manage multiple sub-repositories. This approach helps better manage and maintain different parts of the codebase while ensuring the independence and flexibility of each sub-repository. The sub-repositories are prefixed with the frameworks field.

## Sub-repository List

| Sub-repository Name | Description |
| :----------------------------------------------------------- | :----------------------------------------------------------- |
| [frameworks_bluetooth](../../../../open-vela/frameworks_bluetooth) | This repository aims to provide developers with rich Bluetooth APIs, including API interfaces, various service components, SAL protocol stack adaptation layer, and HAL hardware adaptation layer. |
| [frameworks_connectivity_telephony](../../../../open-vela/frameworks_connectivity_telephony) | This repository provides a set of rich tools and interfaces for applications, covering network services, call services, SMS services, data services, and SIM card services. These interfaces allow developers to easily access Telephony-related information via APIs without needing to understand the internal logic of `Telephony`, enabling efficient app development. |
| [frameworks_graphics_uikit](../../../../open-vela/frameworks_graphics_uikit) | This repository provides `video` and other specialized components based on `LVGL`, extends the font management mechanism, and includes multiple demo use cases based on these components to help developers quickly get started. |
| [frameworks_multimedia_media](../../../../open-vela/frameworks_multimedia_media) | This repository provides key interfaces for multimedia playback and recording, audio focus management, and audio policy. Developers can easily implement multimedia-related features using these interfaces. |
| [frameworks_multimedia_media_pfw](../../../../open-vela/frameworks_multimedia_media_pfw) | This repository provides a general state machine framework with interfaces used by the audio policy module. |
| [frameworks_runtimes_services_brightness](../../../../open-vela/frameworks/runtimes_services_brightness) | This repository provides brightness control functionality, supporting automatic adjustment of screen brightness based on ambient light, while allowing users to manually adjust brightness and dynamically modify the control curve. |
| [frameworks_runtimes_services_am](../../../../open-vela/frameworks/runtimes_services_am) | This repository implements application lifecycle management in the multi-application framework of `openvela`, including creation, startup, pause, resume, and destruction of activities. |
| [frameworks_runtimes_services_pm](../../../../open-vela/frameworks/runtimes_services_pm) | This repository implements package management functionality in the multi-application framework of `openvela`, including installation, uninstallation, and querying of packages. |
| [frameworks_runtimes_services_system_server](../../../../open-vela/frameworks/runtimes_services_system_server) | This repository implements the functionality for starting and managing multiple system services in the `openvela` multi-application framework, including application management, package management, window management, and brightness management services. |
| [frameworks_runtimes_services_wm](../../../../open-vela/frameworks/runtimes_services_wm) | This repository implements window management functionality in the `openvela` multi-application framework, including input, output, and display management capabilities. |
| [frameworks_runtimes_services_xmsdemo](../../../../open-vela/frameworks/runtimes_services_xmsdemo) | This repository provides a demo for application development in the `openvela` multi-application framework, suitable for beginners and developers to get started quickly. |
| [frameworks_runtimes_typescript_ts2native](../../../../open-vela/frameworks/runtimes_typescript_ts2native) | This repository provides the core framework and examples for converting `TypeScript` to native code in `openvela`. |
| [frameworks_runtimes_typescript_ts2wasm](../../../../open-vela/frameworks/runtimes_typescript_ts2wasm) | This repository provides the core framework and examples for converting `TypeScript` to `Wasm` bytecode in `openvela`, aimed at improving the performance of `TypeScript`. |
| [frameworks_runtimes_wasm](../../../../open-vela/frameworks/runtimes_wasm) | This repository provides examples and extended API implementations for the `openvela` Wasm runtime environment. This framework allows quickly importing system capabilities into the Wasm runtime environment. |
| [frameworks_security](../../../../open-vela/frameworks/security) | This repository mainly contains the default security application `TA` (Trusted Application) and `CA` (Certification Authority) implementations in `openvela TEE` (Trusted Execution Environment). |
| [frameworks_security_optee_vela](../../../../open-vela/frameworks/security_optee_vela) | This repository provides the implementation of the `OPTEE` framework compatible with the `openvela` kernel. Using the `OPTEE` framework allows for quick integration with the `openvela` system without needing to understand the underlying architecture details of `openvela`. |
| [frameworks_system_binder](../../../../open-vela/frameworks/system_binder) | This repository provides examples, performance test programs, and the `C` language implementation for various `Binder` scenarios, supporting learning and development of `Binder`. |
| [frameworks_system_charger](../../../../open-vela/frameworks/system_charger) | This repository provides `openvela` charging services to monitor and manage the battery charging process, including thermal control, current limiting, and stop/resume charging scenarios, ensuring safe and fast charging. |
| [frameworks_system_healthd](../../../../open-vela/frameworks/system_healthd) | This repository provides battery information monitoring services in `openvela`, publishing the `battery_state` topic, which can be subscribed to via the `uORB` framework. |
| [frameworks_system_ota](../../../../open-vela/frameworks/system_ota) | This repository mainly contains the `OTA` (Over-The-Air) implementation and `AVB` (Audio/Video Bridging) verification signature implementation. |
| [frameworks_system_topics](../../../../open-vela/frameworks/system_topics) | This repository provides definitions of commonly used `topics` in `openvela`, including system, connectivity, and virtual sensors, supporting publishing and subscribing via the `uORB` framework. |
| [frameworks_system_utils](../../../../open-vela/frameworks/system_utils) | This repository includes system utility components and services, such as `gdbus`, `kvdb`, `trace`, and `uv`. |
| [frameworks_system_utils_uv](../../../../open-vela/frameworks/system_utils_uv) | This repository implements `libuv`-style database and network interfaces, facilitating the integration of these capabilities into asynchronous applications based on `libuv`. |
| [frameworks_system_vibrator](../../../../open-vela/frameworks/system_vibrator) | This framework provides powerful vibration functionality for various devices, allowing customizable vibration patterns, amplitude, and intensity to enhance user experience, and supports cross-core API calls to control vibrator devices. |
29 changes: 29 additions & 0 deletions README_zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,32 @@
\[ [English](README.md) | 简体中文 \]

本项目采用顶层仓库(super repository)管理多个子仓库的方式进行组织。通过这种方式,可以更好地管理和维护不同部分的代码库,同时确保每个子仓库的独立性和灵活性。子仓库以 `frameworks` 字段开头。

## 子仓库列表

| 子仓库链接 | 描述 |
| :----------------------------------------------------------- | :----------------------------------------------------------- |
| [frameworks_bluetooth](../../../../open-vela/frameworks_bluetooth) | 该仓库旨在为应用程序开发者提供丰富的蓝牙应用编程接口,包括 API 接口层、各种 Services 服务组件层、SAL 协议栈适配层和 HAL 硬件适配层。|
| [frameworks_connectivity_telephony](../../../../open-vela/frameworks_connectivity_telephony) | 该仓库为应用程序提供了一组功能丰富的工具和接口,涵盖网络服务、通话服务、短信服务、数据服务和 SIM 卡服务。通过这些接口,应用开发者无需深入了解 `Telephony` 的内部业务逻辑,只需调用 `API` 即可轻松获取与 `Telephony` 相关的信息,并高效完成应用开发。 |
| [frameworks_graphics_uikit](../../../../open-vela/frameworks_graphics_uikit) | 该仓库基于 `LVGL` 提供了 `video` 等特色组件,并扩展了字体管理机制,同时包含多个基于这些组件的 demo 用例,帮助开发者快速上手。 |
| [frameworks_multimedia_media](../../../../open-vela/frameworks_multimedia_media) | 该仓库提供了用于实现多媒体播放与录制、音频焦点管理、音频策略等关键接口。通过这些接口,开发者可以轻松实现多媒体相关功能。 |
| [frameworks_multimedia_media_pfw](../../../../open-vela/frameworks_multimedia_media_pfw) | 该仓库为通用状态机框架,提供接口给音频策略模块使用。 |
| [frameworks_runtimes_services_brightness](../../../../open-vela/frameworks_runtimes_services_brightness) | 该仓库提供亮度控制功能,支持根据环境光自动调节屏幕亮度,并允许用户手动调整亮度,同时实时修改控制曲线。 |
| [frameworks_runtimes_services_am](../../../../open-vela/frameworks_runtimes_services_am) | 该仓库实现了 `openvela` 在多应用框架下的应用程序生命周期管理,包括活动的创建、启动、暂停、恢复和销毁。 |
| [frameworks_runtimes_services_pm](../../../../open-vela/frameworks_runtimes_services_pm) | 该仓库实现了 `openvela` 在多应用框架下的应用包管理功能,包括安装、卸载和查询。 |
| [frameworks_runtimes_services_system_server](../../../../open-vela/frameworks_runtimes_services_system_server) | 该仓库实现了 `openvela` 在多应用框架下启动和管理多个系统服务的功能,包括应用管理、包管理、窗口管理和亮度管理服务。 |
| [frameworks_runtimes_services_wm](../../../../open-vela/frameworks_runtimes_services_wm) | 该仓库实现了 `openvela` 在多应用框架下的窗口管理功能,包括输入、输出和显示管理等能力。 |
| [frameworks_runtimes_services_xmsdemo](../../../../open-vela/frameworks_runtimes_services_xmsdemo) | 该仓库提供了 `openvela` 在多应用框架下的应用开发 demo,适合初学者和开发者快速上手。 |
| [frameworks_runtimes_typescript_ts2native](../../../../open-vela/frameworks_runtimes_typescript_ts2native) | 该仓库提供了 `openvela` 中将 `TypeScript` 转换为原生代码的核心框架和示例。 |
| [frameworks_runtimes_typescript_ts2wasm](../../../../open-vela/frameworks_runtimes_typescript_ts2wasm) | 该仓库是 `openvela` 中将 `TypeScript` 语言转换为 `Wasm` 字节码的核心框架和示例,旨在提高 `TypeScript` 的运行性能。 |
| [frameworks_runtimes_wasm](../../../../open-vela/frameworks_runtimes_wasm) | 该仓库提供了 `openvela` Wasm 运行时环境的部分示例和扩展 API 实现,使用该框架可以快速将系统的能力导入到 Wasm 运行时环境中。 |
| [frameworks_security](../../../../open-vela/frameworks_security) | 该仓库主要包含了 `openvela TEE` 默认的安全应用 `TA``CA` 实现。 |
| [frameworks_security_optee_vela](../../../../open-vela/frameworks_security_optee_vela) | 该仓库提供了兼容 `openvela` 内核的 `OPTEE` 框架实现,使用 `OPTEE` 框架可以快速接入 `openvela` 系统,无需了解 `openvela` 架构层的细节。 |
| [frameworks_system_binder](../../../../open-vela/frameworks_system_binder) | 该仓库提供了 `Binder` 各种场景的示例、性能测试程序,以及 `C` 语言版本的实现,旨在支持 `Binder` 的学习和开发。 |
| [frameworks_system_charger](../../../../open-vela/frameworks_system_charger) | 该仓库提供了 `openvela` 充电服务,用于监控和管理电池充电过程,包括温控、限流和停复充等场景,确保电池安全快速充电。 |
| [frameworks_system_healthd](../../../../open-vela/frameworks_system_healthd) | 该仓库提供了 `openvela` 电池信息监控服务,通过 `battery_state` 主题向外发布,供应用通过 `uORB` 框架订阅。 |
| [frameworks_system_ota](../../../../open-vela/frameworks_system_ota) | 该仓库主要包含 `OTA` 实现和 `AVB` 验签实现。 |
| [frameworks_system_topics](../../../../open-vela/frameworks_system_topics) | 该仓库提供了 `openvela` 常用 `topic` 的定义,包括系统、连接和虚拟传感器等,支持通过 `uORB` 框架进行发布和订阅。 |
| [frameworks_system_utils](../../../../open-vela/frameworks_system_utils) | 该仓库包含了系统基础组件和服务,包括 `gdbus``kvdb``trace``uv` 等。 |
| [frameworks_system_utils_uv](../../../../open-vela/frameworks_system_utils_uv) | 该仓库实现了 `libuv` 风格的数据库和网络等接口,便于将这些能力集成到基于 `libuv` 的异步应用程序中。 |
| [frameworks_system_vibrator](../../../../open-vela/frameworks_system_vibrator) | 该框架旨在为各种设备提供强大的振动功能,通过可自定义的振动模式、幅度和强度提升用户体验,并支持跨核 API 调用以控制振动器设备。 |

0 comments on commit 428b393

Please sign in to comment.