fritzSmartAPI [WIP]

node.js module for Fritzbox Smart Home API (AHA-HTTP-Interface)

This module is still work in progress!
Major changes can and will happend before v1.0.0 Do not use this in an production enviroment

Instalation

npm install fritzsmartapi

Basic Usage

Example to get the session ID using default Fritz!Box hostname (fritz.box):
Supports PBKDF2 (Default; Requires Fritz!OS 7.24) or MD5 (Requires Fritz!OS 5.50) Challenge-Response Process for login
If the Fritz!OS version does not support PBKDF2 then the function automaticly falls back to MD5.

import * as fritzAPI from 'fritzsmartapi';

const credentials = {
  password: 'mypassword',
  user: 'username',
};

const connection = {
  host: 'fritz.box',
  mode: 'PBKDF2', // [Optional] Challenge-Response Process
  useSSL: false,  // [Optional] Use SSL/TLS Connection (default=false)
};

fritzAPI.doInitSession(credentials, connection).
  then((sessionId) => {
    console.log('Session ID: ' + sessionId); // e.g. Session ID: 9c977765016899f8
  }).
  catch((error) => {
    console.log('Login failed', error);
  });

Example to get the a list of all devices with the same connection details:

fritzAPI.getDeviceListInfos(sessionId, connection).
  then((response) => {
    console.log(response); // Device List
    const {device} = response.devicelist;
    const actorId = device[0].identifier; // e.g. Actor identifier of the first device in list
  });

Example to switch a socket on a socket switch on or off:

const switchOn = true;

fritzAPI.setSwitchOnOff(sessionId, actorId, switchOn, connection).
  then((switchState) => {
    console.log('Switch is set to: ' + switchState); // e.g. Switch is set to: true
  });

Functions

Not yet documented

Fritzbox Interface Documentation

• AVM Interfaces

FRITZ!Box login process

• [EN] FRITZ!Box login process PDF
• [DE] Anmeldeverfahren an einer FRITZ!Box PDF

AHA HTTP Interface Documentation

• [EN] Technical Note - Session ID PDF
• [DE] Technical Note - Session ID PDF
• [DE] AHA-HTTP-Interface PDF