Skip to content

CHANGELOG.md

Latest commit

 

History

History
91 lines (71 loc) · 3.75 KB

CHANGELOG.md

File metadata and controls

91 lines (71 loc) · 3.75 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

  • MAJOR API EXPANSION: Complete GATT operations support

    • Full service, characteristic, and descriptor enumeration with capabilities
    • Characteristic read/write operations (both request and command modes)
    • Descriptor read/write operations
    • Manufacturer data and advertisement parsing
    • Paired peripherals access via adapter.paired_peripherals
    • Extended peripheral information: TX power, MTU, enhanced addressing

  • Ruby-friendly API enhancements:

    • Helper methods: peripheral.name, to_s, has_data?, formatted output methods
    • Convenient service/characteristic lookup by UUID
    • Enhanced error handling with CharacteristicError exception class
    • UUID parsing from strings and symbols

  • Cross-platform stability:

    • Fixed Unix library linking (both libsimplecble.a and libsimpleble.a required)
    • Resolved C++ symbol resolution issues on Linux and macOS
    • All platforms (Windows, macOS, Linux) now building and working in CI
    • Full Ruby version matrix support (2.7-3.3) across all platforms

Changed

  • Updated README with accurate API documentation reflecting current comprehensive functionality
  • Enhanced CI workflow to test all Ruby versions across all platforms
  • Improved error handling and memory management throughout C extension

Fixed

  • Unix platforms: Fixed "undefined symbol" errors by linking both SimpleBLE C and C++ libraries
  • Cross-platform compilation issues resolved for all supported operating systems
  • Proper C string memory management for all SimpleBLE API calls

[0.1.0] - 2025-01-25

Added

  • Initial release of ruby-simpleble gem
  • Ruby C extension bindings for SimpleBLE C++ library
  • Cross-platform Bluetooth Low Energy (BLE) support
    • macOS: CoreBluetooth framework integration
    • Linux: DBus/BlueZ backend support (ready for testing)
    • Windows: WinRT Bluetooth APIs (ready for testing)
  • Bluetooth adapter discovery and management
  • BLE device scanning with timeout control
  • Real-time device discovery with proper device enumeration
  • Memory-safe Ruby object lifecycle management
  • Comprehensive exception hierarchy for error handling
  • Module-level convenience methods: SimpleBLE.bluetooth_enabled?, SimpleBLE.adapters, SimpleBLE.scan
  • Object-oriented API with Adapter, Peripheral, Service, Characteristic, and Descriptor classes
  • Cross-platform build system with automatic dependency detection
  • Comprehensive RSpec test suite with integration test support
  • Performance benchmarking tools
  • Docker-based multi-platform testing
  • Complete API documentation with usage examples

Technical Implementation

  • C++ wrapper bridge for SimpleBLE C++ library integration
  • Platform-specific compilation flags and framework linking
  • Vendor SimpleBLE library compilation with CMake integration
  • Thread-safe operations with proper resource cleanup
  • Opaque handle management for BLE resources
  • Cross-platform CI/CD pipeline with GitHub Actions
  • Quality assurance with Qlty integration

Supported Operations

  • Bluetooth adapter enumeration and identification
  • BLE device scanning (working, tested with real devices)
  • Device information access (identifier, address, RSSI)
  • Scan result management and filtering
  • Connection status monitoring

Development Tools

  • Cross-platform build configuration (extconf.rb)
  • Comprehensive test suite with smart integration test skipping
  • Performance benchmarking with memory leak detection
  • Docker-based testing for multiple Ruby versions
  • GitHub Actions CI/CD with cross-platform matrix testing