Skip to content

Commit b5b13f5

Browse files
committed
espulp: update docs
1 parent 717e2b1 commit b5b13f5

File tree

1 file changed

+7
-3
lines changed
  • ports/espressif/bindings/espulp

1 file changed

+7
-3
lines changed

ports/espressif/bindings/espulp/ULP.c

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,9 @@ STATIC mp_obj_t espulp_ulp_obj___exit__(size_t n_args, const mp_obj_t *args) {
9191
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(espulp_ulp___exit___obj, 4, 4, espulp_ulp_obj___exit__);
9292

9393
//| def set_wakeup_period(self, period_index: int, period_us: int) -> None:
94-
//| """Sets the wakeup period for the ULP."""
94+
//| """Sets the wakeup period in microseconds for the ULP.
95+
//| Up to 5 different wakeup periods can be stored (`period_index` = 0..4).
96+
//| By default, period index 0 is used."""
9597
//| ...
9698
STATIC mp_obj_t espulp_ulp_set_wakeup_period(mp_obj_t self_in, mp_obj_t period_index, mp_obj_t period_us) {
9799
espulp_ulp_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -108,10 +110,12 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_3(espulp_ulp_set_wakeup_period_obj, espulp_ulp_se
108110
//| self,
109111
//| program: ReadableBuffer,
110112
//| *,
111-
//| entrypoint: int,
113+
//| entrypoint: int = 0,
112114
//| pins: Sequence[microcontroller.Pin] = ()
113115
//| ) -> None:
114-
//| """Loads the program into ULP memory and then runs the program, starting at entry_point.
116+
//| """Loads the program into ULP memory and then runs the program.
117+
//| `entry_point` specifies the offset (in bytes) of the first instruction
118+
//| from the start of the program.
115119
//| The given pins are claimed and not reset until `halt()` is called.
116120
//|
117121
//| The program will continue to run even when the running Python is halted."""

0 commit comments

Comments
 (0)