mirror of
https://github.com/sascha-hemi/pycom-documentation.git
synced 2026-03-21 06:06:03 +01:00
docs: new doc added and style changes
This commit is contained in:
Aline
231
config.toml
231
config.toml
@@ -1169,289 +1169,198 @@ theme = "doc-theme"
|
||||
[[menu.main]]
|
||||
name = "Pybytes library API"
|
||||
url = "/pybytes/api/"
|
||||
identifier = "pybytes@api"
|
||||
parent = "pybytes"
|
||||
weight = 15
|
||||
|
||||
[[menu.main]]
|
||||
name = "Add custom method"
|
||||
url = "/pybytes/api/add_custom_method"
|
||||
identifier = "pybytes@api@add_custom_method"
|
||||
parent = "pybytes@api"
|
||||
weight = 10
|
||||
identifier= "pybytes@api"
|
||||
parent= "pybytes"
|
||||
weight = 20
|
||||
|
||||
[[menu.main]]
|
||||
name = "Activate Device"
|
||||
url = "/pybytes/api/activate"
|
||||
url = "/pybytes/api/activate/"
|
||||
identifier = "pybytes@api@activate"
|
||||
parent = "pybytes@api"
|
||||
weight = 11
|
||||
|
||||
[[menu.main]]
|
||||
name = "Connect"
|
||||
url = "/pybytes/api/connect"
|
||||
identifier = "pybytes@api@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"
|
||||
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"
|
||||
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"
|
||||
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"
|
||||
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"
|
||||
url = "/pybytes/api/connect_wifi/"
|
||||
identifier = "pybytes@api@connect_wifi"
|
||||
parent = "pybytes@api"
|
||||
weight = 17
|
||||
|
||||
[[menu.main]]
|
||||
name = "Deepsleep"
|
||||
url = "/pybytes/api/deepsleep"
|
||||
url = "/pybytes/api/deepsleep/"
|
||||
identifier = "pybytes@api@deepsleep"
|
||||
parent = "pybytes@api"
|
||||
weight = 18
|
||||
|
||||
[[menu.main]]
|
||||
name = "Disconnect"
|
||||
url = "/pybytes/api/disconnect"
|
||||
identifier = "pybytes@api@disconnect"
|
||||
parent = "pybytes@api"
|
||||
weight = 19
|
||||
|
||||
[[menu.main]]
|
||||
name = "Dump ca"
|
||||
url = "/pybytes/api/dump_ca"
|
||||
identifier = "pybytes@api@dump_ca"
|
||||
name = "Disconnect"
|
||||
url = "/pybytes/api/disconnect/"
|
||||
identifier = "pybytes@api@disconnect"
|
||||
parent = "pybytes@api"
|
||||
weight = 20
|
||||
|
||||
[[menu.main]]
|
||||
name = "Enable lte"
|
||||
url = "/pybytes/api/enable_lte"
|
||||
identifier = "pybytes@api@enable_lte"
|
||||
parent = "pybytes@api"
|
||||
weight = 21
|
||||
|
||||
[[menu.main]]
|
||||
name = "Enable ssl"
|
||||
url = "/pybytes/api/enable_ssl"
|
||||
identifier = "pybytes@api@enable_ssl"
|
||||
name = "Dump CA"
|
||||
url = "/pybytes/api/dump_ca/"
|
||||
identifier = "pybytes@api@dump_ca"
|
||||
parent = "pybytes@api"
|
||||
weight = 22
|
||||
|
||||
[[menu.main]]
|
||||
name = "Enable terminal"
|
||||
url = "/pybytes/api/enable_terminal"
|
||||
identifier = "pybytes@api@enable_terminal"
|
||||
name = "Enable LTE"
|
||||
url = "/pybytes/api/enable_lte/"
|
||||
identifier = "pybytes@api@enable_lte"
|
||||
parent = "pybytes@api"
|
||||
weight = 23
|
||||
|
||||
[[menu.main]]
|
||||
name = "Export config"
|
||||
url = "/pybytes/api/export_config"
|
||||
identifier = "pybytes@api@export_config"
|
||||
name = "Enable SSL"
|
||||
url = "/pybytes/api/enable_ssl/"
|
||||
identifier = "pybytes@api@enable_ssl"
|
||||
parent = "pybytes@api"
|
||||
weight = 24
|
||||
|
||||
[[menu.main]]
|
||||
name = "Get config"
|
||||
url = "/pybytes/api/get_config"
|
||||
identifier = "pybytes@api@get_config"
|
||||
name = "Enable terminal"
|
||||
url = "/pybytes/api/enable_terminal/"
|
||||
identifier = "pybytes@api@enable_terminal"
|
||||
parent = "pybytes@api"
|
||||
weight = 25
|
||||
|
||||
[[menu.main]]
|
||||
name = "Is connected"
|
||||
url = "/pybytes/api/is_connected"
|
||||
identifier = "pybytes@api@is_connected"
|
||||
name = "Export configuration"
|
||||
url = "/pybytes/api/export_config/"
|
||||
identifier = "pybytes@api@export_config"
|
||||
parent = "pybytes@api"
|
||||
weight = 26
|
||||
|
||||
[[menu.main]]
|
||||
name = "isconnected"
|
||||
url = "/pybytes/api/isconnected"
|
||||
identifier = "pybytes@api@isconnected"
|
||||
name = "Get configuration"
|
||||
url = "/pybytes/api/get_config/"
|
||||
identifier = "pybytes@api@get_config"
|
||||
parent = "pybytes@api"
|
||||
weight = 27
|
||||
|
||||
[[menu.main]]
|
||||
name = "Print cfg msg"
|
||||
url = "/pybytes/api/print_cfg_msg"
|
||||
identifier = "pybytes@api@print_cfg_msg"
|
||||
name = "Is connected"
|
||||
url = "/pybytes/api/is_connected/"
|
||||
identifier = "pybytes@api@is_connected"
|
||||
parent = "pybytes@api"
|
||||
weight = 28
|
||||
|
||||
[[menu.main]]
|
||||
name = "Print config"
|
||||
url = "/pybytes/api/print_config"
|
||||
name = "Print configuration"
|
||||
url = "/pybytes/api/print_config/"
|
||||
identifier = "pybytes@api@print_config"
|
||||
parent = "pybytes@api"
|
||||
weight = 29
|
||||
|
||||
[[menu.main]]
|
||||
name = "Read config"
|
||||
url = "/pybytes/api/read_config"
|
||||
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"
|
||||
url = "/pybytes/api/reconnect/"
|
||||
identifier = "pybytes@api@reconnect"
|
||||
parent = "pybytes@api"
|
||||
weight = 31
|
||||
|
||||
[[menu.main]]
|
||||
name = "Register periodical analog pin publish"
|
||||
url = "/pybytes/api/register_periodical_analog_pin_publish"
|
||||
identifier = "pybytes@api@register_periodical_analog_pin_publish"
|
||||
name = "Send info message"
|
||||
url = "/pybytes/api/send_info_message/"
|
||||
identifier = "pybytes@api@send_info_message"
|
||||
parent = "pybytes@api"
|
||||
weight = 32
|
||||
|
||||
[[menu.main]]
|
||||
name = "Register periodical digital pin publish"
|
||||
url = "/pybytes/api/register_periodical_digital_pin_publish"
|
||||
identifier = "pybytes@api@register_periodical_digital_pin_publish"
|
||||
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 analog pin value"
|
||||
url = "/pybytes/api/send_analog_pin_value"
|
||||
identifier = "pybytes@api@send_analog_pin_value"
|
||||
name = "Send signal"
|
||||
url = "/pybytes/api/send_signal/"
|
||||
identifier = "pybytes@api@send_signal"
|
||||
parent = "pybytes@api"
|
||||
weight = 34
|
||||
|
||||
[[menu.main]]
|
||||
name = "Send battery level"
|
||||
url = "/pybytes/api/send_battery_level"
|
||||
identifier = "pybytes@api@send_battery_level"
|
||||
name = "Set configuration"
|
||||
url = "/pybytes/api/set_config/"
|
||||
identifier = "pybytes@api@set_config"
|
||||
parent = "pybytes@api"
|
||||
weight = 35
|
||||
|
||||
[[menu.main]]
|
||||
name = "Send custom message"
|
||||
url = "/pybytes/api/send_custom_message"
|
||||
identifier = "pybytes@api@send_custom_message"
|
||||
name = "Start"
|
||||
url = "/pybytes/api/start/"
|
||||
identifier = "pybytes@api@start"
|
||||
parent = "pybytes@api"
|
||||
weight = 36
|
||||
|
||||
[[menu.main]]
|
||||
name = "Set custom message callback"
|
||||
url = "/pybytes/api/set_custom_message_callback"
|
||||
identifier = "pybytes@api@set_custom_message_callback"
|
||||
name = "Update configuration"
|
||||
url = "/pybytes/api/update_config/"
|
||||
identifier = "pybytes@api@update_config"
|
||||
parent = "pybytes@api"
|
||||
weight = 37
|
||||
|
||||
[[menu.main]]
|
||||
name = "Send custom location"
|
||||
url = "/pybytes/api/send_custom_location"
|
||||
identifier = "pybytes@api@send_custom_location"
|
||||
parent = "pybytes@api"
|
||||
weight = 38
|
||||
|
||||
[[menu.main]]
|
||||
name = "Send digital pin value"
|
||||
url = "/pybytes/api/send_digital_pin_value"
|
||||
identifier = "pybytes@api@send_digital_pin_value"
|
||||
parent = "pybytes@api"
|
||||
weight = 39
|
||||
|
||||
[[menu.main]]
|
||||
name = "Send info message"
|
||||
url = "/pybytes/api/send_info_message"
|
||||
identifier = "pybytes@api@send_info_message"
|
||||
parent = "pybytes@api"
|
||||
weight = 40
|
||||
|
||||
[[menu.main]]
|
||||
name = "Send ping message"
|
||||
url = "/pybytes/api/send_ping_message"
|
||||
identifier = "pybytes@api@send_ping_message"
|
||||
parent = "pybytes@api"
|
||||
weight = 41
|
||||
|
||||
[[menu.main]]
|
||||
name = "Send scan info message"
|
||||
url = "/pybytes/api/send_scan_info_message"
|
||||
identifier = "pybytes@api@send_scan_info_message"
|
||||
parent = "pybytes@api"
|
||||
weight = 42
|
||||
|
||||
[[menu.main]]
|
||||
name = "Send signal"
|
||||
url = "/pybytes/api/send_signal"
|
||||
identifier = "pybytes@api@send_signal"
|
||||
parent = "pybytes@api"
|
||||
weight = 43
|
||||
|
||||
[[menu.main]]
|
||||
name = "Send virtual pin value"
|
||||
url = "/pybytes/api/send_virtual_pin_value"
|
||||
identifier = "pybytes@api@send_virtual_pin_value"
|
||||
parent = "pybytes@api"
|
||||
weight = 44
|
||||
|
||||
[[menu.main]]
|
||||
name = "Set config"
|
||||
url = "/pybytes/api/set_config"
|
||||
identifier = "pybytes@api@set_config"
|
||||
parent = "pybytes@api"
|
||||
weight = 45
|
||||
|
||||
[[menu.main]]
|
||||
name = "Start"
|
||||
url = "/pybytes/api/start"
|
||||
identifier = "pybytes@api@start"
|
||||
parent = "pybytes@api"
|
||||
weight = 46
|
||||
|
||||
[[menu.main]]
|
||||
name = "Update config"
|
||||
url = "/pybytes/api/update_config"
|
||||
identifier = "pybytes@api@update_config"
|
||||
parent = "pybytes@api"
|
||||
weight = 47
|
||||
|
||||
[[menu.main]]
|
||||
name = "Write config"
|
||||
url = "/pybytes/api/write_config"
|
||||
name = "Write configuration"
|
||||
url = "/pybytes/api/write_config/"
|
||||
identifier = "pybytes@api@write_config"
|
||||
parent = "pybytes@api"
|
||||
weight = 48
|
||||
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"
|
||||
@@ -1465,7 +1374,7 @@ theme = "doc-theme"
|
||||
url = "/pybytes/sigfox/"
|
||||
identifier = "pybytes@sigfox"
|
||||
parent = "pybytes"
|
||||
weight = 25
|
||||
weight = 40
|
||||
|
||||
[[menu.main]]
|
||||
name = "DevKit contract"
|
||||
@@ -1486,7 +1395,7 @@ theme = "doc-theme"
|
||||
url = "/pybytes/releases/"
|
||||
identifier = "pybytes@releases"
|
||||
parent = "pybytes"
|
||||
weight = 30
|
||||
weight = 50
|
||||
|
||||
[[menu.main]]
|
||||
name = "Create new release"
|
||||
@@ -1507,21 +1416,21 @@ theme = "doc-theme"
|
||||
url = "/pybytes/smart/"
|
||||
identifier = "pybytes@smart"
|
||||
parent = "pybytes"
|
||||
weight = 35
|
||||
weight = 60
|
||||
|
||||
[[menu.main]]
|
||||
name = "Visualise data"
|
||||
url = "/pybytes/dashboard/"
|
||||
identifier = "pybytes@dashboard"
|
||||
parent = "pybytes"
|
||||
weight = 40
|
||||
weight = 70
|
||||
|
||||
[[menu.main]]
|
||||
name = "Integrations"
|
||||
url = "/pybytes/integrations/"
|
||||
identifier = "pybytes@integrations"
|
||||
parent = "pybytes"
|
||||
weight = 45
|
||||
weight = 80
|
||||
|
||||
[[menu.main]]
|
||||
name = "Amazon IoT"
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
aliases:
|
||||
- pybytes/api
|
||||
---
|
||||
|
||||
|
||||
@@ -12,21 +11,20 @@ There are multiple debug levels, 0 is warnings only, 6 is currently the highest
|
||||
|
||||
#### use:
|
||||
|
||||
import pycom;
|
||||
|
||||
pycom.nvs_set('pybytes_debug', debugLevel)
|
||||
|
||||
```
|
||||
>> import pycom;
|
||||
>> pycom.nvs_set('pybytes_debug', debugLevel)
|
||||
```
|
||||
|
||||
#### e.g.
|
||||
```
|
||||
>> import pycom;
|
||||
>> pycom.nvs_set('pybytes_debug', 6)
|
||||
>> import pycom;
|
||||
>> pycom.nvs_set('pybytes_debug', 6)
|
||||
```
|
||||
|
||||
|
||||
# API List
|
||||
|
||||
* [Add custom method](add_custom_method)
|
||||
|
||||
* [Activate](activate)
|
||||
|
||||
@@ -46,60 +44,36 @@ pycom.nvs_set('pybytes_debug', debugLevel)
|
||||
|
||||
* [Disconnect](disconnect)
|
||||
|
||||
* [Dump ca](dump_ca)
|
||||
* [Dump CA](dump_ca)
|
||||
|
||||
* [Enable lte](enable_lte)
|
||||
* [Enable LTE](enable_lte)
|
||||
|
||||
* [Enable ssl](enable_ssl)
|
||||
* [Enable SSL](enable_ssl)
|
||||
|
||||
* [Enable terminal](enable_terminal)
|
||||
|
||||
* [Export config](export_config)
|
||||
* [Export configuration](export_config)
|
||||
|
||||
* [Get config](get_config)
|
||||
* [Get configuration](get_config)
|
||||
|
||||
* [Is connected](is_connected)
|
||||
|
||||
* [isconnected](isconnected)
|
||||
* [Print configuration](print_config)
|
||||
|
||||
* [Print cfg msg](print_cfg_msg)
|
||||
|
||||
* [Print config](print_config)
|
||||
|
||||
* [Read config](read_config)
|
||||
* [Read configuration](read_config)
|
||||
|
||||
* [Reconnect](reconnect)
|
||||
|
||||
* [Register periodical analog pin publish](register_periodical_analog_pin_publish)
|
||||
|
||||
* [Register periodical digital pin publish](register_periodical_digital_pin_publish)
|
||||
|
||||
* [Send analog pin value](send_analog_pin_value)
|
||||
|
||||
* [Send battery level](send_battery_level)
|
||||
|
||||
* [Send custom message](send_custom_message)
|
||||
|
||||
* [Set custom message callback](set_custom_message_callback)
|
||||
|
||||
* [Send custom location](send_custom_location)
|
||||
|
||||
* [Send digital pin value](send_digital_pin_value)
|
||||
|
||||
* [Send info message](send_info_message)
|
||||
|
||||
* [Send ping message](send_ping_message)
|
||||
|
||||
* [Send scan info message](send_scan_info_message)
|
||||
|
||||
* [Send signal](send_signal)
|
||||
|
||||
* [Send virtual pin value](send_virtual_pin_value)
|
||||
|
||||
* [Set config](set_config)
|
||||
* [Set configuration](set_config)
|
||||
|
||||
* [Start](start)
|
||||
|
||||
* [Update config](update_config)
|
||||
* [Update configuration](update_config)
|
||||
|
||||
* [Write config](write_config)
|
||||
* [Write configuration](write_config)
|
||||
|
||||
@@ -1,11 +1,10 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Activate Device"
|
||||
aliases:
|
||||
- pybytes/api/activate
|
||||
- pybytes/api/activate.html
|
||||
- pybytes/api/activate.md
|
||||
---
|
||||
|
||||
**Activate**
|
||||
----
|
||||
Activate device on Pybytes.
|
||||
|
||||
**Method**
|
||||
@@ -22,17 +21,19 @@ aliases:
|
||||
|
||||
**Example**
|
||||
----
|
||||
pybytes.activate("eyJhIjoiNTYzM...")
|
||||
`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)
|
||||
```
|
||||
>> 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)
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Connect Device"
|
||||
aliases:
|
||||
- pybytes/api/connect
|
||||
---
|
||||
|
||||
**Connect**
|
||||
----
|
||||
Initialize connection based on the configured parameters.
|
||||
|
||||
**Method**
|
||||
@@ -18,4 +16,7 @@ aliases:
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
>> Connected using Sigfox. Only upload stream is supported
|
||||
|
||||
```
|
||||
>> Connected using Sigfox. Only upload stream is supported
|
||||
```
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Connect LoRa ABP"
|
||||
aliases:
|
||||
- pybytes/api/connect_lora_abp
|
||||
---
|
||||
|
||||
**Connect LoRa ABP**
|
||||
----
|
||||
Initialize LoRa ABP connection.
|
||||
|
||||
**Method**
|
||||
@@ -17,7 +15,7 @@ aliases:
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| timeout | Connection timeout | Yes | - |
|
||||
| nanogateway | TBD | Yes | - |
|
||||
| nanogateway | Enable nanogateway | Yes | - |
|
||||
|
||||
**Example**
|
||||
----
|
||||
@@ -25,6 +23,9 @@ aliases:
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
>> Trying to join LoRa.ABP for 15000 seconds...
|
||||
>> Setting up LoRa socket...
|
||||
>> Connected using LoRa
|
||||
|
||||
```
|
||||
>> Trying to join LoRa.ABP for 15000 seconds...
|
||||
>> Setting up LoRa socket...
|
||||
>> Connected using LoRa
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Connect LoRa OTAA"
|
||||
aliases:
|
||||
- pybytes/api/connect_lora_otaa
|
||||
---
|
||||
|
||||
**Connect LoRa OTAA**
|
||||
----
|
||||
Initialize LoRa OTAA connection.
|
||||
|
||||
**Method**
|
||||
@@ -17,7 +15,7 @@ aliases:
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| timeout | Connection timeout | Yes | - |
|
||||
| nanogateway | TBD | Yes | - |
|
||||
| nanogateway | Enable nanogateway | Yes | - |
|
||||
|
||||
**Example**
|
||||
----
|
||||
@@ -25,6 +23,9 @@ aliases:
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
>> Trying to join LoRa.OTAA for 15 seconds...
|
||||
>> Setting up LoRa socket...
|
||||
>> Connected using LoRa
|
||||
|
||||
```
|
||||
>> Trying to join LoRa.OTAA for 15 seconds...
|
||||
>> Setting up LoRa socket...
|
||||
>> Connected using LoRa
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Connect LTE"
|
||||
aliases:
|
||||
- pybytes/api/connect_lte
|
||||
---
|
||||
|
||||
**Connect LTE**
|
||||
----
|
||||
Initialize watchdog for WiFi and LTE connection.
|
||||
|
||||
**Method**
|
||||
@@ -22,7 +20,3 @@ aliases:
|
||||
**Example**
|
||||
----
|
||||
`pybytes.connect_lte(reconnect=True, check_interval=0.5)`
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
TBD
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Connect Sigfox"
|
||||
aliases:
|
||||
- pybytes/api/connect_sigfox
|
||||
---
|
||||
|
||||
**Connect Sigfox**
|
||||
----
|
||||
Initialize Sigfox connection.
|
||||
|
||||
**Method**
|
||||
@@ -18,4 +16,7 @@ aliases:
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
>> Connected using Sigfox. Only upload stream is supported
|
||||
|
||||
```
|
||||
>> Connected using Sigfox. Only upload stream is supported
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Connect Wifi"
|
||||
aliases:
|
||||
- pybytes/api/connect_wifi
|
||||
---
|
||||
|
||||
**Connect Wifi**
|
||||
----
|
||||
Initialize watchdog for WiFi and LTE connection.
|
||||
|
||||
**Method**
|
||||
@@ -14,5 +12,8 @@ aliases:
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
>> Connecting with SSID and PASSWORD
|
||||
>> WiFi connection established
|
||||
|
||||
```
|
||||
>> Connecting with SSID and PASSWORD
|
||||
>> WiFi connection established
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Deepsleep"
|
||||
aliases:
|
||||
- pybytes/api/deepsleep
|
||||
---
|
||||
|
||||
**Deepsleep**
|
||||
----
|
||||
Start deepsleep mode for the given period
|
||||
|
||||
**Method**
|
||||
@@ -17,18 +15,20 @@ aliases:
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| ms | Sleep period in ms | Yes | - |
|
||||
| pins | Affected pins | No | None |
|
||||
| mode | Sleep mode TBD | No | None |
|
||||
| enable_pull | Enable pull | No | None |
|
||||
| pins | A list or tuple containing the GPIO to setup for deepsleep wakeup | No | None |
|
||||
| mode | Configure how GPIOs can wake up -> **machine.WAKEUP_ALL_LOW** or **machine.WAKEUP_ANY_HIGH** | No | None |
|
||||
| enable_pull | If set to **True** keeps the pull up or pull down resistors enabled during deep sleep | No | None |
|
||||
|
||||
**Example**
|
||||
----
|
||||
pybytes.deepsleep(1000)
|
||||
`>> pybytes.deepsleep(1000)`
|
||||
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
After sleep, device reconnect
|
||||
|
||||
>> Connecting with SSID and PASSWORD
|
||||
>> WiFi connection established
|
||||
```
|
||||
>> Connecting with SSID and PASSWORD
|
||||
>> WiFi connection established
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Disconnect"
|
||||
aliases:
|
||||
- pybytes/api/disconnect
|
||||
---
|
||||
|
||||
**Disconnect**
|
||||
----
|
||||
Disconnect device
|
||||
|
||||
**Method**
|
||||
@@ -13,9 +11,12 @@ aliases:
|
||||
**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
|
||||
```
|
||||
>> 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
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Dump CA"
|
||||
aliases:
|
||||
- pybytes/api/dump_ca
|
||||
---
|
||||
|
||||
**Dump CA**
|
||||
----
|
||||
Make a dump_ca
|
||||
|
||||
**Method**
|
||||
@@ -24,4 +22,8 @@ aliases:
|
||||
`pybytes.dump_ca(ca_file='/flash/cert/pycom-ca.pem')`
|
||||
|
||||
**Success Response**
|
||||
`Successfully created /flash/cert/pycom-ca.pem`
|
||||
----
|
||||
|
||||
```
|
||||
>> Successfully created /flash/cert/pycom-ca.pem
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Enable LTE"
|
||||
aliases:
|
||||
- pybytes/api/enable_lte
|
||||
---
|
||||
|
||||
**Enable LTE**
|
||||
----
|
||||
Enable LTE connection
|
||||
|
||||
**Method**
|
||||
@@ -22,11 +20,17 @@ aliases:
|
||||
| apn | APN | No | None |
|
||||
| type | Type | No | None |
|
||||
| reset | Reset | No | None |
|
||||
| fallback | Fallback TBD | No | False |
|
||||
| fallback | If **True** extends network preferences with the given LTE information| No | False |
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.enable_lte('Standard', 1, 3, 'internet', 'IP', False)`
|
||||
`pybytes.enable_lte('standard', 1, 8, 'soracom.io', 'IP', False)`
|
||||
|
||||
**Success Response**
|
||||
`TBD`
|
||||
----
|
||||
|
||||
```
|
||||
>> Pybytes configuration written to /flash/pybytes_config.json
|
||||
>> Watchdog timeout has been increased to 2147483647 ms
|
||||
>> Initialized watchdog for WiFi and LTE connection with timeout 1260000 ms
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Enable SSL"
|
||||
aliases:
|
||||
- pybytes/api/enable_ssl
|
||||
---
|
||||
|
||||
**Enable SSL**
|
||||
----
|
||||
Enable SSL
|
||||
|
||||
**Method**
|
||||
@@ -24,4 +22,8 @@ aliases:
|
||||
`pybytes.enable_ssl('/flash/cert/pycom-ca.pem', True)`
|
||||
|
||||
**Success Response**
|
||||
`Please reset your module to apply the new settings`
|
||||
----
|
||||
|
||||
```
|
||||
>> Please reset your module to apply the new settings
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Enable Terminal"
|
||||
aliases:
|
||||
- pybytes/api/enable_terminal
|
||||
---
|
||||
|
||||
**Enable Terminal**
|
||||
----
|
||||
Enable Terminal
|
||||
|
||||
**Method**
|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Export configuration file"
|
||||
aliases:
|
||||
- pybytes/api/export_config
|
||||
---
|
||||
|
||||
**Export configuration file**
|
||||
----
|
||||
Exports configuration file at specified path.
|
||||
Exports all configuration data into a file at specified path.
|
||||
|
||||
**Method**
|
||||
----
|
||||
@@ -23,4 +21,8 @@ aliases:
|
||||
`pybytes.export_config()`
|
||||
|
||||
**Success Response**
|
||||
`Pybytes configuration exported to /flash/pybytes_config.json`
|
||||
----
|
||||
|
||||
```
|
||||
>> Pybytes configuration exported to /flash/pybytes_config.json
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Get configuration"
|
||||
aliases:
|
||||
- pybytes/api/get_config
|
||||
---
|
||||
|
||||
**Get Config**
|
||||
----
|
||||
Returns configuration data.
|
||||
|
||||
**Method**
|
||||
@@ -23,6 +21,8 @@ aliases:
|
||||
`pybytes.get_config()`
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
|
||||
```json
|
||||
{
|
||||
'ssl': True,
|
||||
|
||||
@@ -17,4 +17,8 @@ aliases:
|
||||
`pybytes.is_connected()`
|
||||
|
||||
**Success Response**
|
||||
`True`
|
||||
----
|
||||
|
||||
```
|
||||
>> True
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Is connected"
|
||||
aliases:
|
||||
- pybytes/api/isconnected
|
||||
---
|
||||
|
||||
**Is connected**
|
||||
----
|
||||
Returns true if connected.
|
||||
|
||||
**Method**
|
||||
@@ -17,4 +15,8 @@ aliases:
|
||||
`pybytes.isconnected()`
|
||||
|
||||
**Success Response**
|
||||
`True`
|
||||
----
|
||||
|
||||
```
|
||||
>> True
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Print config"
|
||||
aliases:
|
||||
- pybytes/api/print_config
|
||||
---
|
||||
|
||||
**Print config**
|
||||
----
|
||||
Prints current configuration in the terminal.
|
||||
|
||||
**Method**
|
||||
@@ -17,17 +15,21 @@ aliases:
|
||||
`pybytes.print_config()`
|
||||
|
||||
**Success Response**
|
||||
>> ssl = True
|
||||
>> wifi = {'ssid': '', 'password': ''}
|
||||
>> lte = {'apn': 'internet', 'cid': 1, 'reset': False, 'carrier': 'Standard', 'band': 3, 'type': 'IP'}
|
||||
>> username = alipsilv@hotmail.com
|
||||
>> network_preferences = ['lte', 'lte', 'lte', 'lora_otaa']
|
||||
>> cfg_msg = Pybytes configuration read from /flash/pybytes_config.json
|
||||
>> dump_ca = True
|
||||
>> wlan_antenna = 0
|
||||
>> server = 10.0.0.61
|
||||
>> lora = {'otaa': {'app_key': '87c8105c151f885bc19ccb9484fe8185', 'app_device_eui': '909d7afb9b82c0f6', 'app_eui': '70B3D57ED000AFA0'}}
|
||||
>> ota_server = {'port': 443, 'domain': 'software.pycom.io'}
|
||||
>> pybytes_autostart = True
|
||||
>> ssl_params = {'ca_certs': '/flash/cert/pycom-ca.pem'}
|
||||
>> device_id = 139e95ed-7213-406b-b07a-a54bfbf021c8
|
||||
----
|
||||
|
||||
```
|
||||
>> ssl = True
|
||||
>> wifi = {'ssid': '', 'password': ''}
|
||||
>> lte = {'apn': 'internet', 'cid': 1, 'reset': False, 'carrier': 'Standard', 'band': 3, 'type': 'IP'}
|
||||
>> username = alipsilv@hotmail.com
|
||||
>> network_preferences = ['lte', 'lte', 'lte', 'lora_otaa']
|
||||
>> cfg_msg = Pybytes configuration read from /flash/pybytes_config.json
|
||||
>> dump_ca = True
|
||||
>> wlan_antenna = 0
|
||||
>> server = 10.0.0.61
|
||||
>> lora = {'otaa': {'app_key': '87c8105c151f885bc19ccb9484fe8185', 'app_device_eui': '909d7afb9b82c0f6', 'app_eui': '70B3D57ED000AFA0'}}
|
||||
>> ota_server = {'port': 443, 'domain': 'software.pycom.io'}
|
||||
>> pybytes_autostart = True
|
||||
>> ssl_params = {'ca_certs': '/flash/cert/pycom-ca.pem'}
|
||||
>> device_id = 139e95ed-7213-406b-b07a-a54bfbf021c8
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Read configuration"
|
||||
aliases:
|
||||
- pybytes/api/read_config
|
||||
---
|
||||
|
||||
**Read config**
|
||||
----
|
||||
Reads configuration from the given file.
|
||||
|
||||
**Method**
|
||||
@@ -24,4 +22,8 @@ aliases:
|
||||
`pybytes.read_config()`
|
||||
|
||||
**Success Response**
|
||||
`Pybytes configuration read from /flash/pybytes_config.json`
|
||||
----
|
||||
|
||||
```
|
||||
>> Pybytes configuration read from /flash/pybytes_config.json
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Reconnect"
|
||||
aliases:
|
||||
- pybytes/api/reconnect
|
||||
---
|
||||
|
||||
**Reconnect**
|
||||
----
|
||||
Reconnects device.
|
||||
|
||||
**Method**
|
||||
@@ -17,8 +15,10 @@ aliases:
|
||||
`pybytes.reconnect()`
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
|
||||
After disconnect
|
||||
----
|
||||
>> Connecting with SSID and PASSWORD
|
||||
>> WiFi connection established
|
||||
```
|
||||
>> Connecting with SSID and PASSWORD
|
||||
>> WiFi connection established
|
||||
```
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
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_analog_pin_publish(persistent, pin_number, period)**
|
||||
|
||||
**Parameters**
|
||||
----
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| persistent | Bool | No | False |
|
||||
| pin number | Analog pin number TBD| Yes | - |
|
||||
| period | Interval in seconds | Yes | - |
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.register_periodical_analog_pin_publish(False, 13, 2)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
@@ -1,30 +0,0 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
aliases:
|
||||
- pybytes/api/register_periodical_digital_pin_publish
|
||||
---
|
||||
|
||||
**Register periodical digital pin publish**
|
||||
----
|
||||
Publish periodically on the given digital pin.
|
||||
|
||||
|
||||
**Method**
|
||||
----
|
||||
**pybytes.register_periodical_digital_pin_publish(persistent, pin_number, pull_mode, period)**
|
||||
|
||||
**Parameters**
|
||||
----
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| persistent | Bool | No | False |
|
||||
| pin number | Analog pin number | Yes | - |
|
||||
| pull mode | PULL_UP or TBD | Yes | PULL_UP |
|
||||
| period | Interval in seconds | Yes | - |
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.register_periodical_digital_pin_publish(False, PIN_NUMBER, Pin.PULL_UP, 2)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
@@ -1,27 +0,0 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
aliases:
|
||||
- pybytes/api/send_analog_pin_value
|
||||
---
|
||||
|
||||
**Send analog pin value**
|
||||
----
|
||||
Send analog pin value.
|
||||
|
||||
**Method**
|
||||
----
|
||||
**pybytes.send_analog_pin_value(persistent, pin_number)**
|
||||
|
||||
**Parameters**
|
||||
----
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| persistent | Bool | No | False |
|
||||
| pin number | Analog pin number TBD| Yes | - |
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.send_analog_pin_value(False, 13)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
@@ -1,26 +0,0 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
aliases:
|
||||
- pybytes/api/send_battery_level
|
||||
---
|
||||
|
||||
**Send battery level**
|
||||
----
|
||||
Send battery level.
|
||||
|
||||
**Method**
|
||||
----
|
||||
**pybytes.send_battery_level(battery_level)**
|
||||
|
||||
**Parameters**
|
||||
----
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| battery_level | battery level | Yes | False |
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.send_battery_level(False, 50)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
aliases:
|
||||
- pybytes/api/send_custom_location
|
||||
---
|
||||
|
||||
**Send custom location**
|
||||
----
|
||||
Send custom location.
|
||||
|
||||
**Method**
|
||||
----
|
||||
**pybytes.send_custom_location(pin, x, y)**
|
||||
|
||||
**Parameters**
|
||||
----
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| pin | TBD | Yes | - |
|
||||
| x | Longitude | Yes | - |
|
||||
| y | Latitude | Yes | - |
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.send_custom_location(pin, 0, 0)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
@@ -1,27 +0,0 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
aliases:
|
||||
- pybytes/api/send_custom_message
|
||||
---
|
||||
|
||||
**Send custom location**
|
||||
----
|
||||
Send custom location.
|
||||
|
||||
**Method**
|
||||
----
|
||||
**pybytes.send_custom_message(message_type, message)**
|
||||
|
||||
**Parameters**
|
||||
----
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| message_type | TBD 0x00 0x07 | Yes | - |
|
||||
| message | Longitude | Yes | - |
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.send_custom_message(TBD, TBD)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
aliases:
|
||||
- pybytes/api/send_digital_pin_value
|
||||
---
|
||||
|
||||
**Send analog pin value**
|
||||
----
|
||||
Send analog pin value.
|
||||
|
||||
**Method**
|
||||
----
|
||||
**pybytes.send_digital_pin_value(persistent, pin_number, pull_mode)**
|
||||
|
||||
**Parameters**
|
||||
----
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| persistent | Bool | No | False |
|
||||
| pin number | Analog pin number TBD| Yes | - |
|
||||
| pull mode | PULL_UP or TBD | Yes | PULL_UP |
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.send_digital_pin_value(False, 12, Pin.PULL_UP)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
@@ -1,12 +1,10 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Send information message"
|
||||
aliases:
|
||||
- pybytes/api/send_info_message
|
||||
---
|
||||
|
||||
**Send info message**
|
||||
----
|
||||
Send info message.
|
||||
Send information message.
|
||||
|
||||
**Method**
|
||||
----
|
||||
@@ -15,6 +13,3 @@ aliases:
|
||||
**Example**
|
||||
----
|
||||
`pybytes.send_info_message()`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Send ping message"
|
||||
aliases:
|
||||
- pybytes/api/send_ping_message
|
||||
---
|
||||
|
||||
**Send ping message**
|
||||
----
|
||||
Send ping message.
|
||||
|
||||
**Method**
|
||||
@@ -15,6 +13,3 @@ aliases:
|
||||
**Example**
|
||||
----
|
||||
`pybytes.send_ping_message()`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
aliases:
|
||||
- pybytes/api/send_scan_info_message
|
||||
---
|
||||
|
||||
**Send scan info message**
|
||||
----
|
||||
Send scan info message.
|
||||
|
||||
**Method**
|
||||
----
|
||||
**pybytes.send_scan_info_message()**
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.send_scan_info_message()`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Send signal"
|
||||
aliases:
|
||||
- pybytes/api/send_signal
|
||||
---
|
||||
|
||||
**Send signal**
|
||||
----
|
||||
Send signal to the given pin.
|
||||
|
||||
**Method**
|
||||
@@ -24,4 +22,7 @@ aliases:
|
||||
`pybytes.send_signal(13,25)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
---
|
||||
```
|
||||
To check the result, look at Pybytes → Device → Data
|
||||
```
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
aliases:
|
||||
- pybytes/api/send_virtual_pin_value
|
||||
---
|
||||
|
||||
**Send ping message**
|
||||
----
|
||||
Send ping message. TBD
|
||||
|
||||
**Method**
|
||||
----
|
||||
**pybytes.send_virtual_pin_value(pin, value)**
|
||||
|
||||
**Parameters**
|
||||
----
|
||||
| name | Description | is Required | Default value
|
||||
| ------------- |:-------------:|:-------------:|:-------------:|
|
||||
| pin | pin | Yes | - |
|
||||
| value | signal value | Yes | - |
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.send_virtual_pin_value(13,25)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Set configuration"
|
||||
aliases:
|
||||
- pybytes/api/set_config
|
||||
---
|
||||
|
||||
**Set configuration**
|
||||
----
|
||||
Set device configuration.
|
||||
|
||||
**Method**
|
||||
@@ -27,4 +25,8 @@ aliases:
|
||||
`pybytes.set_config(key=None, value=None, permanent=True, silent=False, reconnect=False)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
----
|
||||
|
||||
```
|
||||
>> Pybytes configuration written to /flash/pybytes_config.json
|
||||
```
|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Send custom message callback"
|
||||
aliases:
|
||||
- pybytes/api/set_custom_message_callback
|
||||
---
|
||||
|
||||
**Send custom message callback**
|
||||
----
|
||||
Send custom location.
|
||||
Send custom message callback.
|
||||
|
||||
**Method**
|
||||
----
|
||||
@@ -20,7 +18,11 @@ aliases:
|
||||
|
||||
**Example**
|
||||
----
|
||||
`pybytes.set_custom_message_callback(true)`
|
||||
`pybytes.set_custom_message_callback(print("Hello Pycom!"))`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
----
|
||||
|
||||
```
|
||||
>> Hello Pycom!
|
||||
```
|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Start"
|
||||
aliases:
|
||||
- pybytes/api/start
|
||||
---
|
||||
|
||||
**Start device**
|
||||
----
|
||||
Start device - TBD
|
||||
Start/Restart device.
|
||||
|
||||
**Method**
|
||||
----
|
||||
@@ -17,10 +15,13 @@ aliases:
|
||||
`pybytes.start()`
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
|
||||
>> 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)
|
||||
```
|
||||
>> 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)
|
||||
```
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Update configuration"
|
||||
aliases:
|
||||
- pybytes/api/update_config
|
||||
---
|
||||
|
||||
**Update configuration**
|
||||
----
|
||||
Update device configuration.
|
||||
|
||||
**Method**
|
||||
@@ -27,4 +25,6 @@ aliases:
|
||||
`pybytes.update_config(key=None, value=None, permanent=True, silent=False, reconnect=False)`
|
||||
|
||||
**Success Response**
|
||||
TBD
|
||||
----
|
||||
|
||||
TBD test
|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
---
|
||||
title: "Pybytes library API"
|
||||
title: "Write configuration"
|
||||
aliases:
|
||||
- pybytes/api/write_config
|
||||
---
|
||||
|
||||
**Update configuration**
|
||||
----
|
||||
Update device configuration.
|
||||
Write device configuration.
|
||||
|
||||
**Method**
|
||||
----
|
||||
@@ -24,5 +22,8 @@ aliases:
|
||||
`pybytes.write_config(file='/flash/pybytes_config.json', silent=False)`
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
|
||||
>> Pybytes configuration written to /flash/pybytes_config.json
|
||||
```
|
||||
>> Pybytes configuration written to /flash/pybytes_config.json
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user