@foto-andreas/fritzbox.js

FritzBox.js

The most powerful, simple and complete AVM Fritz!Box API.

This project is still a work in progress. See issue #1 for the current status.

Getting Started

This module is future-proof and uses async/await promises.

This means that you need to run NodeJS version 7.6.0 or newer. If your NodeJS version is between 7.0.0 and 7.5.0 you can use the harmony flag --harmony-async-await to make use of the async/await promises.

This package was tested on Fritz!Box 7390 and 7490, with firmware versions 6.53, 6.51 and 6.83.

Installing

npm install fritzbox.js

Usage

A simple example showing how to get the history of calls made with a Fritz!Fon can be seen below.

const fritz = require('fritzbox.js')
const options = {
  username: 'xxx',
  password: 'xxx',
  server: 'fritz.box',
  protocol: 'https' }

;(async () => {

  const calls = await fritz.getCalls(options)
  if (calls.error) return console.log('Error: ' + calls.error.message)
  console.log('Got ' + calls.length + 'calls.')

})()

To minimize overhead and limit login requests made to the Fritz!Box it is recommended to store the SID once one has been obtained using fritz.getSessionId.

Documentation

Want to get started with FritzBox.js? Cool! The API is documented and available here, and you can see some examples in the test/ folder.

Contributing

If you'd like to contribute to FritzBox.js, or file a bug or feature request, please head over to the issue tracker or open a pull request.

Migrating from 1.x.x to 2.x.x

FritzBox.js v2.x is not backwards compatible with v1.x. One of the mayor changes includes the switch to async/await Promises. In v1.x, Promises were implemented with a then, catch:

fritz.getCalls(options)
.then((callHistory) => {
  console.log(callHistory)
})
.catch((error) => {
  console.log(error)
})

With v2.x, the catch will no longer catch any errors, since the module is now built to provide support for await. Any errors will be passed along like this:

fritz.getCalls(options)
.then((callHistory) => {
  if (callHistory.error) return console.log(callHistory.error.message)
  console.log(callHistory)
})

Of course, this can be simplified using await:

let callHistory = await fritz.getCalls(options)
if (callHistory.error) return console.log(callHistory.error.message)
console.log(callHistory)

Note that any Promise waiting to be fulfilled using await should be put inside an async function.

For more changes, please see the roadmap.

License

This software is open-sourced under the MIT License (see the LICENSE file for the full license).

You are required to include a copy of this project's license and copyright notice in your modified or distributed version of FritzBox.js