Skip to content

Commit c6455cd

Browse files
committed
Updated
1 parent 0cff1ad commit c6455cd

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ bool mgos_soft_uart_configure(int uart_no, const struct mgos_soft_uart_config *c
5050
```
5151
Apply given [SOFT-UART configuration](#mgos_soft_uart_config).
5252
53-
> :warning: Stop bit value `1.5` is not supported.
54-
5553
|Parameter||
5654
|--|--|
57-
|uart_no|UART number.|
58-
|cfg|[Configuration structure](#mgos_soft_uart_config).|
55+
|uart_no|SOFT-UART number.|
56+
|cfg|[Config structure](#mgos_soft_uart_config).|
57+
58+
> :warning: Stop bit value `1.5` is not supported.
5959
6060
Example:
6161
```c
@@ -81,18 +81,18 @@ Fill provided `cfg` [structure](#mgos_soft_uart_config) with the default values.
8181
8282
|Parameter||
8383
|--|--|
84-
|uart_no|UART number.|
85-
|cfg|[Configuration structure](#mgos_soft_uart_config).|
84+
|uart_no|SOFT-UART number.|
85+
|cfg|[Config structure](#mgos_soft_uart_config).|
8686
### mgos_soft_uart_config_get
87-
```c|UART number.|
87+
```c|SOFT-UART number.|
8888
bool mgos_soft_uart_config_get(int uart_no, struct mgos_soft_uart_config *cfg);
8989
```
9090
Fill provided [cfg structure](#mgos_soft_uart_config) with the current SOFT-UART configuration. Returns `false` if the specified SOFT-UART has not bee configured yet.
9191

9292
|Parameter||
9393
|--|--|
94-
|uart_no|UART number.|
95-
|cfg|[Configuration structure](#mgos_soft_uart_config).|
94+
|uart_no|SOFT-UART number.|
95+
|cfg|[Config structure](#mgos_soft_uart_config).|
9696
### mgos_soft_uart_set_dispatcher
9797
```c
9898
void mgos_soft_uart_set_dispatcher(int uart_no, mgos_uart_dispatcher_t cb, void *arg);
@@ -101,7 +101,7 @@ Set SOFT-UART dispatcher: a callback which gets called when there is data in the
101101
102102
|Parameter||
103103
|--|--|
104-
|uart_no|UART number.|
104+
|uart_no|SOFT-UART number.|
105105
|cb|Dispatcher's [callback](https://mongoose-os.com/docs/mongoose-os/api/core/mgos_uart.h.md#mgos_uart_dispatcher_t).|
106106
|arg|Callback arguments or `NULL`.|
107107
### mgos_soft_uart_read
@@ -112,7 +112,7 @@ Read data from SOFT-UART input buffer. Note: unlike write, read will not block i
112112

113113
|Parameter||
114114
|--|--|
115-
|uart_no|UART number.|
115+
|uart_no|SOFT-UART number.|
116116
|buf|Buffer.|
117117
|len|Len of the buffer.|
118118
### mgos_soft_uart_read_mbuf
@@ -123,7 +123,7 @@ Like [mgos_soft_uart_read()](#mgos_soft_uart_read), but reads into an mbuf.
123123
124124
|Parameter||
125125
|--|--|
126-
|uart_no|UART number.|
126+
|uart_no|SOFT-UART number.|
127127
|buf|`mbuf` pointer.|
128128
|len|Len of the buffer.|
129129
### mgos_soft_uart_read_avail
@@ -134,7 +134,7 @@ Returns the number of bytes available for reading.
134134

135135
|Parameter||
136136
|--|--|
137-
|uart_no|UART number.|
137+
|uart_no|SOFT-UART number.|
138138
### mgos_soft_uart_set_rx_enabled
139139
```c
140140
bool mgos_soft_uart_set_rx_enabled(int uart_no, bool enabled);
@@ -143,7 +143,7 @@ Controls whether SOFT-UART receiver is enabled. Returns `false` if error.
143143
144144
|Parameter||
145145
|--|--|
146-
|uart_no|UART number.|
146+
|uart_no|SOFT-UART number.|
147147
|enabled|`true` to enable Rx.|
148148
### mgos_soft_uart_is_rx_enabled
149149
```c
@@ -153,7 +153,7 @@ Returns whether SOFT-UART receiver is enabled.
153153

154154
|Parameter||
155155
|--|--|
156-
|uart_no|UART number.|
156+
|uart_no|SOFT-UART number.|
157157
### mgos_soft_uart_write
158158
```c
159159
size_t mgos_soft_uart_write(int uart_no, const void *buf, size_t len);
@@ -162,7 +162,7 @@ Write data to the UART. Note: if there is enough space in the output buffer, the
162162
163163
|Parameter||
164164
|--|--|
165-
|uart_no|UART number.|
165+
|uart_no|SOFT-UART number.|
166166
|buf|Buffer.|
167167
|len|Len of the buffer.|
168168
### mgos_soft_uart_write_avail
@@ -173,7 +173,7 @@ Returns amount of space availabe in the output buffer.
173173

174174
|Parameter||
175175
|--|--|
176-
|uart_no|UART number.|
176+
|uart_no|SOFT-UART number.|
177177
### mgos_soft_uart_printf
178178
```c
179179
int mgos_soft_uart_printf(int uart_no, const char *fmt, ...);
@@ -182,7 +182,7 @@ Write data to UART, printf style. Note: currently this requires that data is ful
182182
183183
|Parameter||
184184
|--|--|
185-
|uart_no|UART number.|
185+
|uart_no|SOFT-UART number.|
186186
|fmt|String format.|
187187
|...|String format args.|
188188
### mgos_soft_uart_flush
@@ -193,7 +193,7 @@ Flush the SOFT-UART output buffer. Waits for data to be sent.
193193

194194
|Parameter||
195195
|--|--|
196-
|uart_no|UART number.|
196+
|uart_no|SOFT-UART number.|
197197
## To Do
198198
- Implement javascript APIs for [Mongoose OS MJS](https://github.com/mongoose-os-libs/mjs).
199199
- Test the library on ESP32 and other MCUs.

0 commit comments

Comments
 (0)