Skip to content

Freebox API toolbox within a Python package

License

Notifications You must be signed in to change notification settings

corwin-31/fbxapitool

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fbxapitool

Warning : this package deals with documented API functions, where some are unstables meaning these can change in the future ; moreover some others was not documented (OpenVPN Client & VM management) when coded, then they are more unstables

This package is an evolution of "freepybox", available here : https://github.com/fstercq/freepybox. In addition of many modifications, it brings new functions to missing API calls. But the Freebox API is not fully covered. Some features has not been tested, as they refers to options that I've not subscribed. It was developed in Python 3 with Delta S box, and tested under Linux (Debian & Ubuntu) and macOS. I've no idea of the effort required to used it on Windows 10, and I'll not do it. Last but not least, it'll only work with last version of the API in end of 2020, which mean version 8.

Install

Manually download and install the last version from github

$ git clone https://github.com/corwin-31/fbxapitool.git
$ python setup.py install

Get started

# Import fbxapitool package
from fbxapitool import Freebox

# Instantiate the Freebox class
# Be ready to authorize the app on the box
fbx = Freebox()

# Connect, open a session to the freebox
fbx.open('mafreebox.freebox.fr',443)

# Do something usefull, rebooting the box for example
fbx.system.reboot()

# Close the session.
fbx.close()

Have a look on the [fbx-status.py] (https://github.com/corwin-31/fbxapitool/blob/master/fbx-status.py) for a more complete overview

Resources

Freebox OS API documentation : http://dev.freebox.fr/sdk/os/ or http://mafreebox.freebox.fr/doc/index.html#

About

Freebox API toolbox within a Python package

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%