Jonathan Cline > Robotics > Robotics::Fialab::Serial

Download:
Robotics-023/Robotics-0.23.tar.bz2

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.23   Source  

NAME ^

Robotics::Fialab::Serial - (Internal module) Software-to-Serial interface for Fialab Serial or USB-Serial on Unix/Win32 for controlling robotics hardware

VERSION ^

Version 0.23

SYNOPSIS ^

Serial and USB-Serial software interface support for Robotics::Fialab. In Perl Robotics environment, the Robotics modules use this module to send hardware commands through a Serial port to the physical hardware.

This module is only useful in the framework of other Robotics modules. It probably should not be used on it's own.

EXPORT ^

FUNCTIONS ^

new

FUNCTIONS ^

probe

Probe the local machine for a Serial port to communicate with as a software-hardware interface.

Finds the port only, does not find hardware (look at hardware modules for that part).

Returns:

Hash, with key:value as follows: key="Fialab-Microsia", value="not-started:name:token" or "ok:name:token" where name is the application-usable alias to use for new()'s "unit" parameter, and token is an internal reference for low level software.

open

(Internal function) Do not call

Open communication to Serial software<->hardware interface

AUTHOR ^

Jonathan Cline, <jcline at ieee.org>

BUGS ^

Please report any bugs or feature requests to bug-robotics at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Robotics. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Robotics::Fialab::Serial

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2009 Jonathan Cline.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: