Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/verify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ jobs:
- name: Full pre-commit
run: |
. venv/bin/activate
pre-commit run --show-diff-on-failure --color=always --all-files
SKIP=no-commit-to-branch pre-commit run --show-diff-on-failure --color=always --all-files

pytest:
runs-on: ubuntu-latest
Expand Down
2 changes: 2 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
default: true
MD013: false
MD024: false
MD033: false
MD041: false
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=CoMPaTech_python-airos&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=CoMPaTech_python-airos)

# Overview

`python-airos` or [`airos`](https://pypi.org/projects/airos) from pypi is an asynchronous Python library designed to programmatically interact with Ubiquiti airOS devices. It mimics a web browser client to fetch device status, configuration, and perform actions like kicking connected stations.

This library is a key component for a potential future core integration with [Home Assistant](https://www.home-assistant.io), with the initial pull request for core integration targeted for the 2025.8 release.
Expand Down Expand Up @@ -116,9 +117,10 @@ The library currently supports the following methods:

- `login()`: Authenticates with the device.
- `status()`: Fetches a comprehensive dictionary of the device's status and statistics.
-` stakick(mac_address)`: Disconnects a specific station by its MAC address.
- `stakick(mac_address)`: Disconnects a specific station by its MAC address.

More features and API calls are planned for future releases.

## Contributing

We welcome contributions as well as additional codeowners to python-airos.