File Coverage

blib/lib/Device/WH1091.pm

Criterion	Covered	Total	%
statement	1	3	33.3
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	2	4	50.0

package Device::WH1091;

use Inline C => DATA => LIBS => '-lusb';
use strict;

BEGIN {
    use Exporter ();
    use vars qw($VERSION $VENDOR_ID $PRODUCT_ID $CONFIG_NO $INTERFACE_NO
    				$INTERFACES_NUM $REQTYPE $REQ $VAL $GET_SIZE $TIMEOUT
    				@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS
    				);
    $VERSION     = '0.03';
    @ISA         = qw(Exporter);
    #Give a hoot don't pollute, do not export more than needed by default
    @EXPORT      = qw();
    @EXPORT_OK   = qw();
    %EXPORT_TAGS = ();
    $VENDOR_ID = 0x1941;
	$PRODUCT_ID = 0x8021;

	$CONFIG_NO = 1;
	$INTERFACE_NO = 0;

	$INTERFACES_NUM = 2;

	$REQTYPE = 0xA1;

	$REQ = 0x1;
	$VAL = 0x300;
	$GET_SIZE = 8;
	$TIMEOUT = 500;


}

sub new
{
	my ($class, %parameters) = @_;
	my $self = bless ({}, ref ($class) || $class);
	$self->{'error'} = undef;
	$self->{'data'} = undef;

	return $self;
}


sub error {
	my $self = shift;
	return $self->{'error'};
}


sub DESTROY {
	my $self = shift;

	if($self->{'dev'}) {
		$self->{'dev'}->release_interface($INTERFACE_NO);

	}
}


sub getdata {

	my $self = shift;

	my $buffer2;
	my $current={};
	my @dir = ['N','NNE','NE','ENE','E','SEE','SE','SSE','S','SSW','SW','WSW','W','WNW','NW','NNW'];

	getweather($buffer2);

	$self->{tindoor} = (get_bufferval($buffer2,242,243)) / 10 ;
	$self->{toutdoor} = (get_bufferval($buffer2, 245, 246) ) / 10;
	$self->{hindoor} = get_bufferval($buffer2, 241);
	$self->{houtdoor} = get_bufferval($buffer2, 244);
	$self->{windspeed} = get_bufferval($buffer2, 249)/10;
	$self->{windgust} = get_bufferval($buffer2, 250)/10;
	$self->{winddir} = get_bufferval($buffer2, 252) * 22.5;
	$self->{winddirtext} = $dir[$self->{winddir}];
	$self->{pressure} = get_bufferval($buffer2, 247, 248)/10;
	$self->{raintot} = get_bufferval($buffer2,253,254) * 3 / 10;
	return 1;

}




sub get_bufferval {

	my $buffer = shift;
	my $byte1 = shift;
	my $byte2 = shift;


	my $ret = ord(substr($buffer,$byte1,1));
	if( defined $byte2 ) {
		$ret = $ret + ord(substr($buffer,$byte2,1)) *256;
	}
	return $ret;
}






=head1 NAME

Device::WH1091 - Access data from the WH1081/1091 weather station.

=head1 SYNOPSIS

  use Device::WH1091;
  my $weather=Device::WH1091->new();

  $weather->getdata();


  my $tindoor = $weather->{tindoor}; 		# Indoor Temp
  my $toutdoor = $weather->{toutdoor}; 		# Outdoor Temp
  my $hindoor = $weather->{hindoor};		# Indoor Humidity
  $houtdoor = $weather->{houtdoor};			# OutDoor Humidity
  $windspeed = $weather->{windspeed};		# WindSpeed (m/s)
  $windgust = $weather->{windgust};			# Wind Gust (m/s)
  $winddir = $weather->{winddir};			# Wind Direction Degrees
  $winddirtext = $weather->{winddirtext};	# Wind Direction Text
  $pressure = $weather->{pressure};			# Air Pressure
  $raintot = $weather->{raintot};			# Total Rain

=head1 DESCRIPTION

Provides an interface to the WH1081/WH1091 weather stations (and others based on the same hardware).

Requires libusb to be installed so essentially limited at this stage to Linux/Unix platforms that have libusb.
Currently, the usb code is inlined C, however this will bechanging to Perl USB at some stage so that this platform dependency is removed.


=head1 USAGE

Instatiate an instance by call WH1091->new();

Whenever you want data, call getdata() and the object variables mention in the SYNOPSIS will be populated.
When you want more data, call getdata() again.

Be aware that the usb weather station only gets wireless updates from the weather head every 30 seconds, so polling more often than that would be pointless.

=head1 BUGS

I am still not 100% confident with the rain data. Your mileage may vary.

I have had this running a continuous loop getting data on an NSLU2 with openwrt for over three months now.

=head1 AUTHOR

    David Peters
    CPAN ID: DAVIDP
    [e-mail]
    http://www.electronf.com

=head1 COPYRIGHT

This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the
LICENSE file included with this module.


=head1 SEE ALSO

perl(1).

=cut

#################### main pod documentation end ###################


1;




__DATA__