Skip to content

Commit 6cb166b

Browse files
committed
docs: contains Lily's review
1 parent 237c759 commit 6cb166b

File tree

10 files changed

+12
-43
lines changed

10 files changed

+12
-43
lines changed

content/pybytes/api/_index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: "Pybytes library API"
33
aliases:
44
---
55

6-
To test Pybytes library API, connect your device to Pymakr and call the methods listed below.
7-
You can use Pybytes library API in your MicroPython project.
6+
To test the Pybytes library API, connect your device to Pymakr and call the methods listed below.
7+
You can use the Pybytes library API in your MicroPython project.
88

99

1010
### Debugging
11-
If you are facing any issues try to enable debugging.
12-
There are multiple debug levels, 0 is warnings only, 99 is currently the highest used).
11+
Enable debugging if you are having any issues.
12+
There are multiple debug levels, the lowest is 0 which is for warnings only and 99 is the highest used and will print more debugging messages
1313

1414
#### use:
1515

@@ -77,5 +77,3 @@ There are multiple debug levels, 0 is warnings only, 99 is currently the highest
7777
* [Start](start)
7878

7979
* [Update configuration](update_config)
80-
81-
* [Write configuration](write_config)

content/pybytes/api/connect_wifi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ aliases:
44
- pybytes/api/connect_wifi
55
---
66

7-
Initialize watchdog for WiFi and LTE connection.
7+
Initialize watchdog for the WiFi and LTE connection.
88

99
**Method**
1010
----

content/pybytes/api/deepsleep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ aliases:
2626

2727
**Success Response**
2828
----
29-
After sleep, device reconnect
29+
After deepsleep, the device reconnects.
3030

3131
```
3232
>> Connecting with SSID and PASSWORD

content/pybytes/api/print_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ aliases:
44
- pybytes/api/print_config
55
---
66

7-
Prints current configuration in the terminal.
7+
Prints the current configuration in the terminal.
88

99
**Method**
1010
----

content/pybytes/api/read_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ aliases:
44
- pybytes/api/read_config
55
---
66

7-
Reads configuration from the given file.
7+
Reads the configuration from the given file.
88

99
**Method**
1010
----

content/pybytes/api/reconnect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ aliases:
1717
**Success Response**
1818
----
1919

20-
After disconnect
20+
After the device disconnects:
2121
```
2222
>> Connecting with SSID and PASSWORD
2323
>> WiFi connection established

content/pybytes/api/set_custom_message_callback.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ aliases:
44
- pybytes/api/set_custom_message_callback
55
---
66

7-
Send custom message callback.
7+
Sends custom message callback.
88

99
**Method**
1010
----

content/pybytes/api/start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ aliases:
44
- pybytes/api/start
55
---
66

7-
Starts Pybytes library.
7+
Opens the Pybytes library.
88

99
**Method**
1010
----

content/pybytes/api/update_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ aliases:
2222

2323
**Example**
2424
----
25-
`pybytes.update_config(key="network_preferences", value="wifi", permanent=True, silent=False, reconnect=False)`
25+
`pybytes.update_config(key="wifi", value={'password': 'Pa$$w0rd'}, permanent=True, silent=False, reconnect=False)`
2626

2727
**Success Response**
2828
----

content/pybytes/api/write_config.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)