@@ -1,7 +1,7 @@ # http://module-build.sourceforge.net/META-spec.html #XXXXXXX This is a prototype!!! It will change in the future!!! XXXXX# name: ElkM1-Control -version: 0.02 +version: 0.1.0 version_from: lib/ElkM1/Control.pm installdirs: site requires: META.yml @@ -107,7 +107,7 @@ my $UNIT_PARAM = { description => 'an unit code from 1..16' }; -our $VERSION = '0.02'; +our $VERSION = '0.1.0'; =head1 METHODS lib/ElkM1/Control.pm @@ -1,12 +1,10 @@ package ElkM1::Control::Message::EthernetModuleTest; +# MessageType: 'XK' + use base ElkM1::Control::Message; -use Carp; -use warnings; use strict; -# MessageType: 'XK' - =head1 NAME ElkM1::Control::Message::EthernetModuleTest; @@ -15,21 +13,58 @@ ElkM1::Control::Message::EthernetModuleTest; =head1 SYNOPSIS - my $msg = $elk->readMessage; - - print "EthernetModuleTest is ".$msg->getString" - if (ref($msg) eq 'ElkM1::Control::Message::EthernetModuleTest') + my $elk = ElkM1::Control->new(host => '192.168.1.115'); + my $msg = $elk->readMessage(); +# TODO - finish this synopsis. +# =cut =head1 DESCRIPTION -This is the subclass of the L<ElkM1::Control::Message> object which represents the 'Ethernet Module Test' message -from the ElkM1 control. This message is sent in response to an ethernet module every 30 seconds. The reply -contains the current date and time of the ElkM1 panel. DO NOT REPLY TO THIS MESSAGE. +This is the subclass of the L<ElkM1::Control::Message> object which represents +the 'Ethernet Module Test' message from the ElkM1 control. This message is sent +every 30 seconds to test any M1XEP Ethernet module installed in the system. + +This object is usually instantiated via the MessageFactory object when a message +is read. One wouldn't normally instantiate this object directly. + +=cut -This object is usually instantiated via the MessageFactory object when a message is read. One wouldn't normally -instantiate this object directly. +# Hash to turn a day of week into a name. +my %DAY_OF_WEEK = ( 1 => 'Sunday', + 2 => 'Monday', + 3 => 'Tuesday', + 4 => 'Wednesday', + 5 => 'Thursday', + 6 => 'Friday', + 7 => 'Saturday' ); + +# Hash to turn a month into a name. +my %MONTH = ( 1 => 'January', + 2 => 'February', + 3 => 'March', + 4 => 'April', + 5 => 'May', + 6 => 'June', + 7 => 'July', + 8 => 'August', + 9 => 'September', + 10 => 'October', + 11 => 'November', + 12 => 'December' ); + +# Hash to turn clock mode into a name. +my %CLOCK_MODE = ( 0 => '24', + 1 => '12' ); + +# Hash to turn DST mode into a name. +my %DST_MODE = ( 0 => 'Inactive', + 1 => 'Active' ); + +# Hash to turn Date mode into a name. +my %DATE_MODE = ( 0 => 'MM/DD', + 1 => 'DD/MM' ); =head1 METHODS @@ -37,15 +72,171 @@ instantiate this object directly. =cut -=item $msg->getString() +=item $msg->getSeconds + +Obtain the seconds value for the test. + +=cut + +sub getSeconds { + my $self = shift; + return substr($self->command,2,2); +} + +=item $msg->getMinutes + +Obtain the minutes value for the test. + +=cut + +sub getMinutes { + my $self = shift; + return substr($self->command,4,2); +} + +=item $msg->getHour + +Get the hour of the test. + +=cut + +sub getHour { + my $self = shift; + return substr($self->command,6,2); +} + +=item $msg->getDayOfWeekValue + +Get the test's day of the week. + +=cut + +sub getDayOfWeekValue { + my $self = shift; + return int(substr($self->command,8,1)); +} + +=item $msg->getDayOfWeek -Just get the data portion of the message for display in the toString method. +Get the name of the day of the week for the test. (ie: Monday, or Friday, etc) =cut -sub getString { +sub getDayOfWeek { my $self = shift; - return substr($self->command,4,18); + return $DAY_OF_WEEK{$self->getDayOfWeekValue}; +} + +=item $msg->getDay + +Get the day of the month for the test. + +=cut + +sub getDay { + my $self = shift; + return int(substr($self->command,9,2)); +} + +=item $msg->getMonthValue + +Get the test's value of the month. +01 = Jan, 02 = Feb, etc. + +=cut + +sub getMonthValue { + my $self = shift; + return int(substr($self->command,11,2)); +} + +=item $msg->getMonth + +Get the name of the month for the test. + +=cut + +sub getMonth { + my $self = shift; + return $MONTH{$self->getMonthValue}; +} + +=item $msg->getYear + +Get the year of the test as an integer. (ie. 05 = 2005). +Add this number to 2000 to get the correct year. + +=cut + +sub getYear { + my $self = shift; + int(substr($self->command,13,2)); +} + +=item $msg->getDSTValue + +Get the Daylight Saving Time (DST) flag (0=Inactive, 1=Active). + +=cut + +sub getDSTValue { + my $self = shift; + return substr($self->command,15,1); +} + +=item $msg->getDST + +Get the Daylight Saving Time (DST) status. + +=cut + +sub getDST { + my $self = shift; + return $DST_MODE{$self->getDSTValue}; +} + +=item $msg->getClockModeValue + +Get the clock's display mode value (0=24 hour, 1=12 hour). + +=cut + +sub getClockModeValue { + my $self = shift; + return substr($self->command,16,1); +} + +=item $msg->getClockMode + +Get the clock's display mode. + +=cut + +sub getClockMode { + my $self = shift; + return $CLOCK_MODE{$self->getClockModeValue}; +} + +=item $msg->getDateModeValue + +Get the date's display mode value (0=MM/DD, 1=DD/MM). + +=cut + +sub getDateModeValue { + my $self = shift; + return substr($self->command,17,1); +} + +=item $msg->getDateMode + +Get the date's display mode. + +=cut + +sub getDateMode { + my $self = shift; + return $DATE_MODE{$self->getDateModeValue}; } =item toString @@ -56,7 +247,15 @@ Return a string which represents the status of this message in a human readable sub toString { my $self = shift; - return "EthernetModuleTest: string=".$self->getString; + + "EthernetModuleTest: time=".$self->getHour.':'.$self->getMinutes.':'.$self->getSeconds. + " dayofweek=".$self->getDayOfWeek.' ('.$self->getDayOfWeekValue.')'. + " month=".$self->getMonth. + " day=".$self->getDay. + " year=".$self->getYear. + " DST=".$self->getDST. + " clock_mode=".$self->getClockMode. + " date_mode=".$self->getDateMode; } =head1 VERSION @@ -73,7 +272,8 @@ L<ElkM1::Control>, L<ElkM1::Control::Message>, L<ElkM1::Control::MessageFactory> =head1 AUTHOR -Karl Smith +Taras Dejneka 2007-11-18 +based on work by James Russo =cut lib/ElkM1/Control/Message/EthernetModuleTest.pm @@ -34,6 +34,7 @@ our %DISPATCH_MAP = ( 'PC' => 'ElkM1::Control::Message::PLCChangeUpdate', 'ZV' => 'ElkM1::Control::Message::ZoneAnalogVoltageReply', 'XK' => 'ElkM1::Control::Message::EthernetModuleTest', + 'PS' => 'ElkM1::Control::Message::PLCStatusReply', ); =head1 METHODS lib/ElkM1/Control/MessageFactory.pm af4342265cc583b6330079dc2e5d25b0743c7aa4 a518f66a875af068813000ff4135dc6d6c33e131 Karl Smith threadhead@gmail.com http://github.com/threadhead/elkm1--control/commit/34fa83c4cf29621c0212489792211da30dfe4648 34fa83c4cf29621c0212489792211da30dfe4648 2009-02-03T22:44:46-08:00 2009-02-03T22:44:46-08:00 fixing merge conflict 84a14a9e3d855762f1db1cd886b8e5f69e3e513b Karl Smith threadhead@gmail.com