Skip to content

Commit bcf31a3

Browse files
pfalconpfalcon
committed
esp8266, stmhal, zephyr: Rename machine.Pin high/low methods to on/off.
For consistent Pin/Signal class hierarchy. With it, Signal is a proper (while still ducktyped) subclass of a Pin, and any (direct) usage of Pin can be replace with Signal. As stmhal's class is reused both as machine.Pin and legacy pyb.Pin, high/low methods actually retained there.
1 parent 299c0a3 commit bcf31a3

3 files changed

Lines changed: 21 additions & 26 deletions

File tree

‎esp8266/machine_pin.c‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -336,21 +336,19 @@ STATIC mp_obj_t pyb_pin_value(mp_uint_t n_args, const mp_obj_t *args) {
336336
}
337337
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(pyb_pin_value_obj, 1, 2, pyb_pin_value);
338338

339-
// pin.low()
340-
STATIC mp_obj_t pyb_pin_low(mp_obj_t self_in) {
339+
STATIC mp_obj_t pyb_pin_off(mp_obj_t self_in) {
341340
pyb_pin_obj_t *self = self_in;
342341
pin_set(self->phys_port, 0);
343342
return mp_const_none;
344343
}
345-
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pyb_pin_low_obj, pyb_pin_low);
344+
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pyb_pin_off_obj, pyb_pin_off);
346345

347-
// pin.high()
348-
STATIC mp_obj_t pyb_pin_high(mp_obj_t self_in) {
346+
STATIC mp_obj_t pyb_pin_on(mp_obj_t self_in) {
349347
pyb_pin_obj_t *self = self_in;
350348
pin_set(self->phys_port, 1);
351349
return mp_const_none;
352350
}
353-
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pyb_pin_high_obj, pyb_pin_high);
351+
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pyb_pin_on_obj, pyb_pin_on);
354352

355353
// pin.irq(handler=None, trigger=IRQ_FALLING|IRQ_RISING, hard=False)
356354
STATIC mp_obj_t pyb_pin_irq(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
@@ -410,8 +408,8 @@ STATIC const mp_map_elem_t pyb_pin_locals_dict_table[] = {
410408
// instance methods
411409
{ MP_OBJ_NEW_QSTR(MP_QSTR_init), (mp_obj_t)&pyb_pin_init_obj },
412410
{ MP_OBJ_NEW_QSTR(MP_QSTR_value), (mp_obj_t)&pyb_pin_value_obj },
413-
{ MP_OBJ_NEW_QSTR(MP_QSTR_low), (mp_obj_t)&pyb_pin_low_obj },
414-
{ MP_OBJ_NEW_QSTR(MP_QSTR_high), (mp_obj_t)&pyb_pin_high_obj },
411+
{ MP_OBJ_NEW_QSTR(MP_QSTR_off), (mp_obj_t)&pyb_pin_off_obj },
412+
{ MP_OBJ_NEW_QSTR(MP_QSTR_on), (mp_obj_t)&pyb_pin_on_obj },
415413
{ MP_OBJ_NEW_QSTR(MP_QSTR_irq), (mp_obj_t)&pyb_pin_irq_obj },
416414

417415
// class constants

‎stmhal/pin.c‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -400,23 +400,19 @@ STATIC mp_obj_t pin_value(mp_uint_t n_args, const mp_obj_t *args) {
400400
}
401401
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(pin_value_obj, 1, 2, pin_value);
402402

403-
/// \method low()
404-
/// Set the pin to a low logic level.
405-
STATIC mp_obj_t pin_low(mp_obj_t self_in) {
403+
STATIC mp_obj_t pin_off(mp_obj_t self_in) {
406404
pin_obj_t *self = self_in;
407405
mp_hal_pin_low(self);
408406
return mp_const_none;
409407
}
410-
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pin_low_obj, pin_low);
408+
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pin_off_obj, pin_off);
411409

412-
/// \method high()
413-
/// Set the pin to a high logic level.
414-
STATIC mp_obj_t pin_high(mp_obj_t self_in) {
410+
STATIC mp_obj_t pin_on(mp_obj_t self_in) {
415411
pin_obj_t *self = self_in;
416412
mp_hal_pin_high(self);
417413
return mp_const_none;
418414
}
419-
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pin_high_obj, pin_high);
415+
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pin_on_obj, pin_on);
420416

