https://github.com/tofuschnitzel/unifi_ap

Python API for UniFi accesspoints
https://github.com/tofuschnitzel/unifi_ap

unifi

Last synced: 5 days ago
JSON representation

Python API for UniFi accesspoints

• Host: GitHub
• URL: https://github.com/tofuschnitzel/unifi_ap
• Owner: tofuSCHNITZEL
• License: mit
• Created: 2023-12-01T09:43:10.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-24T10:30:05.000Z (about 1 year ago)
• Last Synced: 2024-03-25T05:43:33.610Z (10 months ago)
• Topics: unifi
• Language: Python
• Homepage: https://pypi.org/project/unifi-ap/
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# unifi_ap

Python API for UniFi accesspoints

## Installation

* pip install unifi_ap

## Usage

currently this package can only be used by importing it into own python files

```

import unifi_ap

ap = unifi_ap.UniFiAP("10.0.0.253", "admin")

clients = ap.get_clients()

ssids = ap.get_ssids()

clients_for_ssid = ap.get_clients(for_ssids=["guest"])

```

* Address/hostname and username are mandatory  

* if you don't define a password, ssh keys from the local ssh authentication agent are used  

* in addition/alternative to a password you can also define a private key file to be used for the authentication

`UniFiAP("10.0.0.253", "admin", keyfile="my-rsa.key")`

## Features

* get a list of SSIDs that the accesspoint is serving

* get currently connected clients (you can specify the SSIDs for which you want to get the clients - default: all)

## Credits

* inspired by https://pypi.org/project/unifi-tracker/

## License

[MIT](https://choosealicense.com/licenses/mit/)