Pb 833 documentation of pybytes library api

config.toml

@@ -1166,12 +1166,201 @@ theme = "doc-theme"
     parent = "pybytes"
     weight = 10
 
+[[menu.main]]
+    name = "Pybytes library API"
+    url = "/pybytes/api/"
+    identifier= "pybytes@api"
+    parent= "pybytes"
+    weight = 20
+
+[[menu.main]]
+    name = "Activate Device"
+    url = "/pybytes/api/activate/"
+    identifier = "pybytes@api@activate"
+    parent = "pybytes@api"
+    weight = 11
+
+[[menu.main]]
+    name = "Connect"
+    url = "/pybytes/api/connect_device/"
+    identifier = "pybytes@api@connect_device"
+    parent = "pybytes@api"
+    weight = 12
+
+[[menu.main]]
+    name = "Connect LTE"
+    url = "/pybytes/api/connect_lte/"
+    identifier = "pybytes@api@connect_lte"
+    parent = "pybytes@api"
+    weight = 13
+
+[[menu.main]]
+    name = "Connect loRa ABP"
+    url = "/pybytes/api/connect_lora_abp/"
+    identifier = "pybytes@api@connect_lora_abp"
+    parent = "pybytes@api"
+    weight = 14
+
+[[menu.main]]
+    name = "Connect loRa OTAA"
+    url = "/pybytes/api/connect_lora_otaa/"
+    identifier = "pybytes@api@connect_lora_otaa"
+    parent = "pybytes@api"
+    weight = 15
+
+[[menu.main]]
+    name = "Connect Sigfox"
+    url = "/pybytes/api/connect_sigfox/"
+    identifier = "pybytes@api@connect_sigfox"
+    parent = "pybytes@api"
+    weight = 16
+
+[[menu.main]]
+    name = "Connect Wifi"
+    url = "/pybytes/api/connect_wifi/"
+    identifier = "pybytes@api@connect_wifi"
+    parent = "pybytes@api"
+    weight = 17
+
+[[menu.main]]
+    name = "Deepsleep"
+    url = "/pybytes/api/deepsleep/"
+    identifier = "pybytes@api@deepsleep"
+    parent = "pybytes@api"
+    weight = 19
+
+[[menu.main]]
+    name = "Disconnect"
+    url = "/pybytes/api/disconnect/"
+    identifier = "pybytes@api@disconnect"
+    parent = "pybytes@api"
+    weight = 20
+
+[[menu.main]]
+    name = "Dump CA"
+    url = "/pybytes/api/dump_ca/"
+    identifier = "pybytes@api@dump_ca"
+    parent = "pybytes@api"
+    weight = 22
+
+[[menu.main]]
+    name = "Enable LTE"
+    url = "/pybytes/api/enable_lte/"
+    identifier = "pybytes@api@enable_lte"
+    parent = "pybytes@api"
+    weight = 23
+
+[[menu.main]]
+    name = "Enable SSL"
+    url = "/pybytes/api/enable_ssl/"
+    identifier = "pybytes@api@enable_ssl"
+    parent = "pybytes@api"
+    weight = 24
+
+[[menu.main]]
+    name = "Enable terminal"
+    url = "/pybytes/api/enable_terminal/"
+    identifier = "pybytes@api@enable_terminal"
+    parent = "pybytes@api"
+    weight = 25
+
+[[menu.main]]
+    name = "Export configuration"
+    url = "/pybytes/api/export_config/"
+    identifier = "pybytes@api@export_config"
+    parent = "pybytes@api"
+    weight = 26
+
+[[menu.main]]
+    name = "Get configuration"
+    url = "/pybytes/api/get_config/"
+    identifier = "pybytes@api@get_config"
+    parent = "pybytes@api"
+    weight = 27
+
+[[menu.main]]
+    name = "Is connected"
+    url = "/pybytes/api/is_connected/"
+    identifier = "pybytes@api@is_connected"
+    parent = "pybytes@api"
+    weight = 28
+
+[[menu.main]]
+    name = "Print configuration"
+    url = "/pybytes/api/print_config/"
+    identifier = "pybytes@api@print_config"
+    parent = "pybytes@api"
+    weight = 29
+
+[[menu.main]]
+    name = "Read configuration"
+    url = "/pybytes/api/read_config/"
+    identifier = "pybytes@api@read_config"
+    parent = "pybytes@api"
+    weight = 30
+
+[[menu.main]]
+    name = "Reconnect"
+    url = "/pybytes/api/reconnect/"
+    identifier = "pybytes@api@reconnect"
+    parent = "pybytes@api"
+    weight = 31
+
+[[menu.main]]
+    name = "Send info message"
+    url = "/pybytes/api/send_info_message/"
+    identifier = "pybytes@api@send_info_message"
+    parent = "pybytes@api"
+    weight = 32
+
+[[menu.main]]
+    name = "Send ping message"
+    url = "/pybytes/api/send_ping_message/"
+    identifier = "pybytes@api@send_ping_message"
+    parent = "pybytes@api"
+    weight = 33
+
+[[menu.main]]
+    name = "Send signal"
+    url = "/pybytes/api/send_signal/"
+    identifier = "pybytes@api@send_signal"
+    parent = "pybytes@api"
+    weight = 34
+
+[[menu.main]]
+    name = "Set configuration"
+    url = "/pybytes/api/set_config/"
+    identifier = "pybytes@api@set_config"
+    parent = "pybytes@api"
+    weight = 35
+
+[[menu.main]]
+    name = "Start"
+    url = "/pybytes/api/start/"
+    identifier = "pybytes@api@start"
+    parent = "pybytes@api"
+    weight = 36
+
+[[menu.main]]
+    name = "Update configuration"
+    url = "/pybytes/api/update_config/"
+    identifier = "pybytes@api@update_config"
+    parent = "pybytes@api"
+    weight = 37
+
+[[menu.main]]
+    name = "Write configuration"
+    url = "/pybytes/api/write_config/"
+    identifier = "pybytes@api@write_config"
+    parent = "pybytes@api"
+    weight = 38
+
 [[menu.main]]
     name = "Add a device to Pybytes"
     url = "/pybytes/connect/"
     identifier = "pybytes@connect"
     parent = "pybytes"
