drivers: Add micropython.const() wrapper to all const.py files.

Author: nedseb

lib/apds9960/apds9960/const.py

@@ -1,176 +1,178 @@
+from micropython import const
+
 # APDS9960 i2c address
-APDS9960_I2C_ADDR = 0x39
+APDS9960_I2C_ADDR = const(0x39)
 
 # APDS9960 gesture parameters
-APDS9960_GESTURE_THRESHOLD_OUT = 10
-APDS9960_GESTURE_SENSITIVITY_1 = 50
-APDS9960_GESTURE_SENSITIVITY_2 = 20
+APDS9960_GESTURE_THRESHOLD_OUT = const(10)
+APDS9960_GESTURE_SENSITIVITY_1 = const(50)
+APDS9960_GESTURE_SENSITIVITY_2 = const(20)
 
 # APDS9960 device IDs
 APDS9960_DEV_ID = [0xAB, 0x9C, 0xA8, -0x55]
 
 # APDS9960 times (FIFO pause in milliseconds)
-APDS9960_TIME_FIFO_PAUSE = 30
+APDS9960_TIME_FIFO_PAUSE = const(30)
 
 # APDS9960 register addresses
-APDS9960_REG_ENABLE = 0x80
-APDS9960_REG_ATIME = 0x81
-APDS9960_REG_WTIME = 0x83
-APDS9960_REG_AILTL = 0x84
-APDS9960_REG_AILTH = 0x85
-APDS9960_REG_AIHTL = 0x86
-APDS9960_REG_AIHTH = 0x87
-APDS9960_REG_PILT = 0x89
-APDS9960_REG_PIHT = 0x8B
-APDS9960_REG_PERS = 0x8C
-APDS9960_REG_CONFIG1 = 0x8D
-APDS9960_REG_PPULSE = 0x8E
-APDS9960_REG_CONTROL = 0x8F
-APDS9960_REG_CONFIG2 = 0x90
-APDS9960_REG_ID = 0x92
-APDS9960_REG_STATUS = 0x93
-APDS9960_REG_CDATAL = 0x94
-APDS9960_REG_CDATAH = 0x95
-APDS9960_REG_RDATAL = 0x96
-APDS9960_REG_RDATAH = 0x97
-APDS9960_REG_GDATAL = 0x98
-APDS9960_REG_GDATAH = 0x99
-APDS9960_REG_BDATAL = 0x9A
-APDS9960_REG_BDATAH = 0x9B
-APDS9960_REG_PDATA = 0x9C
-APDS9960_REG_POFFSET_UR = 0x9D
-APDS9960_REG_POFFSET_DL = 0x9E
-APDS9960_REG_CONFIG3 = 0x9F
-APDS9960_REG_GPENTH = 0xA0
-APDS9960_REG_GEXTH = 0xA1
-APDS9960_REG_GCONF1 = 0xA2
-APDS9960_REG_GCONF2 = 0xA3
-APDS9960_REG_GOFFSET_U = 0xA4
-APDS9960_REG_GOFFSET_D = 0xA5
-APDS9960_REG_GOFFSET_L = 0xA7
-APDS9960_REG_GOFFSET_R = 0xA9
-APDS9960_REG_GPULSE = 0xA6
-APDS9960_REG_GCONF3 = 0xAA
-APDS9960_REG_GCONF4 = 0xAB
-APDS9960_REG_GFLVL = 0xAE
-APDS9960_REG_GSTATUS = 0xAF
-APDS9960_REG_IFORCE = 0xE4
-APDS9960_REG_PICLEAR = 0xE5
-APDS9960_REG_CICLEAR = 0xE6
-APDS9960_REG_AICLEAR = 0xE7
-APDS9960_REG_GFIFO_U = 0xFC
-APDS9960_REG_GFIFO_D = 0xFD
-APDS9960_REG_GFIFO_L = 0xFE
-APDS9960_REG_GFIFO_R = 0xFF
+APDS9960_REG_ENABLE = const(0x80)
+APDS9960_REG_ATIME = const(0x81)
+APDS9960_REG_WTIME = const(0x83)
+APDS9960_REG_AILTL = const(0x84)
+APDS9960_REG_AILTH = const(0x85)
+APDS9960_REG_AIHTL = const(0x86)
+APDS9960_REG_AIHTH = const(0x87)
+APDS9960_REG_PILT = const(0x89)
+APDS9960_REG_PIHT = const(0x8B)
+APDS9960_REG_PERS = const(0x8C)
+APDS9960_REG_CONFIG1 = const(0x8D)
+APDS9960_REG_PPULSE = const(0x8E)
+APDS9960_REG_CONTROL = const(0x8F)
+APDS9960_REG_CONFIG2 = const(0x90)
+APDS9960_REG_ID = const(0x92)
+APDS9960_REG_STATUS = const(0x93)
+APDS9960_REG_CDATAL = const(0x94)
+APDS9960_REG_CDATAH = const(0x95)
+APDS9960_REG_RDATAL = const(0x96)
+APDS9960_REG_RDATAH = const(0x97)
+APDS9960_REG_GDATAL = const(0x98)
+APDS9960_REG_GDATAH = const(0x99)
+APDS9960_REG_BDATAL = const(0x9A)
+APDS9960_REG_BDATAH = const(0x9B)
+APDS9960_REG_PDATA = const(0x9C)
+APDS9960_REG_POFFSET_UR = const(0x9D)
+APDS9960_REG_POFFSET_DL = const(0x9E)
+APDS9960_REG_CONFIG3 = const(0x9F)
+APDS9960_REG_GPENTH = const(0xA0)
+APDS9960_REG_GEXTH = const(0xA1)
+APDS9960_REG_GCONF1 = const(0xA2)
+APDS9960_REG_GCONF2 = const(0xA3)
+APDS9960_REG_GOFFSET_U = const(0xA4)
+APDS9960_REG_GOFFSET_D = const(0xA5)
+APDS9960_REG_GOFFSET_L = const(0xA7)
+APDS9960_REG_GOFFSET_R = const(0xA9)
+APDS9960_REG_GPULSE = const(0xA6)
+APDS9960_REG_GCONF3 = const(0xAA)
+APDS9960_REG_GCONF4 = const(0xAB)
+APDS9960_REG_GFLVL = const(0xAE)
+APDS9960_REG_GSTATUS = const(0xAF)
+APDS9960_REG_IFORCE = const(0xE4)
+APDS9960_REG_PICLEAR = const(0xE5)
+APDS9960_REG_CICLEAR = const(0xE6)
+APDS9960_REG_AICLEAR = const(0xE7)
+APDS9960_REG_GFIFO_U = const(0xFC)
+APDS9960_REG_GFIFO_D = const(0xFD)
+APDS9960_REG_GFIFO_L = const(0xFE)
+APDS9960_REG_GFIFO_R = const(0xFF)
 
 # APDS9960 bit fields
