Skip to content

Commit 2b4a0c5

Browse files
authored
Update README.md
1 parent dfdb8bc commit 2b4a0c5

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Initializes the scheduler by resetting all timers.
117117
### Starting a Timer
118118
119119
```c
120-
flexitimer_error_t flexitimer_start(int id, TimerType type, uint32_t timeout, TimerCallback callback);
120+
flexitimer_error_t flexitimer_start(timer_id_t id, TimerType type, uint32_t timeout, TimerCallback callback);
121121
```
122122
Starts a timer with the specified id, type, timeout, and callback.
123123
@@ -131,63 +131,63 @@ The scheduler handler that should be called periodically to manage timers.
131131
### Postponing/Delaying a Timer
132132
133133
```c
134-
flexitimer_error_t flexitimer_delay(int id, timer_time_t delay);
134+
flexitimer_error_t flexitimer_delay(timer_id_t id, timer_time_t delay);
135135
```
136136
Postpones / delays the timer with the specified id.
137137
138138
### Pausing a Timer
139139
140140
```c
141-
flexitimer_error_t flexitimer_pause(int id);
141+
flexitimer_error_t flexitimer_pause(timer_id_t id);
142142
```
143143
Pauses the timer with the specified id.
144144
145145
### Resuming a Timer
146146
147147
```c
148-
flexitimer_error_t flexitimer_resume(int id);
148+
flexitimer_error_t flexitimer_resume(timer_id_t id);
149149
```
150150
Resumes the paused timer with the specified id.
151151
152152
### Restarting a Timer
153153
154154
```c
155-
flexitimer_error_t flexitimer_restart(int id);
155+
flexitimer_error_t flexitimer_restart(timer_id_t id);
156156
```
157157
Restarts the timer with the specified id.
158158
159159
### Cancelling a Timer
160160
161161
```c
162-
flexitimer_error_t flexitimer_cancel(int id);
162+
flexitimer_error_t flexitimer_cancel(timer_id_t id);
163163
```
164164
Cancels the timer with the specified id.
165165
166166
### Getting Timer State
167167
168168
```c
169-
flexitimer_error_t flexitimer_get_state(int id, timer_state_t *state);
169+
flexitimer_error_t flexitimer_get_state(timer_id_t id, timer_state_t *state);
170170
```
171171
Gets the state of the timer with the specified id.
172172
173173
### Getting Timer Type
174174
175175
```c
176-
flexitimer_error_t flexitimer_get_type(int id, timer_type_t *type);
176+
flexitimer_error_t flexitimer_get_type(timer_id_t id, timer_type_t *type);
177177
```
178178
Gets the type of the timer with the specified id.
179179
180180
### Getting Original Timeout
181181
182182
```c
183-
flexitimer_error_t flexitimer_get_time(int id, timer_time_t *time);
183+
flexitimer_error_t flexitimer_get_time(timer_id_t id, timer_time_t *time);
184184
```
185185
Gets the original timeout value of the timer with the specified id.
186186
187187
### Getting Remaining Time
188188
189189
```c
190-
flexitimer_error_t flexitimer_get_elapsed(int id, timer_time_t *time);
190+
flexitimer_error_t flexitimer_get_elapsed(timer_id_t id, timer_time_t *time);
191191
```
192192
Gets the remaining time of the timer with the specified id.
193193

0 commit comments

Comments
 (0)