|
17 | 17 | [](https://github.com/compatech/python-airos/actions) |
18 | 18 |
|
19 | 19 | [](https://www.codefactor.io/repository/github/plugwise/python-airos) |
20 | | -[](https://codecov.io/gh/compatech/python-airos) |
| 20 | +[](https://codecov.io/gh/compatech/python-airos) |
21 | 21 |
|
22 | 22 | [](https://sonarcloud.io/summary/new_code?id=CoMPaTech_python-airos) |
23 | 23 | [](https://sonarcloud.io/summary/new_code?id=CoMPaTech_python-airos) |
@@ -111,13 +111,21 @@ if __name__ == "__main__": |
111 | 111 | asyncio.run(main()) |
112 | 112 | ``` |
113 | 113 |
|
114 | | -## Supported API Calls |
| 114 | +## Supported API classes and calls |
115 | 115 |
|
116 | | -The library currently supports the following methods: |
| 116 | +Classes: |
117 | 117 |
|
118 | | -- `login()`: Authenticates with the device. |
119 | | -- `status()`: Fetches a comprehensive dictionary of the device's status and statistics. |
120 | | -- `stakick(mac_address)`: Disconnects a specific station by its MAC address. |
| 118 | +- `airos.data` (directly) as well as `airos.airos8` (indirectly) provides `AirOSData`, a [mashumaro](https://pypi.org/project/mashumaro/) based dataclass |
| 119 | +- `airos.discovery` `provides AirOSDiscoveryProtocol` for the actual discovery |
| 120 | + |
| 121 | +Calls: |
| 122 | + |
| 123 | +- `airos.airos8`: initializes with `host: str, username: str, password: str, session: aiohttp.ClientSession` |
| 124 | + - `login()`: Authenticates with the device. |
| 125 | + - `status()`: Fetches a comprehensive dictionary of the device's status and statistics. |
| 126 | + - `stakick(mac_address: str)`: Disconnects a specific station by its MAC address. |
| 127 | +- `airos.discovery` |
| 128 | + - `async_discover_devices(timeout: int)` mainly for consumption by HA's `config_flow` returnin a dict mapping mac-addresses to discovered info. |
121 | 129 |
|
122 | 130 | More features and API calls are planned for future releases. |
123 | 131 |
|
|
0 commit comments