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