docs added

Author: rex-schilasky

rustecal/docs/book.toml

@@ -0,0 +1,6 @@
+[book]
+title = "rustecal Documentation"
+authors = ["Rex Schilasky"]
+language = "en"
+multilingual = false
+src = "src"

rustecal/docs/src/SUMMARY.md

@@ -0,0 +1,6 @@
+# Summary
+
+- [Introduction](introduction.md)
+- [Usage Guide](usage.md)
+- [Message Types](types.md)
+- [Architecture Overview](architecture.md)

rustecal/docs/src/architecture.md

@@ -0,0 +1,29 @@
+# Architecture Overview
+
+## Overview
+
+`rustecal` builds safe wrappers around the C-based eCAL API, offering two layers:
+
+1. **Low-level Bindings (`rustecal-sys`)**:
+   - Generated via `bindgen`
+   - Exposes raw `unsafe` functions
+
+2. **Safe High-Level API (`rustecal`)**:
+   - Encapsulates lifecycle management
+   - Provides typed pub/sub
+   - Modular message type support
+
+## High-Level Modules
+
+- `Ecal` – initialization/finalization of runtime
+- `Publisher`/`Subscriber` – low-level pub/sub
+- `TypedPublisher`/`TypedSubscriber` – type-safe wrappers
+- `DataTypeInfo` – describes encoding, type name, and optional descriptor
+
+## Message Types as Crates
+
+Each type support lives in a separate crate to reduce dependency bloat:
+
+- `rustecal-types-bytes`
+- `rustecal-types-string`
+- `rustecal-types-protobuf`

rustecal/docs/src/introduction.md

@@ -0,0 +1,13 @@
+# Introduction
+
+Welcome to **rustecal**, a safe and idiomatic Rust binding for [Eclipse eCAL](https://github.com/eclipse-ecal/ecal).
+
+This project is designed to bring fast and reliable pub-sub and service-based IPC to Rust-based applications in domains such as robotics, automotive, embedded, and distributed systems.
+
+rustecal wraps the low-level `ecal_c` C API and builds ergonomic, type-safe abstractions for working with:
+
+- Publishers and Subscribers
+- Strongly typed message serialization (e.g., Strings, Bytes, Protobuf)
+- Cross-platform interprocess communication
+
+This documentation will guide you through usage, architecture, and message type support.

rustecal/docs/src/types.md

@@ -0,0 +1,34 @@
+# Message Types
+
+rustecal supports several message formats, wrapped in type-safe crates:
+
+## `BytesMessage`
+
+Raw byte buffers.
+
+```rust
+use rustecal_types_bytes::BytesMessage;
+
+let msg = BytesMessage(vec![1, 2, 3]);
+```
+
+## `StringMessage`
+
+UTF-8 encoded Rust strings.
+
+```rust
+use rustecal_types_string::StringMessage;
+
+let msg = StringMessage("hello world".into());
+```
+
+## `ProtobufMessage<T>`
+
+Support for `prost::Message`-based Protobuf types.
+
+```rust
+use rustecal_types_protobuf::ProtobufMessage;
+use myproto::MyMessage;
+
+let msg = ProtobufMessage(MyMessage::default());
+```

rustecal/docs/src/usage.md

@@ -0,0 +1,37 @@
+# Usage Guide
+
+## Initialization
+
+Before using any publisher or subscriber, initialize the eCAL runtime:
+
+```rust
+use rustecal::{Ecal, EcalComponents};
+
+fn main() {
+    Ecal::initialize(Some("my_node"), EcalComponents::DEFAULT).unwrap();
+    // ...
+    Ecal::finalize();
+}
+```
+
+## Publishing Strings
+
+```rust
+use rustecal::{TypedPublisher};
+use rustecal_types_string::StringMessage;
+
+let pub_ = TypedPublisher::<StringMessage>::new("hello").unwrap();
+pub_.send(&StringMessage("Hello from Rust".into()));
+```
+
+## Subscribing to Strings
+
+```rust
+use rustecal::{TypedSubscriber};
+use rustecal_types_string::StringMessage;
+
+let mut sub = TypedSubscriber::<StringMessage>::new("hello").unwrap();
+sub.set_callback(|msg| {
+    println!("Received: {}", msg.msg.0);
+});
+```