BThomeV2

Getting Started

  • Installation
    • Arduino/PlatformIO Library
      • PlatformIO (Recommended)
      • Arduino IDE
      • Arduino Library Manager
      • Dependencies
    • Python Testing Tool (bthome-logger)
      • uv (Recommended)
      • pip
      • pipx
      • From GitHub
    • System Requirements
      • Hardware
      • Software
    • Version Compatibility
    • Installation Verification
      • Arduino Library
      • Python Tool
    • Next Steps
  • Quick Start Guide
    • Prerequisites
    • Step 1: Create Project
    • Step 2: Add Library
    • Step 3: Write Your First Sensor Code
    • Step 4: Compile and Upload
    • Step 5: Test with bthome-logger
    • Understanding the Code
      • Basic Structure
      • Measurement Updates
      • Device Names
    • Next Steps
    • Example: Multiple Sensors
    • Troubleshooting
      • BLE initialization fails
      • Sensor not visible in bthome-logger
      • Values not updating
    • Further Reading

Library Documentation

  • API Reference
    • BThomeV2Device Class
      • Initialization
        • begin()
        • end()
      • Advertising Control
        • startAdvertising()
        • stopAdvertising()
        • updateAdvertising()
      • Measurement Management
        • clearMeasurements()
      • Adding Sensors
        • Temperature
        • Humidity
        • Battery
        • Pressure
        • Illuminance
        • CO2
      • Binary Sensors
        • addBinarySensor()
        • Available Binary Sensors
      • Events
        • Button Events
      • Advanced Functions
        • Custom Measurements
        • Encryption (Optional)
        • MAC Address (Platform-Specific)
    • Complete Example
    • Best Practices
      • Update Frequency
      • Memory Management
      • Error Handling
      • Device Naming
    • Platform Differences
      • ESP32
      • nRF52
    • See Also
  • Supported Sensors
    • Measurement Sensors
      • Environmental Sensors
      • Light Sensors
      • Air Quality Sensors
      • Power Sensors
      • Other Sensors
    • Binary Sensors
      • Safety & Security
      • Detection Sensors
      • Hazard Sensors
      • Power & Connectivity
      • Environment
    • Events
      • Button Events
      • Dimmer Events
    • Usage Examples
      • Combining Multiple Sensors
      • Binary Sensor Example
      • Motion Sensor Example
      • Button Example
    • Payload Size Considerations
      • Typical Sensor Sizes
      • Recommendations
    • Sensor Categories
      • Quick Reference by Use Case
    • Home Assistant Integration
    • See Also
  • Examples
    • Available Examples
    • ESP32_Basic
      • Features
      • Code Overview
      • Testing
      • Expected Output
    • ESP32_Button
      • Features
      • Hardware Setup
      • Code Overview
      • Testing
      • Expected Output
    • ESP32_MultipleSensors
      • Features
      • Code Overview
      • Testing
      • Expected Output
    • nRF52_Basic (Not Functional)
      • Known Issues
    • Creating Your Own Example
      • Template
      • Best Practices
    • Testing Your Example
      • Local Testing
      • With bthome-logger
    • See Also
  • Supported Platforms
    • Platform Status Overview
    • ESP32 Platform
      • Supported Boards
      • Requirements
      • Dependencies
      • Features
      • Tested Boards
      • Example Configuration
      • Performance
      • Best Practices
      • Known Issues
    • nRF52 Platform
      • Affected Boards
      • Issues
      • Current Status
      • What Doesn’t Work
      • Workaround
      • Future Plans
    • Platform Comparison
    • Platform Abstraction
      • Architecture
      • Platform-Specific Code
      • Compile-Time Selection
    • Adding New Platforms
      • Requirements
      • Steps
    • Recommendations
      • For New Projects
      • For Existing nRF52 Projects
      • For Battery-Powered Sensors
      • For Production
    • See Also

Testing Tool

  • bthome-logger Tool
    • Overview
    • Installation
      • Recommended: uv
      • Alternative: pipx
      • Alternative: pip
      • From Source
    • Usage
      • Basic Usage
      • Filter by Device Name
      • Verbose Mode
      • Version Information
      • Help
    • Command-Line Options
    • Output Format
      • Header
      • Advertisement Display
      • RSSI Color Coding
    • Supported Sensor Types
      • Environmental Sensors
      • Air Quality
      • Light & Power
      • Binary Sensors
      • Events
    • Practical Use Cases
      • Development Testing
      • Verify Sensor Updates
      • Signal Strength Testing
      • Multiple Sensor Monitoring
      • Debugging
    • Examples
      • Example 1: Basic Temperature Sensor
      • Example 2: Button Events
      • Example 3: Multiple Sensors
      • Example 4: Verbose Mode
    • Troubleshooting
      • Tool doesn’t start
      • No devices found
      • Wrong device name filter
      • Permission errors (Linux)
      • Values not updating
      • Incorrect values displayed
    • Version Compatibility
    • System Requirements
      • Operating Systems
      • Python
      • Hardware
      • Dependencies
    • Advanced Usage
      • Integration with Scripts
      • Continuous Monitoring
    • See Also
  • Advanced Usage Examples
    • Production Monitoring
      • Long-Running Monitoring
      • Automated Testing
    • Multi-Device Scenarios
      • Home Monitoring Setup
      • Filter by Name Pattern
    • Data Analysis
      • Log and Parse Data
      • Extract Specific Measurements
      • Time-Series Data Collection
    • Development Workflows
      • Rapid Prototyping
      • Debugging Advertisement Issues
      • Range and Signal Testing
    • Integration Examples
      • Home Assistant MQTT Bridge
      • Prometheus Exporter
      • Alert System
    • Advanced Filtering
      • Multiple Device Patterns
      • Device Discovery
    • Tips and Tricks
      • Keyboard Shortcuts
      • Output Redirection
      • Performance
    • See Also

Development

  • Development Workflow
    • Repository Structure
    • Development Setup
      • Prerequisites
      • Clone and Install
    • Testing Workflow
      • Local Testing Process
      • Example Test Session
    • Semantic Versioning
      • Version Format
      • Commit Message Format
      • Examples
    • Automated Release Process
      • Workflow Overview
      • Workflow Files
    • Version Template System
      • Templates
      • Update Process
    • Branch Strategy
      • Main Branch
      • Feature Branches
      • Development Branches
    • Making Changes
      • Step-by-Step Guide
    • GitHub Secrets
      • Required Secrets
      • Setup Instructions
      • GitHub Environments
    • Local Testing Before Release
      • Test Library Locally
      • Test Python Tool Locally
      • Test Documentation Build
    • Troubleshooting
      • Release Workflow Fails
      • Version Not Bumping
      • Local Testing Doesn’t Match CI
    • Best Practices
      • Commit Messages
      • Code Changes
      • Documentation
      • Versioning
    • Resources
    • See Also
  • Contributing Guidelines
    • Contributing to BThomeV2
      • How to Contribute
        • Reporting Bugs
        • Suggesting Enhancements
        • Pull Requests
      • Development Guidelines
        • Code Style
        • Platform Support
        • Testing
        • Documentation
      • BThome V2 Protocol
      • Project Structure
      • Adding New Sensor Types
      • Release Process
      • Questions?
      • License
  • Release Process
    • Overview
    • Semantic Versioning
    • See Also

Additional Information

  • Changelog
    • Changelog
      • 1.0.0 - 2025-12-30
        • Added
        • Platform Support
        • Dependencies
  • License
BThomeV2
  • Search

© Copyright 2026, the78mole.

Built with Sphinx using a theme provided by Read the Docs.