Ruby-iFP API Reference

Module Methods

> version = IFP.version

Returns the version in an array.
You can convert it to a readable form like this:

> IFP.version.join(".")


Module Constants

> IFP::FM_STATIONS

Returns number of FM stations the device can store.

> IFP::FREQ_MIN

The lowest frequency possible.

> IFP::FREQ_MAX

The highest frequency possible.

Main Class

Creating a new IFP::Player class:

> require 'ifp'
> player = IFP::Player.new


Raises an Interrupt exception if device is busy or not responding.

Class Methods

> IFP::Player.capacity

Returns player's capacity in bytes.

> IFP::Player.free_space

Returns free space on player in bytes.

> IFP::Player.firmver

Returns raw version integer.

> IFP::Player.battery_state

Returns an integer between 1 and 4 depending on battery status.

> IFP::Player.model

Returns model string.

> IFP::Player.rename(oldName, newName)

Renames file with 'oldName' to 'newName'.
Returns true if successful, false if not.

> IFP::Player.remove_file(file)

Returns true if 'file' has been removed successfully
from player.
Raises IOError if not.

> IFP::Player.entries(dir) {|name, size, type| }

Use the block to collect entries of 'dir' and metadata.
Returns true or false.

> IFP::Player.download_file(src, dest) {|name, bytesDone, bytesTotal, filesDone, filesTotal| }

Downloads 'src' to 'dest'. Use block for
metadata.
Raises IOError on failure.

> IFP::Player.upload_file(src, dest) {|name, bytesDone, bytesTotal, filesDone, filesTotal| }

Uploads 'src' to 'dest'. Use block for
metadata.
Raises IOError on failure.

> IFP::Player.download_dir(src, dest) {|name, bytesDone, bytesTotal, filesDone, filesTotal| }

Downloads 'src' to 'dest'. Use block for
metadata.
Raises IOError on failure.

> IFP::player.upload_dir(src, dest) {|name, bytesDone, bytesTotal, filesDone, filesTotal| }

Uploads 'src' to 'dest'. Use block for
metadata.
Raises IOError on failure.

> IFP::Player.mkdir(dir)

Creates 'dir' on device.
Returns true if successful,
raises IOError if not.

> IFP::Player.rmdir(dir)

Removes 'dir' from device.
Returns true if successful,
raises IOError if not.

> IFP::Player.file?(file)

Returns true if 'file' exists false if not.

> IFP::Player.directory?(dir)

Returns true if 'dir' exists false if not.

> IFP::Player.exists?(file)

Returns true if 'file' exists false if not.

> IFP::Player.treewalk_dirs(dir) {|path, size, type|}

Recursively iters through 'dir'.
Use block to collect files.

> IFP::Player.get_station(n)

Returns an array holding the callsign and frequency of
radio station #n.

> IFP::Player.set_station(n, callsign, freq)

Set radio station #n with label 'callsign' and frequency 'freq'.