Update readme

[CoMPaTech]

Summary by CodeRabbit

• New Features

  • Added comprehensive support for multiple AirOS firmware versions (AirOS6 and AirOS8) with automatic device type detection and intelligent runtime configuration selection based on detected firmware version.

• Refactor

  • Refactored device instantiation and connection management to ensure seamless compatibility across different firmware variants with optimized handling of firmware-specific configurations.

[coderabbitai]

Walkthrough

This PR introduces support for multiple AirOS firmware variants (AirOS6 and AirOS8) through runtime polymorphic device instantiation. The implementation detects firmware version at runtime, selects the appropriate device class, and adapts data structure access patterns to accommodate differences between firmware versions.

Changes

Cohort / File(s)	Summary
Import and Device Detection airos.py (or primary module)	Added imports for AirOS6/AirOS6Data and AirOS8/AirOS8Data; introduced DetectDeviceData helper and async_get_firmware_data function for firmware version detection
Runtime Polymorphic Instantiation README.md, example/main file	Replaced direct AirOS instantiation with firmware-aware device selection logic; instantiates device via airos_class determined by firmware major version; maintains connection data dictionary for reuse
Method and Status Data Access Adaptation Example/main usage	Updated method calls to use airos_device (polymorphic instance); adapted status data access paths to handle variant differences (e.g., status.host, status.wireless.sta vs status.wireless.stations)

Sequence Diagram

sequenceDiagram
    participant User
    participant Main
    participant Device as Device Factory
    participant AirOS6
    participant AirOS8
    
    User->>Main: Invoke script
    Main->>Device: async_get_firmware_data(conn_data)
    Device->>Device: Detect AirOS version
    alt Firmware Major Version 6
        Device->>AirOS6: Select AirOS6 class
    else Firmware Major Version 8
        Device->>AirOS8: Select AirOS8 class
    end
    Device-->>Main: Return device class & data
    
    Main->>Main: airos_device = airos_class(conn_data)
    Main->>airos_device: login()
    airos_device-->>Main: Connection established
    
    Main->>airos_device: status()
    alt AirOS6 structure
        airos_device-->>Main: status.host, status.wireless.stations
    else AirOS8 structure
        airos_device-->>Main: status.host, status.wireless.sta
    end
    
    Main->>Main: Process stations (polymorphic)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

The PR introduces a new polymorphic pattern with runtime device class selection based on firmware detection, affecting multiple logical areas (imports, instantiation, data access). The changes follow a consistent approach across variants but require verification of correct version detection logic, data structure mappings, and end-to-end polymorphic behavior.

Possibly related PRs

• Further refactoring #70: Implements the core login() and status() method refactoring that enables the polymorphic pattern introduced in this PR.
• Fix apmac and add determined mac address #35: Modifies AirOS8 status data handling and derived MAC information, directly related to the status structure adaptation for variant differences.
• Classing #28: Refactors AirOS data class naming and imports (AirOSData → AirOS8Data), establishing the foundation for multi-variant imports in this PR.

Poem

🐰✨ Multiple variants now dance in the night,
Runtime polymorphism sets the device right!
AirOS6, AirOS8—no more guessing game,
One factory, many flavors, architecture's new fame! 🎪

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The pull request title "Update readme" is generic and vague. While the title correctly identifies that README.md is being modified, it uses a non-descriptive term that fails to convey meaningful information about what the README is actually being updated with. Based on the raw summary, the README changes relate to documenting support for multiple AirOS variants, polymorphic device instantiation, and revised connection data handling—none of which is reflected in the title. A teammate scanning the project history would not understand the scope or purpose of the readme update from this title alone.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch readme

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

83-99: Drop or use the unused type alias.

AirOSDataDetect = AirOS8Data | AirOS6Data isn’t referenced later, so the alias reads like a leftover and adds noise to the example. Either remove it or put it to work by annotating status_data (e.g., status_data: AirOSDataDetect = await airos_device.status()).

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 265a842 and c29d450.

📒 Files selected for processing (1)

• README.md (2 hunks)

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.57%. Comparing base (265a842) to head (c29d450).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #119   +/-   ##
=======================================
  Coverage   89.57%   89.57%           
=======================================
  Files           8        8           
  Lines         681      681           
=======================================
  Hits          610      610           
  Misses         71       71           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.