CPAN release 0.69 (#32)

- fix analog input pin operations in Device::Firmata::Platform - added IO::SerialIO::close() - POD updated - dist.ini and ignore.txt removed Co-authored-by: Christian <[email protected]>
ntruchsess · Jun 1, 2020 · e18b27d · e18b27d
1 parent f41b681
commit e18b27d
Show file tree

Hide file tree

Showing 17 changed files with 469 additions and 214 deletions.
diff --git a/Changes b/Changes
@@ -1,5 +1,19 @@
 Revision history for Device-Firmata
 
+0.69    2020.06.01 - Jens B.
+        - fix analog channel mapping in method pin_mode, analog_read and observe_analog of Device::Firmata::Platform
+        - added method close() to Device::Firmata::IO::SerialIO
+        - added and updated POD
+
+0.68    2020.06.01 - Jens B.
+        - dist preparation
+
+0.67    2020.05.31 - Jens B.
+        - dist preparation
+
+0.66    2020.05.31 - Jens B.
+        - dist preparation
+
 0.65    2018.06.09 - Jens B.
         fix push on reference in method attach of Device::Firmata::IO::NetIO
         added and updated POD

diff --git a/MANIFEST b/MANIFEST
@@ -1,82 +1,79 @@
 Changes
 CONTRIBUTING
-dist.ini
 environment
-ignore.txt
-LICENSE
-Makefile.PL
-MANIFEST
-README
-t/00-load.t
-t/boilerplate.t
-t/manifest.t
-t/pod.t
-t/pod-coverage.t
-lib/Device/Firmata/Platform/Arduino.pm
+examples/example-blink.pl
+examples/example-callbacks.pl
+examples/example-i2c.pl
+examples/example-matrix-draw.pl
+examples/example-matrix-time.pl
+examples/example-matrix-time2.pl
+examples/example-matrix.pl
+examples/example-onewire-alarms.pl
+examples/example-onewire.pl
+examples/example-pwm.pl
+examples/example-tcpserver.pl
+examples/example_DHT11.pl
+examples/example_encoder.pl
+examples/example_stepper.pl
+examples/test.pl
+lib/Device/Firmata.pm
 lib/Device/Firmata/Base.pm
 lib/Device/Firmata/Constants.pm
-lib/Device/Firmata/Language.pm
-lib/Device/Firmata/Platform.pm
 lib/Device/Firmata/Error.pm
-lib/Device/Firmata/Protocol.pm
 lib/Device/Firmata/IO/NetIO.pm
 lib/Device/Firmata/IO/SerialIO.pm
-lib/Device/Firmata.pm
-presentation/index.html
-presentation/scripts/jquery.js
-presentation/scripts/global.js
-presentation/scripts/jquery.presentation.js
-presentation/scripts/dd_roundies.js
-presentation/scripts/jquery.presentation-full.js
-presentation/images/HT1632-spec-8.png
-presentation/images/HappySkies.png
-presentation/images/HT1632-spec-4.png
-presentation/images/HT1632-spec-5.png
+lib/Device/Firmata/Language.pm
+lib/Device/Firmata/Platform.pm
+lib/Device/Firmata/Platform/Arduino.pm
+lib/Device/Firmata/Protocol.pm
+LICENSE
+Makefile.PL
+MANIFEST			This list of files
+MANIFEST.SKIP
 presentation/images/ArduinoDuemilanove.png
-presentation/images/HT1632-spec-19.png
-presentation/images/sureelectronics-32x8matrix-back2.png
-presentation/images/HT1632-spec-16.png
-presentation/images/HT1632-spec-6.png
-presentation/images/HT1632-spec-2.png
-presentation/images/structure/bg-body.png
-presentation/images/bear-work.png
-presentation/images/DE-DP105_Ver1.0_EN_0.pdf
-presentation/images/HT1632-spec-7.png
-presentation/images/HT1632-spec-18.png
-presentation/images/HT1632-spec-3.png
-presentation/images/sureelectronics-32x8matrix-back.png
-presentation/images/HT1632-spec-14.png
-presentation/images/HT1632-spec-15.png
 presentation/images/ArduinoIDE.png
+presentation/images/bear-work.png
 presentation/images/Cloud_Background_by_RedemptionDesign_at_deviantart.jpg
-presentation/images/sureelectronics-32x8matrix.png
+presentation/images/DE-DP105_Ver1.0_EN_0.pdf
+presentation/images/firmatagui.png
+presentation/images/HappySkies.png
 presentation/images/HT1632-spec-0.png
-presentation/images/HT1632-spec-9.png
+presentation/images/HT1632-spec-1.png
+presentation/images/HT1632-spec-10.png
 presentation/images/HT1632-spec-11.png
+presentation/images/HT1632-spec-12.png
 presentation/images/HT1632-spec-13.png
-presentation/images/HT1632-spec-10.png
-presentation/images/HT1632-spec-1.png
+presentation/images/HT1632-spec-14.png
+presentation/images/HT1632-spec-15.png
+presentation/images/HT1632-spec-16.png
 presentation/images/HT1632-spec-17.png
-presentation/images/firmatagui.png
+presentation/images/HT1632-spec-18.png
+presentation/images/HT1632-spec-19.png
+presentation/images/HT1632-spec-2.png
+presentation/images/HT1632-spec-3.png
+presentation/images/HT1632-spec-4.png
+presentation/images/HT1632-spec-5.png
+presentation/images/HT1632-spec-6.png
+presentation/images/HT1632-spec-7.png
+presentation/images/HT1632-spec-8.png
+presentation/images/HT1632-spec-9.png
+presentation/images/structure/bg-body.png
+presentation/images/sureelectronics-32x8matrix-back.png
+presentation/images/sureelectronics-32x8matrix-back2.png
+presentation/images/sureelectronics-32x8matrix.png
 presentation/images/write-signal-logic.png
-presentation/images/HT1632-spec-12.png
+presentation/index.html
 presentation/README
+presentation/scripts/dd_roundies.js
+presentation/scripts/global.js
+presentation/scripts/jquery.js
+presentation/scripts/jquery.presentation-full.js
+presentation/scripts/jquery.presentation.js
 presentation/stylesheets/.DS_Store
 presentation/stylesheets/screen.css
-examples/example-matrix.pl
-examples/example-matrix-time2.pl
-examples/example-tcpserver.pl
-examples/example-callbacks.pl
-examples/example-pwm.pl
-examples/example_LCD_I2C.pl
-examples/example-onewire-alarms.pl
-examples/example-i2c.pl
-examples/example-blink.pl
-examples/example-matrix-draw.pl
-examples/example_stepper.pl
-examples/test.pl
-examples/LiquidCrystal_I2C.pm
-examples/example_encoder.pl
-examples/example-onewire.pl
-examples/example-matrix-time.pl
-examples/example_DHT11.pl
+README
+t/00-load.t
+t/boilerplate.t
+t/manifest.t
+t/pod-coverage.t
+t/pod.t
diff --git a/MANIFEST.SKIP b/MANIFEST.SKIP
@@ -1,2 +1,9 @@
 ^.*~$
-MANIFEST.SKIP
+.*\.bak$
+.*\.tar\.gz$
+^.git
+^examples/LiquidCrystal_I2C.pm$
+^examples/example_LCD_I2C.pl$
+^Makefile$
+^Makefile\.old$
+^MYMETA.*
diff --git a/Makefile.PL b/Makefile.PL
@@ -13,11 +13,9 @@ WriteMakefile(
     VERSION_FROM        => 'lib/Device/Firmata.pm',
     ABSTRACT_FROM       => 'lib/Device/Firmata.pm',
     ($ExtUtils::MakeMaker::VERSION >= 6.3001? ('LICENSE'=> 'perl_5') : ()),
+    ($ExtUtils::MakeMaker::VERSION >= 6.18? ('SIGN'=> '0') : ()),
     PL_FILES            => {},
     MIN_PERL_VERSION    => 5.006,
-    CONFIGURE_REQUIRES  => {
-        'ExtUtils::MakeMaker' => 0,
-    },
     BUILD_REQUIRES      => {
         'Test::More' => 0,
     },

diff --git a/README b/README
@@ -1,6 +1,11 @@
 Device-Firmata
 
-Device::Firmata - Perl interface to the Firmata protocol for talking to the arduino microcontroler platform. See http://firmata.org/wiki/Main_Page for more details.
+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 I/O (RS-232, USB, etc.) or TCP/IP (LAN, WiFi). 
+
+Protocol details can be found at https://github.com/firmata/protocol.
+
 
 INSTALLATION
 

diff --git a/dist.ini b/dist.ini
diff --git a/ignore.txt b/ignore.txt
diff --git a/lib/Device/Firmata.pm b/lib/Device/Firmata.pm
@@ -11,17 +11,19 @@ use Device::Firmata::Base
 
 =head1 NAME
 
-Device::Firmata - A Perl implementation of the Firmata protocol.
+Device::Firmata - module for controlling Firmata devices
 
-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 DESCRIPTION
+
+This module allows a computer running Perl to connect to Firmata devices (Arduinos and compatible, including ESP8266), either via serial I/O (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.65
+Version 0.69
 
 =cut
 
-our $VERSION = '0.65';
+our $VERSION = '0.69';
 our $DEBUG = 0;
 
 
@@ -76,7 +78,7 @@ sub open {
   return $platform;
 }
 
-=head2 listen ( host, port )
+=head2 listen ( host, port, [opts] )
 
 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>.
 
@@ -96,11 +98,11 @@ sub listen {
 
 =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.
+In the folder F<examples> you will find more than 15 implementation examples for various Firmata I/O 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>
+L<Device::Firmata::Platform>
 
 =head1 LICENSE
 
@@ -113,7 +115,7 @@ Copyright (C) 2016 Jens B.
 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 L<http://dev.perl.org/licenses/> for more information.
 
 =cut
 

diff --git a/lib/Device/Firmata/Base.pm b/lib/Device/Firmata/Base.pm
@@ -1,5 +1,15 @@
 package Device::Firmata::Base;
 
+=head1 NAME
+
+Device::Firmata::Base - abstract baseclass for Device::Firmata modules
+
+=head1 DESCRIPTION
+
+Provides various convenience methods for module internal use.
+
+=cut
+
 use strict 'vars', 'subs';
 use warnings;
 use vars qw/
@@ -14,12 +24,6 @@ use vars qw/
     $FIRMATA_LOCALE_MESSAGES
 /;
 
-=head1 NAME
-
-Device::Firmata::Base -- Abstract baseclass for Device::Firmata modules
-
-=cut
-
 $FIRMATA_DEBUGGING = 1;
 $FIRMATA_ATTRIBS = {};
 $FIRMATA_LOCALE = 'en';

diff --git a/lib/Device/Firmata/Constants.pm b/lib/Device/Firmata/Constants.pm
@@ -2,7 +2,51 @@ package Device::Firmata::Constants;
 
 =head1 NAME
 
-Device::Firmata::Constants - constants used in the Device::Firmata system
+Device::Firmata::Constants - constants used in the Device::Firmata modules
+
+=head1 DESCRIPTION
+
+Provides several constants to be used with L<Device::Firmata::Platform>.
+
+Pin modes:
+
+=over
+
+=item * PIN_INPUT
+
+=item * PIN_OUTPUT
+
+=item * PIN_ANALOG
+
+=item * PIN_PWM
+
+=item * PIN_SERVO
+
+=item * PIN_SHIFT
+
+=item * PIN_I2C
+
+=item * PIN_ONEWIRE
+
+=item * PIN_STEPPER
+
+=item * PIN_ENCODER
+
+=item * PIN_SERIAL
+
+=item * PIN_PULLUP
+
+=back
+
+Digital pin states:
+
+=over
+
+=item * PIN_LOW
+
+=item * PIN_HIGH
+
+=back
 
 =cut