├── .github ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── .gitignore ├── Adafruit_TCS34725 ├── TCS34725.py └── __init__.py ├── LICENSE ├── README.md ├── examples └── simpletest.py ├── ez_setup.py └── setup.py /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Thank you for opening an issue on an Adafruit Python library repository. To 2 | improve the speed of resolution please review the following guidelines and 3 | common troubleshooting steps below before creating the issue: 4 | 5 | - **Do not use GitHub issues for troubleshooting projects and issues.** Instead use 6 | the forums at http://forums.adafruit.com to ask questions and troubleshoot why 7 | something isn't working as expected. In many cases the problem is a common issue 8 | that you will more quickly receive help from the forum community. GitHub issues 9 | are meant for known defects in the code. If you don't know if there is a defect 10 | in the code then start with troubleshooting on the forum first. 11 | 12 | - **If following a tutorial or guide be sure you didn't miss a step.** Carefully 13 | check all of the steps and commands to run have been followed. Consult the 14 | forum if you're unsure or have questions about steps in a guide/tutorial. 15 | 16 | - **For Python/Raspberry Pi projects check these very common issues to ensure they don't apply**: 17 | 18 | - If you are receiving an **ImportError: No module named...** error then a 19 | library the code depends on is not installed. Check the tutorial/guide or 20 | README to ensure you have installed the necessary libraries. Usually the 21 | missing library can be installed with the `pip` tool, but check the tutorial/guide 22 | for the exact command. 23 | 24 | - **Be sure you are supplying adequate power to the board.** Check the specs of 25 | your board and power in an external power supply. In many cases just 26 | plugging a board into your computer is not enough to power it and other 27 | peripherals. 28 | 29 | - **Double check all soldering joints and connections.** Flakey connections 30 | cause many mysterious problems. See the [guide to excellent soldering](https://learn.adafruit.com/adafruit-guide-excellent-soldering/tools) for examples of good solder joints. 31 | 32 | If you're sure this issue is a defect in the code and checked the steps above 33 | please fill in the following fields to provide enough troubleshooting information. 34 | You may delete the guideline and text above to just leave the following details: 35 | 36 | - Platform/operating system (i.e. Raspberry Pi with Raspbian operating system, 37 | Windows 32-bit, Windows 64-bit, Mac OSX 64-bit, etc.): **INSERT PLATFORM/OPERATING 38 | SYSTEM HERE** 39 | 40 | - Python version (run `python -version` or `python3 -version`): **INSERT PYTHON 41 | VERSION HERE** 42 | 43 | - Error message you are receiving, including any Python exception traces: **INSERT 44 | ERROR MESAGE/EXCEPTION TRACES HERE*** 45 | 46 | - List the steps to reproduce the problem below (if possible attach code or commands 47 | to run): **LIST REPRO STEPS BELOW** 48 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Thank you for creating a pull request to contribute to Adafruit's GitHub code! 2 | Before you open the request please review the following guidelines and tips to 3 | help it be more easily integrated: 4 | 5 | - **Describe the scope of your change--i.e. what the change does and what parts 6 | of the code were modified.** This will help us understand any risks of integrating 7 | the code. 8 | 9 | - **Describe any known limitations with your change.** For example if the change 10 | doesn't apply to a supported platform of the library please mention it. 11 | 12 | - **Please run any tests or examples that can exercise your modified code.** We 13 | strive to not break users of the code and running tests/examples helps with this 14 | process. 15 | 16 | Thank you again for contributing! We will try to test and integrate the change 17 | as soon as we can, but be aware we have many GitHub repositories to manage and 18 | can't immediately respond to every request. There is no need to bump or check in 19 | on a pull request (it will clutter the discussion of the request). 20 | 21 | Also don't be worried if the request is closed or not integrated--sometimes the 22 | priorities of Adafruit's GitHub code (education, ease of use) might not match the 23 | priorities of the pull request. Don't fret, the open source community thrives on 24 | forks and GitHub makes it easy to keep your changes in a forked repo. 25 | 26 | After reviewing the guidelines above you can delete this text from the pull request. 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | 55 | # Sphinx documentation 56 | docs/_build/ 57 | 58 | # PyBuilder 59 | target/ 60 | 61 | #Ipython Notebook 62 | .ipynb_checkpoints 63 | -------------------------------------------------------------------------------- /Adafruit_TCS34725/TCS34725.py: -------------------------------------------------------------------------------- 1 | # The MIT License (MIT) 2 | # 3 | # Copyright (c) 2016 Adafruit Industries 4 | # 5 | # Permission is hereby granted, free of charge, to any person obtaining a copy 6 | # of this software and associated documentation files (the "Software"), to deal 7 | # in the Software without restriction, including without limitation the rights 8 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | # copies of the Software, and to permit persons to whom the Software is 10 | # furnished to do so, subject to the following conditions: 11 | # 12 | # The above copyright notice and this permission notice shall be included in all 13 | # copies or substantial portions of the Software. 14 | # 15 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | # SOFTWARE. 22 | import time 23 | 24 | 25 | TCS34725_ADDRESS = 0x29 26 | TCS34725_ID = 0x12 # 0x44 = TCS34721/TCS34725, 0x4D = TCS34723/TCS34727 27 | 28 | TCS34725_COMMAND_BIT = 0x80 29 | 30 | TCS34725_ENABLE = 0x00 31 | TCS34725_ENABLE_AIEN = 0x10 # RGBC Interrupt Enable 32 | TCS34725_ENABLE_WEN = 0x08 # Wait enable - Writing 1 activates the wait timer 33 | TCS34725_ENABLE_AEN = 0x02 # RGBC Enable - Writing 1 actives the ADC, 0 disables it 34 | TCS34725_ENABLE_PON = 0x01 # Power on - Writing 1 activates the internal oscillator, 0 disables it 35 | TCS34725_ATIME = 0x01 # Integration time 36 | TCS34725_WTIME = 0x03 # Wait time (if TCS34725_ENABLE_WEN is asserted) 37 | TCS34725_WTIME_2_4MS = 0xFF # WLONG0 = 2.4ms WLONG1 = 0.029s 38 | TCS34725_WTIME_204MS = 0xAB # WLONG0 = 204ms WLONG1 = 2.45s 39 | TCS34725_WTIME_614MS = 0x00 # WLONG0 = 614ms WLONG1 = 7.4s 40 | TCS34725_AILTL = 0x04 # Clear channel lower interrupt threshold 41 | TCS34725_AILTH = 0x05 42 | TCS34725_AIHTL = 0x06 # Clear channel upper interrupt threshold 43 | TCS34725_AIHTH = 0x07 44 | TCS34725_PERS = 0x0C # Persistence register - basic SW filtering mechanism for interrupts 45 | TCS34725_PERS_NONE = 0b0000 # Every RGBC cycle generates an interrupt 46 | TCS34725_PERS_1_CYCLE = 0b0001 # 1 clean channel value outside threshold range generates an interrupt 47 | TCS34725_PERS_2_CYCLE = 0b0010 # 2 clean channel values outside threshold range generates an interrupt 48 | TCS34725_PERS_3_CYCLE = 0b0011 # 3 clean channel values outside threshold range generates an interrupt 49 | TCS34725_PERS_5_CYCLE = 0b0100 # 5 clean channel values outside threshold range generates an interrupt 50 | TCS34725_PERS_10_CYCLE = 0b0101 # 10 clean channel values outside threshold range generates an interrupt 51 | TCS34725_PERS_15_CYCLE = 0b0110 # 15 clean channel values outside threshold range generates an interrupt 52 | TCS34725_PERS_20_CYCLE = 0b0111 # 20 clean channel values outside threshold range generates an interrupt 53 | TCS34725_PERS_25_CYCLE = 0b1000 # 25 clean channel values outside threshold range generates an interrupt 54 | TCS34725_PERS_30_CYCLE = 0b1001 # 30 clean channel values outside threshold range generates an interrupt 55 | TCS34725_PERS_35_CYCLE = 0b1010 # 35 clean channel values outside threshold range generates an interrupt 56 | TCS34725_PERS_40_CYCLE = 0b1011 # 40 clean channel values outside threshold range generates an interrupt 57 | TCS34725_PERS_45_CYCLE = 0b1100 # 45 clean channel values outside threshold range generates an interrupt 58 | TCS34725_PERS_50_CYCLE = 0b1101 # 50 clean channel values outside threshold range generates an interrupt 59 | TCS34725_PERS_55_CYCLE = 0b1110 # 55 clean channel values outside threshold range generates an interrupt 60 | TCS34725_PERS_60_CYCLE = 0b1111 # 60 clean channel values outside threshold range generates an interrupt 61 | TCS34725_CONFIG = 0x0D 62 | TCS34725_CONFIG_WLONG = 0x02 # Choose between short and long (12x) wait times via TCS34725_WTIME 63 | TCS34725_CONTROL = 0x0F # Set the gain level for the sensor 64 | TCS34725_ID = 0x12 # 0x44 = TCS34721/TCS34725, 0x4D = TCS34723/TCS34727 65 | TCS34725_STATUS = 0x13 66 | TCS34725_STATUS_AINT = 0x10 # RGBC Clean channel interrupt 67 | TCS34725_STATUS_AVALID = 0x01 # Indicates that the RGBC channels have completed an integration cycle 68 | 69 | TCS34725_CDATAL = 0x14 # Clear channel data 70 | TCS34725_CDATAH = 0x15 71 | TCS34725_RDATAL = 0x16 # Red channel data 72 | TCS34725_RDATAH = 0x17 73 | TCS34725_GDATAL = 0x18 # Green channel data 74 | TCS34725_GDATAH = 0x19 75 | TCS34725_BDATAL = 0x1A # Blue channel data 76 | TCS34725_BDATAH = 0x1B 77 | 78 | TCS34725_INTEGRATIONTIME_2_4MS = 0xFF # 2.4ms - 1 cycle - Max Count: 1024 79 | TCS34725_INTEGRATIONTIME_24MS = 0xF6 # 24ms - 10 cycles - Max Count: 10240 80 | TCS34725_INTEGRATIONTIME_50MS = 0xEB # 50ms - 20 cycles - Max Count: 20480 81 | TCS34725_INTEGRATIONTIME_101MS = 0xD5 # 101ms - 42 cycles - Max Count: 43008 82 | TCS34725_INTEGRATIONTIME_154MS = 0xC0 # 154ms - 64 cycles - Max Count: 65535 83 | TCS34725_INTEGRATIONTIME_700MS = 0x00 # 700ms - 256 cycles - Max Count: 65535 84 | 85 | TCS34725_GAIN_1X = 0x00 # No gain 86 | TCS34725_GAIN_4X = 0x01 # 2x gain 87 | TCS34725_GAIN_16X = 0x02 # 16x gain 88 | TCS34725_GAIN_60X = 0x03 # 60x gain 89 | 90 | # Lookup table for integration time delays. 91 | INTEGRATION_TIME_DELAY = { 92 | 0xFF: 0.0024, # 2.4ms - 1 cycle - Max Count: 1024 93 | 0xF6: 0.024, # 24ms - 10 cycles - Max Count: 10240 94 | 0xEB: 0.050, # 50ms - 20 cycles - Max Count: 20480 95 | 0xD5: 0.101, # 101ms - 42 cycles - Max Count: 43008 96 | 0xC0: 0.154, # 154ms - 64 cycles - Max Count: 65535 97 | 0x00: 0.700 # 700ms - 256 cycles - Max Count: 65535 98 | } 99 | 100 | 101 | # Utility methods: 102 | def calculate_color_temperature(r, g, b): 103 | """Converts the raw R/G/B values to color temperature in degrees Kelvin.""" 104 | # 1. Map RGB values to their XYZ counterparts. 105 | # Based on 6500K fluorescent, 3000K fluorescent 106 | # and 60W incandescent values for a wide range. 107 | # Note: Y = Illuminance or lux 108 | X = (-0.14282 * r) + (1.54924 * g) + (-0.95641 * b) 109 | Y = (-0.32466 * r) + (1.57837 * g) + (-0.73191 * b) 110 | Z = (-0.68202 * r) + (0.77073 * g) + ( 0.56332 * b) 111 | # Check for divide by 0 (total darkness) and return None. 112 | if (X + Y + Z) == 0: 113 | return None 114 | # 2. Calculate the chromaticity co-ordinates 115 | xc = (X) / (X + Y + Z) 116 | yc = (Y) / (X + Y + Z) 117 | # Check for divide by 0 again and return None. 118 | if (0.1858 - yc) == 0: 119 | return None 120 | # 3. Use McCamy's formula to determine the CCT 121 | n = (xc - 0.3320) / (0.1858 - yc) 122 | # Calculate the final CCT 123 | cct = (449.0 * (n ** 3.0)) + (3525.0 *(n ** 2.0)) + (6823.3 * n) + 5520.33 124 | return int(cct) 125 | 126 | def calculate_lux(r, g, b): 127 | """Converts the raw R/G/B values to luminosity in lux.""" 128 | illuminance = (-0.32466 * r) + (1.57837 * g) + (-0.73191 * b) 129 | return int(illuminance) 130 | 131 | 132 | class TCS34725(object): 133 | """TCS34725 color sensor.""" 134 | 135 | def __init__(self, integration_time=TCS34725_INTEGRATIONTIME_2_4MS, 136 | gain=TCS34725_GAIN_4X, address=TCS34725_ADDRESS, i2c=None, **kwargs): 137 | """Initialize the TCS34725 sensor.""" 138 | # Setup I2C interface for the device. 139 | if i2c is None: 140 | import Adafruit_GPIO.I2C as I2C 141 | i2c = I2C 142 | self._device = i2c.get_i2c_device(address, **kwargs) 143 | # Make sure we're connected to the sensor. 144 | chip_id = self._readU8(TCS34725_ID) 145 | if chip_id != 0x44: 146 | raise RuntimeError('Failed to read TCS34725 chip ID, check your wiring.') 147 | # Set default integration time and gain. 148 | self.set_integration_time(integration_time) 149 | self.set_gain(gain) 150 | # Enable the device (by default, the device is in power down mode on bootup). 151 | self.enable() 152 | 153 | def _readU8(self, reg): 154 | """Read an unsigned 8-bit register.""" 155 | return self._device.readU8(TCS34725_COMMAND_BIT | reg) 156 | 157 | def _readU16LE(self, reg): 158 | """Read a 16-bit little endian register.""" 159 | return self._device.readU16LE(TCS34725_COMMAND_BIT | reg) 160 | 161 | def _write8(self, reg, value): 162 | """Write a 8-bit value to a register.""" 163 | self._device.write8(TCS34725_COMMAND_BIT | reg, value) 164 | 165 | def enable(self): 166 | """Enable the chip.""" 167 | # Flip on the power and enable bits. 168 | self._write8(TCS34725_ENABLE, TCS34725_ENABLE_PON) 169 | time.sleep(0.01) 170 | self._write8(TCS34725_ENABLE, (TCS34725_ENABLE_PON | TCS34725_ENABLE_AEN)) 171 | 172 | def disable(self): 173 | """Disable the chip (power down).""" 174 | # Flip off the power on and enable bits. 175 | reg = self._readU8(TCS34725_ENABLE) 176 | reg &= ~(TCS34725_ENABLE_PON | TCS34725_ENABLE_AEN) 177 | self._write8(TCS34725_ENABLE, reg) 178 | 179 | def set_integration_time(self, integration_time): 180 | """Sets the integration time for the TC34725. Provide one of these 181 | constants: 182 | - TCS34725_INTEGRATIONTIME_2_4MS = 2.4ms - 1 cycle - Max Count: 1024 183 | - TCS34725_INTEGRATIONTIME_24MS = 24ms - 10 cycles - Max Count: 10240 184 | - TCS34725_INTEGRATIONTIME_50MS = 50ms - 20 cycles - Max Count: 20480 185 | - TCS34725_INTEGRATIONTIME_101MS = 101ms - 42 cycles - Max Count: 43008 186 | - TCS34725_INTEGRATIONTIME_154MS = 154ms - 64 cycles - Max Count: 65535 187 | - TCS34725_INTEGRATIONTIME_700MS = 700ms - 256 cycles - Max Count: 65535 188 | """ 189 | self._integration_time = integration_time 190 | self._write8(TCS34725_ATIME, integration_time) 191 | 192 | def get_integration_time(self): 193 | """Return the current integration time value. This will be one of the 194 | constants specified in the set_integration_time doc string. 195 | """ 196 | return self._readU8(TCS34725_ATIME) 197 | 198 | def set_gain(self, gain): 199 | """Adjusts the gain on the TCS34725 (adjusts the sensitivity to light). 200 | Use one of the following constants: 201 | - TCS34725_GAIN_1X = No gain 202 | - TCS34725_GAIN_4X = 2x gain 203 | - TCS34725_GAIN_16X = 16x gain 204 | - TCS34725_GAIN_60X = 60x gain 205 | """ 206 | self._write8(TCS34725_CONTROL, gain) 207 | 208 | def get_gain(self): 209 | """Return the current gain value. This will be one of the constants 210 | specified in the set_gain doc string. 211 | """ 212 | return self._readU8(TCS34725_CONTROL) 213 | 214 | def get_raw_data(self): 215 | """Reads the raw red, green, blue and clear channel values. Will return 216 | a 4-tuple with the red, green, blue, clear color values (unsigned 16-bit 217 | numbers). 218 | """ 219 | # Read each color register. 220 | r = self._readU16LE(TCS34725_RDATAL) 221 | g = self._readU16LE(TCS34725_GDATAL) 222 | b = self._readU16LE(TCS34725_BDATAL) 223 | c = self._readU16LE(TCS34725_CDATAL) 224 | # Delay for the integration time to allow for next reading immediately. 225 | time.sleep(INTEGRATION_TIME_DELAY[self._integration_time]) 226 | return (r, g, b, c) 227 | 228 | def set_interrupt(self, enabled): 229 | """Enable or disable interrupts by setting enabled to True or False.""" 230 | enable_reg = self._readU8(TCS34725_ENABLE) 231 | if enabled: 232 | enable_reg |= TCS34725_ENABLE_AIEN 233 | else: 234 | enable_reg &= ~TCS34725_ENABLE_AIEN 235 | self._write8(TCS34725_ENABLE, enable_reg) 236 | time.sleep(1) 237 | 238 | def clear_interrupt(self): 239 | """Clear interrupt.""" 240 | self._device.write8(0x66 & 0xff) 241 | 242 | def set_interrupt_limits(self, low, high): 243 | """Set the interrupt limits to provied unsigned 16-bit threshold values. 244 | """ 245 | self._device.write8(0x04, low & 0xFF) 246 | self._device.write8(0x05, low >> 8) 247 | self._device.write8(0x06, high & 0xFF) 248 | self._device.write8(0x07, high >> 8) 249 | -------------------------------------------------------------------------------- /Adafruit_TCS34725/__init__.py: -------------------------------------------------------------------------------- 1 | from .TCS34725 import * 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2016 Adafruit Industries 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DEPRECATED LIBRARY Adafruit Python TCS34725 2 | 3 | This library has been deprecated! 4 | 5 | We are now only using our CircuitPython sensor libraries in Python. 6 | 7 | We are leaving the code up for historical/research purposes but archiving the 8 | repository. 9 | 10 | Check out this guide for using the TCS34725 with Python! 11 | 12 | https://learn.adafruit.com/adafruit-color-sensors/python-circuitpython 13 | 14 | ---- 15 | 16 | Python code to use the TCS34725 color sensor with the Raspberry Pi & BeagleBone Black. 17 | 18 | ## Installation 19 | 20 | To install the library from source (recommended) run the following commands on a Raspberry Pi or other Debian-based OS system: 21 | 22 | sudo apt-get install git build-essential python-dev 23 | cd ~ 24 | git clone https://github.com/adafruit/Adafruit_Python_TCS34725.git 25 | cd Adafruit_Python_TCS34725 26 | sudo python setup.py install 27 | 28 | Alternatively you can install from pip with: 29 | 30 | sudo pip install adafruit-tcs34725 31 | 32 | Note that the pip install method **won't** install the example code. 33 | -------------------------------------------------------------------------------- /examples/simpletest.py: -------------------------------------------------------------------------------- 1 | # Simple demo of reading color data with the TCS34725 sensor. 2 | # Will read the color from the sensor and print it out along with lux and 3 | # color temperature. 4 | # Author: Tony DiCola 5 | # License: Public Domain 6 | import time 7 | 8 | # Import the TCS34725 module. 9 | import Adafruit_TCS34725 10 | 11 | 12 | # Create a TCS34725 instance with default integration time (2.4ms) and gain (4x). 13 | import smbus 14 | tcs = Adafruit_TCS34725.TCS34725() 15 | 16 | # You can also override the I2C device address and/or bus with parameters: 17 | #tcs = Adafruit_TCS34725.TCS34725(address=0x30, busnum=2) 18 | 19 | # Or you can change the integration time and/or gain: 20 | #tcs = Adafruit_TCS34725.TCS34725(integration_time=Adafruit_TCS34725.TCS34725_INTEGRATIONTIME_700MS, 21 | # gain=Adafruit_TCS34725.TCS34725_GAIN_60X) 22 | # Possible integration time values: 23 | # - TCS34725_INTEGRATIONTIME_2_4MS (2.4ms, default) 24 | # - TCS34725_INTEGRATIONTIME_24MS 25 | # - TCS34725_INTEGRATIONTIME_50MS 26 | # - TCS34725_INTEGRATIONTIME_101MS 27 | # - TCS34725_INTEGRATIONTIME_154MS 28 | # - TCS34725_INTEGRATIONTIME_700MS 29 | # Possible gain values: 30 | # - TCS34725_GAIN_1X 31 | # - TCS34725_GAIN_4X 32 | # - TCS34725_GAIN_16X 33 | # - TCS34725_GAIN_60X 34 | 35 | # Disable interrupts (can enable them by passing true, see the set_interrupt_limits function too). 36 | tcs.set_interrupt(False) 37 | 38 | # Read the R, G, B, C color data. 39 | r, g, b, c = tcs.get_raw_data() 40 | 41 | # Calculate color temperature using utility functions. You might also want to 42 | # check out the colormath library for much more complete/accurate color functions. 43 | color_temp = Adafruit_TCS34725.calculate_color_temperature(r, g, b) 44 | 45 | # Calculate lux with another utility function. 46 | lux = Adafruit_TCS34725.calculate_lux(r, g, b) 47 | 48 | # Print out the values. 49 | print('Color: red={0} green={1} blue={2} clear={3}'.format(r, g, b, c)) 50 | 51 | # Print out color temperature. 52 | if color_temp is None: 53 | print('Too dark to determine color temperature!') 54 | else: 55 | print('Color Temperature: {0} K'.format(color_temp)) 56 | 57 | # Print out the lux. 58 | print('Luminosity: {0} lux'.format(lux)) 59 | 60 | # Enable interrupts and put the chip back to low power sleep/disabled. 61 | tcs.set_interrupt(True) 62 | tcs.disable() 63 | -------------------------------------------------------------------------------- /ez_setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """Bootstrap setuptools installation 3 | 4 | To use setuptools in your package's setup.py, include this 5 | file in the same directory and add this to the top of your setup.py:: 6 | 7 | from ez_setup import use_setuptools 8 | use_setuptools() 9 | 10 | To require a specific version of setuptools, set a download 11 | mirror, or use an alternate download directory, simply supply 12 | the appropriate options to ``use_setuptools()``. 13 | 14 | This file can also be run as a script to install or upgrade setuptools. 15 | """ 16 | import os 17 | import shutil 18 | import sys 19 | import tempfile 20 | import zipfile 21 | import optparse 22 | import subprocess 23 | import platform 24 | import textwrap 25 | import contextlib 26 | 27 | from distutils import log 28 | 29 | try: 30 | from site import USER_SITE 31 | except ImportError: 32 | USER_SITE = None 33 | 34 | DEFAULT_VERSION = "3.5.1" 35 | DEFAULT_URL = "https://pypi.python.org/packages/source/s/setuptools/" 36 | 37 | def _python_cmd(*args): 38 | """ 39 | Return True if the command succeeded. 40 | """ 41 | args = (sys.executable,) + args 42 | return subprocess.call(args) == 0 43 | 44 | 45 | def _install(archive_filename, install_args=()): 46 | with archive_context(archive_filename): 47 | # installing 48 | log.warn('Installing Setuptools') 49 | if not _python_cmd('setup.py', 'install', *install_args): 50 | log.warn('Something went wrong during the installation.') 51 | log.warn('See the error message above.') 52 | # exitcode will be 2 53 | return 2 54 | 55 | 56 | def _build_egg(egg, archive_filename, to_dir): 57 | with archive_context(archive_filename): 58 | # building an egg 59 | log.warn('Building a Setuptools egg in %s', to_dir) 60 | _python_cmd('setup.py', '-q', 'bdist_egg', '--dist-dir', to_dir) 61 | # returning the result 62 | log.warn(egg) 63 | if not os.path.exists(egg): 64 | raise IOError('Could not build the egg.') 65 | 66 | 67 | def get_zip_class(): 68 | """ 69 | Supplement ZipFile class to support context manager for Python 2.6 70 | """ 71 | class ContextualZipFile(zipfile.ZipFile): 72 | def __enter__(self): 73 | return self 74 | def __exit__(self, type, value, traceback): 75 | self.close 76 | return zipfile.ZipFile if hasattr(zipfile.ZipFile, '__exit__') else \ 77 | ContextualZipFile 78 | 79 | 80 | @contextlib.contextmanager 81 | def archive_context(filename): 82 | # extracting the archive 83 | tmpdir = tempfile.mkdtemp() 84 | log.warn('Extracting in %s', tmpdir) 85 | old_wd = os.getcwd() 86 | try: 87 | os.chdir(tmpdir) 88 | with get_zip_class()(filename) as archive: 89 | archive.extractall() 90 | 91 | # going in the directory 92 | subdir = os.path.join(tmpdir, os.listdir(tmpdir)[0]) 93 | os.chdir(subdir) 94 | log.warn('Now working in %s', subdir) 95 | yield 96 | 97 | finally: 98 | os.chdir(old_wd) 99 | shutil.rmtree(tmpdir) 100 | 101 | 102 | def _do_download(version, download_base, to_dir, download_delay): 103 | egg = os.path.join(to_dir, 'setuptools-%s-py%d.%d.egg' 104 | % (version, sys.version_info[0], sys.version_info[1])) 105 | if not os.path.exists(egg): 106 | archive = download_setuptools(version, download_base, 107 | to_dir, download_delay) 108 | _build_egg(egg, archive, to_dir) 109 | sys.path.insert(0, egg) 110 | 111 | # Remove previously-imported pkg_resources if present (see 112 | # https://bitbucket.org/pypa/setuptools/pull-request/7/ for details). 113 | if 'pkg_resources' in sys.modules: 114 | del sys.modules['pkg_resources'] 115 | 116 | import setuptools 117 | setuptools.bootstrap_install_from = egg 118 | 119 | 120 | def use_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, 121 | to_dir=os.curdir, download_delay=15): 122 | to_dir = os.path.abspath(to_dir) 123 | rep_modules = 'pkg_resources', 'setuptools' 124 | imported = set(sys.modules).intersection(rep_modules) 125 | try: 126 | import pkg_resources 127 | except ImportError: 128 | return _do_download(version, download_base, to_dir, download_delay) 129 | try: 130 | pkg_resources.require("setuptools>=" + version) 131 | return 132 | except pkg_resources.DistributionNotFound: 133 | return _do_download(version, download_base, to_dir, download_delay) 134 | except pkg_resources.VersionConflict as VC_err: 135 | if imported: 136 | msg = textwrap.dedent(""" 137 | The required version of setuptools (>={version}) is not available, 138 | and can't be installed while this script is running. Please 139 | install a more recent version first, using 140 | 'easy_install -U setuptools'. 141 | 142 | (Currently using {VC_err.args[0]!r}) 143 | """).format(VC_err=VC_err, version=version) 144 | sys.stderr.write(msg) 145 | sys.exit(2) 146 | 147 | # otherwise, reload ok 148 | del pkg_resources, sys.modules['pkg_resources'] 149 | return _do_download(version, download_base, to_dir, download_delay) 150 | 151 | def _clean_check(cmd, target): 152 | """ 153 | Run the command to download target. If the command fails, clean up before 154 | re-raising the error. 155 | """ 156 | try: 157 | subprocess.check_call(cmd) 158 | except subprocess.CalledProcessError: 159 | if os.access(target, os.F_OK): 160 | os.unlink(target) 161 | raise 162 | 163 | def download_file_powershell(url, target): 164 | """ 165 | Download the file at url to target using Powershell (which will validate 166 | trust). Raise an exception if the command cannot complete. 167 | """ 168 | target = os.path.abspath(target) 169 | cmd = [ 170 | 'powershell', 171 | '-Command', 172 | "(new-object System.Net.WebClient).DownloadFile(%(url)r, %(target)r)" % vars(), 173 | ] 174 | _clean_check(cmd, target) 175 | 176 | def has_powershell(): 177 | if platform.system() != 'Windows': 178 | return False 179 | cmd = ['powershell', '-Command', 'echo test'] 180 | devnull = open(os.path.devnull, 'wb') 181 | try: 182 | try: 183 | subprocess.check_call(cmd, stdout=devnull, stderr=devnull) 184 | except Exception: 185 | return False 186 | finally: 187 | devnull.close() 188 | return True 189 | 190 | download_file_powershell.viable = has_powershell 191 | 192 | def download_file_curl(url, target): 193 | cmd = ['curl', url, '--silent', '--output', target] 194 | _clean_check(cmd, target) 195 | 196 | def has_curl(): 197 | cmd = ['curl', '--version'] 198 | devnull = open(os.path.devnull, 'wb') 199 | try: 200 | try: 201 | subprocess.check_call(cmd, stdout=devnull, stderr=devnull) 202 | except Exception: 203 | return False 204 | finally: 205 | devnull.close() 206 | return True 207 | 208 | download_file_curl.viable = has_curl 209 | 210 | def download_file_wget(url, target): 211 | cmd = ['wget', url, '--quiet', '--output-document', target] 212 | _clean_check(cmd, target) 213 | 214 | def has_wget(): 215 | cmd = ['wget', '--version'] 216 | devnull = open(os.path.devnull, 'wb') 217 | try: 218 | try: 219 | subprocess.check_call(cmd, stdout=devnull, stderr=devnull) 220 | except Exception: 221 | return False 222 | finally: 223 | devnull.close() 224 | return True 225 | 226 | download_file_wget.viable = has_wget 227 | 228 | def download_file_insecure(url, target): 229 | """ 230 | Use Python to download the file, even though it cannot authenticate the 231 | connection. 232 | """ 233 | try: 234 | from urllib.request import urlopen 235 | except ImportError: 236 | from urllib2 import urlopen 237 | src = dst = None 238 | try: 239 | src = urlopen(url) 240 | # Read/write all in one block, so we don't create a corrupt file 241 | # if the download is interrupted. 242 | data = src.read() 243 | dst = open(target, "wb") 244 | dst.write(data) 245 | finally: 246 | if src: 247 | src.close() 248 | if dst: 249 | dst.close() 250 | 251 | download_file_insecure.viable = lambda: True 252 | 253 | def get_best_downloader(): 254 | downloaders = [ 255 | download_file_powershell, 256 | download_file_curl, 257 | download_file_wget, 258 | download_file_insecure, 259 | ] 260 | 261 | for dl in downloaders: 262 | if dl.viable(): 263 | return dl 264 | 265 | def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, 266 | to_dir=os.curdir, delay=15, downloader_factory=get_best_downloader): 267 | """ 268 | Download setuptools from a specified location and return its filename 269 | 270 | `version` should be a valid setuptools version number that is available 271 | as an egg for download under the `download_base` URL (which should end 272 | with a '/'). `to_dir` is the directory where the egg will be downloaded. 273 | `delay` is the number of seconds to pause before an actual download 274 | attempt. 275 | 276 | ``downloader_factory`` should be a function taking no arguments and 277 | returning a function for downloading a URL to a target. 278 | """ 279 | # making sure we use the absolute path 280 | to_dir = os.path.abspath(to_dir) 281 | zip_name = "setuptools-%s.zip" % version 282 | url = download_base + zip_name 283 | saveto = os.path.join(to_dir, zip_name) 284 | if not os.path.exists(saveto): # Avoid repeated downloads 285 | log.warn("Downloading %s", url) 286 | downloader = downloader_factory() 287 | downloader(url, saveto) 288 | return os.path.realpath(saveto) 289 | 290 | def _build_install_args(options): 291 | """ 292 | Build the arguments to 'python setup.py install' on the setuptools package 293 | """ 294 | return ['--user'] if options.user_install else [] 295 | 296 | def _parse_args(): 297 | """ 298 | Parse the command line for options 299 | """ 300 | parser = optparse.OptionParser() 301 | parser.add_option( 302 | '--user', dest='user_install', action='store_true', default=False, 303 | help='install in user site package (requires Python 2.6 or later)') 304 | parser.add_option( 305 | '--download-base', dest='download_base', metavar="URL", 306 | default=DEFAULT_URL, 307 | help='alternative URL from where to download the setuptools package') 308 | parser.add_option( 309 | '--insecure', dest='downloader_factory', action='store_const', 310 | const=lambda: download_file_insecure, default=get_best_downloader, 311 | help='Use internal, non-validating downloader' 312 | ) 313 | parser.add_option( 314 | '--version', help="Specify which version to download", 315 | default=DEFAULT_VERSION, 316 | ) 317 | options, args = parser.parse_args() 318 | # positional arguments are ignored 319 | return options 320 | 321 | def main(): 322 | """Install or upgrade setuptools and EasyInstall""" 323 | options = _parse_args() 324 | archive = download_setuptools( 325 | version=options.version, 326 | download_base=options.download_base, 327 | downloader_factory=options.downloader_factory, 328 | ) 329 | return _install(archive, _build_install_args(options)) 330 | 331 | if __name__ == '__main__': 332 | sys.exit(main()) 333 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | try: 2 | # Try using ez_setup to install setuptools if not already installed. 3 | from ez_setup import use_setuptools 4 | use_setuptools() 5 | except ImportError: 6 | # Ignore import error and assume Python 3 which already has setuptools. 7 | pass 8 | 9 | from setuptools import setup, find_packages 10 | 11 | from codecs import open 12 | from os import path 13 | 14 | here = path.abspath(path.dirname(__file__)) 15 | 16 | # Get the long description from the README file 17 | with open(path.join(here, 'README.md'), encoding='utf-8') as f: 18 | long_description = f.read() 19 | 20 | classifiers = ['Development Status :: 4 - Beta', 21 | 'Operating System :: POSIX :: Linux', 22 | 'License :: OSI Approved :: MIT License', 23 | 'Intended Audience :: Developers', 24 | 'Programming Language :: Python :: 2.7', 25 | 'Programming Language :: Python :: 3', 26 | 'Topic :: Software Development', 27 | 'Topic :: System :: Hardware'] 28 | 29 | setup(name = 'Adafruit_TCS34725', 30 | version = '1.0.3', 31 | author = 'Tony DiCola', 32 | author_email = 'tdicola@adafruit.com', 33 | description = 'Python code to use the TCS34725 color sensor with the Raspberry Pi & BeagleBone Black.', 34 | license = 'MIT', 35 | classifiers = classifiers, 36 | url = 'https://github.com/adafruit/Adafruit_Python_TCS34725/', 37 | dependency_links = ['https://github.com/adafruit/Adafruit_Python_GPIO/tarball/master#egg=Adafruit-GPIO-0.6.5'], 38 | install_requires = ['Adafruit-GPIO>=0.6.5'], 39 | packages = find_packages(), 40 | 41 | long_description = long_description, 42 | long_description_content_type = 'text/markdown') 43 | --------------------------------------------------------------------------------