diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 20 |
1 files changed, 12 insertions, 8 deletions
@@ -1,11 +1,15 @@ | |||
1 | Ubiquiti mFi Controller | 1 | Ubiquiti mFi Controller |
2 | ======================= | 2 | ======================= |
3 | This repo contains a python implementation of a parser for the Ubiquiti Inform | ||
4 | Protocol. This protocol is used by Ubiquiti Unifi access points to communicate | ||
5 | with the controller for ongoing metrics collection and configuration. It's also | ||
6 | used in the Ubiquiti mFi products for command and control of light switches, | ||
7 | power outlets, mPorts and power strips. | ||
3 | 8 | ||
4 | This repo contains an alternative web controller for the Ubiquiti mFi mPower | 9 | The goal of this library is to build a fully functional replacement for the |
5 | strips. Who knows what could happen here. My initial goal is to provide a | 10 | abandoned Ubiquiti controller. A fully functional python library for inform |
6 | simple mobile site to control the switches. | 11 | parsing and serialization exists in the python directory along with a sample |
7 | 12 | server that just sends NOOP packets to devices checking in. The python work is | |
8 | Installation | 13 | considered finished and will be split into a new repo at some point. All |
9 | ============ | 14 | further work will go into a Go (golang) API on which the controller will be |
10 | Run ``pip install -r requirements.txt`` from within a virtualenv then start | 15 | built. |
11 | with ``python server.py`` | ||