File Coverage

blib/lib/GQRX/Remote.pm

Criterion	Covered	Total	%
statement	72	113	63.7
branch	18	40	45.0
condition	4	7	57.1
subroutine	17	22	77.2
pod	0	17	0.0
total	111	199	55.7

package GQRX::Remote;

use IO::Socket::INET;

use warnings;
use strict;

our $VERSION = '1.0.1';


sub new {
    my $class = shift();
    my %options = @_;
    my $self = {
        _connection => undef,  # IO::Socket connection to GQRX
        _last_error => undef,

        # Options definable on init:
        exit_on_error => 0 # When true, exit on any error
    };

    bless ($self, $class);

    foreach (keys %options) {
        $self->{$_} = $options{$_};
    }

    return ($self);
}


sub DESTROY {
    # Automatically disconnect when the object is destroyed
    my ($self) = @_;

    $self->disconnect();
}


sub _set_error {
    my ($self, $error) = @_;

    if ($self->{exit_on_error}) {
        die "GQRX::Remote: ERROR: $error\n";
    }

    $self->{_last_error} = $error;
}


sub error {
    my ($self) = @_;

    return ($self->{_last_error});
}


sub connect {
    my $self = shift();
    my (%option) = @_;
    my $connection;

    if ($self->{_connection}) { # Close any existent connection
        $self->disconnect();
    }

    $connection = new IO::Socket::INET(
        PeerHost => $option{host} || '127.0.0.1',
        PeerPort => $option{port} || 7356,
        Proto => 'tcp'
        );

    if (! $connection) {
        $self->_set_error("Failed to establish connection to gqrx: $@");
        return (undef);
    }

    $self->{_connection} = $connection;

    return (1);
}


sub disconnect {
    my ($self) = @_;

    if ($self->{_connection} && $self->{_connection}->connected()) {
        $self->{_connection}->send("c\n"); # Send the close command to the server
        $self->{_connection}->close();
    }

    $self->{_connection} = undef;
}


sub read_line {
    my ($self) = shift();
    my $buf;

    if (! $self->{_connection}->connected()) {
        $self->_set_error("Connection lost");
        return (undef);
    }

    $buf = $self->{_connection}->getline();

    if (! defined($buf)) {
	return (undef);
    }
    else {
	chomp($buf);
	return ($buf);
    }
}


sub command {
    my $self = shift();
    my $command = shift();
    my (%opt) = @_;
    my $buf;

    if (! $self->{_connection}) {
        $self->_set_error("Failed to send: Not connected");
        return (undef);
    }
    elsif (! $self->{_connection}->connected()) {
        $self->_set_error("Failed to send: Connection lost");
        return (undef);
    }

    $self->{_connection}->send($command . "\n");

    return ($self->read_line(%opt));
}


sub set_frequency {
    my ($self, $frequency) = @_;
    my $response = $self->command("F $frequency");

    if (! defined($response)) {
        return (undef);
    }
    elsif ($response ne 'RPRT 0') {
        $self->_set_error("Set frequency failed. Unexpected response: $response");
        return (undef);
    }

    return (1);
}


sub get_frequency {
    my ($self) = @_;

    return ($self->command("f"));
}


sub set_demodulator_mode {
    my ($self, $mode) = @_;
    my $response = $self->command("M $mode");

    if (! defined($response)) {
        return (undef);
    }
    elsif ($response ne 'RPRT 0') {
        $self->_set_error("Set demodulator mode failed. Unexpected response: $response");
        return (undef);
    }

    return (1);
}


sub get_demodulator_mode {
    my ($self) = @_;

    return ($self->command("m"));
}


sub get_signal_strength {
    my ($self) = @_;

    return ($self->command("l STRENGTH"));
}


sub get_squelch_threshold {
    my ($self) = @_;

    return ($self->command("l SQL"));
}


sub set_squelch_threshold {
    my ($self, $level) = @_;
    my $response = $self->command("L SQL $level");

    if (! defined($response)) {
        return (undef);
    }
    elsif ($response ne 'RPRT 0') {
        $self->_set_error("Set demodulator mode failed. Unexpected response: $response");
        return (undef);
    }

    return (1);
}


sub get_recorder_status {
    my ($self) = @_;

    return ($self->command("u RECORD"));
}


sub set_recorder_status {
    my ($self, $status) = @_;
    my $response = $self->command("U RECORD $status");


    if (! defined($response)) {
        return (undef);
    }
    elsif ($response ne 'RPRT 0') {
        $self->_set_error("Failed to set recorder state.  Unexpected response: $response");
        return (undef);
    }

    return (1);
}


sub start_recording {
    my ($self) = @_;
    my $response = $self->command("AOS");

    if (! defined($response)) {
        return (undef);
    }
    elsif ($response ne 'RPRT 0') {
        $self->_set_error("Failed to start recording.  Unexpected response: $response");
        return (undef);
    }

    return (1);
}


sub stop_recording {
    my ($self) = @_;
    my $response = $self->command("LOS");

    if (! defined($response)) {
        return (undef);
    }
    elsif ($response ne 'RPRT 0') {
        $self->_set_error("Failed to stop recording.  Unexpected response: $response");
        return (undef);
    }

    return (1);
}


1;


__END__