Home

B-Scan Technical Wiki

Welcome to the B-Scan technical documentation wiki. This contains detailed technical information for developers, researchers, and contributors working with B-Scan's universal inventory management system.

Quick Navigation

🏗️ Architecture & Design

• Architecture Overview - Universal component system, threading, and design patterns
• Database & Storage - Data persistence, catalog generation, and storage architecture
• API Integration - Component factories, identifier system, and integration patterns

🔧 Development

• Development Guide - Build setup, testing, debugging, and contribution workflow
• Implementation Summary - Complete project implementation overview
• Test Data Integration - Real RFID test data usage and integration
• Cache Design - Performance optimisation and caching architecture
• Code Patterns - Common implementation patterns and best practices
• Threading Architecture - Dispatcher usage, concurrency, and performance

📡 RFID Technical Specifications

• RFID Formats - Detailed specifications for supported RFID formats
• Bambu Lab RFID - Complete Bambu Lab RFID technical details
• Generic RFID - Support for custom and generic RFID formats

🏛️ Data Architecture

• Entity Relationships - Database schema and data model diagrams
• Component System - Hierarchical component architecture details
• Identifier System - Universal identification method specifications

🌐 Community & Research

• Community Resources - Research databases, tools, and collaboration
• RFID Research - Community RFID tag databases and research projects
• Development Resources - Test data, submodules, and validation tools
• Security Analysis - Security considerations and defensive analysis

📚 Documentation & Wiki Management

• Documentation Overview - Complete documentation structure and guidelines
• Wiki Sync - Bidirectional wiki synchronisation system

Getting Started

If you're new to B-Scan development:

1. Start with Architecture Overview to understand the universal component system
2. Review Development Guide for build setup and testing
3. Check RFID Formats if working with identification methods
4. Browse Community Resources for research data and tools

Key Concepts

Universal Design Philosophy

B-Scan is built on the principle of identification-method agnostic inventory management:

• Any identification method can track any component type
• Hierarchical component relationships allow complex inventory structures
• Runtime catalog generation supports both official and user-defined product data
• Plugin architecture enables easy extension for new identification methods

Core Architecture

Identification Source → Data Extraction → Interpretation → Component Creation → Inventory Management
     (RFID, QR, Manual)      (Format-specific)    (SKU Lookup)    (Factory Pattern)      (Hierarchical)

Contributing to the Wiki

This wiki is maintained alongside the codebase. When contributing:

• Keep technical accuracy - All specifications should match implementation
• Use clear examples - Include code snippets and practical examples
• Cross-reference - Link related concepts and maintain navigation
• Update timestamps - Use ISO 8601 format in frontmatter for all edits

Technical Support

• Implementation questions: Open GitHub issues with question label
• Architecture discussions: Use GitHub Discussions
• Bug reports: Include relevant wiki sections in bug reports
• Feature requests: Reference applicable architecture patterns

---

Last updated: 2025-01-30 - Architecture overview and navigation structure