Source code annotations and documentation added.

Author: mathertel

.gitignore

@@ -0,0 +1,5 @@
+################################################################################
+# This .gitignore file was automatically created by Microsoft(R) Visual Studio.
+################################################################################
+
+/.development

examples/DMXSerialFlow/DMXSerialFlow.ino

@@ -1,7 +1,7 @@
 // - - - - -
 // DmxSerial - A hardware supported interface to DMX.
 // DMXSerialFlow.ino: Sample DMX application for sending 60 DMX values.
-// Copyright (c) 2014 by Matthias Hertel, http://www.mathertel.de
+// Copyright (c) 2014-2015 by Matthias Hertel, http://www.mathertel.de
 // This work is licensed under a BSD style license. See http://www.mathertel.de/License.aspx
 // 
 // Documentation and samples are available at http://www.mathertel.de/Arduino
@@ -21,16 +21,13 @@ const int RedPin =    9;  // PWM output pin for Red Light.
 const int GreenPin =  6;  // PWM output pin for Green Light.
 const int BluePin =   5;  // PWM output pin for Blue Light.
 
-// The number of RGB pixels, RGB channels are transfered
-#define PIXELS 60
 
 void setup(void)
 {
   // Serial.begin(57600); // only on Leonardo
   // Serial.println("DMXSerialFlow DMX Example");
 
   DMXSerial.init(DMXController);
-  // DMXSerial.init(DMXController, 4);
 
   // Set the number of channels the controller will send
   // this call is not needed, because the DMXController extends the DMX packet length automatically when data is added.
@@ -84,7 +81,7 @@ void loop(void)
   // uncomment this line to have a scenario where DMX values are changed every 5 seconds 
   // alpha &= 0xFF00;
 
-  for (int n = 0; n < PIXELS; n++) {
+  for (int n = 0; n < 20; n++) {
     setChannelRGB (n*3+1, alpha + n*64);
   } // for
 
@@ -98,4 +95,4 @@ void loop(void)
 
 
 
-
+

examples/DmxSerialRecv/DmxSerialRecv.ino

@@ -5,7 +5,7 @@
 // address 2 (green) -> PWM Port 6
 // address 3 (blue) -> PWM Port 5
 // 
-// Copyright (c) 2011 by Matthias Hertel, http://www.mathertel.de
+// Copyright (c) 2011-2015 by Matthias Hertel, http://www.mathertel.de
 // This work is licensed under a BSD style license. See http://www.mathertel.de/License.aspx
 // 
 // Documentation and samples are available at http://www.mathertel.de/Arduino

examples/DmxSerialSend/DmxSerialSend.ino

@@ -1,14 +1,20 @@
 // - - - - -
 // DmxSerial - A hardware supported interface to DMX.
-// DmxSerialSend.ino: Sample DMX application for sending 3 DMX values:
+// DmxSerialSend.ino: Sample DMX application for sending 3 DMX values.
+// There colors in the 3 lists (RedList, GreenList and BlueList) are placed into the DMX buffer with a slow fade.
+// DMXSerial works in the background and constantly sends the actual values over the DMX interface.
+// The actual values are also available on the built in PWM ports:
 // address 1 (red) -> also available on PWM Port 9
 // address 2 (green) -> also available on PWM Port 6
 // address 3 (blue) -> also available on PWM Port 5
 // 
-// Copyright (c) 2011 by Matthias Hertel, http://www.mathertel.de
+// Copyright (c) 2011-2015 by Matthias Hertel, http://www.mathertel.de
 // This work is licensed under a BSD style license. See http://www.mathertel.de/License.aspx
 // 
 // Documentation and samples are available at http://www.mathertel.de/Arduino
+// The repository is on github : https://github.com/mathertel/DMXSerial
+// The repository on github is made available in the Arduino Library Manager.
+//
 // 25.07.2011 creation of the DmxSerial library.
 // 10.09.2011 fully control the serial hardware register
 //            without using the Arduino Serial (HardwareSerial) class to avoid ISR implementation conflicts.
@@ -75,4 +81,4 @@ void loop() {
   } // if
 
   delayMicroseconds(2000); // wait a little bit
-} // loop
+} // loop

library.properties

@@ -1,9 +1,9 @@
-name=DMXSerial
-version=1.3.0
-author=Matthias Hertel
-maintainer=Matthias Hertel <www.mathertel.de>
+name=DMXSerial
+version=1.2.0
+author=Matthias Hertel <[email protected]>
+maintainer=Matthias Hertel <mathertel@hotmail.com>
 sentence=Enables DMX communication using the built-in serial port for Arduino boards UNO, Leonardo, Mega.
-paragraph=This is a library for implementing DMX controllers and devices.
 category=Communication
+paragraph=This is a library to implement DMX controllers and devices.
 url=http://www.mathertel.de/Arduino/DMXSerial.aspx
-architectures=*
+architectures=avr