@lukesthl/fritzbox

[![npm package][npm-img]][npm-url]
[![Build Status][build-img]][build-url]
[![Downloads][downloads-img]][downloads-url]
[![Issues][issues-img]][issues-url]
[![Code Coverage][codecov-img]][codecov-url]
[![Commitizen Friendly][commitizen-img]][commitizen-url]
[![Semantic Release][semantic-release-img]][semantic-release-url]

> A library for accessing a AVM Fritz!Box via TR-064 and HTTP API.

Features

- Supports the command language of the TR-064 API of a Fritz!Box (partially typed with interfaces)
- Supports the SmartHome HTTP API
- Typesafe commands: DeviceInfo, DeviceLog, LanDeviceHosts, SID, Reboot, SmartHome Devices/Groups, SmartHome DeviceStats, EcoStats, NetworkStats
- SSL encryption and authentication
- async/await promises
- generic support
- Custom TR-064 Commands

Install

``bash
npm install @lukesthl/fritzbox
`

Usage

`ts
import { FritzBox } from '@lukesthl/fritzbox';

const fritzbox = new FritzBox({
username: FRITZBOX_USERNAME,
password: FRITZBOX_PASSWORD,
});

const deviceInfo = await fritzbox.deviceInfo.getInfo();

console.log(deviceInfo.NewHardwareVersion); // FRITZ!Box 7590 (UI)
`

API

$3

#### username

Type: string

#### password

Type: string

##### host (optional, default = fritz.box)

Type: string

##### port (optional, default = 49000)

Type: number

##### ssl (optional, default = false)

Type: boolean

##### tr064 (optional, default = true)

Type: boolean

$3

Official Doc

Router Information, Device Logs, TR-069 Provisioning Code, Security Port

`ts
const deviceInfo = await fritzbox.deviceInfo.getInfo();

const deviceLog = await fritzbox.deviceInfo.getDeviceLog();

const securityPort = await fritzbox.deviceInfo.getSecurityPort();

await fritzbox.deviceInfo.setProvisioningCode({
NewProvisioningCode: '123',
});
`

$3

Official Doc

Network Devices

`ts
const hostListPath = await fritzbox.lanDeviceHosts.getHostListPath();

const hosts = await fritzbox.lanDeviceHosts.getHosts();
// Host {
// mac: string;
// ip: string;
// active: boolean;
// name: string;
// interface: string;
// }[]
`

$3

Official Doc

Get SID, Reboot

`ts
// for cached Sid use fritzbox.getSid();
const urlSidResponse = await fritzbox.deviceConfig.getUrlSID();

await fritzbox.deviceConfig.reboot();
`

$3

`ts
const response = await fritzBox.exec({
serviceId: 'urn:DeviceConfig-com:serviceId:DeviceConfig1',
actionName: 'Reboot',
});
`

$3

Official Doc

SmartHome Devices / Stats

`ts
const { devices, deviceGroups } = await fritzBox.smartHome.getDevices();

const deviceStats =
await fritzBox.homeautomation.deviceStats.getBasicDeviceStats(
devices.at(0).ain
);
`

$3

Current Network Stats (past 100 sec.), Eco Stats (CPU-Usage, CPU-Temp, RAM)
Use at your own risk.

`ts
const networkStats = await fritzBox.unofficial.networkMonitor.getNetworkStats();

const [firstSyncGroup] = networkStats?.data.sync_groups || [];
let currentNetworkTraffic: NetworkTraffic[] | null = null;
if (firstSyncGroup) {
currentNetworkTraffic =
fritzBox.unofficial.networkMonitor.getNetworkTrafficBySyncGroup(
firstSyncGroup
);
}
// interface NetworkTraffic {
// downBytes: number;
// uploadDefaultBytes: number;
// uploadImportantBytes: number;
// uploadRealtimeBytes: number;
// date: Date;
// }

const ecoStats = await fritzBox.unofficial.ecoStat.getEcoStat();
``

AVM Documentation

- API Informations
- TR-064 Overview

Special Thanks

This is an fork of @seydx's package

[build-img]: https://github.com/lukesthl/fritzbox/actions/workflows/release.yml/badge.svg
[build-url]: https://github.com/lukesthl/fritzbox/actions/workflows/release.yml
[downloads-img]: https://img.shields.io/npm/dt/@lukesthl/fritzbox
[downloads-url]: https://www.npmtrends.com/@lukesthl/fritzbox
[npm-img]: https://img.shields.io/npm/v/@lukesthl/fritzbox
[npm-url]: https://www.npmjs.com/package/@lukesthl/fritzbox
[issues-img]: https://img.shields.io/github/issues/lukesthl/fritzbox
[issues-url]: https://github.com/lukesthl/fritzbox/issues
[codecov-img]: https://codecov.io/gh/lukesthl/fritzbox/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/lukesthl/fritzbox
[semantic-release-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]: https://github.com/semantic-release/semantic-release
[commitizen-img]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]: http://commitizen.github.io/cz-cli/