sascha_hemi/pycom-documentation
1
0
Fork 0
mirror of https://github.com/sascha-hemi/pycom-documentation.git synced 2026-03-21 19:06:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Aline
2020-01-15 15:54:57 +01:00
parent 7cac853d87
commit e86d87e6c3
34 changed files with 430 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

273
config.toml
View File

@@ -1173,6 +1173,279 @@ theme = "doc-theme"
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
[[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"
identifier = "pybytes@api@connect"
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 = 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"
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"
parent = "pybytes@api"
weight = 22
[[menu.main]]
name = "Enable terminal"
url = "/pybytes/api/enable_terminal"
identifier = "pybytes@api@enable_terminal"
parent = "pybytes@api"
weight = 23
[[menu.main]]
name = "Export config"
url = "/pybytes/api/export_config"
identifier = "pybytes@api@export_config"
parent = "pybytes@api"
weight = 24
[[menu.main]]
name = "Get config"
url = "/pybytes/api/get_config"
identifier = "pybytes@api@get_config"
parent = "pybytes@api"
weight = 25
[[menu.main]]
name = "Is connected"
url = "/pybytes/api/is_connected"
identifier = "pybytes@api@is_connected"
parent = "pybytes@api"
weight = 26
[[menu.main]]
name = "isconnected"
url = "/pybytes/api/isconnected"
identifier = "pybytes@api@isconnected"
parent = "pybytes@api"
weight = 27
[[menu.main]]
name = "Print cfg msg"
url = "/pybytes/api/print_cfg_msg"
identifier = "pybytes@api@print_cfg_msg"
parent = "pybytes@api"
weight = 28
[[menu.main]]
name = "Print config"
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"
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 = "Register periodical analog pin publish"
url = "/pybytes/api/register_periodical_analog_pin_publish"
identifier = "pybytes@api@register_periodical_analog_pin_publish"
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"
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"
parent = "pybytes@api"
weight = 34
[[menu.main]]
name = "Send battery level"
url = "/pybytes/api/send_battery_level"
identifier = "pybytes@api@send_battery_level"
parent = "pybytes@api"
weight = 35
[[menu.main]]
name = "Send custom message"
url = "/pybytes/api/send_custom_message"
identifier = "pybytes@api@send_custom_message"
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"
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"
identifier = "pybytes@api@write_config"
parent = "pybytes@api"
weight = 48
[[menu.main]]
name = "Add a device to Pybytes"
url = "/pybytes/connect/"

80
content/pybytes/api/_index.md
View File

@@ -4,7 +4,11 @@ aliases:
- pybytes/api
---
* [Connect Wifi](connect_wifi)
* [Add custom method](add_custom_method)
* [Activate](activate)
* [Connect](connect)
* [Connect LTE](connect_lte)
@@ -14,70 +18,66 @@ aliases:
* [Connect Sigfox](connect_sigfox)
* [Connect Wifi](connect_wifi)
* [Deepsleep](deepsleep)
* [Disconnect](disconnect)
* [Send custom message](send_custom_message)
* [Dump ca](dump_ca)
* [Set custom message callback](set_custom_message_callback)
* [Enable lte](enable_lte)
* [Send ping message](send_ping_message)
* [Send info message](send_info_message)
* [Send scan info message](send_scan_info_message)
* [Send digital pin value](send_digital_pin_value)
* [Send analog pin value](send_analog_pin_value)
* [Send virtual pin value](send_virtual_pin_value)
* [Send signal](send_signal)
* [Register periodical digital pin publish](register_periodical_digital_pin_publish)
* [Register periodical analog pin publish](register_periodical_analog_pin_publish)
* [Add custom method](add_custom_method)
* [Enable ssl](enable_ssl)
* [Enable terminal](enable_terminal)
* [Send battery level](send_battery_level)
* [Export config](export_config)
* [Send custom location](send_custom_location)
* [Get config](get_config)
* [Is connected](is_connected)
* [isconnected](isconnected)
* [Connect](connect)
* [Write config](write_config)
* [Print cfg msg](print_cfg_msg)
* [Print config](print_config)
* [Get config](get_config)
* [Set config](set_config)
* [Update config](update_config)
* [Read config](read_config)
* [Reconnect](reconnect)
* [Export config](export_config)
* [Register periodical analog pin publish](register_periodical_analog_pin_publish)
* [Enable ssl](enable_ssl)
* [Register periodical digital pin publish](register_periodical_digital_pin_publish)
* [Enable lte](enable_lte)
* [Send analog pin value](send_analog_pin_value)
* [Deepsleep](deepsleep)
* [Send battery level](send_battery_level)
* [Dump ca](dump_ca)
* [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)
* [Start](start)
* [Activate](activate)
* [Update config](update_config)
* [Write config](write_config)

4
content/pybytes/api/activate.md
View File

@@ -6,7 +6,7 @@ aliases:
**Activate**
----
Activate device
Activate device on Pybytes.
**Method**
----
@@ -17,7 +17,7 @@ aliases:
----
| name | Description | is Required | Default value
| ------------- |:-------------:|:-------------:|:-------------:|
| activation string | generated by Pybytes | Yes | - |
| activation string | Generated by Pybytes | Yes | - |
**Example**

10
content/pybytes/api/connect.md
View File

@@ -6,8 +6,16 @@ aliases:
**Connect**
----
Initialize connection based on default parameters
Initialize connection based on the configured parameters.
**Method**
----
**pybytes.connect()**
**Example**
----
`pybytes.connect()`
**Success Response**
----
>> Connected using Sigfox. Only upload stream is supported

21
content/pybytes/api/connect_lora_abp.md
View File

@@ -6,8 +6,25 @@ aliases:
**Connect LoRa ABP**
----
Initialize LoRa ABP connection
Initialize LoRa ABP connection.
**Method**
----
**pybytes.connect_lora_abp()**
**pybytes.connect_lora_abp(timeout, nanogateway)**
**Parameters**
----
| name | Description | is Required | Default value
| ------------- |:-------------:|:-------------:|:-------------:|
| timeout | Connection timeout | Yes | - |
| nanogateway | TBD | Yes | - |
**Example**
----
`pybytes.connect_lora_abp(15000, false)`
**Success Response**
----
>> Trying to join LoRa.ABP for 15000 seconds...
>> Setting up LoRa socket...
>> Connected using LoRa

21
content/pybytes/api/connect_lora_otaa.md
View File

@@ -6,8 +6,25 @@ aliases:
**Connect LoRa OTAA**
----
Initialize LoRa OTAA connection
Initialize LoRa OTAA connection.
**Method**
----
**pybytes.connect_lora_otaa()**
**pybytes.connect_lora_otaa(timeout, nanogateway)**
**Parameters**
----
| name | Description | is Required | Default value
| ------------- |:-------------:|:-------------:|:-------------:|
| timeout | Connection timeout | Yes | - |
| nanogateway | TBD | Yes | - |
**Example**
----
`pybytes.connect_lora_otaa(timeout=15, nanogateway=False)`
**Success Response**
----
>> Trying to join LoRa.OTAA for 15 seconds...
>> Setting up LoRa socket...
>> Connected using LoRa

19
content/pybytes/api/connect_lte.md
View File

@@ -6,8 +6,23 @@ aliases:
**Connect LTE**
----
Initialize watchdog for WiFi and LTE connection
Initialize watchdog for WiFi and LTE connection.
**Method**
----
**pybytes.connect_lte()**
**pybytes.connect_lte(reconnect=True, check_interval=0.5)**
**Parameters**
----
| name | Description | is Required | Default value
| ------------- |:-------------:|:-------------:|:-------------:|
| reconnect | Boolean | Yes | - |
| check_interval | interval in seconds | Yes | - |
**Example**
----
`pybytes.connect_lte(reconnect=True, check_interval=0.5)`
**Success Response**
----
TBD

10
content/pybytes/api/connect_sigfox.md
View File

@@ -6,8 +6,16 @@ aliases:
**Connect Sigfox**
----
Initialize Sigfox connection
Initialize Sigfox connection.
**Method**
----
**pybytes.connect_sigfox()**
**Example**
----
`pybytes.connect_sigfox()`
**Success Response**
----
>> Connected using Sigfox. Only upload stream is supported

2
content/pybytes/api/connect_wifi.md
View File

@@ -6,7 +6,7 @@ aliases:
**Connect Wifi**
----
Initialize watchdog for WiFi and LTE connection
Initialize watchdog for WiFi and LTE connection.
**Method**
----

4
content/pybytes/api/deepsleep.md
View File

@@ -16,9 +16,9 @@ aliases:
----
| name | Description | is Required | Default value
| ------------- |:-------------:|:-------------:|:-------------:|
| ms | Time to sleep in ms | Yes | - |
| ms | Sleep period in ms | Yes | - |
| pins | Affected pins | No | None |
| mode | Sleep mode | No | None |
| mode | Sleep mode TBD | No | None |
| enable_pull | Enable pull | No | None |
**Example**

2
content/pybytes/api/enable_lte.md
View File

@@ -22,7 +22,7 @@ aliases:
| apn | APN | No | None |
| type | Type | No | None |
| reset | Reset | No | None |
| fallback | Fallbackena | No | False |
| fallback | Fallback TBD | No | False |
**Example**
----

4
content/pybytes/api/export_config.md
View File

@@ -4,9 +4,9 @@ aliases:
- pybytes/api/export_config
---
**Export Config**
**Export configuration file**
----
Export configuration file
Exports configuration file at specified path.
**Method**
----

2
content/pybytes/api/get_config.md
View File

@@ -6,7 +6,7 @@ aliases:
**Get Config**
----
Returns configuration data
Returns configuration data.
**Method**
----

2
content/pybytes/api/is_connected.md
View File

@@ -6,7 +6,7 @@ aliases:
**Is connected**
----
Returns true if connected
Returns true if connected.
**Method**
----

2
content/pybytes/api/isconnected.md
View File

@@ -6,7 +6,7 @@ aliases:
**Is connected**
----
Returns true if connected
Returns true if connected.
**Method**
----

30
content/pybytes/api/print_config.md
View File

@@ -6,7 +6,7 @@ aliases:
**Print config**
----
Prints current configuration in the terminal
Prints current configuration in the terminal.
**Method**
----
@@ -17,17 +17,17 @@ 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

2
content/pybytes/api/read_config.md
View File

@@ -6,7 +6,7 @@ aliases:
**Read config**
----
Reads configuration from file
Reads configuration from the given file.
**Method**
----

2
content/pybytes/api/reconnect.md
View File

@@ -6,7 +6,7 @@ aliases:
**Reconnect**
----
Reconnects device
Reconnects device.
**Method**
----

2
content/pybytes/api/register_periodical_analog_pin_publish.md
View File

@@ -6,7 +6,7 @@ aliases:
**Register periodical analog pin publish**
----
Publish periodically on the given analog pin
Publish periodically on the given analog pin.
**Method**
----

2
content/pybytes/api/register_periodical_digital_pin_publish.md
View File

@@ -6,7 +6,7 @@ aliases:
**Register periodical digital pin publish**
----
Publish periodically on the given digital pin
Publish periodically on the given digital pin.
**Method**

2
content/pybytes/api/send_analog_pin_value.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send analog pin value**
----
Send analog pin value
Send analog pin value.
**Method**
----

2
content/pybytes/api/send_battery_level.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send battery level**
----
Send battery level
Send battery level.
**Method**
----

2
content/pybytes/api/send_custom_location.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send custom location**
----
Send custom location
Send custom location.
**Method**
----

2
content/pybytes/api/send_custom_message.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send custom location**
----
Send custom location
Send custom location.
**Method**
----

2
content/pybytes/api/send_digital_pin_value.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send analog pin value**
----
Send analog pin value
Send analog pin value.
**Method**
----

2
content/pybytes/api/send_info_message.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send info message**
----
Send info message
Send info message.
**Method**
----

2
content/pybytes/api/send_ping_message.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send ping message**
----
Send ping message
Send ping message.
**Method**
----

2
content/pybytes/api/send_scan_info_message.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send scan info message**
----
Send scan info message
Send scan info message.
**Method**
----

2
content/pybytes/api/send_signal.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send signal**
----
Send signal
Send signal to the given pin.
**Method**
----

2
content/pybytes/api/send_virtual_pin_value.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send ping message**
----
Send ping message
Send ping message. TBD
**Method**
----

2
content/pybytes/api/set_config.md
View File

@@ -6,7 +6,7 @@ aliases:
**Set configuration**
----
Set device configuration
Set device configuration.
**Method**
----

2
content/pybytes/api/set_custom_message_callback.md
View File

@@ -6,7 +6,7 @@ aliases:
**Send custom message callback**
----
Send custom location
Send custom location.
**Method**
----

2
content/pybytes/api/update_config.md
View File

@@ -6,7 +6,7 @@ aliases:
**Update configuration**
----
Update device configuration
Update device configuration.
**Method**
----

2
content/pybytes/api/write_config.md
View File

@@ -6,7 +6,7 @@ aliases:
**Update configuration**
----
Update device configuration
Update device configuration.
**Method**
----