libindigo-rs

libindigo Documentation

Welcome to the libindigo documentation. This directory contains comprehensive documentation for the libindigo Rust library for INDIGO protocol clients.

Quick Links

• GitHub Setup Instructions - Set up GitHub issue templates and workflows
• GitHub Issues Guide - Create issues from planning documents
• Roo Workflow Scheme - AI-assisted development workflow
• Ways of Working - GitHub issue types and processes

Documentation Structure

User Guides

Essential guides for using libindigo:

• Logging Configuration - Configure logging and tracing
• Server Monitoring - Monitor INDIGO server availability

Architecture

Technical architecture and design documents:

• Client Strategies - FFI vs Pure Rust implementation strategies

Protocols

INDIGO protocol documentation:

• JSON Protocol - JSON protocol specification and usage
• INDI Protocol - Original INDI protocol specification (PDF)
• Transport Implementation - TCP transport layer details

Development

Development guides and processes:

• Build Instructions - How to build the project
• Contributing Guidelines - How to contribute
• Testing Guide - Running and writing tests

Project Management

• CHANGES.md - Feature backlog and changelog
• Planning Documents - Active planning documents
• Roorules - AI assistant rules and guidelines

Getting Started

For Users

1. Read the README for project overview
2. Check BUILD.md for build instructions
3. Review examples/ for usage examples
4. See Client Strategies to choose implementation

For Contributors

1. Read Ways of Working for GitHub workflow
2. Review Roo Workflow Scheme for AI-assisted development
3. Check GitHub Issues Guide for creating issues
4. Follow GitHub Setup Instructions for repository setup

For Maintainers

1. Review CHANGES.md for release planning
2. Check plans/ for active planning documents
3. Use GitHub Issues Guide to create tracking issues
4. Follow Roo Workflow Scheme for coordinating work

Architecture Overview

libindigo implements a dual-strategy pattern for INDIGO client connectivity:

Pure Rust Strategy (Default)

• Zero C dependencies at runtime
• Pure Rust implementation of INDIGO protocol
• Supports both XML and JSON protocols
• Async-first design with tokio
• Cross-platform compatibility

Use when: You want zero FFI dependencies, modern async Rust, or web integration.

FFI Strategy

• Uses upstream INDIGO C library
• Full hardware driver support
• Battle-tested C implementation
• Async wrapper around synchronous FFI

Use when: You need hardware driver support or proven C implementation.

See Client Strategies for details.

Protocol Support

XML Protocol (Version 2.0)

• Traditional INDIGO protocol
• Full feature support
• BASE64 BLOB encoding
• Supported by both strategies

JSON Protocol (Version 512)

• Modern JSON-based protocol
• Better web integration
• URL-referenced BLOBs only
• Supported by Pure Rust strategy

See JSON Protocol for details.

Key Features

Implemented (v0.1.2)

• ✅ Dual strategy pattern (FFI and Pure Rust)
• ✅ XML protocol support
• ✅ JSON protocol support
• ✅ Protocol negotiation
• ✅ Async client API
• ✅ Property streaming
• ✅ BLOB support
• ✅ ZeroConf/Bonjour server discovery
• ✅ Integration test harness

Planned (v0.2.0)

• 🚧 Automated property constants generation
• 🚧 Replace hardcoded property strings
• 🚧 Documentation organization

Planned (v0.3.0)

• 📋 Trait-based device API (Camera, Mount, Focuser, etc.)
• 📋 Property wrappers
• 📋 Device-specific methods

See CHANGES.md for complete roadmap.

Testing

Unit Tests

# Core crate (strategy-agnostic)
cargo test -p libindigo --lib

# Pure Rust client
cargo test -p libindigo-rs --lib

# FFI client
cargo test -p libindigo-ffi --lib

Integration Tests

# Pure Rust client (requires INDIGO server)
cargo test -p libindigo-rs --test '*'

# FFI client (requires INDIGO server)
cargo test -p libindigo-ffi --test '*'

See Testing Guide for details.

Examples

The examples/ directory contains working examples:

• discover_servers.rs - Simple server discovery
• continuous_discovery.rs - Continuous monitoring
• auto_connect.rs - Auto-discover and connect
• discovery_with_filter.rs - Filtered discovery

Run examples:

cargo run --example discover_servers --features rs,auto

API Documentation

Generate API documentation:

cargo doc --no-deps --features rs --open

Support

• Issues: Use GitHub issue templates (see GitHub Setup Instructions)
• Discussions: Use GitHub Discussions for questions
• Documentation: Check this directory first

Contributing

We welcome contributions! Please:

1. Read Ways of Working
2. Follow Roo Workflow Scheme
3. Use appropriate issue templates
4. Write tests for new features
5. Update documentation

License

This project is licensed under the MIT License. See LICENSE.md for details.

References

External Documentation

• INDIGO Website
• INDIGO GitHub
• INDIGO Documentation

Internal Documentation

• Planning Documents
• Archived Plans
• Test Documentation
• Build Documentation

---

Last Updated: 2026-03-05 Version: 0.2.0

This site is open source. Improve this page.