Mark Hindess > Device-RFXCOM-1.142010 > Device::W800

Download:
Device-RFXCOM-1.142010.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.142010   Source  

NAME ^

Device::W800 - Module to support W800 RF receiver

VERSION ^

version 1.142010

SYNOPSIS ^

  # for a USB-based device
  my $rx = Device::W800->new(device => '/dev/ttyUSB0');

  $|=1; # don't buffer output

  # simple interface to read received data
  my $timeout = 10; # 10 seconds
  while (my $data = $rx->read($timeout)) {
    print $data->summary,"\n";
  }

  # for a networked device
  $rx = Device::W800->new(device => '10.0.0.1:10001');

DESCRIPTION ^

Module to decode messages from an W800 RF receiver from WGL & Associates.

IMPORTANT: This API is still subject to change.

METHODS ^

new(%parameters)

This constructor returns a new W800 RF receiver object. The only supported parameter is:

device

The name of the device to connect to. The value can be a tty device name or a hostname:port for TCP-based serial port redirection.

The default is /dev/w800 in anticipation of a scenario where a udev rule has been used to identify the USB tty device of the W800.

read_one(\$buffer)

This method attempts to remove a single RF message from the buffer passed in via the scalar reference. When a message is removed a data structure is returned that represents the data received. If insufficient data is available then undef is returned. If a duplicate message is received then 0 is returned.

IMPORTANT: This API is still subject to change.

SEE ALSO ^

Device::RFXCOM::RX

W800 website: http://www.wgldesigns.com/w800.html

AUTHOR ^

Mark Hindess <soft-cpan@temporalanomaly.com>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by Mark Hindess.

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

syntax highlighting: