Skip to content

Commit 0b133c7

Browse files
GadgetoidGadgetoid
authored
Merge pull request #931 from pimoroni/driver/as7343
AS7343: New driver for the 14 channel spectrometer
2 parents 5691573 + 8bb1708 commit 0b133c7

18 files changed

+924
-0
lines changed

‎common/pimoroni_i2c.cpp‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,15 @@ namespace pimoroni {
4040
i2c_write_blocking(i2c, address, buffer, 2, false);
4141
}
4242

43+
void I2C::reg_write_uint16(uint8_t address, uint8_t reg, uint16_t value) {
44+
uint8_t buffer[3] = {
45+
reg,
46+
(uint8_t)((value & 0xff00) >> 8),
47+
(uint8_t)(value & 0x00ff)
48+
};
49+
i2c_write_blocking(i2c, address, buffer, 3, false);
50+
}
51+
4352
uint8_t I2C::reg_read_uint8(uint8_t address, uint8_t reg) {
4453
uint8_t value;
4554
i2c_write_blocking(i2c, address, &reg, 1, false);

‎common/pimoroni_i2c.hpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ namespace pimoroni {
6363
i2c_inst_t* pin_to_inst(uint pin);
6464

6565
void reg_write_uint8(uint8_t address, uint8_t reg, uint8_t value);
66+
void reg_write_uint16(uint8_t address, uint8_t reg, uint16_t value);
6667
uint8_t reg_read_uint8(uint8_t address, uint8_t reg);
6768
uint16_t reg_read_uint16(uint8_t address, uint8_t reg);
6869
int16_t reg_read_int16(uint8_t address, uint8_t reg);

‎drivers/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ add_subdirectory(is31fl3731)
1616
add_subdirectory(fatfs)
1717
add_subdirectory(sdcard)
1818
add_subdirectory(as7262)
19+
add_subdirectory(as7343)
1920
add_subdirectory(bh1745)
2021
add_subdirectory(bme68x)
2122
add_subdirectory(bmp280)

‎drivers/as7343/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include(as7343.cmake)

‎drivers/as7343/as7343.cmake‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
set(DRIVER_NAME as7343)
2+
add_library(${DRIVER_NAME} INTERFACE)
3+
4+
target_sources(${DRIVER_NAME} INTERFACE
5+
${CMAKE_CURRENT_LIST_DIR}/${DRIVER_NAME}.cpp)
6+
7+
target_include_directories(${DRIVER_NAME} INTERFACE ${CMAKE_CURRENT_LIST_DIR})
8+
9+
# Pull in pico libraries that we need
10+
target_link_libraries(${DRIVER_NAME} INTERFACE pico_stdlib hardware_i2c pimoroni_i2c)

‎drivers/as7343/as7343.cpp‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
#include <cstdlib>
2+
#include <math.h>
3+
#include <map>
4+
#include <vector>
5+
#include <cstring>
6+
7+
#include "as7343.hpp"
8+
9+
namespace pimoroni {
10+
11+
bool AS7343::init() {
12+
if(interrupt != PIN_UNUSED) {
13+
gpio_set_function(interrupt, GPIO_FUNC_SIO);
14+
gpio_set_dir(interrupt, GPIO_IN);
15+
gpio_pull_up(interrupt);
16+
}
17+
18+
uint8_t aux_id, revision_id, hardware_id;
19+
get_version(aux_id, revision_id, hardware_id);
20+
21+
if(hardware_id != HARDWARE_ID) {
22+
return false;
23+
}
24+
25+
reset();
26+
27+
bank_select(0);
28+
29+
// Enable all 7 channels in output FIFO
30+
i2c->set_bits(address, reg::FIFO_MAP, 0, FIFO_MAP_CH5 | FIFO_MAP_CH4 | FIFO_MAP_CH3 | FIFO_MAP_CH2 | FIFO_MAP_CH1 | FIFO_MAP_CH0 | FIFO_MAP_ASTATUS);
31+
32+
// Set the PON bit
33+
i2c->reg_write_uint8(address, reg::ENABLE, ENABLE_WEN | ENABLE_SMUXEN | ENABLE_SP_EN | ENABLE_PON);
34+
35+
return true;
36+
}
37+
38+
void AS7343::reset() {
39+
i2c->reg_write_uint8(address, reg::CONTROL, CONTROL_SW_RESET);
40+
sleep_ms(1000);
41+
}
42+
43+
i2c_inst_t* AS7343::get_i2c() const {
44+
return i2c->get_i2c();
45+
}
46+
47+
int AS7343::get_sda() const {
48+
return i2c->get_sda();
49+
}
50+
51+
int AS7343::get_scl() const {
52+
return i2c->get_scl();
53+
}
54+
55+
int AS7343::get_int() const {
56+
return interrupt;
57+
}
58+
59+
void AS7343::bank_select(uint8_t bank) {
60+
if(bank == 1) {
61+
i2c->set_bits(address, reg::CFG0, 0, CFG0_BANK);
62+
} else {
63+
i2c->clear_bits(address, reg::CFG0, 0, CFG0_BANK);
64+
}
65+
}
66+
67+
void AS7343::get_version(uint8_t &auxid, uint8_t &revid, uint8_t &hwid) {
68+
bank_select(1);
69+
auxid = i2c->reg_read_uint8(address, reg::AUXID) & 0b00001111;
70+
revid = i2c->reg_read_uint8(address, reg::REVID) & 0b00000111;
71+
hwid = i2c->reg_read_uint8(address, reg::ID);
72+
bank_select(0);
73+
}
74+
75+
void AS7343::set_gain(float gain) {
76+
if(gain == 0.5f) {
77+
i2c->reg_write_uint8(address, reg::CFG1, 0);
78+
} else {
79+
uint16_t ugain = (uint16_t)gain;
80+
uint16_t bitlength = 0;
81+
while(ugain > 0) {
82+
bitlength++;
83+
ugain >>= 1;
84+
}
85+
i2c->reg_write_uint8(address, reg::CFG1, bitlength & 0x1f);
86+
}
87+
}
88+
89+
void AS7343::set_channels(channel_count channel_count) {
90+
this->read_cycles = uint8_t(channel_count) / 6;
91+
this->ch_count = (uint8_t)channel_count;
92+
uint8_t temp = i2c->reg_read_uint8(address, reg::CFG20) & ~CFG20_18_CH;
93+
switch(channel_count) {
94+
case channel_count::SIX_CHANNEL:
95+
temp |= CFG20_6_CH;
96+
break;
97+
case channel_count::TWELVE_CHANNEL:
98+
temp |= CFG20_12_CH;
99+
break;
100+
case channel_count::EIGHTEEN_CHANNEL:
101+
temp |= CFG20_18_CH;
102+
break;
103+
}
104+
i2c->reg_write_uint8(address, reg::CFG20, temp);
105+
}
106+
107+
void AS7343::set_illumination_current(float current) {
108+
current -= 4;
109+
current /= 2.0f;
110+
uint8_t temp = i2c->reg_read_uint8(address, reg::LED) & 0b10000000;
111+
temp |= (uint8_t)current;
112+
i2c->reg_write_uint8(address, reg::LED, temp);
113+
}
114+
115+
void AS7343::set_illumination_led(bool state) {
116+
uint8_t temp = i2c->reg_read_uint8(address, reg::LED) & 0b01111111;
117+
temp |= state ? 0x80 : 0x00;
118+
i2c->reg_write_uint8(address, reg::LED, temp);
119+
}
120+
121+
void AS7343::set_measurement_time(float measurement_time_ms) {
122+
constexpr float resolution = 2.78f;
123+
i2c->reg_write_uint8(address, reg::WTIME, (uint8_t)((measurement_time_ms - resolution) / resolution));
124+
}
125+
126+
void AS7343::set_integration_time(float integration_time_us, uint8_t repeat) {
127+
constexpr float resolution = 2.78f;
128+
constexpr float max_astep = (65534 + 1) * resolution;
129+
130+
if (integration_time_us <= max_astep) {
131+
i2c->reg_write_uint8(address, reg::ATIME, repeat - 1);
132+
i2c->reg_write_uint16(address, reg::ASTEP, (uint16_t)((integration_time_us - resolution) / resolution) & 0xfffe);
133+
} else {
134+
// Time out of range...
135+
}
136+
}
137+
138+
void AS7343::read_fifo(uint16_t *buf) {
139+
uint16_t expected_results = read_cycles * 7;
140+
uint16_t result_slot = 0;
141+
142+
while (i2c->reg_read_uint8(address, reg::FIFO_LVL) < expected_results) {
143+
sleep_ms(1);
144+
}
145+
146+
while (i2c->reg_read_uint8(address, reg::FIFO_LVL) > 0 && expected_results > 0) {
147+
buf[result_slot] = i2c->reg_read_uint16(address, reg::FDATA);
148+
expected_results--;
149+
result_slot++;
150+
}
151+
}
152+
153+
AS7343::reading AS7343::read() {
154+
reading result;
155+
read_fifo((uint16_t *)&result);
156+
return result;
157+
}
158+
159+
160+
}

‎drivers/as7343/as7343.hpp‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
#pragma once
2+
3+
#include <string>
4+
5+
#include "hardware/i2c.h"
6+
#include "hardware/gpio.h"
7+
#include "common/pimoroni_common.hpp"
8+
#include "common/pimoroni_i2c.hpp"
9+
#include "as7343_regs.hpp"
10+
11+
namespace pimoroni {
12+
13+
class AS7343 {
14+
//--------------------------------------------------
15+
// Constants
16+
//--------------------------------------------------
17+
public:
18+
static const uint8_t DEFAULT_I2C_ADDRESS = 0x39;
19+
20+
//--------------------------------------------------
21+
// Enums
22+
//--------------------------------------------------
23+
public:
24+
enum class channel_count : uint8_t {
25+
SIX_CHANNEL = 6,
26+
TWELVE_CHANNEL = 12,
27+
EIGHTEEN_CHANNEL = 18
28+
};
29+
/*
30+
enum class COMPENSATION_GAIN : float {
31+
F1 = 1.84f,
32+
F2 = 6.03f,
33+
FZ = 4.88f,
34+
F3 = 13.74f,
35+
F4 = 3.37f,
36+
FY = 2.82f,
37+
F5 = 6.72f,
38+
FXL = 2.22f,
39+
F6 = 3.17f,
40+
F7 = 1.95f,
41+
F8 = 12.25f,
42+
NIR = 1.00f,
43+
};
44+
*/
45+
46+
//--------------------------------------------------
47+
// Substructures
48+
//--------------------------------------------------
49+
public:
50+
struct reading {
51+
// Cycle 1
52+
uint16_t FZ = 0; // 428-480 nm
53+
uint16_t FY = 0; // 534-593 nm
54+
uint16_t FXL = 0; // 593-628 nm
55+
uint16_t NIR = 0; // 849-903 nm
56+
57+
uint16_t c1_vis_tl = 0; // Visible top-left
58+
uint16_t c1_vis_br = 0; // Visible bottom-right
59+
uint16_t c1_astatus = 0; // (c1_astatus >> 8) & 0b10001111
60+
// 0b10000000 = saturated
61+
// 0b00001111 = gain lowest nibble
62+
63+
// Cycle 2
64+
uint16_t F2 = 0; // 408-448 nm
65+
uint16_t F3 = 0; // 448-500 mn
66+
uint16_t F4 = 0; // 500-534 nm
67+
uint16_t F6 = 0; // 618-665 nm
68+
69+
uint16_t c2_vis_tl = 0;
70+
uint16_t c2_vis_br = 0;
71+
uint16_t c2_astatus = 0;
72+
73+
// Cycle 3
74+
uint16_t F1 = 0; // 396-408 nm
75+
uint16_t F5 = 0; // 531-594 nm
76+
uint16_t F7 = 0; // 685-715 nm
77+
uint16_t F8 = 0; // 715-766 nm
78+
79+
uint16_t c3_vis_tl = 0;
80+
uint16_t c3_vis_br = 0;
81+
uint16_t c3_astatus = 0;
82+
};
83+
84+
85+
//--------------------------------------------------
86+
// Variables
87+
//--------------------------------------------------
88+
private:
89+
I2C *i2c;
90+
91+
// interface pins with our standard defaults where appropriate
92+
int8_t address = DEFAULT_I2C_ADDRESS;
93+
uint interrupt = PIN_UNUSED;
94+
95+
uint8_t read_cycles = 1;
96+
uint8_t ch_count = (uint8_t)channel_count::SIX_CHANNEL;
97+
98+
99+
//--------------------------------------------------
100+
// Constructors/Destructor
101+
//--------------------------------------------------
102+
public:
103+
AS7343(uint interrupt = PIN_UNUSED) : AS7343(new I2C(), interrupt) {};
104+
105+
AS7343(I2C *i2c, uint interrupt = PIN_UNUSED) : i2c(i2c), interrupt(interrupt) {}
106+
107+
108+
//--------------------------------------------------
109+
// Methods
110+
//--------------------------------------------------
111+
public:
112+
bool init();
113+
void reset();
114+
115+
// For print access in micropython
116+
i2c_inst_t* get_i2c() const;
117+
int get_sda() const;
118+
int get_scl() const;
119+
int get_int() const;
120+
121+
void get_version(uint8_t &auxid, uint8_t &revid, uint8_t &hwid);
122+
123+
reading read();
124+
125+
void read_fifo(uint16_t *buf);
126+
127+
void set_gain(float gain);
128+
void set_illumination_current(float current);
129+
void set_illumination_led(bool state);
130+
void set_measurement_time(float measurement_time_ms);
131+
void set_integration_time(float integration_time_us, uint8_t repeat=1);
132+
133+
void set_channels(channel_count channel_count);
134+
135+
private:
136+
void bank_select(uint8_t bank=0);
137+
};
138+
139+
}

0 commit comments

Comments
 (0)