device::modem::usrobotics(3pm) [debian man page]
Device::Modem::UsRobotics(3pm) User Contributed Perl Documentation Device::Modem::UsRobotics(3pm) NAME
Device::Modem::UsRobotics - USR modems extensions to control self-mode SYNOPSIS
use Device::Modem::UsRobotics; my $modem = new Device::Modem::UsRobotics( port => '/dev/ttyS1' ); $modem->connect( baudrate => 9600 ); my %info = $modem->messages_info(); print "There are $info{unreleased_voice_msg} unread voice messages on $info{stored_voice_msg} total "; print "There are $info{unreleased_fax_msg} unread fax messages on $info{stored_fax_msg} total "; # Get details about message n. X my %msg = $modem->message_info(1); index type information attributes status day hour minute callerid page addresshigh addresslow checksum print 'This is a ', ($msg{type} == 2 ? 'voice' : 'fax'), 'message', " "; print 'It came from no. ', $msg{callerid}, " "; # ... # Now clear all messages $modem->clear_memory(); WARNING
This module is not documented yet, and it is a rough work in progress. Until now, it correctly reads voice/fax messages information, but when saving voice messages to disk, sometimes they are incorrectly decoded. So, if you need a working program, check out the good old TkUsr by Ludovic Drolez, unless you want to help develop Device::Modem::UsRobotics. DOCS TO BE COMPLETED FROM NOW..... Yes, I'm a bad boy :-) DESCRIPTION
Bla Bla Bla... METHODS
clear_memory() Used to permanently clear the memory space of the modem. There are separate memory spaces, one for voice/fax messages and one for user set- tings. Examples: $modem->clear_memory('user'); # or $modem->clear_memory(1) $modem->clear_memory('messages'); # or $modem->clear_memory(2) To clear both, you can use: $modem->clear_memory('all'); # or $modem->clear_memory(0); Parameters: $memtype String or integer that selects the type of memory to be cleared, where 0 is for "all", 1 is for "user" memory, 2 is for "messages" mem- ory. SUPPORT
Please feel free to contact me at my e-mail address cosimo@cpan.org for any information, to resolve problems you can encounter with this module or for any kind of commercial support you may need. AUTHOR
Cosimo Streppone, cosimo@cpan.org COPYRIGHT
(C) 2004-2005 Cosimo Streppone, cosimo@cpan.org This library is free software; you can only redistribute it and/or modify it under the same terms as Perl itself. SEE ALSO
Device::Modem, perl perl v5.8.8 2005-04-30 Device::Modem::UsRobotics(3pm)
Check Out this Related Man Page
Device::Modem::Protocol::Xmodem(3pm) User Contributed Perl Documentation Device::Modem::Protocol::Xmodem(3pm) NAME
Device::Modem::Protocol::Xmodem Xmodem::Block Class that represents a single Xmodem data block. Synopsis my $b = Xmodem::Block->new( 1, 'My Data...<until-128-chars>...' ); if( defined $b ) { # Ok, block instanced, verify its checksum if( $b->verify( 'checksum', <my_chksum> ) ) { ... } else { ... } } else { # No block } # Calculate checksum, crc16, 32, ... $crc16 = $b->crc16(); $crc32 = $b->crc32(); $chksm = $b->checksum(); Xmodem::Buffer Class that implements an Xmodem receive buffer of data blocks. Every block of data is represented by a "Xmodem::Block" object. Blocks can be pushed and popped from the buffer. You can retrieve the last block, or the list of blocks from buffer. Synopsis my $buf = Xmodem::Buffer->new(); my $b1 = Xmodem::Block->new(1, 'Data...'); $buf->push($b1); my $b2 = Xmodem::Block->new(2, 'More data...'); $buf->push($b2); my $last_block = $buf->last(); print 'now I have ', scalar($buf->blocks()), ' in the buffer'; # TODO document replace() function ??? Xmodem::Constants Package that contains all useful Xmodem protocol constants used in handshaking and data blocks encoding procedures Synopsis Xmodem::Constants::soh ........... 'start of header' Xmodem::Constants::eot ........... 'end of trasmission' Xmodem::Constants::ack ........... 'acknowlegded' Xmodem::Constants::nak ........... 'not acknowledged' Xmodem::Constants::can ........... 'cancel' Xmodem::Constants::C ........... `C' ASCII char Xmodem::Constants::XMODEM ........ basic xmodem protocol Xmodem::Constants::XMODEM_1K ..... xmodem protocol with 1k blocks Xmodem::Constants::XMODEM_CRC .... xmodem protocol with CRC checks Xmodem::Constants::CHECKSUM ...... type of block checksum Xmodem::Constants::CRC16 ......... type of block crc16 Xmodem::Constants::CRC32 ......... type of block crc32 Xmodem::Receiver Control class to initiate and complete a "X-modem" file transfer in receive mode Synopsis my $recv = Xmodem::Receiver->new( modem => {Device::Modem object}, filename => 'name of file', XXX protocol => 'xmodem' | 'xmodem-crc', | 'xmodem-1k' ); $recv->run(); Object methods abort_transfer() Sends a cancel char ("can"), that signals to sender that transfer is aborted. This is issued if we receive a bad block number, which usually means we got a bad line. modem() Returns the underlying Device::Modem object. receive_message() Retreives message from modem and if a block is detected it breaks it into appropriate parts. run() Starts a new transfer until file receive is complete. The only parameter accepted is the (optional) local filename to be written. send_ack() Sends an acknowledge ("ack") char, to signal that we received and stored a correct block Resets count of timeouts and returns the "Xmo- dem::Block" object of the data block received. send_timeout() Sends a timeout ("nak") char, to signal that we received a bad block header (either a bad start char or a bad block number), or a bad data checksum. Increments count of timeouts and at ten timeouts, aborts transfer. See also - Device::Modem perl v5.8.8 2005-04-30 Device::Modem::Protocol::Xmodem(3pm)