syncloudsoft/unifi-client

A simple client for UBNT's new controller API to perform some basic tasks.

This package's canonical repository appears to be gone and the package has been frozen as a result.

1.1.1 2018-04-04 01:20 UTC

This package is not auto-updated.

Last update: 2019-11-04 06:54:42 UTC


README

A simple client for UBNT's new controller API to perform some basic tasks.

Latest Version Downloads PHP Version License

Install

composer require syncloudsoft/unifi-client

Usage

<?php

/**
 * @desc Create a Syncloud\Unifi\Client and then login to controller.
 */
$client = new Syncloud\Unifi\Client('https://localhost:8443/');

/**
 * @desc At first, a long to the controller is required.
 */
$client->login('admin_user', 'secret_pass');

/**
 * @desc Get list of connected devices for a site.
 */
$devices = $client->devices('default');

/**
 * @desc Get list of connected clients for a site.
 */
$guests = $client->clients('default');

/**
 * @desc Authorize a guest MAC address for 10 minutes.
 */
$client->authorize('default', '6f:d7:b9:7f:4e:61', 10);

/**
 * @desc Un-authorize a guest MAC address.
 */
$client->unauthorize('default', '6f:d7:b9:7f:4e:61');

/**
 * @desc Block a guest MAC address.
 */
$client->block('default', '6f:d7:b9:7f:4e:61');

/**
 * @desc Unblock a guest MAC address.
 */
$client->unblock('default', '6f:d7:b9:7f:4e:61');

/**
 * @desc Update WLAN configuration for a site & a provided WLAN ID.
 */
$client->wlanconf('default', 'dd982884edf68487cb8ff664b3dfdf12', [
    'name' => 'My New SSID',
]);

/**
 * @desc Reboot an access point.
 */
$client->reboot('default', '6f:d7:b9:7f:4e:61');

/**
 * @desc You can logout when you are done.
 */
$client->logout();

License

See LICENSE file.