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

my $res = $fbx->call_log;

contact

my $res = $fbx->contact;

connection

connection

my $res = $fbx->connection;

connection config

my $res = $fbx->connection_config;

connection ipv6 config

my $res = $fbx->connection_ipv6_config;

connection xdsl

my $res = $fbx->connection_xdsl;

connection ftth

my $res = $fbx->connection_ftth;

connection dyndns noip

my $res = $fbx->connection_dyndns({suff=>"noip/status"});

dhcp

dhcp config

my $res = $fbx->dhcp_config;

dhcp static lease

my $res = $fbx->dhcp_static_lease;

dhcp dynamic lease

my $res = $fbx->dhcp_dynamic_lease;

download

downloads

my $res = $fbx->downloads;

download task

my $res = $fbx->get_download_task( { suff => "0" } );

download task log

my $res = $fbx->get_download_task( { suff => "0/log" } );

downloads task del

my $res = $fbx->del_download_task( { suff => "0" } );

downloads task del with file erase

my $res = $fbx->del_download_task( { suff => "0/erase" } );

downloads update

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

download add

my $res = $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

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

update priority of download file

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

download tracker

my $res = $res = $fbx->get_download_task( {suff => "76/trackers"});

download peers

my $res = $res = $fbx->get_download_task( {suff => "76/peers"});

downloads stats

my $res = $fbx->downloads_stats;

download feeds

my $res = $fbx->downloads_feeds;

download feed

my $res = $fbx->downloads_feeds( { suff => "1"};

del feed

my $res = $fbx->del_feed({suff => "1"});

update feed

my $res = $fbx->upd_feed({suff=>"1", auto_download=> \1});

refresh feed

my $res = $fbx->refresh_feed({suff=>"1/fetch"});

refresh all feeds

my $res = $fbx->refresh_feeds;

download feed items

my $res = $fbx->downloads_feeds({suff=>"1/items"};

update a feed item

my $res = $fbx->upd_feed({suff=>"1/items/6"};

download a feed item

my $res = $fbx->download_feed_item({suff=>"1/items/6/download"};

mark all items as read

my $res = $fbx->mark_all_read({suff=>"1/items/mark_all_as_read"};

add feed

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

update downloads config

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

update throttling

my $res = $res = $fbx->upd_downloads_throttle({throttling => "schedule"});

downloads config

my $res = $fbx->downloads_config;

freeplugs

freeplugs_net

my $res = $fbx->freeplugs_net;

fs

fs tasks

my $res = $fbx->fs_tasks;

fs task

my $res = $fbx->fs_tasks({suff=>"12"});

fs task

my $res = $fbx->upd_task({suff=>"12", state=>"paused"});

list files

my $res = $fbx->list_files({suff=>"/Disque dur/Photos/"});

file info

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

ftp

ftp config

my $res = $fbx->ftp_config;

lan

lan config

my $res = $fbx->lan_config;

lan browser interfaces

my $res = $res = $fbx->lan_browser_interfaces;

lan browser interfaces pub

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

lcd

lcd

my $res = $res = $fbx->lcd;

lcd brightness back

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

nat

fw dmz

my $res = $fbx->fw_dmz;

fw redir

my $res = $fbx->fw_redir;

fw incoming

my $res = $fbx->fw_incoming;

parental

parental config

my $res = $fbx->parental_config;

parental filter

my $res = $fbx->parental_filter;

share

my $res = $fbx->share_link;

upload

my $res = $fbx->upload;

airmedia config

my $res = $fbx->airmedia_config;

airmedia receivers

my $res = $fbx->airmedia_receivers;

shares

netshare samba

my $res = $fbx->netshare_samba;

netshare afp

my $res = $fbx->netshare_afp;

storage

storage disk

my $res = $fbx->storage_disk;

storage partition

my $res = $fbx->storage_partition;

switch

switch status

my $res = $fbx->switch_sts;

system

system

my $res = $fbx->system;

upnp

upnpigd config

my $res = $fbx->upnpigd_config;

upnpigd redir

my $res = $fbx->upnpigd_redir;

upnpav

upnpav

my $res = $fbx->upnpav;

vpn

vpn

my $res = $fbx->vpn;

vpn user

my $res = $fbx->vpn_user;

vpn ip_pool

my $res = $fbx->vpn_ip_pool;

vpn client config

my $res = $fbx->vpn_client_config;

vpn client status

my $res = $fbx->vpn_client_status;

vpn client log

my $res = $fbx->vpn_client_log;

wifi

wifi config

my $res = $fbx->wifi_config;

wifi ap

my $res = $fbx->wifi_ap;

wifi bss

my $res = $fbx->wifi_bss;

wifi planning

my $res = $fbx->wifi_planning;

wifi mac filter

my $res = $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>