Mark Hindess

NAME

AnyEvent::RFXCOM::TX - AnyEvent module for an RFXCOM transmitter

VERSION

version 1.142240

SYNOPSIS

  # Create simple RFXCOM message reader with logging callback
  my $tx = AnyEvent::RFXCOM::TX->new(device => '/dev/ttyUSB0');

  # transmit an X10 RF message
  my $cv = $tx->transmit(type => 'x10', command => 'on', device => 'a1');

  # wait for acknowledgement from transmitter
  $cv->recv;

DESCRIPTION

AnyEvent module for handling communication with an RFXCOM transmitter.

METHODS

new(%params)

Constructs a new AnyEvent::RFXCOM::TX object. The supported parameters are:

device

The name of the device to connect to. The value can be a tty device name or a hostname:port for TCP-based RFXCOM transmitters. The default is /dev/rfxcom-tx. See Device::RFXCOM::TX for more information.

receiver_connected

This parameter should be set to a true value if a receiver is connected to the transmitter.

flamingo

This parameter should be set to a true value to enable the transmission for "flamingo" RF messages.

harrison

This parameter should be set to a true value to enable the transmission for "harrison" RF messages.

koko

This parameter should be set to a true value to enable the transmission for "klik-on klik-off" RF messages.

x10

This parameter should be set to a false value to disable the transmission for "x10" RF messages. This protocol is enable by default in keeping with the hardware default.

There is no option to enable homeeasy messages because they use either the klik-on klik-off protocol or homeeasy specific commands in order to trigger them.

cleanup()

This method attempts to destroy any resources in the event of a disconnection or fatal error. It is not yet implemented.

THANKS

Special thanks to RFXCOM, http://www.rfxcom.com/, for their excellent documentation and for giving me permission to use it to help me write this code. I own a number of their products and highly recommend them.

SEE ALSO

AnyEvent(3)

RFXCOM website: http://www.rfxcom.com/

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.