The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

WWW::FBX::Role::API::APIv3 - Freebox API v3

SYNOPSIS

    with 'WWW::FBX::Role::API::APIv3';

DESCRIPTION

WWW::FBX::Role::API::APIv3 is the freebox6 API version 3 as a Moose Role

API

API documentation is given here: http://dev.freebox.fr/sdk/os/ The following methods are currently implemented in this library:

call

call log

$fbx->call_log;

contact

$fbx->contact;

connection

connection

$fbx->connection;

connection config

$fbx->connection_config;

connection ipv6 config

$fbx->connection_ipv6_config;

connection xdsl

$fbx->connection_xdsl;

connection ftth

$fbx->connection_ftth;

connection dyndns noip

$fbx->connection_dyndns("noip/status");

dhcp

dhcp config

$fbx->dhcp_config;

dhcp static lease

$fbx->dhcp_static_lease;

dhcp dynamic lease

$fbx->dhcp_dynamic_lease;

download

downloads

$fbx->downloads;

download task

$fbx->get_download_task( 77 );

download task log

$fbx->get_download_task( "77/log" );

downloads task del

$fbx->del_download_task( 77 );

downloads task del with file erase

$fbx->del_download_task( "77/erase" );

downloads update

$fbx->upd_download_task( 0, { io_priority => "high" } );

download add

$res = $fbx->add_download_task( { download_url => "http://cdimage.debian.org/debian-cd/current/arm64/bt-cd/debian-8.4.0-arm64-CD-1.iso.torrent"} );

download add by local file

$res=$fbx->add_download_task_file( {download_file => [ "debian-8.4.0-arm64-netinst.iso.torrent" ] });

update priority of download file

$res=$fbx->change_prio_download_file( "76/files/76-0", { priority=>"high"} );

download tracker

$res = $fbx->get_download_task( "76/trackers");

download peers

$res = $fbx->get_download_task( "76/peers");

downloads stats

$fbx->downloads_stats;

download feeds

$fbx->downloads_feeds;

download feed

$fbx->downloads_feeds( 1 );

del feed

$fbx->del_feed( 1 );

update feed

$fbx->upd_feed(1, {auto_download=> \1});

refresh feed

$fbx->refresh_feed("1/fetch");

refresh all feeds

$fbx->refresh_feeds;

download feed items

$fbx->downloads_feeds("1/items");

update a feed item

$fbx->upd_feed("1/items/6");

download a feed item

$fbx->download_feed_item("1/items/6/download");

mark all items as read

$fbx->mark_all_read( "1/items/mark_all_as_read" );

add feed

$res = $fbx->add_feed("http://www.nzb-rss.com/rss/Debian-unstable.rss");

update downloads config

$res = $fbx->upd_downloads_config({max_downloading_tasks => 6, download_dir=>"/Disque dur/Téléchargements/"});

update throttling

$res = $fbx->upd_downloads_throttle( "schedule" );

download file to disk

$res = $fbx->download_file( "Disque dur/Photos/cyril/DSCF4322.JPG" );

get upload id

$res = $fbx->upload_auth( {upload_name => "DSCF4322.JPG", dirname => "/Disque dur/"} );

upload file by upload id

$res = $fbx->upload_file( {id=> $res->{result}{id}, filename=>"DSCF4322.JPG"});

upload file directly

$res = $fbx->upload_file( {filename => "DSCF4322.JPG", dirname => "/Disque dur/"} );

downloads config

$fbx->downloads_config;

freeplugs

list freeplugs

$fbx->freeplugs_net;

get a particular freeplugs

$fbx->freeplugs_net("F4:CA:E5:1D:46:AE");

reset freeplug

$fbx->reset_freeplug("F4:CA:E5:1D:46:AE");

fs

fs tasks

$fbx->fs_tasks;

fs task

$fbx->fs_tasks(12);

del fs task

$fbx->del_task(12);

update fs task

$fbx->upd_task(12, state=>"paused"});

list files

$res = $fbx->list_files("Disque dur/");

file info

$res = $fbx->file_info("Disque dur/Photos/Sydney/DSCF4323.JPG");

not JSON!

$res = $fbx->download_file("Disque dur/Photos/cyril/DSCF4322.JPG"), "download RAW file;

ftp

ftp config

$fbx->ftp_config;

lan

lan config

$fbx->lan_config;

lan browser interfaces

$res = $fbx->lan_browser_interfaces;

lan browser interfaces pub

$fbx->list_hosts($res->{result}->[0]->{name} );

lcd

lcd

$res = $fbx->lcd;

lcd brightness back

$fbx->set_lcd({ brightness => $res->{result}{brightness} });

nat

fw dmz

$fbx->fw_dmz;

fw redir

$fbx->fw_redir;

fw incoming

$fbx->fw_incoming;

parental

parental config

$fbx->parental_config;

parental filter

$fbx->parental_filter;

share

$fbx->share_link;

upload status

$fbx->upload;

upload status of a task

$fbx->upload(1);

airmedia config

$fbx->airmedia_config;

airmedia receivers

$fbx->airmedia_receivers;

shares

netshare samba

$fbx->netshare_samba;

netshare afp

$fbx->netshare_afp;

storage

storage disk

$fbx->storage_disk;

storage partition

$fbx->storage_partition;

switch

switch status

$fbx->switch_sts;

system

get system info

$fbx->system;

reboot system

$fbx->reboot;

upnp

upnpigd config

$fbx->upnpigd_config;

upnpigd redir

$fbx->upnpigd_redir;

upnpav

upnpav

$res=$fbx->upnpav;

set upnpav

$fbx->set_upnpav($res->{result}{enabled});

vpn

vpn

$fbx->vpn;

vpn user

$fbx->vpn_user;

vpn ip_pool

$fbx->vpn_ip_pool;

vpn client config

$fbx->vpn_client_config;

vpn client status

$fbx->vpn_client_status;

vpn client log

$fbx->vpn_client_log;

wifi

wifi config

$fbx->wifi_config;

wifi ap

$fbx->wifi_ap;

wifi bss

$fbx->wifi_bss;

wifi planning

$fbx->wifi_planning;

wifi mac filter

$fbx->wifi_mac_filter;

LICENSE

Copyright (C) Laurent Kislaire.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Laurent Kislaire <teebeenator@gmail.com>