Pb 833 documentation of pybytes library api #206

alipsilv · 2020-01-17T17:05:22Z

This PR contains Pybytes API library documentation

…a-server Pb 787 documentation for pycom lora server

content/pybytes/api/get_config.md

content/pybytes/api/print_config.md

content/pybytes/api/activate.md

content/pybytes/api/_index.md

content/pybytes/api/connect_device.md

jirkadev · 2020-01-20T10:30:35Z

content/pybytes/api/send_signal.md

+  - pybytes/api/send_signal
+---
+
+  Send signal to the given pin.


Let's replace the word pin with signal_number.

I know that in the code the parameter name is still named pin. But it can confuse users, it does not have anything common with hardware pins on a device

maybe, in the future, it's worth to change the parameter name from pin to signal_number

Please exchange the pin parameter to signal_number on this page.

Yes, I think it is a good idea to change the parameter name in the code. Please do it now, and create PR in pybytes-devices repository

content/pybytes/api/set_config.md

content/pybytes/api/start.md

jirkadev · 2020-01-20T10:36:08Z

content/pybytes/api/update_config.md

+**Example**
+----
+`pybytes.update_config(key=None, value=None, permanent=True, silent=False, reconnect=False)`
+
+**Success Response**
+----
+
+TBD test


Let's write some good example here, please. And complete the response

I could not see the difference between pybytes.update_config and pybytes.set_config.

pybytes.update_config(key="network_preferences", value="wifi", permanent=True, silent=False, reconnect=False)

I think this works I've just updated wifi password. Please use this as an example in docs.
Also, write a Success response. thanks

>>> pybytes.print_config() wifi = {'ssid': 'Pycom', 'password': 'PyE!ndh0ven#'} cfg_msg = Pybytes configuration read from /flash/pybytes_config.json wlan_antenna = 0 ota_server = {'port': 443, 'domain': 'software.pycom.io'} server = mqtt.pybytes.pycom.io ssl = False lte = {'apn': 'soracom.io', 'cid': 1, 'reset': False, 'carrier': 'standard', 'band': 99, 'type': 'IP'} device_id = 9305509f-4ea8-4d6b-824f-539c39e7ddf2 network_preferences = ['lte', 'wifi'] pybytes_autostart = True dump_ca = False username = [email protected] >>> >>> >>> pybytes.update_config(key="wifi", value={'password': 'Pa$$w0rd'}, permanent=True, silent=False, reconnect=False) Pybytes configuration written to /flash/pybytes_config.json >>> >>> >>> pybytes.print_config() wifi = {'ssid': 'Pycom', 'password': 'Pa$$w0rd'} cfg_msg = Pybytes configuration read from /flash/pybytes_config.json wlan_antenna = 0 ota_server = {'port': 443, 'domain': 'software.pycom.io'} server = mqtt.pybytes.pycom.io ssl = False lte = {'apn': 'soracom.io', 'cid': 1, 'reset': False, 'carrier': 'standard', 'band': 99, 'type': 'IP'} device_id = 9305509f-4ea8-4d6b-824f-539c39e7ddf2 network_preferences = ['lte', 'wifi'] pybytes_autostart = True dump_ca = False username = [email protected] >>>

ok it should work if a key you're trying to update is an object. if you have lte object in your confing, this should work:

pybytes.update_config(key="lte", value={'band': 99}, permanent=True, silent=False, reconnect=False)

I think it does not work on arrays like network_preferences
I wrote a ticket for this bug and assigned it to you. Thank you
https://pycomiot.atlassian.net/browse/PB-861

jirkadev · 2020-01-23T11:04:41Z

content/pybytes/api/write_config.md

+  - pybytes/api/write_config
+---
+
+  Write device configuration.


I took a look at this method and it is the private method which sneaked to public API
It will write config from self.__conf to a file

Let's remove this method from documentation

jirkadev · 2020-01-23T11:04:41Z

content/pybytes/api/write_config.md

+  - pybytes/api/write_config
+---
+
+  Write device configuration.


I took a look at this method and it is the private method which sneaked to public API
It will write config from self.__conf to a file