421417
/// \method name()
422418
/// Get the pin name.
@@ -500,8 +496,11 @@ STATIC const mp_rom_map_elem_t pin_locals_dict_table[] = {
500496
// instance methods
501497
{ MP_ROM_QSTR(MP_QSTR_init), MP_ROM_PTR(&pin_init_obj) },
502498
{ MP_ROM_QSTR(MP_QSTR_value), MP_ROM_PTR(&pin_value_obj) },
503-
{ MP_ROM_QSTR(MP_QSTR_low), MP_ROM_PTR(&pin_low_obj) },
504-
{ MP_ROM_QSTR(MP_QSTR_high), MP_ROM_PTR(&pin_high_obj) },
499+
{ MP_ROM_QSTR(MP_QSTR_off), MP_ROM_PTR(&pin_off_obj) },
500+
{ MP_ROM_QSTR(MP_QSTR_on), MP_ROM_PTR(&pin_on_obj) },
501+
// Legacy names as used by pyb.Pin
502+
{ MP_ROM_QSTR(MP_QSTR_low), MP_ROM_PTR(&pin_off_obj) },
503+
{ MP_ROM_QSTR(MP_QSTR_high), MP_ROM_PTR(&pin_on_obj) },
505504
{ MP_ROM_QSTR(MP_QSTR_name), MP_ROM_PTR(&pin_name_obj) },
506505
{ MP_ROM_QSTR(MP_QSTR_names), MP_ROM_PTR(&pin_names_obj) },
507506
{ MP_ROM_QSTR(MP_QSTR_af_list), MP_ROM_PTR(&pin_af_list_obj) },

‎zephyr/machine_pin.c‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -138,21 +138,19 @@ STATIC mp_obj_t machine_pin_value(size_t n_args, const mp_obj_t *args) {
138138
}
139139
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(machine_pin_value_obj, 1, 2, machine_pin_value);
140140

141-
// pin.low()
142-
STATIC mp_obj_t machine_pin_low(mp_obj_t self_in) {
141+
STATIC mp_obj_t machine_pin_off(mp_obj_t self_in) {
143142
machine_pin_obj_t *self = self_in;
144143
(void)gpio_pin_write(self->port, self->pin, 0);
145144
return mp_const_none;
146145
}
147-
STATIC MP_DEFINE_CONST_FUN_OBJ_1(machine_pin_low_obj, machine_pin_low);
146+
STATIC MP_DEFINE_CONST_FUN_OBJ_1(machine_pin_off_obj, machine_pin_off);
148147

149-
// pin.high()
150-
STATIC mp_obj_t machine_pin_high(mp_obj_t self_in) {
148+
STATIC mp_obj_t machine_pin_on(mp_obj_t self_in) {
151149
machine_pin_obj_t *self = self_in;
152150
(void)gpio_pin_write(self->port, self->pin, 1);
153151
return mp_const_none;
154152
}
155-
STATIC MP_DEFINE_CONST_FUN_OBJ_1(machine_pin_high_obj, machine_pin_high);
153+
STATIC MP_DEFINE_CONST_FUN_OBJ_1(machine_pin_on_obj, machine_pin_on);
156154

157155
STATIC mp_uint_t machine_pin_ioctl(mp_obj_t self_in, mp_uint_t request, uintptr_t arg, int *errcode) {
158156
(void)errcode;
@@ -176,8 +174,8 @@ STATIC const mp_map_elem_t machine_pin_locals_dict_table[] = {
176174
// instance methods
177175
{ MP_OBJ_NEW_QSTR(MP_QSTR_init), (mp_obj_t)&machine_pin_init_obj },
178176
{ MP_OBJ_NEW_QSTR(MP_QSTR_value), (mp_obj_t)&machine_pin_value_obj },
179-
{ MP_OBJ_NEW_QSTR(MP_QSTR_low), (mp_obj_t)&machine_pin_low_obj },
180-
{ MP_OBJ_NEW_QSTR(MP_QSTR_high), (mp_obj_t)&machine_pin_high_obj },
177+
{ MP_OBJ_NEW_QSTR(MP_QSTR_off), (mp_obj_t)&machine_pin_off_obj },
178+
{ MP_OBJ_NEW_QSTR(MP_QSTR_on), (mp_obj_t)&machine_pin_on_obj },
181179

182180
// class constants
183181
{ MP_OBJ_NEW_QSTR(MP_QSTR_IN), MP_OBJ_NEW_SMALL_INT(GPIO_DIR_IN) },

0 commit comments

Comments
 (0)