Merge pull request #123 from astro-pi/feature/rgb-function

Feature/rgb function

Author: G3zz

docs/api.md

@@ -881,6 +881,8 @@ The following properties of the `ColourSensor` object provide direct access to t
 `blue_raw` | int | The amount of incident blue light, between 0 and `max_raw`
 `clear_raw` | int | The amount of incident light (brightness), between 0 and `max_raw`
 `colour_raw` | tuple | A 4-tuple containing the RGBC (Red, Green, Blue and Clear) raw sensor readings, each between 0 and `max_raw`
+`rgb` | tuple | A 3-tuple containing the RGB raw sensor readings, each between 0 and `max_raw`.
+`brightness` | int | An alias to the `clear_raw` property - the amount of incident light, between 0 and `max_raw`
 
 Here is an example comparing raw values to the corresponding scaled ones, for a given number of integration cycles.
 
@@ -901,4 +903,4 @@ print(f"Scaled values: {sense.colour.colour}")
 
 Custom Sense HAT exceptions are statically defined in the `sense_hat.exceptions` module. 
 The exceptions relate to problems encountered while initialising the colour chip or due to setting invalid parameters. 
-Each exception includes a message describing the issue encountered, and is subclassed from the base class `SenseHatException`. 
+Each exception includes a message describing the issue encountered, and is subclassed from the base class `SenseHatException`. 

docs/changelog.md

@@ -2,6 +2,10 @@
 
 ## v2
 
+### 2.4.0
+- Added `rgb` method to allow for easy reuse of sense hat colour sensor values
+- Added `brightness` method alias for the sense hat colour sensor
+
 ### 2.3.x
 
 - Added support for the light/colour sensor in the v2 Sense HAT

sense_hat/__init__.py

@@ -13,4 +13,4 @@
     ACTION_HELD,
     )
 
-__version__ = '2.3.1'
+__version__ = '2.4.0'

sense_hat/colour.py

@@ -15,7 +15,6 @@ class HardwareInterface:
     actual hardware. Using this intermediate layer of abstraction, a
     `ColourSensor` object interacts with the hardware without being
     aware of how this interaction is implemented.
-
     Different subclasses of the `HardwareInterface` class can provide
     access to the hardware through e.g. I2C, `libiio` and its system
     files or even a hardware emulator.
@@ -131,7 +130,6 @@ class I2C(HardwareInterface):
     """
     An implementation of the `HardwareInterface` for the TCS34725 sensor
     that uses I2C to control the sensor and retrieve measurements.
-
     Use the datasheet as a reference: https://ams.com/tcs34725#tab/documents
     """
 
@@ -342,6 +340,7 @@ def colour_raw(self):
     green_raw = property(lambda self: self.interface.get_green())
     blue_raw = property(lambda self: self.interface.get_blue())
     clear_raw = property(lambda self: self.interface.get_clear())
+    brightness = clear_raw
 
     @property
     def _scaling(self):
@@ -351,6 +350,10 @@ def _scaling(self):
     def colour(self):
         return tuple(reading // self._scaling for reading in self.colour_raw)
 
+    @property
+    def rgb(self):
+        return tuple(reading // self._scaling for reading in self.colour_raw)[0:3]
+
     color = colour
     red = property(lambda self: self.red_raw // self._scaling )
     green = property(lambda self: self.green_raw // self._scaling )