Skip to content

Commit

Permalink
release of version 1.0
Browse files Browse the repository at this point in the history
added description to index.php
added version numbering to index.php and class.unifi.php
code and comments cleanup
  • Loading branch information
malle-pietje committed Mar 20, 2016
1 parent 01d31a1 commit bdf4d69
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
19 changes: 19 additions & 0 deletions index.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
<?php
/*
Unifi API Browser
This tool is for browsing data that is exposed through Ubiquiti's Unifi Controller API,
written in PHP, javascript and the Bootstrap CSS framework.
Please keep the following in mind:
- not all data collections/API endpoints are supported (yet), see the list below of
the currently supported data collections/API endpoints
- currently only supports versions 4.x.x of the Unifi Controller software
- there is still work to be done to add/improve functionality and usability of this
tool so suggestions/comments are welcome. Please use the github issue list or the
Ubiquiti Community forums for this:
https://community.ubnt.com/t5/UniFi-Wireless/Unifi-API-browser-tool-released/m-p/1392651
VERSION: 1.0
------------------------------------------------------------------------------------
The MIT License (MIT)
Copyright (c) 2015, Slooffmaster
Expand All @@ -21,6 +39,7 @@
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

/*
Expand Down
11 changes: 7 additions & 4 deletions phpapi/class.unifi.php
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
<?php
/*
Unifi PHP API
- this Unifi API client comes bundled with the Unifi API Browser tool and is based on the work done by
the following developers:
domwo: http://community.ubnt.com/t5/UniFi-Wireless/little-php-class-for-unifi-api/m-p/603051
fbagnol: https://github.com/fbagnol/class.unifi.php
and the API as published by Ubiquiti:
https://dl.ubnt.com/unifi/4.7.6/unifi_sh_api
VERSION: 1.0
NOTE:
this Class will only work with Unifi Controller versions 4.x. There are no checks to prevent you from
trying to use it with a pre-4.x version controller.
Expand Down Expand Up @@ -239,8 +242,8 @@ public function unblock_sta($mac) {

/*
daily stats method
parameter <start>
parameter <end>
optional parameter <start>
optional parameter <end>
NOTE: defaults to the past 30*7*24 hours
"bytes" are no longer returned with controller version 4.9.1 and later
*/
Expand All @@ -265,8 +268,8 @@ public function stat_daily_site($start = NULL, $end = NULL) {

/*
hourly stats method for a site
parameter <start>
parameter <end>
optional parameter <start>
optional parameter <end>
NOTE: defaults to the past 7*24 hours
"bytes" are no longer returned with controller version 4.9.1 and later
*/
Expand Down

0 comments on commit bdf4d69

Please sign in to comment.