Unifi PoE Server

Express server that exposes control of PoE ports on compatible Unifi devices via REST API. It just works!

Installation

Have node installed on your system as a prerequisite

# Install the server globally
npm install -g diogosalazar/unifi-poe-server

Set up controller credentials

Start the server by running from a command prompt or terminal:

# start the server
unifi-poe-server

Controller Credentials

For PoE port mode control to work an admin account must be created and its credentials passed to the unifi-poe-server

Via Environment Variables

Set up these variables on your system prior to starting the server:

# Set up environment variables
UNIFI_POE_USERNAME=admin-username
UNIFI_POE_PASSWORD=password
UNIFI_POE_URL=https://controller-url

# Start the server
unifi-poe-server

Or save them in a .env file to the root directory of this project if running from source

Via JSON file

Create a credentials file with log-in information for the target controller:

{
  "username": "<admin username>",
  "password": "<admin password>",
  "url": "https://<unifi controller url>"
}

Pass it to unifi-poe-server command

# Start the server
unifi-poe-server my-controller-credentials.json

Or save it to the root directory of this project as credentials.json if running from source

Starting the server from source

Clone this repository and configure your controller credentials.

# Clone the repository
git clone https://github.com/diogosalazar/unifi-poe-server.git

# Change into the cloned directory
cd unifi-poe-server

# Install dependencies
npm install

Start the server by running at the root of the unifi-poe-server folder:

# start the server
node .

The server should start at http://localhost:3000.

API Endpoints

Send a GET request to query a port status: http://localhost:3000/unifi-poe/[device-name]/[port-index]

Send a POST request to set a port status: http://localhost:3000/unifi-poe/[device-name]/[port-index]/[port-status]

Where [device-name] corresponds to the name of the device registered with the target controller that has the PoE port to be controlled/queried, [port-index] corresponds to the port number, and [port-status] should be one of off or auto to set a new port mode.

Return values and Errors

The PoE port can be set to an 'on' or 'off' value, where on signifies power is available at the port for compatible connected devices, and off signifies the port transmits data but does not provide power to any connect devices on that port.

In the API, the 'on' value corresponds to auto and the 'off' value corresponds to off.

A successful GET request to query a port status will return a JSON object with the port PoE mode.

Example response for a port with PoE disabled:

{
  "poe_mode": "off",
}

Example response for a port with PoE enabled:

{
  "poe_mode": "auto",
}

A successful POST request to set a new PoE mode will return a JSON object indicating whether the request was successful or not:

Example for successful request setting a new PoE mode:

{
  "success": true,
}

Example for failed request setting a new PoE mode:

{
  "error": "Invalid credentials",
}