Andy Smith > Ham-Fldigi-0.02 > Ham::Fldigi::Client

Download:
Ham-Fldigi-0.02.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.002   Source  

NAME ^

Ham::Fldigi::Client - Perl extension for communicating with Fldigi.

SYNOPSIS ^

  use Ham::Fldigi;
  my $f = new Ham::Fldigi;
        my $c = $f->client('Hostname' => 'localhost',
                                                                                 'Port' => '7362',
                                                                                 'Name' => 'example');

        $c->command('fldigi.version');

DESCRIPTION ^

This module is for communicating with individual Fldigi instances.

It uses Fldigi's XMLRPC service, which usually runs on localhost:7362, providing support for it has been compiled in.

EXPORT

None by default.

CONSTRUCTORS ^

Client->new('Hostname' => hostname, 'Port' => port, 'Name' => name)

Creates a new Ham::Fldigi::Client object with the specified arguments. By default, 'localhost' and '7362' are assumed for Hostname and Port respectively. Name is for use with Ham::Fldigi::Shell, and can be safely left blank.

METHODS ^

Client->command(command, [arguments])

Send command command, with optional arguments arguments.

Client->version

Query for the version of Fldigi.

Client->send("text")

Clears the TX window of any existing text, adds the text passed as text, and then transmits. It automatically adds a '^r' at the end to tell Fldigi to switch back to RX afterwards.

SEE ALSO ^

The source code for this module is hosted on Github at https://github.com/m0vkg/Perl-Ham-Fldigi.

AUTHOR ^

Andy Smith M0VKG, <andy@m0vkg.org.uk>

COPYRIGHT AND LICENSE ^

Copyright (C) 2012 by Andy Smith

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.12.4 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: