Skip to content

Commit 6fcbaf5

Browse files
committed
AS7343: MicroPython bindings.
1 parent 6803f00 commit 6fcbaf5

File tree

7 files changed

+271
-0
lines changed

7 files changed

+271
-0
lines changed

drivers/as7343/as7343.cpp

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ namespace pimoroni {
1515
gpio_pull_up(interrupt);
1616
}
1717

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+
1825
reset();
1926

2027
bank_select(0);

drivers/as7343/as7343_regs.hpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ namespace pimoroni {
112112
FDATA = 0xFE // 0xFFFF
113113
};
114114

115+
constexpr uint8_t HARDWARE_ID = 0b10000001;
116+
115117
constexpr uint8_t CFG0_LOW_POWER = 0b00100000;
116118
constexpr uint8_t CFG0_BANK = 0b00010000;
117119
constexpr uint8_t CFG0_WLONG = 0b00000100;
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
#include "breakout_as7343.h"
2+
3+
////////////////////////////////////////////////////////////////////////////////////////////////////
4+
// BreakoutAS7343 Class
5+
////////////////////////////////////////////////////////////////////////////////////////////////////
6+
7+
/***** Methods *****/
8+
MP_DEFINE_CONST_FUN_OBJ_1(BreakoutAS7343_reset_obj, BreakoutAS7343_reset);
9+
MP_DEFINE_CONST_FUN_OBJ_1(BreakoutAS7343_version_obj, BreakoutAS7343_version);
10+
MP_DEFINE_CONST_FUN_OBJ_1(BreakoutAS7343_read_obj, BreakoutAS7343_read);
11+
12+
MP_DEFINE_CONST_FUN_OBJ_2(BreakoutAS7343_set_gain_obj, BreakoutAS7343_set_gain);
13+
MP_DEFINE_CONST_FUN_OBJ_2(BreakoutAS7343_set_integration_time_obj, BreakoutAS7343_set_integration_time);
14+
MP_DEFINE_CONST_FUN_OBJ_2(BreakoutAS7343_set_measurement_time_obj, BreakoutAS7343_set_measurement_time);
15+
16+
MP_DEFINE_CONST_FUN_OBJ_2(BreakoutAS7343_set_illumination_current_obj, BreakoutAS7343_set_illumination_current);
17+
MP_DEFINE_CONST_FUN_OBJ_2(BreakoutAS7343_set_illumination_led_obj, BreakoutAS7343_set_illumination_led);
18+
19+
MP_DEFINE_CONST_FUN_OBJ_2(BreakoutAS7343_set_channels_obj, BreakoutAS7343_set_channels);
20+
21+
/***** Binding of Methods *****/
22+
STATIC const mp_rom_map_elem_t BreakoutAS7343_locals_dict_table[] = {
23+
{ MP_ROM_QSTR(MP_QSTR_reset), MP_ROM_PTR(&BreakoutAS7343_reset_obj) },
24+
{ MP_ROM_QSTR(MP_QSTR_version), MP_ROM_PTR(&BreakoutAS7343_version_obj) },
25+
{ MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&BreakoutAS7343_read_obj) },
26+
27+
{ MP_ROM_QSTR(MP_QSTR_set_gain), MP_ROM_PTR(&BreakoutAS7343_set_gain_obj) },
28+
{ MP_ROM_QSTR(MP_QSTR_set_measurement_time), MP_ROM_PTR(&BreakoutAS7343_set_measurement_time_obj) },
29+
{ MP_ROM_QSTR(MP_QSTR_set_integration_time), MP_ROM_PTR(&BreakoutAS7343_set_integration_time_obj) },
30+
{ MP_ROM_QSTR(MP_QSTR_set_illumination_current), MP_ROM_PTR(&BreakoutAS7343_set_illumination_current_obj) },
31+
{ MP_ROM_QSTR(MP_QSTR_set_illumination_led), MP_ROM_PTR(&BreakoutAS7343_set_illumination_led_obj) },
32+
{ MP_ROM_QSTR(MP_QSTR_set_channels), MP_ROM_PTR(&BreakoutAS7343_set_channels_obj) },
33+
};
34+
STATIC MP_DEFINE_CONST_DICT(BreakoutAS7343_locals_dict, BreakoutAS7343_locals_dict_table);
35+
36+
/***** Class Definition *****/
37+
#ifdef MP_DEFINE_CONST_OBJ_TYPE
38+
MP_DEFINE_CONST_OBJ_TYPE(
39+
breakout_as7343_BreakoutAS7343_type,
40+
MP_QSTR_BreakoutAS7343,
41+
MP_TYPE_FLAG_NONE,
42+
make_new, BreakoutAS7343_make_new,
43+
locals_dict, (mp_obj_dict_t*)&BreakoutAS7343_locals_dict
44+
);
45+
#else
46+
const mp_obj_type_t breakout_as7343_BreakoutAS7343_type = {
47+
{ &mp_type_type },
48+
.name = MP_QSTR_BreakoutAS7343,
49+
.make_new = BreakoutAS7343_make_new,
50+
.locals_dict = (mp_obj_dict_t*)&BreakoutAS7343_locals_dict,
51+
};
52+
#endif
53+
54+
55+
////////////////////////////////////////////////////////////////////////////////////////////////////
56+
// breakout_as7343 Module
57+
////////////////////////////////////////////////////////////////////////////////////////////////////
58+
59+
/***** Globals Table *****/
60+
STATIC const mp_map_elem_t breakout_as7343_globals_table[] = {
61+
{ MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR_breakout_as7343) },
62+
{ MP_OBJ_NEW_QSTR(MP_QSTR_BreakoutAS7343), (mp_obj_t)&breakout_as7343_BreakoutAS7343_type },
63+
};
64+
STATIC MP_DEFINE_CONST_DICT(mp_module_breakout_as7343_globals, breakout_as7343_globals_table);
65+
66+
/***** Module Definition *****/
67+
const mp_obj_module_t breakout_as7343_user_cmodule = {
68+
.base = { &mp_type_module },
69+
.globals = (mp_obj_dict_t*)&mp_module_breakout_as7343_globals,
70+
};
71+
72+
////////////////////////////////////////////////////////////////////////////////////////////////////
73+
#if MICROPY_VERSION <= 70144
74+
MP_REGISTER_MODULE(MP_QSTR_breakout_as7343, breakout_as7343_user_cmodule, MODULE_BREAKOUT_AS7343_ENABLED);
75+
#else
76+
MP_REGISTER_MODULE(MP_QSTR_breakout_as7343, breakout_as7343_user_cmodule);
77+
#endif
78+
////////////////////////////////////////////////////////////////////////////////////////////////////
79+
////////////////////////////////////////////////////////////////////////////////////////////////////
Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
#include "drivers/as7343/as7343.hpp"
2+
#include "common/pimoroni_i2c.hpp"
3+
#include "micropython/modules/util.hpp"
4+
5+
6+
using namespace pimoroni;
7+
8+
extern "C" {
9+
#include "breakout_as7343.h"
10+
#include "pimoroni_i2c.h"
11+
12+
/***** Variables Struct *****/
13+
typedef struct _breakout_as7343_BreakoutAS7343_obj_t {
14+
mp_obj_base_t base;
15+
AS7343 *breakout;
16+
_PimoroniI2C_obj_t *i2c;
17+
} breakout_as7343_BreakoutAS7343_obj_t;
18+
19+
20+
21+
/***** Constructor *****/
22+
mp_obj_t BreakoutAS7343_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
23+
breakout_as7343_BreakoutAS7343_obj_t *self = nullptr;
24+
25+
enum { ARG_i2c, ARG_int };
26+
static const mp_arg_t allowed_args[] = {
27+
{ MP_QSTR_i2c, MP_ARG_OBJ, {.u_obj = nullptr} },
28+
{ MP_QSTR_interrupt, MP_ARG_INT, {.u_int = PIN_UNUSED} },
29+
};
30+
31+
// Parse args.
32+
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
33+
mp_arg_parse_all_kw_array(n_args, n_kw, all_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
34+
35+
self = m_new_obj(breakout_as7343_BreakoutAS7343_obj_t);
36+
self->base.type = &breakout_as7343_BreakoutAS7343_type;
37+
38+
self->i2c = PimoroniI2C_from_machine_i2c_or_native(args[ARG_i2c].u_obj);
39+
40+
self->breakout = m_new_class(AS7343, (pimoroni::I2C *)(self->i2c->i2c), args[ARG_int].u_int);
41+
42+
if(!self->breakout->init()) {
43+
mp_raise_msg(&mp_type_RuntimeError, "BreakoutAS7343: breakout not found when initialising");
44+
}
45+
46+
return MP_OBJ_FROM_PTR(self);
47+
}
48+
49+
/***** Methods *****/
50+
mp_obj_t BreakoutAS7343_reset(mp_obj_t self_in) {
51+
breakout_as7343_BreakoutAS7343_obj_t *self = MP_OBJ_TO_PTR2(self_in, breakout_as7343_BreakoutAS7343_obj_t);
52+
self->breakout->reset();
53+
54+
return mp_const_none;
55+
}
56+
57+
mp_obj_t BreakoutAS7343_version(mp_obj_t self_in) {
58+
breakout_as7343_BreakoutAS7343_obj_t *self = MP_OBJ_TO_PTR2(self_in, breakout_as7343_BreakoutAS7343_obj_t);
59+
60+
uint8_t aux_id, revision_id, hardware_id;
61+
self->breakout->get_version(aux_id, revision_id, hardware_id);
62+
63+
mp_obj_t tuple[3];
64+
tuple[0] = mp_obj_new_int(aux_id);
65+
tuple[1] = mp_obj_new_int(revision_id);
66+
tuple[2] = mp_obj_new_int(hardware_id);
67+
return mp_obj_new_tuple(3, tuple);
68+
}
69+
70+
mp_obj_t BreakoutAS7343_read(mp_obj_t self_in) {
71+
breakout_as7343_BreakoutAS7343_obj_t *self = MP_OBJ_TO_PTR2(self_in, breakout_as7343_BreakoutAS7343_obj_t);
72+
AS7343::reading reading = self->breakout->read();
73+
74+
mp_obj_t tuple[12];
75+
tuple[0] = mp_obj_new_float(reading.FZ);
76+
tuple[1] = mp_obj_new_float(reading.FY);
77+
tuple[2] = mp_obj_new_float(reading.FXL);
78+
tuple[3] = mp_obj_new_float(reading.NIR);
79+
80+
tuple[4] = mp_obj_new_float(reading.F2);
81+
tuple[5] = mp_obj_new_float(reading.F3);
82+
tuple[6] = mp_obj_new_float(reading.F4);
83+
tuple[7] = mp_obj_new_float(reading.F6);
84+
85+
tuple[8] = mp_obj_new_float(reading.F1);
86+
tuple[9] = mp_obj_new_float(reading.F5);
87+
tuple[10] = mp_obj_new_float(reading.F7);
88+
tuple[11] = mp_obj_new_float(reading.F8);
89+
90+
return mp_obj_new_tuple(12, tuple);
91+
}
92+
93+
mp_obj_t BreakoutAS7343_set_gain(mp_obj_t self_in, mp_obj_t value_in) {
94+
breakout_as7343_BreakoutAS7343_obj_t *self = MP_OBJ_TO_PTR2(self_in, breakout_as7343_BreakoutAS7343_obj_t);
95+
96+
self->breakout->set_gain(mp_obj_get_int(value_in));
97+
98+
return mp_const_none;
99+
}
100+
101+
mp_obj_t BreakoutAS7343_set_measurement_time(mp_obj_t self_in, mp_obj_t value_in) {
102+
breakout_as7343_BreakoutAS7343_obj_t *self = MP_OBJ_TO_PTR2(self_in, breakout_as7343_BreakoutAS7343_obj_t);
103+
104+
self->breakout->set_measurement_time(mp_obj_get_float(value_in));
105+
106+
return mp_const_none;
107+
}
108+
109+
mp_obj_t BreakoutAS7343_set_integration_time(mp_obj_t self_in, mp_obj_t value_in) {
110+
breakout_as7343_BreakoutAS7343_obj_t *self = MP_OBJ_TO_PTR2(self_in, breakout_as7343_BreakoutAS7343_obj_t);
111+
112+
self->breakout->set_integration_time(mp_obj_get_float(value_in));
113+
114+
return mp_const_none;
115+
}
116+
117+
mp_obj_t BreakoutAS7343_set_illumination_current(mp_obj_t self_in, mp_obj_t value_in) {
118+
breakout_as7343_BreakoutAS7343_obj_t *self = MP_OBJ_TO_PTR2(self_in, breakout_as7343_BreakoutAS7343_obj_t);
119+
120+
self->breakout->set_illumination_current(mp_obj_get_int(value_in));
121+
122+
return mp_const_none;
123+
}
124+
125+
mp_obj_t BreakoutAS7343_set_illumination_led(mp_obj_t self_in, mp_obj_t value_in) {
126+
breakout_as7343_BreakoutAS7343_obj_t *self = MP_OBJ_TO_PTR2(self_in, breakout_as7343_BreakoutAS7343_obj_t);
127+
128+
self->breakout->set_illumination_led(value_in == mp_const_true);
129+
130+
return mp_const_none;
131+
}
132+
133+
mp_obj_t BreakoutAS7343_set_channels(mp_obj_t self_in, mp_obj_t value_in) {
134+
breakout_as7343_BreakoutAS7343_obj_t *self = MP_OBJ_TO_PTR2(self_in, breakout_as7343_BreakoutAS7343_obj_t);
135+
136+
self->breakout->set_channels((AS7343::channel_count)mp_obj_get_int(value_in));
137+
138+
return mp_const_none;
139+
}
140+
}
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Include MicroPython API.
2+
#include "py/runtime.h"
3+
4+
/***** Constants *****/
5+
6+
7+
/***** Extern of Class Definition *****/
8+
extern const mp_obj_type_t breakout_as7343_BreakoutAS7343_type;
9+
10+
/***** Extern of Class Methods *****/
11+
extern mp_obj_t BreakoutAS7343_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args);
12+
extern mp_obj_t BreakoutAS7343_reset(mp_obj_t self_in);
13+
extern mp_obj_t BreakoutAS7343_version(mp_obj_t self_in);
14+
extern mp_obj_t BreakoutAS7343_read(mp_obj_t self_in);
15+
16+
extern mp_obj_t BreakoutAS7343_set_gain(mp_obj_t self_in, mp_obj_t value_in);
17+
extern mp_obj_t BreakoutAS7343_set_measurement_time(mp_obj_t self_in, mp_obj_t value_in);
18+
extern mp_obj_t BreakoutAS7343_set_integration_time(mp_obj_t self_in, mp_obj_t value_in);
19+
20+
extern mp_obj_t BreakoutAS7343_set_illumination_current(mp_obj_t self_in, mp_obj_t value_in);
21+
extern mp_obj_t BreakoutAS7343_set_illumination_led(mp_obj_t self_in, mp_obj_t value_in);
22+
23+
extern mp_obj_t BreakoutAS7343_set_channels(mp_obj_t self_in, mp_obj_t value_in);
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
set(MOD_NAME breakout_as7343)
2+
string(TOUPPER ${MOD_NAME} MOD_NAME_UPPER)
3+
add_library(usermod_${MOD_NAME} INTERFACE)
4+
5+
target_sources(usermod_${MOD_NAME} INTERFACE
6+
${CMAKE_CURRENT_LIST_DIR}/${MOD_NAME}.c
7+
${CMAKE_CURRENT_LIST_DIR}/${MOD_NAME}.cpp
8+
${CMAKE_CURRENT_LIST_DIR}/../../../drivers/as7343/as7343.cpp
9+
)
10+
11+
target_include_directories(usermod_${MOD_NAME} INTERFACE
12+
${CMAKE_CURRENT_LIST_DIR}
13+
)
14+
15+
target_compile_definitions(usermod_${MOD_NAME} INTERFACE
16+
-DMODULE_${MOD_NAME_UPPER}_ENABLED=1
17+
)
18+
19+
target_link_libraries(usermod INTERFACE usermod_${MOD_NAME})

micropython/modules/micropython-common-breakouts.cmake

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ include(breakout_encoder_wheel/micropython)
44
include(breakout_ioexpander/micropython)
55
include(breakout_ltr559/micropython)
66
include(breakout_as7262/micropython)
7+
include(breakout_as7343/micropython)
78
include(breakout_rgbmatrix5x5/micropython)
89
include(breakout_matrix11x7/micropython)
910
include(breakout_msa301/micropython)

0 commit comments

Comments
 (0)