From 6cb166be084e6ddc1571202572b30c31acca5315 Mon Sep 17 00:00:00 2001 From: Aline Date: Mon, 27 Jan 2020 21:23:15 +0100 Subject: [PATCH] docs: contains Lily's review --- content/pybytes/api/_index.md | 10 +++---- content/pybytes/api/connect_wifi.md | 2 +- content/pybytes/api/deepsleep.md | 2 +- content/pybytes/api/print_config.md | 2 +- content/pybytes/api/read_config.md | 2 +- content/pybytes/api/reconnect.md | 2 +- .../api/set_custom_message_callback.md | 2 +- content/pybytes/api/start.md | 2 +- content/pybytes/api/update_config.md | 2 +- content/pybytes/api/write_config.md | 29 ------------------- 10 files changed, 12 insertions(+), 43 deletions(-) delete mode 100644 content/pybytes/api/write_config.md diff --git a/content/pybytes/api/_index.md b/content/pybytes/api/_index.md index ccad19f..55d2510 100644 --- a/content/pybytes/api/_index.md +++ b/content/pybytes/api/_index.md @@ -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) diff --git a/content/pybytes/api/connect_wifi.md b/content/pybytes/api/connect_wifi.md index c5dc87c..7a7edc4 100644 --- a/content/pybytes/api/connect_wifi.md +++ b/content/pybytes/api/connect_wifi.md @@ -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** ---- diff --git a/content/pybytes/api/deepsleep.md b/content/pybytes/api/deepsleep.md index 064a82f..c5323d7 100644 --- a/content/pybytes/api/deepsleep.md +++ b/content/pybytes/api/deepsleep.md @@ -26,7 +26,7 @@ aliases: **Success Response** ---- -After sleep, device reconnect +After deepsleep, the device reconnects. ``` >> Connecting with SSID and PASSWORD diff --git a/content/pybytes/api/print_config.md b/content/pybytes/api/print_config.md index 6d6533e..9d1456a 100644 --- a/content/pybytes/api/print_config.md +++ b/content/pybytes/api/print_config.md @@ -4,7 +4,7 @@ aliases: - pybytes/api/print_config --- - Prints current configuration in the terminal. + Prints the current configuration in the terminal. **Method** ---- diff --git a/content/pybytes/api/read_config.md b/content/pybytes/api/read_config.md index e1b9f48..3ada3d8 100644 --- a/content/pybytes/api/read_config.md +++ b/content/pybytes/api/read_config.md @@ -4,7 +4,7 @@ aliases: - pybytes/api/read_config --- - Reads configuration from the given file. + Reads the configuration from the given file. **Method** ---- diff --git a/content/pybytes/api/reconnect.md b/content/pybytes/api/reconnect.md index 0ae7d85..c4eaf55 100644 --- a/content/pybytes/api/reconnect.md +++ b/content/pybytes/api/reconnect.md @@ -17,7 +17,7 @@ aliases: **Success Response** ---- -After disconnect +After the device disconnects: ``` >> Connecting with SSID and PASSWORD >> WiFi connection established diff --git a/content/pybytes/api/set_custom_message_callback.md b/content/pybytes/api/set_custom_message_callback.md index 606be69..9ca7eb6 100644 --- a/content/pybytes/api/set_custom_message_callback.md +++ b/content/pybytes/api/set_custom_message_callback.md @@ -4,7 +4,7 @@ aliases: - pybytes/api/set_custom_message_callback --- - Send custom message callback. + Sends custom message callback. **Method** ---- diff --git a/content/pybytes/api/start.md b/content/pybytes/api/start.md index 6eab3b3..14e06a1 100644 --- a/content/pybytes/api/start.md +++ b/content/pybytes/api/start.md @@ -4,7 +4,7 @@ aliases: - pybytes/api/start --- - Starts Pybytes library. + Opens the Pybytes library. **Method** ---- diff --git a/content/pybytes/api/update_config.md b/content/pybytes/api/update_config.md index 40597a6..dbe4a54 100644 --- a/content/pybytes/api/update_config.md +++ b/content/pybytes/api/update_config.md @@ -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** ---- diff --git a/content/pybytes/api/write_config.md b/content/pybytes/api/write_config.md deleted file mode 100644 index 54950b3..0000000 --- a/content/pybytes/api/write_config.md +++ /dev/null @@ -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 -```