-APDS9960_BIT_PON = 0b00000001
-APDS9960_BIT_AEN = 0b00000010
-APDS9960_BIT_PEN = 0b00000100
-APDS9960_BIT_WEN = 0b00001000
-APDS9960_BIT_AIEN = 0b00010000
-APDS9960_BIT_PIEN = 0b00100000
-APDS9960_BIT_GEN = 0b01000000
-APDS9960_BIT_GVALID = 0b00000001
-APDS9960_BIT_AVALID = 0b00000001
-APDS9960_BIT_PVALID = 0b00000010
-APDS9960_BIT_GINT = 0b00000100
-APDS9960_BIT_AINT = 0b00010000
-APDS9960_BIT_PINT = 0b00100000
-APDS9960_BIT_PGSAT = 0b01000000
-APDS9960_BIT_CPSAT = 0b10000000
+APDS9960_BIT_PON = const(0b00000001)
+APDS9960_BIT_AEN = const(0b00000010)
+APDS9960_BIT_PEN = const(0b00000100)
+APDS9960_BIT_WEN = const(0b00001000)
+APDS9960_BIT_AIEN = const(0b00010000)
+APDS9960_BIT_PIEN = const(0b00100000)
+APDS9960_BIT_GEN = const(0b01000000)
+APDS9960_BIT_GVALID = const(0b00000001)
+APDS9960_BIT_AVALID = const(0b00000001)
+APDS9960_BIT_PVALID = const(0b00000010)
+APDS9960_BIT_GINT = const(0b00000100)
+APDS9960_BIT_AINT = const(0b00010000)
+APDS9960_BIT_PINT = const(0b00100000)
+APDS9960_BIT_PGSAT = const(0b01000000)
+APDS9960_BIT_CPSAT = const(0b10000000)
 
 # APDS9960 modes
-APDS9960_MODE_POWER = 0
-APDS9960_MODE_AMBIENT_LIGHT = 1
-APDS9960_MODE_PROXIMITY = 2
-APDS9960_MODE_WAIT = 3
-APDS9960_MODE_AMBIENT_LIGHT_INT = 4
-APDS9960_MODE_PROXIMITY_INT = 5
-APDS9960_MODE_GESTURE = 6
-APDS9960_MODE_ALL = 7
+APDS9960_MODE_POWER = const(0)
+APDS9960_MODE_AMBIENT_LIGHT = const(1)
+APDS9960_MODE_PROXIMITY = const(2)
+APDS9960_MODE_WAIT = const(3)
+APDS9960_MODE_AMBIENT_LIGHT_INT = const(4)
+APDS9960_MODE_PROXIMITY_INT = const(5)
+APDS9960_MODE_GESTURE = const(6)
+APDS9960_MODE_ALL = const(7)
 
 # LED Drive values
