CPAN release 0.65 (#29)

* module version, dependency on Device::SerialPort

- fixed Perl module version in dist.in
- added missing Perl module dependency on Device::SerialPort to
Makefile.PL to ease installation via CPAN

* skip author test for normal user installs

- disable all author test (manifiest, pod, pod-coverage) for normal user
installs

* UNIX newlines

- use UNIX newlines in .pm files
- trailing whitspaces removed from .pm files

* License clarification, Kwalitee improvements

- resolved conflicting licence information from README and license.txt
introduced by contributor Chris Fedde in 2011.03 to license chosen by
original author Aki Mimoto in 2011.02
- replaced license.txt file with LICENSE file
- added 'use warnings' to all Perl files
- added pod to Firmata.pm

* Fix push on reference in method attach of Device::Firmata::IO::NetIO, POD update

- fix push on reference in method attach of Device::Firmata::IO::NetIO
- added and updated POD

CONTRIBUTING

@@ -0,0 +1 @@
+Anybody willing to contribute is very welcome! Please submit pull-requests against branch 'master' at https://github.com/ntruchsess/perl-firmata.

Changes

@@ -1,15 +1,19 @@
 Revision history for Device-Firmata
 
-0.64    2018.01.03 - Jens Beyer
+0.65    2018.06.09 - Jens B.
+        fix push on reference in method attach of Device::Firmata::IO::NetIO
+        added and updated POD
+
+0.64    2018.01.03 - Jens B.
         support Firmata protocol version 2.5 feature PIN_PULLUP (Constants, Platform, Protocol)
 
-0.63    2016.03.19 - Jens Beyer
+0.63    2016.03.19 - Jens B.
         supported protocol version detection modified (Protocol)
 
-0.62    2016.02.22 - Jens Beyer
+0.62    2016.02.22 - Jens B.
         added software serial support (Platform, Protocol)
 
-0.61    2016.01.09 - Jens Beyer
+0.61    2016.01.09 - Jens B.
         added serial pin support (Platform, Protocol, Constants)
         added protocol version query (Platform)
         fixed messages_handle: REPORT_VERSION returns protocol version (Platform)

LICENSE

@@ -1,10 +1,10 @@
 COPYRIGHT AND LICENSE
 
-Copyright (C) 2010 amimato
-Copyright (C) 2012 ntruchsess
-Copyright (C) 2016 jnsbyr
+Copyright (C) 2010 Aki Mimoto
+Copyright (C) 2012 Norbert Truchsess
+Copyright (C) 2016 Jens B.
 
-This is free software; you can redistribute it and/or modify it under
-the same terms as the Perl 5 programming language system itself.
+This is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
 
 See http://dev.perl.org/licenses/ for more information.

MANIFEST

@@ -1,4 +1,6 @@
 Changes
+CONTRIBUTING
+dist.ini
 environment
 ignore.txt
 LICENSE

MANIFEST.SKIP

@@ -1 +1,2 @@
-^.*~$
+^.*~$
+MANIFEST.SKIP

Makefile.PL

@@ -38,6 +38,7 @@ WriteMakefile(
     },
     META_MERGE => {
         'meta-spec' => { version => 2 },
+         homepage => 'https://github.com/ntruchsess/perl-firmata/',
          resources => {
              repository => {
                  type => 'git',

README

@@ -11,36 +11,43 @@ To install this module, run the following commands:
 	make test
 	make install
 
+
 SUPPORT AND DOCUMENTATION
 
 After installing, you can find documentation for this module with the
 perldoc command.
 
     perldoc Device::Firmata
+
+You will find a web presentation on "Controlling an Arduino with Perl" 
+at file://presentation/index.html.
 
-You can also look for information at:
+The folder "example" holds more than 15 Perl example applications for 
+various Firmata IO implementations incl. I2C and 1-Wire.
 
-    RT, CPAN's request tracker
-        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Device-Firmata
+You can also look for information at:
 
     AnnoCPAN, Annotated CPAN documentation
         http://annocpan.org/dist/Device-Firmata
 
+    Search meta::cpan
+        https://metacpan.org/release/Device-Firmata
+
+    RT, CPAN's request tracker
+        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Device-Firmata
+
     CPAN Ratings
         http://cpanratings.perl.org/d/Device-Firmata
 
-    Search CPAN
-        http://search.cpan.org/dist/Device-Firmata/
-
 
 COPYRIGHT AND LICENSE
 
-Copyright (C) 2010 amimato
-Copyright (C) 2012 ntruchsess
-Copyright (C) 2016 jnsbyr
+Copyright (C) 2010 Aki Mimoto
+Copyright (C) 2012 Norbert Truchsess
+Copyright (C) 2016 Jens B.
 
-This is free software; you can redistribute it and/or modify it under
-the same terms as the Perl 5 programming language system itself.
+This is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
 
 See http://dev.perl.org/licenses/ for more information.
 

dist.ini

@@ -4,7 +4,7 @@ license = Perl_5
 copyright_holder = Aki Mimoto, Norbert Truchsess, Jens B.
 copyright_year = 2010
 
-version = 0.64
+version = 0.65
 
 [GatherDir]
 [MetaYAML]

lib/Device/Firmata.pm

@@ -11,15 +11,17 @@ use Device::Firmata::Base
 
 =head1 NAME
 
-Device::Firmata - Perl interface to Firmata for the arduino platform.
+Device::Firmata - A Perl implementation of the Firmata protocol.
+
+This module allows a computer running Perl to connect to Firmata devices (Arduinos and compatible, including ESP8266), either via serial IO (RS-232, USB, etc.) or TCP/IP (LAN, WiFi). Protocol details can be found at L<https://github.com/firmata/protocol>.
 
 =head1 VERSION
 
-Version 0.64
+Version 0.65
 
 =cut
 
-our $VERSION = '0.64';
+our $VERSION = '0.65';
 our $DEBUG = 0;
 
 
@@ -46,11 +48,11 @@ our $DEBUG = 0;
         sleep 0.5;
     }
 
-=head1 SUBROUTINES/METHODS
+=head1 METHODS
 
-=head2 open(serialPort)
+=head2 open ( serialPort , [opts] )
 
-Establish a serial connection with an Arduino micro-controller. The first argument is the name of the serial device mapped to the arduino, e.g. '/dev/ttyUSB0' or 'COM9'.
+Establish a serial connection with a Firmata device. The first parameter is the name of the serial device connected with the Firmata device, e.g. '/dev/ttyUSB0' or 'COM9'. The second parameter is  an optional hash of parameters for the serial port. The parameter C<baudrate> is supported and defaults to C<57600>. Returns a L<Device::Firmata::Platform> object.
 
 =cut
 
@@ -74,9 +76,9 @@ sub open {
   return $platform;
 }
 
-=head2 listen(host, port)
+=head2 listen ( host, port )
 
-Start a TCP server bound to given local address and port for the arduino to connect to.
+Start a TCP server bound to given local address and port for the Arduino to connect to. Returns a L<Device::Firmata::IO::NetIO> object. An implementation example can be found in file F<examples/example-tcpserver.pl>.
 
 =cut
 
@@ -92,16 +94,26 @@ sub listen {
   return $netio->listen( $ip, $port, $opts ) || die "Could not bind to socket";
 }
 
+=head1 EXAMPLES
+
+In the folder F<examples> you will find more than 15 implementation examples for various Firmata IO operations including digital I/O, PWM, stepper and encoder as well as bus I/O for I2C and 1-Wire.
+
+=head1 SEE ALSO
+
+L<Device::Firmata::Base>
+
 =head1 LICENSE
 
-    Copyright (C) 2010 amimato
-    Copyright (C) 2012 ntruchsess
-    Copyright (C) 2016 jnsbyr
+Copyright (C) 2010 Aki Mimoto
+
+Copyright (C) 2012 Norbert Truchsess
+
+Copyright (C) 2016 Jens B.
 
-    This is free software; you can redistribute it and/or modify it under
-    the same terms as the Perl 5 programming language system itself.
+This is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
 
-    See http://dev.perl.org/licenses/ for more information.
+See http://dev.perl.org/licenses/ for more information.
 
 =cut