Let's remove this method from documentation

jirkadev

ok

lilycey

A few changes for readability (please also double check the 0-99 debugging level)

lilycey · 2020-01-24T10:26:37Z

content/pybytes/api/_index.md

+aliases:
+---
+
+To test Pybytes library API, connect your device to Pymakr and call the methods listed below.


1st comment: To test the Pybytes library API, connect your device to Pymakr and call the methods listed below.

lilycey · 2020-01-24T10:27:11Z

content/pybytes/api/_index.md

+---
+
+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.


2nd comment: You can use the Pybytes library API in your MicroPython project.

lilycey · 2020-01-24T10:29:08Z

content/pybytes/api/_index.md

+
+
+### Debugging
+If you are facing any issues try to enable debugging.


3rd comment: 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.

lilycey · 2020-01-24T10:29:34Z

content/pybytes/api/_index.md

+
+### 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).


4th comment: ( I have just moved this sentence into the 3rd comment, so you can delete it)

lilycey · 2020-01-24T10:30:44Z

content/pybytes/api/deepsleep.md

+
+**Success Response**
+----
+After sleep, device reconnect


5th comment: After deepsleep, the device reconnects.

lilycey · 2020-01-24T10:53:32Z

content/pybytes/api/set_custom_message_callback.md

+  - pybytes/api/set_custom_message_callback
+---
+
+  Send custom message callback.


7th comment: Sends custom message callback.

lilycey · 2020-01-24T11:01:18Z

content/pybytes/api/start.md

+  - pybytes/api/start
+---
+
+  Starts Pybytes library.


8th comment: Opens the Pybytes library.

lilycey · 2020-01-24T11:39:43Z

content/pybytes/api/read_config.md

+  - pybytes/api/read_config
+---
+
+  Reads configuration from the given file.


Reads the configuration from the given file.

lilycey · 2020-01-24T16:55:15Z

content/pybytes/api/connect_wifi.md

+  - pybytes/api/connect_wifi
+---
+
+  Initialize watchdog for WiFi and LTE connection.


Initialize watchdog for the WiFi and LTE connection.

lilycey · 2020-01-24T17:02:27Z

content/pybytes/api/print_config.md

+  - pybytes/api/print_config
+---
+
+  Prints current configuration in the terminal.


Prints the current configuration in the terminal.

alipsilv added 10 commits December 20, 2019 17:17

docs: pybytes api documentation

46e07d1

docs: documentation added for pybytes library api

3b59353

doc: new documentation added

8768d76

Merge branch 'publish' into pb-833-documentation-of-pybytes-library-api

f07f708

doc: new api documentation added

7cac853

docs: revised methods, list of methods should appear in the main menu

e86d87e

docs: debbuging information should appear on the main page

fb61c75

Merge pull request #200 from pycom/pb-787-documentation-for-pycom-lor…

41f8792

…a-server Pb 787 documentation for pycom lora server

docs: new doc added and style changes

cb6fa98

fix: conflicts resolved

172d2c4

alipsilv requested a review from lilycey January 17, 2020 17:07

jirkadev reviewed Jan 20, 2020

View reviewed changes

docs: contains Jirka review

ec2d584

jirkadev reviewed Jan 23, 2020

View reviewed changes

refactor: updated structure of pybytes library api page

01d112c

jirkadev reviewed Jan 23, 2020

View reviewed changes

lilycey reviewed Jan 27, 2020

View reviewed changes

alipsilv added 2 commits January 27, 2020 21:01

doc: method update_config documented

237c759

docs: contains Lily's review

6cb166b

jirkadev approved these changes Jan 28, 2020

View reviewed changes

alipsilv merged commit c6a895a into development-publish Jan 28, 2020

gijsio deleted the pb-833-documentation-of-pybytes-library-api branch July 20, 2020 10:55



		### Debugging
		If you are facing any issues try to enable debugging.

Pb 833 documentation of pybytes library api #206

Pb 833 documentation of pybytes library api #206

Uh oh!

Conversation

alipsilv commented Jan 17, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jirkadev left a comment

Choose a reason for hiding this comment

Uh oh!

lilycey left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!