PHPackages                             ocolin/uisp-extended - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. ocolin/uisp-extended

ActiveLibrary[HTTP & Networking](/categories/http)

ocolin/uisp-extended
====================

SSH-based device management for Ubiquiti radios, extending the UISP API with features not available through the standard interface.

v0.1.0(3mo ago)05MITPHPPHP ^8.2

Since Apr 26Pushed 3mo agoCompare

[ Source](https://github.com/ocolin/uisp-extended)[ Packagist](https://packagist.org/packages/ocolin/uisp-extended)[ Docs](https://github.com/ocolin/uisp-extended)[ RSS](/packages/ocolin-uisp-extended/feed)WikiDiscussions main Synced 3w ago

READMEChangelogDependencies (4)Versions (2)Used By (0)

UISP Extended
=============

[](#uisp-extended)

Ubiquiti's UISP platform provides a comprehensive API for managing network devices, but certain administrative tasks are not exposed through the API and must be performed directly on the device via SSH. ocolin/uisp-extended fills that gap by providing a clean PHP interface for SSH-based device management, designed to complement the ocolin/uisp package.

Experimental
------------

[](#experimental)

This is currently experimental and has not been fully tested on every known device.

---

Requirements
------------

[](#requirements)

- PHP ^8.2
- phpseclib/phpseclib ^ 3.0

---

Installation
------------

[](#installation)

```
composer require ocolin/uisp-extended

```

---

Configuration
-------------

[](#configuration)

### Arguments

[](#arguments)

When creating a Ubiquiti device class, there are a few parameters that you can use:

NameTypeDefaultDescriptionipstring`REQUIRED`IP address of devicepasswordstring`REQUIRED`Password for loginusernamestringadminUsername for loginportinteger22SSH port### Logging in

[](#logging-in)

Upon instantiation, you will log into the device automatically. An error is thrown if the connection fails or authentication does not pass.

### Example

[](#example)

```
// Minimal
$device = new Ocolin\UispExtended\Device(
    ip: '192.168.1.100', password: 'rosebud'
);

// Customized
$device = new Ocolin\UispExtended\Device(
    ip: '192.168.1.100', password: 'rosebud', username: 'admin', port: 2222
)
```

### Exceptions

[](#exceptions)

- `AuthenticationException` — thrown if login credentials are incorrect
- `ConnectionException` — thrown if the device is unreachable

---

Functions
---------

[](#functions)

### Get Device Information

[](#get-device-information)

You can get information about the device such as the type name, model, family, and firmware.

#### Output Object

[](#output-object)

NameTypeDescriptionnamestringName of the device modelmodelstringModel of devicefamilystringFamily of device modelfirmwarestringDevice firmware version#### Example

[](#example-1)

```
$info = $device->getDeviceInfo();
print_r( $info );
/*
Ocolin\UispExtended\DTO\DeviceInfo Object
(
    [name] => PowerBeam 5AC
    [model] => PBE-5AC-Gen2
    [family] => WA
    [firmware] => 8.7.11
)
 */
```

### Get MAC table

[](#get-mac-table)

This provides a MAC/bridge table on the device. It outputs an array of MAC entry objects.

#### Object parameters

[](#object-parameters)

NameTypeDescriptionmacstringMAC addressinterfacestringInterface address is onisLocalbooleanIs MAC address a local one?agingTimerfloatAge of MAC address#### Example:

[](#example-2)

```
$macs = $device->getMacTable();
print_r( $macs );
/*
Array
(
    [0] => Ocolin\UispExtended\DTO\MacEntry Object
        (
            [mac] => 00:0b:78:66:db:d0
            [interface] => eth0
            [isLocal] =>
            [agingTimer] => 2.11
        )

    [1] => Ocolin\UispExtended\DTO\MacEntry Object
        (
            [mac] => 04:f1:7d:05:07:c7
            [interface] => eth0
            [isLocal] =>
            [agingTimer] => 289.92
        )
)
 */
```

### Update password

[](#update-password)

This function allows you to update the password on a device. This function returns void, but will throw an error upon failure which will state where in the process it failed.

This will auto-detect the model of radio and execute the corresponding password update procedure automatically.

#### Example:

[](#example-3)

```
$device->changePassword( newPassword: 'myUpdatedPassword' );
```

#### Exceptions

[](#exceptions-1)

- `ConnectionException` - Error connecting to device.
- `PasswordChangeException` - Error updating the password with message.
- `ScriptNotFoundException` - Internal error reading CLI shell script.

### Update Wave Password

[](#update-wave-password)

This function was created in the event of a user wants to specifically change password on a Wve device instead of relying on changePassword() which automatically detects the type of device.

The same errors will be thrown as changePassword().

#### Example

[](#example-4)

```
$device->changePasswordWave( newPassword: 'myUpdatedPassword' );
```

### Update AirOS Password

[](#update-airos-password)

This function was created in the event a user wants to specifically change the password on a non-Wave type of device.

The same errors will be thrown as changePassword().

#### Example

[](#example-5)

```
$device->changePasswordAirOS( newPassword: 'myUpdatedPassword' );
```

### Reboot

[](#reboot)

While UISP has a reboot function, one was added here in case it needed to be used as standalone.

#### Example

[](#example-6)

```
$device->reboot();
```

###  Health Score

33

—

LowBetter than 72% of packages

Maintenance82

Actively maintained with recent releases

Popularity5

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

90d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e97ac0aa452b872ddc3f7f4c56c83852574a27bb74622f8c054d11ca20008fc9?d=identicon)[Ocolin](/maintainers/Ocolin)

---

Tags

sshnetworkubiquitiradiowaveuispairmaxairos

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/ocolin-uisp-extended/health.svg)

```
[![Health](https://phpackages.com/badges/ocolin-uisp-extended/health.svg)](https://phpackages.com/packages/ocolin-uisp-extended)
```

###  Alternatives

[leantime/leantime

Open source project management system for non-project managers. Simple like Trello, powerful like Jira. Built with neurodiversity in mind.

10.2k4.0k](/packages/leantime-leantime)[art-of-wifi/unifi-api-client

API client class for use with Ubiquiti's UniFi controller

1.3k416.9k](/packages/art-of-wifi-unifi-api-client)[altayalp/ftp-client

FTP and SFTP client for Php

1973.6k](/packages/altayalp-ftp-client)[mwguerra/web-terminal

A web-based terminal component for Filament/Laravel with command whitelisting and multiple connection types

296.1k](/packages/mwguerra-web-terminal)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)