Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nunofgs/find3-unifi
Push wi-fi clients from a UniFi controller to a FIND3 server
https://github.com/nunofgs/find3-unifi
find find3 home-assistant home-automation indoor-positioning room-presence unifi
Last synced: 2 months ago
JSON representation
Push wi-fi clients from a UniFi controller to a FIND3 server
- Host: GitHub
- URL: https://github.com/nunofgs/find3-unifi
- Owner: nunofgs
- Created: 2018-04-08T21:18:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T00:54:56.000Z (about 2 years ago)
- Last Synced: 2024-10-12T05:29:29.911Z (3 months ago)
- Topics: find, find3, home-assistant, home-automation, indoor-positioning, room-presence, unifi
- Language: JavaScript
- Size: 288 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Introduction
This application will query your UniFi controller for all active Wi-Fi clients and report them to a FIND3 server.
Each UniFi access point will be reported as a node which will increase the chances of correct indoor positioning.
## Usage
Run the app via docker:
```sh
$ docker run --rm -it -e "DEBUG=*" -e "FIND3_URL=http://localhost:8003" -e … nunofgs/find3-unifi
```
## Environment Variables
Configuration is done through the following environment variables:
| Variable | Default value | Description |
| ---------------- | ------------- | --------------------------------------------------------- |
| _DEBUG_ | _[n/a]_ | Output debugging information (ex: `*` or `*unifi*`) |
| _SCAN_INTERVAL_ | _5000_ | The interval at which clients are polled and reported |
| _FIND3_GROUP_ | _[n/a]_ | The FIND3 family name |
| _FIND3_URL_ | _[n/a]_ | The URL of the FIND3 server (ex: `http://localhost:8003`) |
| _UNIFI_ADDRESS_ | _[n/a]_ | The UniFi server address |
| _UNIFI_PASSWORD_ | _ubnt_ | The UniFi server password |
| _UNIFI_PORT_ | _8443_ | The UniFi server port |
| _UNIFI_SITE_ | _default_ | The UniFi site |
| _UNIFI_USERNAME_ | _admin_ | The UniFi server username |
## License
MIT