mirrors/unleashed-firmware
1
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-13 13:09:49 +04:00
Code Issues Activity

New js modules documentation added (#3736)

Browse Source 
* New js modules documentation added
* Documentation: Spelling and formatting

Co-authored-by: ElectronicsInFocus <rnadyrshin@gmail.com>
Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
Ruslan Nadyrshin
2024-06-30 15:18:46 +04:00
committed by GitHub
parent 0b2827836d
commit 9a02e23dc7
7 changed files with 491 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/js/js_serial.md
View File

@@ -53,7 +53,7 @@ serial.read(10, 5000); // Read 10 bytes, with 5s timeout
```
## readln
Read from serial port untill line break character
Read from serial port until line break character
### Parameters
(optional) Timeout value in ms
@@ -68,7 +68,7 @@ serial.readln(5000); // Read with 5s timeout
```
## readBytes
Read from serial port untill line break character
Read from serial port until line break character
### Parameters
- Number of bytes to read
@@ -81,7 +81,7 @@ ArrayBuffer with received data or undefined if nothing was received before timeo
```js
serial.readBytes(4); // Read 4 bytes, without timeout
// Read one byte from receive buffer with zero timeout, returns UNDEFINED if Rx bufer is empty
// Read one byte from receive buffer with zero timeout, returns UNDEFINED if Rx buffer is empty
serial.readBytes(1, 0);
```