Skip to content

Commit ec2d584

Browse files
committed
docs: contains Jirka review
1 parent 172d2c4 commit ec2d584

File tree

10 files changed

+69
-48
lines changed

10 files changed

+69
-48
lines changed

content/pybytes/api/_index.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,6 @@ title: "Pybytes library API"
33
aliases:
44
---
55

6-
7-
If you are facing any issues try to enable debugging.
8-
9-
### Debugging
10-
There are multiple debug levels, 0 is warnings only, 6 is currently the highest used).
11-
12-
#### use:
13-
14-
```
15-
>> import pycom;
16-
>> pycom.nvs_set('pybytes_debug', debugLevel)
17-
```
18-
19-
#### e.g.
20-
```
21-
>> import pycom;
22-
>> pycom.nvs_set('pybytes_debug', 6)
23-
```
24-
25-
266
# API List
277

288

@@ -77,3 +57,23 @@ There are multiple debug levels, 0 is warnings only, 6 is currently the highest
7757
* [Update configuration](update_config)
7858

7959
* [Write configuration](write_config)
60+
61+
# Issues
62+
63+
If you are facing any issues try to enable debugging.
64+
65+
### Debugging
66+
There are multiple debug levels, 0 is warnings only, 6 is currently the highest used).
67+
68+
#### use:
69+
70+
```
71+
>> import pycom;
72+
>> pycom.nvs_set('pybytes_debug', debugLevel)
73+
```
74+
75+
#### e.g.
76+
```
77+
>> import pycom;
78+
>> pycom.nvs_set('pybytes_debug', 6)
79+
```

content/pybytes/api/activate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ aliases:
55
- pybytes/api/activate.md
66
---
77

8-
Activate device on Pybytes.
8+
Activate device on Pybytes, via Pymakr plugin.
99

1010
**Method**
1111
----

content/pybytes/api/connect_device.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,20 @@ aliases:
1717
**Success Response**
1818
----
1919

20+
WiFi:
2021
```
21-
>> Connected using Sigfox. Only upload stream is supported
22+
>> Connecting with SSID and PASSWORD
23+
>> WiFi connection established
24+
```
25+
26+
LTE:
27+
```
28+
>> LTE connection established
29+
```
30+
31+
LoRa ABP:
32+
```
33+
>> Trying to join LoRa.ABP for 15000 seconds...
34+
>> Setting up LoRa socket...
35+
>> Connected using LoRa
2236
```

content/pybytes/api/connect_lte.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,10 @@ aliases:
2020
**Example**
2121
----
2222
`pybytes.connect_lte(reconnect=True, check_interval=0.5)`
23+
24+
**Success Response**
25+
----
26+
27+
```
28+
>> LTE connection established
29+
```

