Author: Shoe-Pi(original), modified by Luis Soenksen Introduction
This is a set of functions for using the Sparkfun AS7262 Visible Spectrometer Breakout with the Raspberry Pi. Please note that these were written for and have only been tested on the visible spectrometer board, not the similar AS7263 near infra-red board.
There are 5 files in this repo:
- README.md is the file you're currently reading and contains information about how to use this repo.
- Adafruit_Python_AS7262.py contains all of the functions which make the AS7262 board work with the Pi.
- Basic_example.py is, well, a basic example of how to use the AS7262 board with the Pi.
The AS7262 communicates with the Pi using the I2C bus. The I2C address of the device is 0x49, and the script requires the SMBus, time and struct Python modules, all installed on the Pi by default.
Connecting the board
The board has what Sparkfun calls Qwiic connectors, but it's possible to connect the board to the Raspberry Pi's GPIO pin headers with a little soldering. Use jumper wires to connect the breakout's GND to one of the Pi's GPIO Ground wires, 3v3 to the Pi's 3v3 pin, SDA to BCM2/GPIO3, and SCL to BCM3/GPIO5. See Pinout.xyz if you need help. This script doesn't currently support interacting with the interrupt or reset pins.
Suggested usage:
-
Ensure that I2C is enabled on your Pi: run
sudo raspi-configin a terminal, and then go toInterfacing Options>I2C>yes. If you're going to try the UHHD_spectrometer.py example script make sure you've got the Pimoroni Unicorn HAT HD installed (See Pimoroni's GitHub page for the UHHD). -
Download this repo by running
git clone https://github.com/Shoe-Pi/AS7262_Piin a terminal. -
Place the file called "AS7262_Pi.py" in the same directory as your script, and import it.
-
Use
set_gain(gain)to set the gain (by default the Sparkfun Arduino library for the AS7262 uses a gain value of 3, for x64 gain). -
Use
set_integration_time(time)to set the integration time (by default the Sparkfun Arduino library uses a value of 50, for 140ms cycle time). -
Use
set_measurement_mode(mode)to tell the board how often to take readings. A value of 3 measures a single set of red, orange, yellow, green, blue and violet values. -
Use
get_calibrated_values()to return a list of 6 floats with values in the order ROYGBV.
- take_single_measurement()
Function to get the breakout to take a single set of red, orange, yellow, green, blue and violet readings and return them as a list of 6 floats in the order ROYGBV.
- take_single_measurement_with_led()
The same as take_single_measurement(), but turns on the white LED on the breakout before measuring and disables it afterwards.
- get_calibrated_values()
Function to read, process and return stored calibrated red, orange, yellow, green, blue and violet values as a list of floats in the order ROYGBV. Note that once get_calibrated_readings() is used a flag is set on the AS7262 stating that no new values are available to be read until the device takes another set of readings. For set_measurement_mode() values of 0-2 this shouldn't cause issues because the board will continuously take new readings. However, in measurement mode 3 (single measurement mode) subsequent attempts to retrieve readings will fail until the board is put back into mode 3 to take another set of readings.
- set_measurement_mode(mode)
Tells the breakout how to take measurements, MUST be passed an integer value of 0, 1, 2 or 3. Defaults to mode 2.
0 = continuous violet, blue, green and yellow readings every (integration time * 2.8) milliseconds.
1 = continuous green, yellow, orange and red readings every (integration time * 2.8) milliseconds.
2 = continuous readings of all channels (violet, blue, green, yellow, orange and red) every (integration time * 2 * 2.8) milliseconds.
3 = single measurement of all channels (no repeat readings/rate).
- enable_main_led()
Turns on the breakout's white LED. The brightness is controlled by set_led_current(). The LED is off by default.
- disable_main_led()
Turns the breakout's white LED off.
- set_led_current(current_level)
Sets the current provided to the white LED, MUST be passed an integer value of 0, 1, 2 or 3. More current is brighter, but note that the LED doesn't actually turn on until enable_main_led() is used. Defaults to 12.5 mA (mode 0).
0 = 12.5 mA
1 = 25 mA
2 = 50 mA
3 = 100 mA
- enable_indicator_led()
Turns on the breakout's blue indicator LED. The brightness is controlled by set_indicator_current(). The LED is off by default.
- disable_indicator_led()
Turns the breakout's indicator LED off.
- set_indicator_current(current_level)
Sets the current provided to the indicator LED, MUST be passed an integer value of 0, 1, 2 or 3. More current is brighter, but note that the LED doesn't actually turn on until enable_indicator_led() is used. Defaults to 1 mA (mode 0).
0 = 1 mA
1 = 2 mA
2 = 4 mA
3 = 8 mA
- soft_reset()
Soft resets the breakout with a 0.8 second wait for the reset to complete (this time was determined experimentally, anything less seems to cause the I2C bus to timeout). This should reset all control registers to their default values.
- set_gain(gain)
Sets the gain of the spectrometer. More gain = higher readings, MUST be passed an integer value of 0, 1, 2 or 3. Defaults to x1 (mode 0). Sparkfun's library for the AS7262 seems to routinely use a value of 3/x64.
0 = x1 gain
1 = x3.7 gain
2 = x16 gain
3 = x64 gain
- set_integration_time(time)
Sets the integration time of the readings. Higher values mean longer measurements but are less prone to noise (?). Must be given an integer between 1 and 255, refer to the set_measurement_mode() section to see how this affects the time to take a reading. Defaults to 255. Sparkfun's library for the AS7262 seems to routinely use a value of 50.
- get_temperature()
Returns the temperature in °C from the sensor using the built in temperature sensor. This only seems to return integers.
- get_temperature_f()
Returns the temperature in °F from the sensor by converting the centrigade value of get_temperature() to °F.
- read_reg(reg_to_read)
Returns a single byte from a virtual register on the breakout. reg_to_read should be the address of the register to read. The AS7262 uses an odd virtual register system which makes it more complicated to read data from the device than usual. If that makes no sense then don't worry, this function is just here so that the other functions can use it: you won't need to use it yourself.
- write_reg(reg_to_write_to, command_to_write)
Function to write a single byte to a single virtual register on the breakout. reg_to_write_to should be the address of the virtual register to be written to (BEFORE bit 7 is set to 1 to indicate a write, i.e. use the same address as for reading), command_to_write should be a single hex value to be written to that register. Like I2C reads, the AS7262 uses a slightly odd system for writing to registers and so this function handles that.