-APDS9960_LED_DRIVE_100MA = 0
-APDS9960_LED_DRIVE_50MA = 1
-APDS9960_LED_DRIVE_25MA = 2
-APDS9960_LED_DRIVE_12_5MA = 3
+APDS9960_LED_DRIVE_100MA = const(0)
+APDS9960_LED_DRIVE_50MA = const(1)
+APDS9960_LED_DRIVE_25MA = const(2)
+APDS9960_LED_DRIVE_12_5MA = const(3)
 
 # Proximity Gain (PGAIN) values
-APDS9960_PGAIN_1X = 0
-APDS9960_PGAIN_2X = 1
-APDS9960_PGAIN_4X = 2
-APDS9960_PGAIN_8X = 3
+APDS9960_PGAIN_1X = const(0)
+APDS9960_PGAIN_2X = const(1)
+APDS9960_PGAIN_4X = const(2)
+APDS9960_PGAIN_8X = const(3)
 
 # ALS Gain (AGAIN) values
-APDS9960_AGAIN_1X = 0
-APDS9960_AGAIN_4X = 1
-APDS9960_AGAIN_16X = 2
-APDS9960_AGAIN_64X = 3
+APDS9960_AGAIN_1X = const(0)
+APDS9960_AGAIN_4X = const(1)
+APDS9960_AGAIN_16X = const(2)
+APDS9960_AGAIN_64X = const(3)
 
 # Gesture Gain (GGAIN) values
-APDS9960_GGAIN_1X = 0
-APDS9960_GGAIN_2X = 1
-APDS9960_GGAIN_4X = 2
-APDS9960_GGAIN_8X = 3
+APDS9960_GGAIN_1X = const(0)
+APDS9960_GGAIN_2X = const(1)
+APDS9960_GGAIN_4X = const(2)
+APDS9960_GGAIN_8X = const(3)
 
 # LED Boost values
-APDS9960_LED_BOOST_100 = 0
-APDS9960_LED_BOOST_150 = 1
-APDS9960_LED_BOOST_200 = 2
-APDS9960_LED_BOOST_300 = 3
+APDS9960_LED_BOOST_100 = const(0)
+APDS9960_LED_BOOST_150 = const(1)
+APDS9960_LED_BOOST_200 = const(2)
+APDS9960_LED_BOOST_300 = const(3)
 
 # Gesture wait time values
-APDS9960_GWTIME_0MS = 0
-APDS9960_GWTIME_2_8MS = 1
-APDS9960_GWTIME_5_6MS = 2
-APDS9960_GWTIME_8_4MS = 3
-APDS9960_GWTIME_14_0MS = 4
-APDS9960_GWTIME_22_4MS = 5
-APDS9960_GWTIME_30_8MS = 6
-APDS9960_GWTIME_39_2MS = 7
+APDS9960_GWTIME_0MS = const(0)
+APDS9960_GWTIME_2_8MS = const(1)
+APDS9960_GWTIME_5_6MS = const(2)
+APDS9960_GWTIME_8_4MS = const(3)
+APDS9960_GWTIME_14_0MS = const(4)
+APDS9960_GWTIME_22_4MS = const(5)
+APDS9960_GWTIME_30_8MS = const(6)
+APDS9960_GWTIME_39_2MS = const(7)
 
 # Default values
-APDS9960_DEFAULT_ATIME = 219  # 103ms
-APDS9960_DEFAULT_WTIME = 246  # 27ms
-APDS9960_DEFAULT_PROX_PPULSE = 0x87  # 16us, 8 pulses
-APDS9960_DEFAULT_GESTURE_PPULSE = 0x89  # 16us, 10 pulses
-APDS9960_DEFAULT_POFFSET_UR = 0  # 0 offset
-APDS9960_DEFAULT_POFFSET_DL = 0  # 0 offset
-APDS9960_DEFAULT_CONFIG1 = 0x60  # No 12x wait (WTIME)
+APDS9960_DEFAULT_ATIME = const(219)  # 103ms
+APDS9960_DEFAULT_WTIME = const(246)  # 27ms
+APDS9960_DEFAULT_PROX_PPULSE = const(0x87)  # 16us, 8 pulses
+APDS9960_DEFAULT_GESTURE_PPULSE = const(0x89)  # 16us, 10 pulses
+APDS9960_DEFAULT_POFFSET_UR = const(0)  # 0 offset
+APDS9960_DEFAULT_POFFSET_DL = const(0)  # 0 offset
+APDS9960_DEFAULT_CONFIG1 = const(0x60)  # No 12x wait (WTIME)
 APDS9960_DEFAULT_LDRIVE = APDS9960_LED_DRIVE_100MA
 APDS9960_DEFAULT_PGAIN = APDS9960_PGAIN_4X
 APDS9960_DEFAULT_AGAIN = APDS9960_AGAIN_4X
