Skip to content

Commit 9181af2

Browse files
authored
Update README.md
1 parent c5fded0 commit 9181af2

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
[![Newest commit](https://github.com/compatech/python-airos/workflows/Latest%20commit/badge.svg)](https://github.com/compatech/python-airos/actions)
1818

1919
[![CodeFactor](https://www.codefactor.io/repository/github/compatech/python-airos/badge)](https://www.codefactor.io/repository/github/plugwise/python-airos)
20-
[![codecov](https://codecov.io/gh/compatech/python-airos/branch/main/graph/badge.svg?token=WI5K2IZWNS)](https://codecov.io/gh/compatech/python-airos)
20+
[![codecov](https://codecov.io/gh/compatech/python-airos/graph/badge.svg?token=WI5K2IZWNS)](https://codecov.io/gh/compatech/python-airos)
2121

2222
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=CoMPaTech_python-airos&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=CoMPaTech_python-airos)
2323
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=CoMPaTech_python-airos&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=CoMPaTech_python-airos)
@@ -111,13 +111,21 @@ if __name__ == "__main__":
111111
asyncio.run(main())
112112
```
113113

114-
## Supported API Calls
114+
## Supported API classes and calls
115115

116-
The library currently supports the following methods:
116+
Classes:
117117

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.
121129

122130
More features and API calls are planned for future releases.
123131

0 commit comments

Comments
 (0)