-    weight = 20
+    weight = 30
 
 [[menu.main]]
     name = "Provisioning via USB"
@@ -1181,25 +1370,39 @@ theme = "doc-theme"
     weight = 10
 
 [[menu.main]]
-    name = "Project Releases"
-    url = "/pybytes/releases/"
-    identifier = "pybytes@releases"
+    name = "Sigfox"
+    url = "/pybytes/sigfox/"
+    identifier = "pybytes@sigfox"
     parent = "pybytes"
+    weight = 40
+
+[[menu.main]]
+    name = "DevKit contract"
+    url = "/pybytes/sigfox/devkit/"
+    identifier = "pybytes@sigfox@devkit"
+    parent = "pybytes@sigfox"
+    weight = 10
+
+[[menu.main]]
+    name = "Custom contract"
+    url = "/pybytes/sigfox/custom/"
+    identifier = "pybytes@sigfox@custom"
+    parent = "pybytes@sigfox"
     weight = 20
 
 [[menu.main]]
-    name = "Pybytes iOS"
-    url = "/pybytes/smart/"
-    identifier = "pybytes@smart"
+    name = "Project Releases"
+    url = "/pybytes/releases/"
+    identifier = "pybytes@releases"
     parent = "pybytes"
-    weight = 20
+    weight = 50
 
 [[menu.main]]
     name = "Create new release"
     url = "/pybytes/releases/new/"
     identifier = "pybytes@releases@new"
     parent = "pybytes@releases"
-    weight = 20
+    weight = 10
 
 [[menu.main]]
     name = "Deploy release"
@@ -1255,14 +1458,14 @@ theme = "doc-theme"
     url = "/pybytes/dashboard/"
     identifier = "pybytes@dashboard"
     parent = "pybytes"
-    weight = 30
+    weight = 70
 
 [[menu.main]]
     name = "Integrations"
     url = "/pybytes/integrations/"
     identifier = "pybytes@integrations"
     parent = "pybytes"
-    weight = 40
+    weight = 80
 
 [[menu.main]]
     name = "Amazon IoT"

content/pybytes/api/_index.md

@@ -0,0 +1,79 @@
+---
+title: "Pybytes library API"
+aliases:
+---
+
+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
+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:
+
+```
+>> import pycom;
+>> pycom.nvs_set('pybytes_debug', debugLevel)
+```
+
+#### e.g.
+```
+>> import pycom;
+>> pycom.nvs_set('pybytes_debug', 99)
+```    
+
+
+# API List
+
+
+* [Activate](activate)
+
+* [Connect](connect)
+
+* [Connect LTE](connect_lte)
+
+* [Connect LoRa ABP](connect_lora_abp)
+
+* [Connect LoRa OTAA](connect_lora_otaa)
+
+* [Connect Sigfox](connect_sigfox)
+
+* [Connect Wifi](connect_wifi)
+
+* [Deepsleep](deepsleep)
+
+* [Disconnect](disconnect)
+
+* [Dump CA](dump_ca)
+
+* [Enable LTE](enable_lte)
+
+* [Enable SSL](enable_ssl)
+
+* [Enable terminal](enable_terminal)
+
+* [Export configuration](export_config)
+
+* [Get configuration](get_config)
+
+* [Is connected](is_connected)
+
+* [Print configuration](print_config)
+
+* [Read configuration](read_config)
+
+* [Reconnect](reconnect)
+
+* [Send info message](send_info_message)
+
+* [Send ping message](send_ping_message)
+
+* [Send signal](send_signal)
+
+* [Set configuration](set_config)
+
+* [Start](start)
+
+* [Update configuration](update_config)

content/pybytes/api/activate.md

@@ -0,0 +1,39 @@
+---
+title: "Activate Device"
+aliases:
+  - pybytes/api/activate.html
+  - pybytes/api/activate.md
+---
+
+  Activate device on Pybytes, via Pymakr plugin.
+
+**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)
+```