Rename frequency and modulation

Restoring the original `frequency` property to refer to the proximity
modulator timing (to keep from making a breaking change to the API)
and renamed the new property to `samplerate`.

Author: stonehippo

adafruit_vcnl4010.py

@@ -56,20 +56,20 @@
 
 # User-facing constants:
 # Number of proximity measuremenrs per second
-FREQUENCY_1_95 = 0
-FREQUENCY_3_90625 = 1
-FREQUENCY_7_8125 = 2
-FREQUENCY_16_625 = 3
-FREQUENCY_31_25 = 4
-FREQUENCY_62_5 = 5
-FREQUENCY_125 = 6
-FREQUENCY_250 = 7
+SAMPLERATE_1_95 = 0
+SAMPLERATE_3_90625 = 1
+SAMPLERATE_7_8125 = 2
+SAMPLERATE_16_625 = 3
+SAMPLERATE_31_25 = 4
+SAMPLERATE_62_5 = 5
+SAMPLERATE_125 = 6
+SAMPLERATE_250 = 7
 
 # Proximity modulator timing
-MODULATION_3M125 = 3
-MODULATION_1M5625 = 2
-MODULATION_781K25 = 1
-MODULATION_390K625 = 0
+FREQUENCY_3M125 = 3
+FREQUENCY_1M5625 = 2
+FREQUENCY_781K25 = 1
+FREQUENCY_390K625 = 0
 
 # Disable pylint's name warning as it causes too much noise.  Suffixes like
 # BE (big-endian) or mA (milli-amps) don't confirm to its conventions--by
@@ -124,8 +124,8 @@ def __init__(self, i2c, address=_VCNL4010_I2CADDR_DEFAULT):
         if (revision & 0xF0) != 0x20:
             raise RuntimeError("Failed to find VCNL4010, check wiring!")
         self.led_current = 20
-        self.frequency = FREQUENCY_1_95
-        self.modulation = MODULATION_390K625
+        self.samplerate = SAMPLERATE_1_95
+        self.frequency = FREQUENCY_390K625
         self._write_u8(_VCNL4010_INTCONTROL, 0x08)
 
     def _read_u8(self, address):
@@ -180,43 +180,48 @@ def led_current_mA(self, val):
         self.led_current = val // 10
 
     @property
-    def frequency(self):
+    def samplerate(self):
         """
         The frequency of proximity measurements per second.  Must be a value of:
 
-        - FREQUENCY_1_95: 1.95 measurements/sec (default)
-        - FREQUENCY_3_90625: 3.90625 measurements/sec
-        - FREQUENCY_7_8125: 7.8125 measurements/sec
-        - FREQUENCY_16_625: 16.625 measurements/sec
-        - FREQUENCY_31_25: 31.25 measurements/sec
-        - FREQUENCY_62_5: 62.5 measurements/sec
-        - FREQUENCY_125: 125 measurements/sec
-        - FREQUENCY_250: 250 measurements/sec
+        - SAMPLERATE_1_95: 1.95 measurements/sec (default)
+        - SAMPLERATE_3_90625: 3.90625 measurements/sec
+        - SAMPLERATE_7_8125: 7.8125 measurements/sec
+        - SAMPLERATE_16_625: 16.625 measurements/sec
+        - SAMPLERATE_31_25: 31.25 measurements/sec
+        - SAMPLERATE_62_5: 62.5 measurements/sec
+        - SAMPLERATE_125: 125 measurements/sec
+        - SAMPLERATE_250: 250 measurements/sec
 
         See the datasheet for how frequency changes the power consumption and
         proximity detection accuracy.
         """
         return self._read_u8(_VCNL4010_PROXRATE)
 
-    @frequency.setter
-    def frequency(self, val):
+    @samplerate.setter
+    def samplerate(self, val):
         assert 0 <= val <= 7
         self._write_u8(_VCNL4010_PROXRATE, val)
 
     @property
-    def modulation(self):
+    def frequency(self):
         """
-        Proximity modulator timimg.  Must be a value of:
-
-        - MODULATION_3M125: 3.125 Mhz
-        - MODULATION_1M5625: 1.5625 Mhz
-        - MODULATION_781K25: 781.25 Khz
-        - MODULATION_390K625: 390.625 Khz (default)
+        Proximity modulator timimg. This is the frequency of the IR square
+        wave used for the proximity measurement.
+        
+        Must be a value of:
+
+        - FREQUENCY_3M125: 3.125 Mhz
+        - FREQUENCY_1M5625: 1.5625 Mhz
+        - FREQUENCY_781K25: 781.25 Khz
+        - FREQUENCY_390K625: 390.625 Khz (default)
+        
+        The datasheet recommended leaving this at the default.
         """
         return (self._read_u8(_VCNL4010_MODTIMING) >> 3) & 0x03
 
-    @modulation.setter
-    def modulation(self, val):
+    @frequency.setter
+    def frequency(self, val):
         assert 0 <= val <= 3
         timing = self._read_u8(_VCNL4010_MODTIMING)
         timing &= ~0b00011000