Add support for PWM

CONTRIBUTING.md

@@ -2,9 +2,15 @@ Contributing
 ===
 ## Style
 - **Indent**: Tabs
+- **Spacing**: See existing pages
 - **One Line Conditionals**: Never
 - **Comments**: Use Doxygen compatible comments [https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html](https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html)
+- **General**: The goal is to be as clear as possible. Shorter code is not always better.
 
 ## Documentation
-- Do not update documentation files! In other words, don't make pull requests for `gh-pages` branch which contains everything in the `/extra/documentation/html` directory, they will be ignored.
+- Documentation is built using Doxygen
+- Do not update documentation files! In other words, don't make pull requests for `gh-pages` branch which contains everything in the `/extra/documentation` directory, they will be ignored.
 - Do add documentation to code in the form of Doxygen compatible comments.
+
+## Issues
+- Report issues [here](https://github.com/fenichelar/Pin/issues)

README.md

@@ -47,6 +47,12 @@ myPin.setHigh();
 myPin.setLow();
 ~~~~~~~~~~~~~
 
+## PWM
+Set duty cycle to ~50% (not all pins support PWM)
+~~~~~~~~~~~~~{.cpp}
+myPin.setDutyCycle(127);
+~~~~~~~~~~~~~
+
 ## Get Pin Info
 Get mode (INPUT/OUTPUT)
 ~~~~~~~~~~~~~{.cpp}
@@ -73,7 +79,7 @@ myPin.toggleState();
 
 ## Simultaneous Operations on Multiple Pins
 
-All Pins in array must use the same DDR, PORT, and PIN registers. Look at the corresponding file in the boards directory to determine what registers each pin uses on a given board. Because this library is built for speed, the array of pins is not automatically checked to be valid for simultaneous operations. An invalid array will produce unexpected results without error, therefore it is highly recommended that the array be validated using the `checkPinGroup` function during setup.
+All Pins in array must use the same DDR, PORT, and PIN registers. Look at the Arduino documentation for your board to determine what registers each pin uses. Because this library is built for speed, the array of pins is not automatically checked to be valid for simultaneous operations. An invalid array will produce unexpected results without error, therefore it is highly recommended that the array be validated using the `checkPinGroup()` function during setup.
 
 Import Pin library with support for simultaneous operations
 ~~~~~~~~~~~~~{.cpp}

examples/Pin-Group/Pin-Group.ino

@@ -9,7 +9,7 @@
 #include <PinGroup.h>  // Include Pin library group functions
 
 // The Pins used in this array must all be on the same DDR and PORT registers
-// Look at the coresponding file in the boards directory to determine what register each pin is on
+// Look at the Arduino documentation for your board to determine what registers each pin uses
 Pin myPinGroup[] = {2,3,5};  // Create array of Pin objects for digital pins labelled 2,3,5 on the Arduino Uno or Mega (not valid for Leonardo)
 
 /**
@@ -35,6 +35,10 @@ void loop() {
 
   delay(200);  // Wait 200 milliseconds
 
+  setOutputHigh(myPinGroup);  // Simultaneously set array of Pins to output high
+
+  delay(200);  // Wait 200 milliseconds
+
   setInput(myPinGroup);  // Simultaneously set array of Pins to input mode
 
   delay(200);  // Wait 200 milliseconds

examples/Pin-PWM/Pin-PWM.ino

@@ -0,0 +1,25 @@
+/**
+  @file Pin-PWM.ino
+  @author Alec Fenichel
+  @brief Pin PWM example
+  @details Use PWM with the Pin library
+*/
+
+#include <Pin.h>  // Include Pin library
+
+Pin myPin = Pin(5);  // Create Pin object for digital pin labelled 5 on any of the supported boards
+
+/**
+  Called at start
+ */
+void setup() {
+  myPin.setOutput();  // Set Pin to output mode
+  // The Pin must support PWM
+  myPin.setDutyCycle(127);  // Set Pin duty cycle to 127 (~50%)
+}
+
+/**
+  Called continously after setup
+ */
+void loop() {
+}

keywords.txt

@@ -25,6 +25,7 @@ setHigh	KEYWORD2
 setLow	KEYWORD2
 setOutputHigh	KEYWORD2
 setOutputLow	KEYWORD2
+setDutyCycle	KEYWORD2
 
 toggleMode	KEYWORD2
 toggleState	KEYWORD2

library.properties

@@ -1,5 +1,5 @@
 name=Pin
-version=2.2.3
+version=2.3.0
 author=Alec Fenichel <[email protected]>
 maintainer=Alec Fenichel <[email protected]>
 sentence=An easy to use Arduino library for fast digital I/O using port manipulation.

src/Pin.cpp

@@ -8,17 +8,6 @@
 
 #include "Pin.h"
 
-/**
-	Struct for storing register addresses and offset
- */
-struct pinMapping {
-	volatile uint8_t* pin;  ///< Address of the PIN register, used to read pin if the pin is set as an input
-	volatile uint8_t* port;  ///< Address of the PORT register, used to set output if the pin is set as an output or set pull-up resistor if the pin is set as an input
-	volatile uint8_t* ddr;  ///< Address of the DDR register, used to define data direction
-	const uint8_t offset;  ///< Bit mask for specific pin inside register
-	const uint8_t timer;  ///< Timer used for specific pin
-};
-
 
 // ################################# Constructors #################################
 
@@ -39,11 +28,7 @@ Pin::Pin(uint8_t number) {
  */
 Pin::Pin(uint8_t number, bool analog) {
 	if (analog) {
-		#ifdef Board_H
-			init(number + ANALOGOFFSET);
-		#else
-			init(analogInputToDigitalPin(number));
-		#endif
+		init(analogInputToDigitalPin(number));
 	} else {
 		init(number);
 	}
@@ -56,19 +41,11 @@ Pin::Pin(uint8_t number, bool analog) {
  */
 void Pin::init(uint8_t number) {
 	_number = number;
-	#ifdef Board_H
-		_offset = pinMappings[_number].offset;
-		_timer = pinMappings[_number].timer;
-		_PIN = pinMappings[_number].pin;
-		_PORT = pinMappings[_number].port;
-		_DDR = pinMappings[_number].ddr;
-	#else
-		_offset = digitalPinToBitMask(_number);
-		_timer = digitalPinToTimer(_number);
-		_PIN = portInputRegister(digitalPinToPort(_number));
-		_PORT = portOutputRegister(digitalPinToPort(_number));
-		_DDR = portModeRegister(digitalPinToPort(_number));
-	#endif
+	_offset = digitalPinToBitMask(_number);
+	_timer = digitalPinToTimer(_number);
+	_PIN = portInputRegister(digitalPinToPort(_number));
+	_PORT = portOutputRegister(digitalPinToPort(_number));
+	_DDR = portModeRegister(digitalPinToPort(_number));
 }
 
 
@@ -300,6 +277,15 @@ void Pin::setOutputLow() {
 	PORT_LOW;
 }
 
+/**
+	Set the PWM duty cycle
+
+  @param value the duty cycle (0-255)
+ */
+void Pin::setDutyCycle(int value) {
+	analogWrite(_number,value);
+}
+
 // #################### Toggle ####################
 
 /**

src/Pin.h

@@ -9,8 +9,7 @@
 #include "Arduino.h"
 
 
-#ifndef Pin_H
-#define Pin_H
+#pragma once
 
 
 // ################################# Defines #################################
@@ -65,6 +64,7 @@ class Pin {
 		void setLow();
 		void setOutputHigh();
 		void setOutputLow();
+		void setDutyCycle(int value);
 		// Toggle
 		void toggleMode();
 		void toggleState();
@@ -80,5 +80,3 @@ class Pin {
 		volatile uint8_t* _PORT;
 		volatile uint8_t* _DDR;
 };
-
-#endif

src/PinGroup.h

@@ -9,8 +9,7 @@
 #include "Pin.h"
 
 
-#ifndef PinGroup_H
-#define PinGroup_H
+#pragma once
 
 
 // ################################# Defines #################################
@@ -206,5 +205,3 @@ bool checkPinGroup(Pin (&pins)[N]) {
 
 	return true;
 }
-
-#endif