nightf0rc3 / connectbox

API wrapper for the Connect Box (modem/router)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ConnectBox API

npm version

This package is a simple api wrapper for the web interface of the Connect Box (modem/router provided by ISPs e.g. Unitymedia) Currently only a couple of the web interface functions are implemented.

Installing

Using npm:

npm i connectbox

Usage

This example shows how to get an unformatted list of all currently connected devices.

import ConnectBox from 'connectbox';
// creating an ConnectBox object with the ip address of the target
const connectBox = new ConnectBox('192.168.0.1');
// logging in with the "password"
await connectBox.login('password');
// getting the list of all connected devices
const devices = await connectBox.getConnectedDevices();
console.log(devices);

About

API wrapper for the Connect Box (modem/router)


Languages

Language:TypeScript 82.7%Language:JavaScript 17.3%