diff --git a/content/pybytes/api/activate.md b/content/pybytes/api/activate.md index e69de29..1a209da 100644 --- a/content/pybytes/api/activate.md +++ b/content/pybytes/api/activate.md @@ -0,0 +1,40 @@ +--- +title: "Pybytes library API" +aliases: + - pybytes/api/activate +--- + +**Activate** +---- + Activate device + + +**Method** +---- +**pybytes.activate(activation_string)** + + +**Parameters** +---- +| name | Description | is Required | Default value +| ------------- |:-------------:|:-------------:|:-------------:| +| activation string | generated by Pybytes | Yes | - | + + + +**Example** +---- +pybytes.activate("eyJhIjoiNTYzM...") + + +**Success Response** +---- + + >> Please wait while we try to connect to Pycom + >> Wifi connection established... activating device! + >> WMAC: 807D3AC325E8 + >> Firmware: 1.20.1.r2 + >> Pybytes: 1.3.0 + >> Initialized watchdog for WiFi and LTE connection with timeout 1260000 ms + >> WiFi connection established + >> Pybytes connected successfully (using the built-in pybytes library) diff --git a/content/pybytes/api/connect_wifi.md b/content/pybytes/api/connect_wifi.md index e5c582d..92970cb 100644 --- a/content/pybytes/api/connect_wifi.md +++ b/content/pybytes/api/connect_wifi.md @@ -12,3 +12,8 @@ aliases: **Method** ---- **pybytes.connect_wifi()** + +**Success Response** +---- + >> Connecting with SSID and PASSWORD + >> WiFi connection established diff --git a/content/pybytes/api/deepsleep.md b/content/pybytes/api/deepsleep.md index 15c821a..c487e6c 100644 --- a/content/pybytes/api/deepsleep.md +++ b/content/pybytes/api/deepsleep.md @@ -27,5 +27,9 @@ aliases: pybytes.deepsleep(1000) -## Success Response -TBD +**Success Response** +---- +After sleep, device reconnect + + >> Connecting with SSID and PASSWORD + >> WiFi connection established diff --git a/content/pybytes/api/disconnect.md b/content/pybytes/api/disconnect.md index da31db7..4c803e9 100644 --- a/content/pybytes/api/disconnect.md +++ b/content/pybytes/api/disconnect.md @@ -12,3 +12,11 @@ aliases: **Method** ---- **pybytes.disconnect()** + +**Success Response** + + >> Watchdog timeout has been increased to 2147483647 ms + >> self.__connection_status=1 | self.__network_type=0 + >> MQTT over WIFI||LTE... disconnecting MQTT + >> Packet sent. (Length: 2) + >> Connected over WIFI... disconnecting diff --git a/content/pybytes/api/dump_ca.md b/content/pybytes/api/dump_ca.md index 5dd4992..943d1cc 100644 --- a/content/pybytes/api/dump_ca.md +++ b/content/pybytes/api/dump_ca.md @@ -24,5 +24,5 @@ aliases: ---- `pybytes.dump_ca(ca_file='/flash/cert/pycom-ca.pem')` -## Success Response +**Success Response** `Successfully created /flash/cert/pycom-ca.pem` diff --git a/content/pybytes/api/enable_lte.md b/content/pybytes/api/enable_lte.md index 8acc6f4..bb4a21e 100644 --- a/content/pybytes/api/enable_lte.md +++ b/content/pybytes/api/enable_lte.md @@ -29,5 +29,5 @@ aliases: ---- `pybytes.enable_lte('Standard', 1, 3, 'internet', 'IP', False)` -## Success Response +**Success Response** `TBD` diff --git a/content/pybytes/api/enable_ssl.md b/content/pybytes/api/enable_ssl.md index a1e195f..8777e6a 100644 --- a/content/pybytes/api/enable_ssl.md +++ b/content/pybytes/api/enable_ssl.md @@ -24,5 +24,5 @@ aliases: ---- `pybytes.enable_ssl('/flash/cert/pycom-ca.pem', True)` -## Success Response +**Success Response** `Please reset your module to apply the new settings` diff --git a/content/pybytes/api/export_config.md b/content/pybytes/api/export_config.md index 60d5f40..d4f94a9 100644 --- a/content/pybytes/api/export_config.md +++ b/content/pybytes/api/export_config.md @@ -23,5 +23,5 @@ aliases: ---- `pybytes.export_config()` -## Success Response +**Success Response** `Pybytes configuration exported to /flash/pybytes_config.json` diff --git a/content/pybytes/api/get_config.md b/content/pybytes/api/get_config.md index 5eb9a69..432f1ed 100644 --- a/content/pybytes/api/get_config.md +++ b/content/pybytes/api/get_config.md @@ -23,7 +23,7 @@ aliases: ---- `pybytes.get_config()` -## Success Response +**Success Response** ```json { 'ssl': True, diff --git a/content/pybytes/api/is_connected.md b/content/pybytes/api/is_connected.md index c48e966..5b72aaa 100644 --- a/content/pybytes/api/is_connected.md +++ b/content/pybytes/api/is_connected.md @@ -17,5 +17,5 @@ aliases: ---- `pybytes.is_connected()` -## Success Response +**Success Response** `True` diff --git a/content/pybytes/api/isconnected.md b/content/pybytes/api/isconnected.md index 418a842..9fed8bc 100644 --- a/content/pybytes/api/isconnected.md +++ b/content/pybytes/api/isconnected.md @@ -17,5 +17,5 @@ aliases: ---- `pybytes.isconnected()` -## Success Response +**Success Response** `True` diff --git a/content/pybytes/api/print_config.md b/content/pybytes/api/print_config.md index 513a701..3fc68ed 100644 --- a/content/pybytes/api/print_config.md +++ b/content/pybytes/api/print_config.md @@ -17,7 +17,7 @@ aliases: ---- `pybytes.print_config()` -## Success Response +**Success Response** ssl = True wifi = {'ssid': '', 'password': ''} lte = {'apn': 'internet', 'cid': 1, 'reset': False, 'carrier': 'Standard', 'band': 3, 'type': 'IP'} diff --git a/content/pybytes/api/read_config.md b/content/pybytes/api/read_config.md index cef2711..71b5769 100644 --- a/content/pybytes/api/read_config.md +++ b/content/pybytes/api/read_config.md @@ -24,5 +24,5 @@ aliases: ---- `pybytes.read_config()` -## Success Response +**Success Response** `Pybytes configuration read from /flash/pybytes_config.json` diff --git a/content/pybytes/api/reconnect.md b/content/pybytes/api/reconnect.md index 3e866b8..61a0f9c 100644 --- a/content/pybytes/api/reconnect.md +++ b/content/pybytes/api/reconnect.md @@ -17,5 +17,9 @@ aliases: ---- `pybytes.reconnect()` -## Success Response -`TBD` +**Success Response** + +After disconnect +---- + >> Connecting with SSID and PASSWORD + >> WiFi connection established diff --git a/content/pybytes/api/register_periodical_analog_pin_publish.md b/content/pybytes/api/register_periodical_analog_pin_publish.md index e69de29..68dc467 100644 --- a/content/pybytes/api/register_periodical_analog_pin_publish.md +++ b/content/pybytes/api/register_periodical_analog_pin_publish.md @@ -0,0 +1,30 @@ +--- +title: "Pybytes library API" +aliases: + - pybytes/api/register_periodical_analog_pin_publish +--- + +**Register periodical analog pin publish** +---- + Publish periodically on the given analog pin + + +**Method** +---- +**pybytes.register_periodical_digital_pin_publish(persistent, pin_number, pull_mode, period)** + +**Parameters** +---- +| name | Description | is Required | Default value +| ------------- |:-------------:|:-------------:|:-------------:| +| persistent | TBD | TBD | TBD | +| pin number | Reconnect after changes | TBD | TBD | +| pull mode | Reconnect after changes | TBD | TBD | +| period | Time in ms | Yes | - | + +**Example** +---- +`pybytes.register_periodical_digital_pin_publish(TBD, TBD, TBD, 1000)` + +**Success Response** +TBD