-APDS9960_DEFAULT_PILT = 0  # Low proximity threshold
-APDS9960_DEFAULT_PIHT = 50  # High proximity threshold
-APDS9960_DEFAULT_AILT = 0xFFFF  # Force interrupt for calibration
-APDS9960_DEFAULT_AIHT = 0
-APDS9960_DEFAULT_PERS = 0x11  # 2 consecutive prox or ALS for int.
-APDS9960_DEFAULT_CONFIG2 = 0x01  # No saturation interrupts or LED boost
-APDS9960_DEFAULT_CONFIG3 = 0  # Enable all photodiodes, no SAI
-APDS9960_DEFAULT_GPENTH = 40  # Threshold for entering gesture mode
-APDS9960_DEFAULT_GEXTH = 30  # Threshold for exiting gesture mode
-APDS9960_DEFAULT_GCONF1 = 0x40  # 4 gesture events for int., 1 for exit
+APDS9960_DEFAULT_PILT = const(0)  # Low proximity threshold
+APDS9960_DEFAULT_PIHT = const(50)  # High proximity threshold
+APDS9960_DEFAULT_AILT = const(0xFFFF)  # Force interrupt for calibration
+APDS9960_DEFAULT_AIHT = const(0)
+APDS9960_DEFAULT_PERS = const(0x11)  # 2 consecutive prox or ALS for int.
+APDS9960_DEFAULT_CONFIG2 = const(0x01)  # No saturation interrupts or LED boost
+APDS9960_DEFAULT_CONFIG3 = const(0)  # Enable all photodiodes, no SAI
+APDS9960_DEFAULT_GPENTH = const(40)  # Threshold for entering gesture mode
+APDS9960_DEFAULT_GEXTH = const(30)  # Threshold for exiting gesture mode
+APDS9960_DEFAULT_GCONF1 = const(0x40)  # 4 gesture events for int., 1 for exit
 APDS9960_DEFAULT_GGAIN = APDS9960_GGAIN_4X
 APDS9960_DEFAULT_GLDRIVE = APDS9960_LED_DRIVE_100MA
 APDS9960_DEFAULT_GWTIME = APDS9960_GWTIME_2_8MS
-APDS9960_DEFAULT_GOFFSET = 0  # No offset scaling for gesture mode
-APDS9960_DEFAULT_GPULSE = 0xC9  # 32us, 10 pulses
-APDS9960_DEFAULT_GCONF3 = 0  # All photodiodes active during gesture
-APDS9960_DEFAULT_GIEN = 0  # Disable gesture interrupts
+APDS9960_DEFAULT_GOFFSET = const(0)  # No offset scaling for gesture mode
+APDS9960_DEFAULT_GPULSE = const(0xC9)  # 32us, 10 pulses
+APDS9960_DEFAULT_GCONF3 = const(0)  # All photodiodes active during gesture
+APDS9960_DEFAULT_GIEN = const(0)  # Disable gesture interrupts
 
 # gesture directions
-APDS9960_DIR_NONE = 0
-APDS9960_DIR_LEFT = 1
-APDS9960_DIR_RIGHT = 2
-APDS9960_DIR_UP = 3
-APDS9960_DIR_DOWN = 4
-APDS9960_DIR_NEAR = 5
-APDS9960_DIR_FAR = 6
-APDS9960_DIR_ALL = 7
+APDS9960_DIR_NONE = const(0)
+APDS9960_DIR_LEFT = const(1)
+APDS9960_DIR_RIGHT = const(2)
+APDS9960_DIR_UP = const(3)
+APDS9960_DIR_DOWN = const(4)
+APDS9960_DIR_NEAR = const(5)
+APDS9960_DIR_FAR = const(6)
+APDS9960_DIR_ALL = const(7)
 
 # state definitions
-APDS9960_STATE_NA = 0
-APDS9960_STATE_NEAR = 1
-APDS9960_STATE_FAR = 2
-APDS9960_STATE_ALL = 3
+APDS9960_STATE_NA = const(0)
+APDS9960_STATE_NEAR = const(1)
+APDS9960_STATE_FAR = const(2)
+APDS9960_STATE_ALL = const(3)