mirror of
https://github.com/sascha-hemi/pycom-documentation.git
synced 2026-03-21 10:05:56 +01:00
doc: new documentation added
This commit is contained in:
@@ -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)
|
||||
|
||||
@@ -12,3 +12,8 @@ aliases:
|
||||
**Method**
|
||||
----
|
||||
**pybytes.connect_wifi()**
|
||||
|
||||
**Success Response**
|
||||
----
|
||||
>> Connecting with SSID and PASSWORD
|
||||
>> WiFi connection established
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -29,5 +29,5 @@ aliases:
|
||||
----
|
||||
`pybytes.enable_lte('Standard', 1, 3, 'internet', 'IP', False)`
|
||||
|
||||
## Success Response
|
||||
**Success Response**
|
||||
`TBD`
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -23,5 +23,5 @@ aliases:
|
||||
----
|
||||
`pybytes.export_config()`
|
||||
|
||||
## Success Response
|
||||
**Success Response**
|
||||
`Pybytes configuration exported to /flash/pybytes_config.json`
|
||||
|
||||
@@ -23,7 +23,7 @@ aliases:
|
||||
----
|
||||
`pybytes.get_config()`
|
||||
|
||||
## Success Response
|
||||
**Success Response**
|
||||
```json
|
||||
{
|
||||
'ssl': True,
|
||||
|
||||
@@ -17,5 +17,5 @@ aliases:
|
||||
----
|
||||
`pybytes.is_connected()`
|
||||
|
||||
## Success Response
|
||||
**Success Response**
|
||||
`True`
|
||||
|
||||
@@ -17,5 +17,5 @@ aliases:
|
||||
----
|
||||
`pybytes.isconnected()`
|
||||
|
||||
## Success Response
|
||||
**Success Response**
|
||||
`True`
|
||||
|
||||
@@ -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'}
|
||||
|
||||
@@ -24,5 +24,5 @@ aliases:
|
||||
----
|
||||
`pybytes.read_config()`
|
||||
|
||||
## Success Response
|
||||
**Success Response**
|
||||
`Pybytes configuration read from /flash/pybytes_config.json`
|
||||
|
||||
@@ -17,5 +17,9 @@ aliases:
|
||||
----
|
||||
`pybytes.reconnect()`
|
||||
|
||||
## Success Response
|
||||
`TBD`
|
||||
**Success Response**
|
||||
|
||||
After disconnect
|
||||
----
|
||||
>> Connecting with SSID and PASSWORD
|
||||
>> WiFi connection established
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user