WWW::FBX::Role::API::APIv3 - Freebox API v3
with 'WWW::FBX::Role::API::APIv3';
WWW::FBX::Role::API::APIv3 is the freebox6 API version 3 as a Moose Role
API documentation is given here: http://dev.freebox.fr/sdk/os/ The following methods are currently implemented in this library:
$fbx->rrd( { db => "temp", fields => [ "cpub" ], precision => 1 } );
$fbx->call_log;
$fbx->contact;
$res = $fbx->connection;
$res = $fbx->connection_config;
$fbx->connection_ipv6_config;
$fbx->connection_xdsl;
$fbx->connection_ftth;
$res = $fbx->upd_connection({ping=>\1});
$res = $fbx->upd_ipv6_config({ipv6_enabled=>\0});
$res = $fbx->connection_dyndns("noip/status");
$res = $fbx->upd_connection_dyndns("noip/status", {enabled=>\0});
$fbx->dhcp_config;
$fbx->dhcp_static_lease;
$fbx->dhcp_dynamic_lease;
$fbx->downloads;
$fbx->downloads_config;
$fbx->downloads_stats;
$fbx->downloads_feeds;
$res = $fbx->downloads_config;
$res = $fbx->get_download_task;
$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"} );
$res = $fbx->upd_downloads_config({max_downloading_tasks => $max_dl_tasks});
$res = $fbx->upd_downloads_throttle( "schedule" );
$res = $fbx->get_download_task( $id );
$res = $fbx->get_download_task( "$id/log" );
$fbx->upd_download_task( $id, { io_priority => "high" } );
$res = $fbx->get_download_task("$id/files") ;
$res = $fbx->change_prio_download_file( "$id/files/$id_file", { priority=>"high"} );
$res = $fbx->del_download_task( $id );
$res = $fbx->add_download_task_file( {download_file => [ "mine/debian-8.4.0-arm64-netinst.iso.torrent" ] });
$res = $fbx->get_download_task( "$id/trackers");
$res = $fbx->get_download_task( "$id/peers");
$fbx->del_download_task( "$id/erase" );
$res = $fbx->downloads_feeds;
$res = $fbx->add_feed( "http://www.esa.int/rssfeed/Our_Activities/Space_News" );
$fbx->upd_feed( $id , {auto_download=> \1} );
$res = $fbx->downloads_feeds("$id/items");
$fbx->refresh_feed( "$id/fetch" );
$fbx->refresh_feeds;
$fbx->downloads_feeds("$id/items");
$fbx->upd_feed("$id/items/$id_file");
$fbx->download_feed_item("$id/items/$id_file/download");
$fbx->mark_all_read( "$id/items/mark_all_as_read" );
$fbx->del_feed( $id );
$res = $fbx->download_file( "Disque dur/Photos/cyril/DSCF4322.JPG" );
$res = $fbx->download_file( "Disque dur/Photos/cyril/DSCF4321.JPG" );
$res = $fbx->upload_auth( {upload_name => "DSCF4322.JPG", dirname => "/Disque dur/"} );
$res = $fbx->upload_file( {id=> $res->{id}, filename=>"DSCF4322.JPG"});
$res = $fbx->upload_file( {filename => "DSCF4321.JPG", dirname => "/Disque dur/"} );
$fbx->freeplugs_net;
$fbx->freeplugs_net("F4:CA:E5:1D:46:AE");
$fbx->reset_freeplug("F4:CA:E5:1D:46:AE");
$fbx->fs_tasks;
$fbx->fs_tasks(12);
$fbx->del_task(12);
$fbx->upd_task(12, state=>"paused"});
$res = $fbx->list_files("Disque dur/");
$res = $fbx->file_info("Disque dur/Photos/Sydney/DSCF4323.JPG");
$res = $fbx->mv( {files=>[ qw/a.txt b.txt/ ], dst => "/Disque dur/directory", mode => "overwrite" } );
$res = $fbx->cp( {files=>[ qw/a.txt b.txt/ ], dst => "/Disque dur/directory", mode => "overwrite" } );
$res = $fbx->archive( {files=>[ qw/a.txt b.txt/ ], dst => "/Disque dur/archive.zip", mode => "overwrite" } );
$res = $fbx->rm( {files=>[ qw/a.txt b.txt/ ] } );
$res = $fbx->cat( {files=>[ qw/a.txt b.txt/ ], dst=>"/Disque dur/file", multi_volumes=\0, delete_files=>\0, append=>\1, overwrite=>\0 } );
$res = $fbx->cat( { src => "foo.iso", dst=>"/Disque dur/directory", password =>"", delete_archive=>\0, overwrite=>\0 } );
$res = $fbx->repair( { src => "foo.iso.par2", delete_archive=>\0 } );
$res = $fbx->hash( { src => "foo.iso", hash_type=>"md5" } );
$res = $fbx->mkdir( { parent => "/Disque dur/", dirname => "directory" } );
$res = $fbx->rename( { src => "/Disque dur/a.txt", dst => "b.txt' } );
$res = $fbx->download_file("Disque dur/Photos/cyril/DSCF4322.JPG");
$fbx->ftp_config;
$res = $fbx->lan_config;
$res = $fbx->lan_browser_interfaces;
$res = $fbx->list_hosts( $net );
$res = $fbx->list_hosts("$net/$id");
$res = $fbx->upd_host("$net/$id", { id => $id , host_type => "networking_device" });
$res = $fbx->upd_lan_config( {mode=>"router"} );
$res = $fbx->wol_host( $net, {mac => "B8:27:EB:73:8C:4E"} );
$res = $fbx->lcd;
$fbx->set_lcd({ brightness => $res->{brightness} });
$fbx->fw_dmz;
$fbx->fw_redir;
$fbx->fw_redir(0);
$fbx->fw_incoming;
$fbx->fw_incoming("bittorent-main");
$fbx->parental_config;
$fbx->parental_filter;
$fbx->share_link;
$fbx->upload;
$fbx->upload(1);
$fbx->airmedia_config;
$fbx->airmedia_receivers;
$res = $fbx->netshare_samba;
$fbx->netshare_afp;
$fbx->storage_disk;
$fbx->storage_partition;
$res = $fbx->switch_sts;
$res = $fbx->switch_port(1);
$res = $fbx->switch_port("1/stats/");
$res = $fbx->set_switch_port(1 , {duplex=>"auto"} );
$fbx->system;
$fbx->reboot;
$fbx->upnpigd_config;
$fbx->upnpigd_redir;
$res=$fbx->upnpav;
$fbx->set_upnpav($res->{enabled});
$fbx->vpn;
$fbx->vpn_user;
$fbx->vpn_ip_pool;
$fbx->vpn_client_config;
$fbx->vpn_client_status;
$fbx->vpn_client_log;
$fbx->wifi_config;
$fbx->wifi_ap;
$fbx->wifi_ap(0);
$fbx->wifi_ap( "0/allowed_channel_comb" );
$fbx->wifi_ap( "0/stations" );
$fbx->wifi_ap( "0/neighbors" );
$fbx->wifi_ap( "0/channel_usage" );
$fbx->wifi_bss;
$fbx->wifi_bss( "00:24:D4:AA:BB:CC" );
$fbx->wifi_planning;
$fbx->wifi_mac_filter;
Copyright (C) Laurent Kislaire.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Laurent Kislaire <teebeenator@gmail.com>
To install WWW::FBX, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WWW::FBX
CPAN shell
perl -MCPAN -e shell install WWW::FBX
For more information on module installation, please visit the detailed CPAN module installation guide.