Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
1d5fd7e
chore: docs - Add gRPC API documentation for TIMPANI Rust implementation
LGSI-KarumuriHari May 12, 2026
a21f138
Add gRPC architecture documentation and update system architecture
LGSI-KarumuriHari May 12, 2026
5e21552
chore: remove migration milestones section from README.md
LGSI-KarumuriHari May 12, 2026
792cf74
Merge pull request #63 from LGSI-KarumuriHari/main to development branch
basheerFZ May 13, 2026
d0e552e
Refactor documentation to standardize naming conventions for "timpani…
LGSI-KarumuriHari May 13, 2026
e4a9f26
docs: update documentation to standardize phases to steps in developm…
LGSI-KarumuriHari May 13, 2026
b30c574
Add Low-Level Design documents for timpani-o migration from C++ to Rust
LGSI-KarumuriHari May 13, 2026
1374343
docs: update documentation to reflect Low-Level Design (LLD) terminol…
LGSI-KarumuriHari May 13, 2026
10206f2
Merge pull request #67 from LGSI-KarumuriHari/main
basheerFZ May 13, 2026
3507f13
docs: add standardized metadata headers and revision history to docum…
LGSI-KarumuriHari May 13, 2026
59db1ff
docs: update document status to draft and revise metadata for LLD doc…
LGSI-KarumuriHari May 13, 2026
75e6519
Merge pull request #68 from LGSI-KarumuriHari/development_0.5
basheerFZ May 13, 2026
e4067f0
Add system requirements and feature specifications for timpani
LGSI-KarumuriHari May 13, 2026
8e57bdf
docs: reorganize documentation structure and update legends in archit…
LGSI-KarumuriHari May 14, 2026
747a117
docs: enhance architecture diagrams with improved link styles for cla…
LGSI-KarumuriHari May 14, 2026
ea79c5e
docs: update architecture diagram legends for clarity and improved sc…
LGSI-KarumuriHari May 14, 2026
13d3ac0
docs: update last modified dates and enhance revision history across …
LGSI-KarumuriHari May 14, 2026
ddd3c3e
Merge pull request #69 from LGSI-KarumuriHari/development_0.5
basheerFZ May 14, 2026
6abd324
docs: add scope legends to block diagrams and remove outdated images
LGSI-KarumuriHari May 14, 2026
77dc331
Merge pull request #71 from LGSI-KarumuriHari/development_0.5
basheerFZ May 14, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 34 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,25 @@
* SPDX-License-Identifier: MIT
-->

# TIMPANI
# timpani

Distributed real-time scheduling system with time-triggered execution capabilities. TIMPANI provides both C and Rust implementations of node executors and schedulers for deterministic real-time applications.
Distributed real-time scheduling system with time-triggered execution capabilities. timpani provides both C and Rust implementations of node executors and schedulers for deterministic real-time applications.

This repository contains both original C implementations and modern Rust ports with enhanced type safety and memory safety.

## Architecture

- **TIMPANI-N (Node Executor)**: Executes time-triggered tasks on individual nodes
- **TIMPANI-O (Node Scheduler)**: Orchestrates and schedules tasks across distributed nodes
- **timpani-n(Node Executor)**: Executes time-triggered tasks on individual nodes
- **timpani-o (Node Scheduler)**: Orchestrates and schedules tasks across distributed nodes
- **Sample Applications**: Real-time test applications for system validation

## Getting Started

### Clone the Repository

```bash
git clone --recurse-submodules https://github.com/MCO-PICCOLO/TIMPANI.git
cd TIMPANI
git clone --recurse-submodules https://github.com/eclipse-timpani/timpani.git
cd timpani
```

> **Note:** Use `--recurse-submodules` to automatically clone the required submodules (libbpf, etc.).
Expand All @@ -42,7 +42,7 @@ make
```
*For detailed setup and usage → [Full Documentation](sample-apps/README.md)*

### [TIMPANI-N (Node Executor)](timpani-n/README.md)
### [timpani-n(Node Executor)](timpani-n/README.md)
C implementation of the time-triggered node executor component.

**Quick Build:**
Expand All @@ -58,7 +58,7 @@ make

*For detailed setup, dependencies, and usage → [Full Documentation](timpani-n/README.md)*

### [TIMPANI-O (Node Scheduler)](timpani-o/README.md)
### [timpani-o (Node Scheduler)](timpani-o/README.md)
C implementation of the orchestrator component with gRPC & protobuf support for distributed scheduling.

**Quick Build:**
Expand All @@ -70,10 +70,10 @@ make
```
*For detailed setup, protobuf configuration, and usage → [Full Documentation](timpani-o/README.md)*

### [TIMPANI Rust Components](timpani_rust/README.md)
Rust ports of TIMPANI components with enhanced type safety and memory safety.
### [timpani Rust Components](timpani_rust/README.md)
Rust ports of timpani components with enhanced type safety and memory safety.

#### [Rust TIMPANI-N (Node Executor)](timpani_rust/timpani-n/README.md)
#### [Rust timpani-n(Node Executor)](timpani_rust/timpani-n/README.md)
Rust implementation of the node executor with comprehensive CLI interface, configuration validation, and structured logging. **Status**: Configuration parsing complete, runtime features in development.

**Quick Build:**
Expand All @@ -84,7 +84,7 @@ cargo test # Run tests
```
*For detailed setup, usage examples, and current status → [Full Documentation](timpani_rust/timpani-n/README.md)*

#### [Rust TIMPANI-O (Node Scheduler)](timpani_rust/timpani-o/)
#### [Rust timpani-o (Node Scheduler)](timpani_rust/timpani-o/)
Rust implementation of the global scheduler component. **Status**: In development.

**Quick Build:**
Expand All @@ -102,10 +102,29 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
## 📖 Documentation Structure

```
TIMPANI/
timpani/
├── README.md # This file - main project overview
├── doc/ # 📚 Comprehensive documentation
│ ├── README.md # Documentation guide
│ ├── architecture/ # Architecture documentation
│ │ ├── HLD/ # High-Level Design
│ │ │ ├── timpani_system_design_document.md
│ │ │ └── timpani_rust_grpc_architecture.md
│ │ └── LLD/ # Low-Level Design
│ │ ├── timpani-o/ # Orchestrator components (10 docs)
│ │ └── timpani-n/ # Node executor components (10 docs)
│ ├── features/ # Feature & Requirements
│ │ ├── timpani_features.md
│ │ └── requirements/timpani_requirements.md
│ ├── docs/ # Implementation guides
│ │ ├── api.md
│ │ ├── getting-started.md
│ │ └── developments.md
│ └── contribution/ # Contribution guidelines
│ ├── coding-rule.md
│ └── guidelines-en.md
├── sample-apps/
── README.md # Sample applications documentation
── README.md # Sample applications documentation
├── timpani-n/
│ ├── README.md # C implementation: Node executor
│ ├── README.CentOS.md # CentOS setup guide
Expand All @@ -124,4 +143,4 @@ TIMPANI/

---

**Navigation:** [Sample Apps](sample-apps/) | [TIMPANI-N (C)](timpani-n/) | [TIMPANI-O (C)](timpani-o/) | [Rust Components](timpani_rust/) | [Rust TIMPANI-N](timpani_rust/timpani-n/)
**Navigation:** [Sample Apps](sample-apps/) | [timpani-n(C)](timpani-n/) | [timpani-o (C)](timpani-o/) | [Rust Components](timpani_rust/) | [Rust timpani-n](timpani_rust/timpani-n/)
Loading
Loading