content/pybytes/api/get_config.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,34 +31,34 @@ aliases:
3131
'password': 'PASSWORD'
3232
},
3333
'lte': {
34-
'apn': 'internet',
35-
'cid': 1,
34+
'apn': 'apn',
35+
'cid': 999,
3636
'reset': False,
37-
'carrier': 'Standard',
38-
'band': 3,
39-
'type': 'IP'
37+
'carrier': 'carrier',
38+
'band': 999,
39+
'type': 'type'
4040
},
4141
'username': 'user@email.com',
4242
'network_preferences': ['lte', 'lora_otaa'],
43-
'cfg_msg': 'Pybytes configuration read from /flash/pybytes_config.json',
43+
'cfg_msg': 'Pybytes configuration read from file.json',
4444
'dump_ca': True,
4545
'wlan_antenna': 0,
46-
'server': '10.0.0.61',
46+
'server': 'xx.x.x.xx',
4747
'lora': {
4848
'otaa': {
49-
'app_key': '87c8105c151f885bc19ccb9484fe8185',
50-
'app_device_eui': '909d7afb9b82c0f6',
51-
'app_eui': '70B3D57ED000AFA0'
49+
'app_key': 'app_key',
50+
'app_device_eui': 'app_device_eui',
51+
'app_eui': 'app_eui'
5252
}
5353
},
5454
'ota_server': {
55-
'port': 443,
55+
'port': 999,
5656
'domain': 'software.pycom.io'
5757
},
5858
'pybytes_autostart': True,
5959
'ssl_params': {
60-
'ca_certs': '/flash/cert/pycom-ca.pem'
60+
'ca_certs': 'ca_certs'
6161
},
62-
'device_id': '139e95ed-7213-406b-b07a-a54bfbf021c8'
62+
'device_id': 'device_id'
6363
}
6464
```

content/pybytes/api/print_config.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@ aliases:
2020
```
2121
>> ssl = True
2222
>> wifi = {'ssid': '', 'password': ''}
23-
>> lte = {'apn': 'internet', 'cid': 1, 'reset': False, 'carrier': 'Standard', 'band': 3, 'type': 'IP'}
24-
>> username = alipsilv@hotmail.com
23+
>> lte = {'apn': 'apn', 'cid': 999, 'reset': False, 'carrier': 'carrier', 'band': 999, 'type': 'type'}
24+
>> username = user@email.com
2525
>> network_preferences = ['lte', 'lte', 'lte', 'lora_otaa']
26-
>> cfg_msg = Pybytes configuration read from /flash/pybytes_config.json
26+
>> cfg_msg = Pybytes configuration read from file.json
2727
>> dump_ca = True
2828
>> wlan_antenna = 0
29-
>> server = 10.0.0.61
30-
>> lora = {'otaa': {'app_key': '87c8105c151f885bc19ccb9484fe8185', 'app_device_eui': '909d7afb9b82c0f6', 'app_eui': '70B3D57ED000AFA0'}}
31-
>> ota_server = {'port': 443, 'domain': 'software.pycom.io'}
29+
>> server = xx.x.x.xx
30+
>> lora = {'otaa': {'app_key': 'app_key', 'app_device_eui': 'app_device_eui', 'app_eui': 'app_eui'}}
31+
>> ota_server = {'port': 000, 'domain': 'domain.com'}
3232
>> pybytes_autostart = True
33-
>> ssl_params = {'ca_certs': '/flash/cert/pycom-ca.pem'}
34-
>> device_id = 139e95ed-7213-406b-b07a-a54bfbf021c8
33+
>> ssl_params = {'ca_certs': 'ca_certs'}
34+
>> device_id = device_id
3535
```

content/pybytes/api/send_signal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ aliases:
44
- pybytes/api/send_signal
55
---
66

7-
Send signal to the given pin.
7+
Send signal to the given signal number.
88

99
**Method**
1010
----

content/pybytes/api/set_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ aliases:
2222

2323
**Example**
2424
----
25-
`pybytes.set_config(key=None, value=None, permanent=True, silent=False, reconnect=False)`
25+
`pybytes.set_config(key="network_preferences", value="wifi", permanent=True, silent=False, reconnect=False)`
2626

2727
**Success Response**
2828
----

content/pybytes/api/start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ aliases:
44
- pybytes/api/start
55
---
66

7-
Start/Restart device.
7+
Starts Pybytes library.
88

99
**Method**
1010
----

content/pybytes/api/update_config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ aliases:
44
- pybytes/api/update_config
55
---
66

7-
Update device configuration.
7+
Update device configuration parameters.
88

99
**Method**
1010
----
@@ -22,7 +22,7 @@ aliases:
2222

2323
**Example**
2424
----
25-
`pybytes.update_config(key=None, value=None, permanent=True, silent=False, reconnect=False)`
25+
`pybytes.update_config(key="network_preferences", value="wifi", permanent=True, silent=False, reconnect=False)`
2626

2727
**Success Response**
2828
----

0 commit comments

Comments
 (0)