sascha_hemi/pycom-documentation
1
0
Fork 0
mirror of https://github.com/sascha-hemi/pycom-documentation.git synced 2026-03-21 18:06:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: contains Lily's review

Browse Source
This commit is contained in:
Aline
2020-01-27 21:23:15 +01:00
parent 237c759619
commit 6cb166be08
10 changed files with 12 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
content/pybytes/api/_index.md
View File

@@ -3,13 +3,13 @@ title: "Pybytes library API"
aliases:
---
To test Pybytes library API, connect your device to Pymakr and call the methods listed below.
You can use Pybytes library API in your MicroPython project.
To test the Pybytes library API, connect your device to Pymakr and call the methods listed below.
You can use the Pybytes library API in your MicroPython project.
### Debugging
If you are facing any issues try to enable debugging.
There are multiple debug levels, 0 is warnings only, 99 is currently the highest used).
Enable debugging if you are having any issues.
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
#### use:
@@ -77,5 +77,3 @@ There are multiple debug levels, 0 is warnings only, 99 is currently the highest
* [Start](start)
* [Update configuration](update_config)
* [Write configuration](write_config)

2
content/pybytes/api/connect_wifi.md
View File

@@ -4,7 +4,7 @@ aliases:
- pybytes/api/connect_wifi
---
Initialize watchdog for WiFi and LTE connection.
Initialize watchdog for the WiFi and LTE connection.
**Method**
----

2
content/pybytes/api/deepsleep.md
View File

@@ -26,7 +26,7 @@ aliases:
**Success Response**
----
After sleep, device reconnect
After deepsleep, the device reconnects.
```
>> Connecting with SSID and PASSWORD

2
content/pybytes/api/print_config.md
View File

@@ -4,7 +4,7 @@ aliases:
- pybytes/api/print_config
---
Prints current configuration in the terminal.
Prints the current configuration in the terminal.
**Method**
----

2
content/pybytes/api/read_config.md
View File

@@ -4,7 +4,7 @@ aliases:
- pybytes/api/read_config
---
Reads configuration from the given file.
Reads the configuration from the given file.
**Method**
----

2
content/pybytes/api/reconnect.md
View File

@@ -17,7 +17,7 @@ aliases:
**Success Response**
----
After disconnect
After the device disconnects:
```
>> Connecting with SSID and PASSWORD
>> WiFi connection established

2
content/pybytes/api/set_custom_message_callback.md
View File

@@ -4,7 +4,7 @@ aliases:
- pybytes/api/set_custom_message_callback
---
Send custom message callback.
Sends custom message callback.
**Method**
----

2
content/pybytes/api/start.md
View File

@@ -4,7 +4,7 @@ aliases:
- pybytes/api/start
---
Starts Pybytes library.
Opens the Pybytes library.
**Method**
----

2
content/pybytes/api/update_config.md
View File

@@ -22,7 +22,7 @@ aliases:
**Example**
----
`pybytes.update_config(key="network_preferences", value="wifi", permanent=True, silent=False, reconnect=False)`
`pybytes.update_config(key="wifi", value={'password': 'Pa$$w0rd'}, permanent=True, silent=False, reconnect=False)`
**Success Response**
----

29
content/pybytes/api/write_config.md
View File

@@ -1,29 +0,0 @@
---
title: "Write configuration"
aliases:
- pybytes/api/write_config
---
Write device configuration.
**Method**
----
**pybytes.write_config(file='/flash/pybytes_config.json', silent=False)**
**Parameters**
----
| name | Description | is Required | Default value
| ------------- |:-------------:|:-------------:|:-------------:|
| file | File path | Yes | '/flash/pybytes_config.json' |
| silent | boolean | No | False |
**Example**
----
`pybytes.write_config(file='/flash/pybytes_config.json', silent=False)`
**Success Response**
----
```
>> Pybytes configuration written to /flash/pybytes_config.json
```