|
| 1 | +**This feature is not included in precompiled binaries.** |
| 2 | +To use it you must [compile your build](compile-your-build). Add the following to `user_config_override.h`: |
| 3 | +``` |
| 4 | +#ifndef USE_APDS9960 |
| 5 | +#define USE_APDS9960 // Enable APDS9960 Proximity Sensor (+4k7 code) |
| 6 | +#endif |
| 7 | +``` |
| 8 | +---- |
| 9 | +<img src="https://i.postimg.cc/qRLyPy1n/APDS-9960-1-720x533.jpg" align=right> |
| 10 | +Broadcom APDS-9960 is a digital RGB, ambient light, proximity and gesture sensor device in a single 8-pin package. The device has an I2C compatible interface providing red, green, blue, clear (RGBC), proximity and gesture sensing with IR LED. The RGB and ambient light sensing feature detects light intensity under various lighting conditions and through various attentuation materials including darkened glass. In addition, the integrated UV-IR blocking filter enables accurate ambient light and correlated color temperature sensing. |
| 11 | + |
| 12 | +## Configuration |
| 13 | +### Wiring |
| 14 | +| Breakout | ESP8266 | |
| 15 | +|----------|-----------| |
| 16 | +| VCC/VIN | +3.3VDC | |
| 17 | +| GND | GND | |
| 18 | +| SCL | GPIOy | |
| 19 | +| SDA | GPIOx | |
| 20 | +| INT/IRQ | not used | |
| 21 | + |
| 22 | +### Tasmota Configuration |
| 23 | +In the _Configuration -> Configure Module_ page assign: |
| 24 | +1. GPIOx to `I2C SDA (6)` |
| 25 | +2. GPIOy to `I2C SCL (5)` |
| 26 | + |
| 27 | +After configuring the GPIO's the driver will detect the APDS-9960 automatically. |
| 28 | +On first boot sensor will start in gesture mode. It will not appear in the webUI but it can be observed via MQTT messages in console: |
| 29 | + |
| 30 | +```json |
| 31 | +21:34:21 MQT: tele/tasmota/RESULT = {"Gesture":"Off"} |
| 32 | +21:34:23 MQT: tele/tasmota/RESULT = {"Gesture":"On"} |
| 33 | +21:34:25 MQT: tele/tasmota/SENSOR = {"Time":"2019-10-31T21:34:25","APDS9960":{"None":1}} |
| 34 | +21:34:26 MQT: tele/tasmota/SENSOR = {"Time":"2019-10-31T21:34:26","APDS9960":{"Right":1}} |
| 35 | +21:34:29 MQT: tele/tasmota/SENSOR = {"Time":"2019-10-31T21:34:29","APDS9960":{"Down":1}} |
| 36 | +21:34:29 MQT: tele/tasmota/SENSOR = {"Time":"2019-10-31T21:34:29","APDS9960":{"Right":1}} |
| 37 | +21:34:31 MQT: tele/tasmota/SENSOR = {"Time":"2019-10-31T21:34:31","APDS9960":{"Left":1}} |
| 38 | +21:34:33 MQT: tele/tasmota/SENSOR = {"Time":"2019-10-31T21:34:33","APDS9960":{"Up":1}} |
| 39 | +21:34:35 MQT: tele/tasmota/SENSOR = {"Time":"2019-10-31T21:34:35","APDS9960":{"Down":1}} |
| 40 | +``` |
| 41 | + |
| 42 | +When you enable RGBC mode with `Sensor27 0` sensor will show up in web UI: |
| 43 | + |
| 44 | + |
| 45 | +and in MQTT topic (according to TelePeriod): |
| 46 | +`MQT: tele/tasmota/SENSOR = {"Time":"2019-10-31T21:48:51","APDS9960":{"Red":282,"Green":252,"Blue":196,"Ambient":169,"CCT":4217,"Proximity":9}}` |
| 47 | + |
| 48 | +## Commands |
| 49 | +| Command | Value | Description | |
| 50 | +|---|---|---| |
| 51 | +| Sensor27 || Show APDS9960 gesture/RGBC mode | |
| 52 | +| Sensor27 | 0 / off | Disable APDS9960 gesture mode/Enable RGBC mode | |
| 53 | +| Sensor27 | 1 / on | Enable APDS9960 gesture mode/Disable RGBC mode | |
| 54 | +| Sensor27 | 2 / on | Enable APDS9960 gesture mode/Disable RGBC mode with half gain| |
| 55 | +| Sensor27 | 3 ...255 | Set ATIME register for different integration times| |
| 56 | + |
| 57 | +### Example rules |
| 58 | +***In gesture sensing mode `Tele-APDS9960` is the trigger (APDS9960 will not work)*** |
| 59 | + |
| 60 | +Device will be in RGBC mode until something is close to it, then it switches into gesture mode for 60 seconds. |
| 61 | +``` |
| 62 | +Rule on APDS9960#Proximity=250 do backlog Sensor27 1; RuleTimer1 60 endon on Rules#Timer=1 do Sensor27 0 endon |
| 63 | +``` |
| 64 | + |
| 65 | +Relay ON when ambient light is below 100 lux. |
| 66 | +``` |
| 67 | +Rule on APDS9960#Ambient<100 do POWER ON endon |
| 68 | +``` |
| 69 | + |
| 70 | +Control ON/OFF, brightness and color temperature with gestures |
| 71 | +``` |
| 72 | +Rule on Tele-APDS9960#Long do power toggle endon on Tele-APDS9960#Up do dimmer + endon on Tele-APDS9960#Down do dimmer - endon on Tele-APDS9960#Left do ct + endon on Tele-APDS9960#Right do ct - endon |
| 73 | +``` |
| 74 | + |
| 75 | +## Known issues: |
| 76 | + |
| 77 | +1. The different PCB’s on the market seem to differ quite substantially regarding to their electrical characteristics. We have at least one case report, where this led to a malfunction on an ESP8266-board within Tasmota but in another library too. The exact technical reason can only be suspected, but it is probably related to electrical noise and/or power consumption. |
| 78 | +In the case from above the sensor measured an incorrect high proximity value, which resulted in repeated triggering of a "LONG" gesture. The solution was to decrease the gain factor for proximity and gesture. Therefore the argument 2 (`sensor27 2`) was introduced to change this at runtime. |
| 79 | +If you experience gesture sensing problems you could try this out, but if you measure proximity values <25 with nothing in front of the sensor (e.g. web interface after `sensor27 0`), then there is very likely another problem. It can be assumed, that the gesture sensitivity will suffer with reduced gain, so first try option 1 (=default). |
| 80 | +Beside that better wiring and maybe an additional capacitor over VCC and GROUND might be helpful. |
| 81 | + |
| 82 | +2. The measurement of the light level is briefly described in the datasheet and the open-source-libraries use the ambient-light-value directly from the sensor or calculate a LUX-value from RGB. Both variants are usable and differentiate between low and strong light, but the absolute values are questionable and at the moment we have an uncalibrated sensor. |
| 83 | +All known solutions use a fixed integration time, which is more or less the same as a fixed exposure time in photography. In contrast the TSL2561-library uses various integration times and maybe this is possible on the APDS9960 too. |
| 84 | +To eventually achieve this in the future, the option to set this integration time at runtime was added. Every argument between 3 and 255 sets the ATIME-register. |
| 85 | +The formula is: integration time = (256-ATIME)*2,78 ms, so with the default value of 219 we get (256-219)*2,78 = 102,86 ms. That means a smaller ATIME makes the integration time longer and more photons are captured, which might be usable for (very) low light conditions, because otherwise the sensor will saturate too early. The opposite is valid for a bigger ATIME value. |
| 86 | +The change of this value only makes sense for: users who need to change the sensitivity, if the sensor resides behind dark glass or want to contribute to the development of a new LUX-calculation in the driver. If we get enough feedback, this could lead to an improvement on the software side. Feel free to open (or search for) an issue, if you have measured the APDS9960 against other devices with different ATIME-values at different light levels. This is not a trivial task though. |
| 87 | + |
| 88 | +## Generally available types of breakout boards |
| 89 | + |
| 90 | + |
| 91 | + |
| 92 | + |
| 93 | + |
| 94 | + |
| 95 | +#### Where to get |
| 96 | + * ~ 2€ at [AliExpress](https://www.aliexpress.com/wholesale?catId=0&initiative_id=&SearchText=apds-9960) |
| 97 | + * ~ $8 at [Adafruit](https://www.adafruit.com/product/3595) |
| 98 | + |
| 99 | +[APDS-9960 Datasheet](https://docs.broadcom.com/docs/AV02-4191EN) |
0 commit comments