Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit27ae59c

Browse files
committed
doc(iwatchdog): update with new GitHub alerts formatting
Signed-off-by: Frederic Pillon <frederic.pillon@st.com>
1 parentaa37c03 commit27ae59c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

‎libraries/IWatchdog/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ IWatchdogClass IWatchdog = IWatchdogClass();
5353

5454
####Predefined values
5555

56-
* Minimal timeout in microseconds:`IWDG_TIMEOUT_MIN`
57-
* Maximal timeout in microseconds:`IWDG_TIMEOUT_MAX`
56+
* Minimal timeout in**microseconds**:`IWDG_TIMEOUT_MIN`
57+
* Maximal timeout in**microseconds**:`IWDG_TIMEOUT_MAX`
5858

5959
####`void begin(uint32_t timeout, uint32_t window = IWDG_TIMEOUT_MAX)`
6060

6161
The`begin()` function would initialize the IWDG hardware block.
6262

63-
The`timeout` parameter is in microseconds and set the timer reset timeout.
63+
The`timeout` parameter is in**microseconds** and set the timer reset timeout.
6464
When the timer reaches zero the hardware block would generate a reset signal
6565
for the CPU.
6666

@@ -84,22 +84,22 @@ Valid timeout values depends of the LSI clock. Typically, it is 32kH value are b
8484
| 8193ms - 16384ms | 4ms
8585
| 16385ms - 32768ms | 8ms
8686

87-
The optional`window` parameter is in microseconds and must be less than`timeout`.
87+
The optional`window` parameter is in**microseconds and must be less than`timeout`**.
8888
If the window option is enabled, the counter must be refreshed inside the window;
8989
otherwise, a system reset is generated.
9090

91-
**Note:**
92-
Window feature is not available for all STM32 series.
91+
>[!NOTE]
92+
>Window feature is not available for all STM32 series.
9393
9494
Calling the`begin()` method with value outside of the valid range
9595
would return without initializing the watchdog timer.
9696

97-
**WARNING:**
98-
*Once started the IWDG timer can not be stopped. If you are
99-
planning to debug the live system, the watchdog timer may cause the
100-
system to be reset while you are stopped in the debugger. Also consider
101-
the iwatchdog timer implications if you are designing a system which puts
102-
the CPU in sleep mode.*
97+
>[!WARNING]
98+
>Once started the IWDG timer can not be stopped. If you are
99+
>planning to debug the live system, the watchdog timer may cause the
100+
>system to be reset while you are stopped in the debugger. Also consider
101+
>the iwatchdog timer implications if you are designing a system which puts
102+
>the CPU in sleep mode.*
103103
104104
####`void reload()`
105105

@@ -119,7 +119,7 @@ The `timeout` and optional `window` parameters are the same than `begin()` metho
119119
The`get()` method allows to get the current timeout and window values
120120
currently set.
121121

122-
The`timeout` and optional`window` pointers to get values are in microseconds.
122+
The`timeout` and optional`window` pointers to get values are in**microseconds**.
123123

124124
####`bool isEnabled()`
125125

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp