Skip to content

Commit 2214e87

Browse files
committed
fix(chips-api/time): change timer_id type from uint32_t to timer_t
1 parent 5146aa1 commit 2214e87

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/chips-api/time.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ Note: `timer_init()` can only be called from `chip_init()`. Do not call it at a
3838
3939
:::
4040
41-
### void timer_start(uint32_t timer_id, uint32_t micros, bool repeat)
41+
### void timer_start(timer_t timer_id, uint32_t micros, bool repeat)
4242
4343
Schedules the timer given by `timer_id`. The `micros` argument determines how many microseconds will pass until the timer will call `chip_timer_event()`. If `repeat` is `false`, the timer event will be called once (one-shot timer). If repeat is `true`, the timer event will keep getting called every `micros` microseconds, until you call `timer_stop()` or reconfigure the timer with `timer_start`.
4444
45-
### void timer_start_ns(uint32_t timer_id, uint64_t nanos, bool repeat)
45+
### void timer_start_ns(timer_t timer_id, uint64_t nanos, bool repeat)
4646
4747
Similar to `timer_start`, but specifies the duration of the timer in nanoseconds instead of microseconds. Prefer `timer_start()` when possible, in order to improve performance.
4848
49-
### void timer_stop(uint32_t timer_id)
49+
### void timer_stop(timer_t timer_id)
5050
5151
Stops the given timer. If the timer hasn't fired yet, it won't fire until you call `timer_start()` again.

0 commit comments

Comments
 (0)