BLE2WLED Documentation

Bluetooth Beacon to WLED Visualizer

Getting Started

• Introduction
  • Overview
  • Key Features
  • Use Cases
  • Prerequisites
  • Architecture
  • Data Flow
  • Signal Strength to Distance Conversion
  • Color Mapping Strategy
  • Next Steps
• Installation
  • From Source
  • Next Steps
• Quickstart
  • 1. Installation
  • 2. Basic Setup
  • 3. Test with Simulator
  • 4. Real-Time Statistics
  • 5. Python API (Production)
  • 6. HTTP Alternative
  • 7. Configuration with Authentication
  • Next Steps

User Guides

• Configuration
  • Configuration Methods
  • Configuration Reference
  • Validation
  • Next Steps
• CLI Simulator Guide
  • Features
  • Basic Usage
  • Command-Line Options
  • Basic Examples
  • Live MQTT Examples
  • Python API
  • Display Output
  • Next Steps
• Docker
  • Building the Docker Image
  • Run with overridden environment variables
  • Build and start the container with Docker Compose
  • Viewing Logs
  • Stop the container
• MQTT Authentication
  • Overview
  • Configuration
  • CLI Usage
  • Python API
  • Security Best Practices
  • Testing
  • Next Steps
• HTTP Retry Logic
  • Overview
  • How It Works
  • Usage
  • Logging Output
  • Performance Impact
  • Typical Scenarios
  • Optimization Tips
  • Next Steps

API Reference

• API Reference
  • ble2wled.config - Configuration Management
  • ble2wled.states - Beacon State Management
  • ble2wled.colors - Color Calculations
  • ble2wled.animation - Animation Loop
  • ble2wled.wled - WLED Device Communication
  • ble2wled.mqtt - MQTT Beacon Listener
  • ble2wled.simulator - LED Simulator and Mock Beacons
  • Overview
• ble2wled.config - Configuration Management
  • Config
  • Overview
  • Properties
  • Methods
  • Examples
  • See Also
• ble2wled.states - Beacon State Management
  • BeaconState
  • Overview
  • Key Classes
  • Classes
  • Examples
  • See Also
• ble2wled.colors - Color Calculations
  • estimate_distance_from_rssi()
  • lerp()
  • gradient_color()
  • ble_beacon_to_rgb()
  • Overview
  • Functions
  • Examples
  • See Also
• ble2wled.animation - Animation Loop
  • BeaconRunner
  • add_trail()
  • Overview
  • Functions
  • Animation Parameters
  • Examples
  • See Also
• ble2wled.wled - WLED Device Communication
  • LEDController
  • WLEDHTTPController
  • WLEDUDPController
  • Overview
  • Classes
  • LED Data Format
  • Examples
  • Choosing Between UDP and HTTP
  • Error Handling
  • Debugging
  • See Also
• ble2wled.mqtt - MQTT Beacon Listener
  • EspresenseBeaconListener
  • BeaconMQTTListener
  • Overview
  • Classes
  • Examples
  • Error Handling
  • Troubleshooting
  • Performance
  • See Also
• ble2wled.simulator - LED Simulator and Mock Beacons
  • LEDSimulator
  • MockBeaconGenerator
  • Overview
  • Classes
  • Examples
  • CLI Usage
  • Performance
  • See Also

Project

• Changelog
• License
• GitHub