Support for PCA9685 as RGB/RGBW/W dimmer (#421)

Author: user2684

.travis.yml

@@ -454,4 +454,25 @@ jobs:
        - sed -r -i 's/\/\/(SensorPH .+)/\1/' $SKETCH
        - sed -r -i 's/\/\/(#include <sensors\/SensorPH.h>)/\1/' $SKETCH
        - eval $OTA_CONFIGURATION
+       - eval $COMPILE
+    - name: "SensorPca9685W"
+      script: 
+       - arduino --install-library "Adafruit PWM Servo Driver Library"
+       - sed -r -i 's/\/\/(SensorPca9685W .+)/\1/' $SKETCH
+       - sed -r -i 's/\/\/(#include <sensors\/SensorPca9685W.h>)/\1/' $SKETCH
+       - eval $OTA_CONFIGURATION
+       - eval $COMPILE
+    - name: "SensorPca9685Rgb"
+      script: 
+       - arduino --install-library "Adafruit PWM Servo Driver Library"
+       - sed -r -i 's/\/\/(SensorPca9685Rgb .+)/\1/' $SKETCH
+       - sed -r -i 's/\/\/(#include <sensors\/SensorPca9685Rgb.h>)/\1/' $SKETCH
+       - eval $OTA_CONFIGURATION
+       - eval $COMPILE
+    - name: "SensorPca9685Rgbw"
+      script: 
+       - arduino --install-library "Adafruit PWM Servo Driver Library"
+       - sed -r -i 's/\/\/(SensorPca9685Rgbw .+)/\1/' $SKETCH
+       - sed -r -i 's/\/\/(#include <sensors\/SensorPca9685Rgbw.h>)/\1/' $SKETCH
+       - eval $OTA_CONFIGURATION
        - eval $COMPILE

README.md

@@ -144,6 +144,9 @@ SensorNeopixel           | 1     | Control a Neopixel LED
 SensorSDS011             | 2     | SDS011 air quality sensor, return concentrations of 2.5 and 10 micrometer particles.              | https://github.com/ricki-z/SDS011
 SensorFPM10A             | 1     | FPM10A fingerprint sensor                                                                         | https://github.com/adafruit/Adafruit-Fingerprint-Sensor-Library
 SensorPH                 | 1     | PH ( SKU SEN161 ) sensor, measure the analog value from the amplifier module                      | -
+SensorPca9685W 	         | 1     | Generic dimmer sensor (S_DIMMER) used to drive a single channel pwm output of PCA9685             | https://github.com/adafruit/Adafruit-PWM-Servo-Driver-Library
+SensorPca9685Rgb         | 1     | Generic RGB-dimmer sensor (S_RGB_LIGHT) used to drive RGB resp. 3-channel pwm output of PCA9685   | https://github.com/adafruit/Adafruit-PWM-Servo- Driver-Library 
+SensorPca9685Rgbw        | 1     | Generic RGBW-dimmer sensor (S_RGBW_LIGHT) used to drive RGBW resp. 4-channel pwm output of PCA9685| https://github.com/adafruit/Adafruit-PWM-Servo-Driver-Library
 
 Those sensors requiring a pin to operate would take it as an argument in the constructor. 
 NodeManager automatically creates all the child_ids, assigning an incremental counter. If you need to set your own child_id, pass it as the last argument to the constructor
@@ -268,7 +271,7 @@ You can interact with each class provided by NodeManager through a set of API fu
 	void registerTimer(Timer* timer);
 #endif
 	// return the next-available child id
-	uint8_t getAvailableChildId(uint8_t child_id = 255);
+	uint8_t getAvailableChildId(uint8_t child_id = 0);
 	// list containing all the registered sensors
 	List<Sensor*> sensors;
 	// return the Child object of the given child_id
@@ -882,6 +885,60 @@ Each sensor class may expose additional methods.
     void setPH4Voltage(float value);
 ~~~
 
+* SensorPca9685W
+~~~c
+    // [101] set the effect to use for a smooth transition, can be one of SensorDimmer::EASE_LINEAR (0), SensorDimmer::EASE_INSINE (1), SensorDimmer::EASE_OUTSINE (2), SensorDimmer::EASE_INOUTSINE (3) (default: EASE_LINEAR)
+    void setEasing(int value);
+    // [102] the duration of entire the transition in seconds (default: 1)
+    void setDuration(int value);
+    // [103] the duration of a single step of the transition in milliseconds (default: 100)
+    void setStepDuration(int value);
+    //get instance of PCA9685-board
+    Adafruit_PWMServoDriver* getPWMServoDriver();
+    //set instance of PCA9685-board, if using more than one pca9685-dimmer sensor on the same pca9685-board
+    void setPWMServoDriver(Adafruit_PWMServoDriver* servoDriver);
+    //set the RGB (red/green/blue) value as hex-string (e.g. 000000...black/off, ff0000...red, 00ff00...green, 0000ff...blue, ffa500...orange, ffffff...white)
+    void setRgbVal(String hexstring);
+    //get the current RGB (red/green/blue) value as hex-string
+    String getRgbVal();
+~~~
+
+* SensorPca9685Rgb
+~~~c
+    // [101] set the effect to use for a smooth transition, can be one of SensorDimmer::EASE_LINEAR (0), SensorDimmer::EASE_INSINE (1), SensorDimmer::EASE_OUTSINE (2), SensorDimmer::EASE_INOUTSINE (3) (default: EASE_LINEAR)
+    void setEasing(int value);
+    // [102] the duration of entire the transition in seconds (default: 1)
+    void setDuration(int value);
+    // [103] the duration of a single step of the transition in milliseconds (default: 100)
+    void setStepDuration(int value);
+    //get instance of PCA9685-board
+    Adafruit_PWMServoDriver* getPWMServoDriver();
+    //set instance of PCA9685-board, if using more than one pca9685-dimmer sensor on the same pca9685-board
+    void setPWMServoDriver(Adafruit_PWMServoDriver* servoDriver);
+    //set the RGB (red/green/blue) value as hex-string (e.g. 000000...black/off, ff0000...red, 00ff00...green, 0000ff...blue, ffa500...orange, ffffff...white)
+    void setRgbVal(String hexstring);
+    //get the current RGB (red/green/blue) value as hex-string
+    String getRgbVal();
+~~~
+
+* SensorPca9685Rgbw
+~~~c
+    // [101] set the effect to use for a smooth transition, can be one of SensorDimmer::EASE_LINEAR (0), SensorDimmer::EASE_INSINE (1), SensorDimmer::EASE_OUTSINE (2), SensorDimmer::EASE_INOUTSINE (3) (default: EASE_LINEAR)
+    void setEasing(int value);
+    // [102] the duration of entire the transition in seconds (default: 1)
+    void setDuration(int value);
+    // [103] the duration of a single step of the transition in milliseconds (default: 100)
+    void setStepDuration(int value);
+    //get instance of PCA9685-board
+    Adafruit_PWMServoDriver* getPWMServoDriver();
+    //set instance of PCA9685-board, if using more than one pca9685-dimmer sensor on the same pca9685-board
+    void setPWMServoDriver(Adafruit_PWMServoDriver* servoDriver);
+    //set the RGBW (red/green/blue/white) value as hex-string (see RGB-examples from PCA9685RGB and add "00".."ff" for the white-channel)
+    void setRgbwVal(String hexstring);
+    //get the current RGBW (red/green/blue/white) value as hex-string
+    String getRgbwVal();
+~~~
+
 ### OTA Configuration
 
 When `NODEMANAGER_OTA_CONFIGURATION` is set to ON the API presented above can be also called remotely through `SensorConfiguration`, which is automatically added to NodeManager. SensorConfiguration exposes by default child id 200 that can be used to interact with the service by sending `V_CUSTOM` type of messages and commands within the payload. For each `REQ` message, the node will respond with a `SET` message if successful. 

examples/Template/Template.ino

@@ -346,6 +346,15 @@ NodeManager. Just uncomment the settings you need and the sensors you want to ad
 //#include <sensors/SensorPH.h>
 //SensorPH ph(A0);
 
+//#include <sensors/SensorPca9685W.h>
+//SensorPca9685W pca9685W;
+
+//#include <sensors/SensorPca9685Rgb.h>
+//SensorPca9685Rgb pca9685Rgb;
+
+//#include <sensors/SensorPca9685Rgbw.h>
+//SensorPca9685Rgbw pca9685Rgbw;
+
 /***********************************
  * Main Sketch
  */

keywords.txt

@@ -210,4 +210,8 @@ SensorThermistor	KEYWORD1
 SensorTSL2561	KEYWORD1
 SensorTTP	KEYWORD1
 SensorVL53L0X	KEYWORD1
-SensorWaterMeter	KEYWORD1
+SensorWaterMeter	KEYWORD1
+SensorPH	KEYWORD1
+SensorPca9685Rgb	KEYWORD1
+SensorPca9685Rgbw	KEYWORD1
+SensorPca9685W	KEYWORD1

nodemanager/Node.cpp

@@ -461,9 +461,14 @@ void NodeManager::loop() {
 
 	// return the next available child_id
 	uint8_t NodeManager::getAvailableChildId(uint8_t child_id) {
-		// Childs 0 and 255 not allowed
-		if ( (child_id != 0) && (child_id != 255) ) return child_id;
+		if (child_id != 0) {
+			// requested a specific child_id, check if it is available
+			Child* child = getChild(child_id);
+			if (child == nullptr) return child_id;
+		}
+		// automatic child_id assignment or child already in use
 		for (int i = 1; i < 255; i++) {
+			// look for the first available child_id
 			Child* child = getChild(i);
 			if (child == nullptr) return i;
 		}

nodemanager/Node.h

@@ -74,7 +74,7 @@ class NodeManager {
 	// register a timer
 	void registerTimer(Timer* timer);
 	// return the next-available child id
-	uint8_t getAvailableChildId(uint8_t child_id = 255);
+	uint8_t getAvailableChildId(uint8_t child_id = 0);
 	// list containing all the registered sensors
 	List<Sensor*> sensors;
 	// return the Child object of the given child_id

sensors/Display.h

@@ -28,7 +28,7 @@ class Display: public Sensor {
 	const char* _caption = "";
 
 public:
-	Display(uint8_t child_id = 255): Sensor(-1) {
+	Display(uint8_t child_id = 0): Sensor(-1) {
 		_name = "";
 		// We don't need any sensors, but we need a child, otherwise the loop will never be executed
 		children.allocateBlocks(1);

sensors/DisplayHD44780.h

@@ -34,7 +34,7 @@ class DisplayHD44780: public Display {
 	uint8_t _i2caddress = 0x38;
 	int _column = 0;
 public:
-	DisplayHD44780(uint8_t child_id = 255): Display(child_id) {
+	DisplayHD44780(uint8_t child_id = 0): Display(child_id) {
 		_name = "HD44780";
 		children.get()->setDescription(_name);
 	};

sensors/DisplaySSD1306.h

@@ -39,7 +39,7 @@ class DisplaySSD1306: public Display {
 	uint8_t _contrast = -1;
 
 public:
-	DisplaySSD1306(uint8_t child_id = 255): Display(child_id) {
+	DisplaySSD1306(uint8_t child_id = 0): Display(child_id) {
 		_name = "SSD1306";
 		children.get()->setDescription(_name);
 	};

sensors/SensorAM2320.h

@@ -31,11 +31,11 @@ class SensorAM2320: public Sensor {
 	AM2320* _th;
 
 public:
-	SensorAM2320(uint8_t child_id = 255): Sensor(-1) {
+	SensorAM2320(uint8_t child_id = 0): Sensor(-1) {
 		_name = "AM2320";
 		children.allocateBlocks(2);
 		new Child(this,FLOAT,nodeManager.getAvailableChildId(child_id),S_TEMP,V_TEMP,_name);
-		new Child(this,FLOAT,nodeManager.getAvailableChildId(child_id+1),S_HUM,V_HUM,_name);
+		new Child(this,FLOAT,child_id > 0 ? nodeManager.getAvailableChildId(child_id+1) : nodeManager.getAvailableChildId(child_id),S_HUM,V_HUM,_name);
 	};
 
 	// define what to do during setup