/ 
Device-RFXCOM-1.110471
River stage one • 1 direct dependent • 1 total dependent
/ Device::RFXCOM::Response

NAME

Device::RFXCOM::Response - Device::RFXCOM::Response class for data from RFXCOM receiver

VERSION

version 1.110471

SYNOPSIS

# see Device::RFXCOM::RX

DESCRIPTION

Base class for RFXCOM response modules.

METHODS

new(%params)

This constructor returns a new response object.

type()

This method returns the type of the response. It will be one of:

unknown

for a message that could not be decoded

version

for a response to a version check request

mode

for a response to a mode setting request

empty

for an empty message

or it will be a string representing the type of device from which the message originated.

header_byte()

This method returns the header byte contains the length in buts and master/slave flag for the message.

master()

This method returns true of the message originated from the master receiver or false of it originated from a slave receiver.

hex_data()

This method returns a hex string representing the payload of the RF message.

data()

This method returns the binary string of the payload of the RF message.

length()

This method returns the length of the payload of the RF message (in bytes).

bytes()

This method returns an array reference of bytes representing the payload of the RF message.

messages()

This method returns an array reference of message objects generated from the payload.

duplicate()

This method returns a true value if the message was identical to another sent recently.

summary()

This method returns a string summary of the contents of the RF message. (If there are multiple message objects produced from the payload then this may be a multiline string.)

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

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

AUTHOR

Mark Hindess <soft-rfxcom@temporalanomaly.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 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.