Skip to content

Commit e86d87e

Browse files
committed
docs: revised methods, list of methods should appear in the main menu
1 parent 7cac853 commit e86d87e

34 files changed

+427
-89
lines changed

config.toml

Lines changed: 273 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1173,6 +1173,279 @@ theme = "doc-theme"
11731173
parent = "pybytes"
11741174
weight = 15
11751175

1176+
[[menu.main]]
1177+
name = "Add custom method"
1178+
url = "/pybytes/api/add_custom_method"
1179+
identifier = "pybytes@api@add_custom_method"
1180+
parent = "pybytes@api"
1181+
weight = 10
1182+
1183+
[[menu.main]]
1184+
name = "Activate Device"
1185+
url = "/pybytes/api/activate"
1186+
identifier = "pybytes@api@activate"
1187+
parent = "pybytes@api"
1188+
weight = 11
1189+
1190+
[[menu.main]]
1191+
name = "Connect"
1192+
url = "/pybytes/api/connect"
1193+
identifier = "pybytes@api@connect"
1194+
parent = "pybytes@api"
1195+
weight = 12
1196+
1197+
[[menu.main]]
1198+
name = "Connect LTE"
1199+
url = "/pybytes/api/connect_lte"
1200+
identifier = "pybytes@api@connect_lte"
1201+
parent = "pybytes@api"
1202+
weight = 13
1203+
1204+
[[menu.main]]
1205+
name = "Connect LoRa ABP"
1206+
url = "/pybytes/api/connect_lora_abp"
1207+
identifier = "pybytes@api@connect_lora_abp"
1208+
parent = "pybytes@api"
1209+
weight = 14
1210+
1211+
[[menu.main]]
1212+
name = "Connect LoRa OTAA"
1213+
url = "/pybytes/api/connect_lora_otaa"
1214+
identifier = "pybytes@api@connect_lora_otaa"
1215+
parent = "pybytes@api"
1216+
weight = 15
1217+
1218+
[[menu.main]]
1219+
name = "Connect Sigfox"
1220+
url = "/pybytes/api/connect_sigfox"
1221+
identifier = "pybytes@api@connect_sigfox"
1222+
parent = "pybytes@api"
1223+
weight = 16
1224+
1225+
[[menu.main]]
1226+
name = "Connect Wifi"
1227+
url = "/pybytes/api/connect_wifi"
1228+
identifier = "pybytes@api@connect_wifi"
1229+
parent = "pybytes@api"
1230+
weight = 17
1231+
1232+
[[menu.main]]
1233+
name = "Deepsleep"
1234+
url = "/pybytes/api/deepsleep"
1235+
identifier = "pybytes@api@deepsleep"
1236+
parent = "pybytes@api"
1237+
weight = 18
1238+
1239+
[[menu.main]]
1240+
name = "Disconnect"
1241+
url = "/pybytes/api/disconnect"
1242+
identifier = "pybytes@api@disconnect"
1243+
parent = "pybytes@api"
1244+
weight = 19
1245+
1246+
[[menu.main]]
1247+
name = "Dump ca"
1248+
url = "/pybytes/api/dump_ca"
1249+
identifier = "pybytes@api@dump_ca"
1250+
parent = "pybytes@api"
1251+
weight = 20
1252+
1253+
[[menu.main]]
1254+
name = "Enable lte"
1255+
url = "/pybytes/api/enable_lte"
1256+
identifier = "pybytes@api@enable_lte"
1257+
parent = "pybytes@api"
1258+
weight = 21
1259+
1260+
[[menu.main]]
1261+
name = "Enable ssl"
1262+
url = "/pybytes/api/enable_ssl"
1263+
identifier = "pybytes@api@enable_ssl"
1264+
parent = "pybytes@api"
1265+
weight = 22
1266+
1267+
[[menu.main]]
1268+
name = "Enable terminal"
1269+
url = "/pybytes/api/enable_terminal"
1270+
identifier = "pybytes@api@enable_terminal"
1271+
parent = "pybytes@api"
1272+
weight = 23
1273+
1274+
[[menu.main]]
1275+
name = "Export config"
1276+
url = "/pybytes/api/export_config"
1277+
identifier = "pybytes@api@export_config"
1278+
parent = "pybytes@api"
1279+
weight = 24
1280+
1281+
[[menu.main]]
1282+
name = "Get config"
1283+
url = "/pybytes/api/get_config"
1284+
identifier = "pybytes@api@get_config"
1285+
parent = "pybytes@api"
1286+
weight = 25
1287+
1288+
[[menu.main]]
1289+
name = "Is connected"
1290+
url = "/pybytes/api/is_connected"
1291+
identifier = "pybytes@api@is_connected"
1292+
parent = "pybytes@api"
1293+
weight = 26
1294+
1295+
[[menu.main]]
1296+
name = "isconnected"
1297+
url = "/pybytes/api/isconnected"
1298+
identifier = "pybytes@api@isconnected"
1299+
parent = "pybytes@api"
1300+
weight = 27
1301+
1302+
[[menu.main]]
1303+
name = "Print cfg msg"
1304+
url = "/pybytes/api/print_cfg_msg"
1305+
identifier = "pybytes@api@print_cfg_msg"
1306+
parent = "pybytes@api"
1307+
weight = 28
1308+
1309+
[[menu.main]]
1310+
name = "Print config"
1311+
url = "/pybytes/api/print_config"
1312+
identifier = "pybytes@api@print_config"
1313+
parent = "pybytes@api"
1314+
weight = 29
1315+
1316+
[[menu.main]]
1317+
name = "Read config"
1318+
url = "/pybytes/api/read_config"
1319+
identifier = "pybytes@api@read_config"
1320+
parent = "pybytes@api"
1321+
weight = 30
1322+
1323+
[[menu.main]]
1324+
name = "Reconnect"
1325+
url = "/pybytes/api/reconnect"
1326+
identifier = "pybytes@api@reconnect"
1327+
parent = "pybytes@api"
1328+
weight = 31
1329+
1330+
[[menu.main]]
1331+
name = "Register periodical analog pin publish"
1332+
url = "/pybytes/api/register_periodical_analog_pin_publish"
1333+
identifier = "pybytes@api@register_periodical_analog_pin_publish"
1334+
parent = "pybytes@api"
1335+
weight = 32
1336+
1337+
[[menu.main]]
1338+
name = "Register periodical digital pin publish"
1339+
url = "/pybytes/api/register_periodical_digital_pin_publish"
1340+
identifier = "pybytes@api@register_periodical_digital_pin_publish"
1341+
parent = "pybytes@api"
1342+
weight = 33
1343+
1344+
[[menu.main]]
1345+
name = "Send analog pin value"
1346+
url = "/pybytes/api/send_analog_pin_value"
1347+
identifier = "pybytes@api@send_analog_pin_value"
1348+
parent = "pybytes@api"
1349+
weight = 34
1350+
1351+
[[menu.main]]
1352+
name = "Send battery level"
1353+
url = "/pybytes/api/send_battery_level"
1354+
identifier = "pybytes@api@send_battery_level"
1355+
parent = "pybytes@api"
1356+
weight = 35
1357+
1358+
[[menu.main]]
1359+
name = "Send custom message"
1360+
url = "/pybytes/api/send_custom_message"
1361+
identifier = "pybytes@api@send_custom_message"
1362+
parent = "pybytes@api"
1363+
weight = 36
1364+
1365+
[[menu.main]]
1366+
name = "Set custom message callback"
1367+
url = "/pybytes/api/set_custom_message_callback"
1368+
identifier = "pybytes@api@set_custom_message_callback"
1369+
parent = "pybytes@api"
1370+
weight = 37
1371+
1372+
[[menu.main]]
1373+
name = "Send custom location"
1374+
url = "/pybytes/api/send_custom_location"
1375+
identifier = "pybytes@api@send_custom_location"
1376+
parent = "pybytes@api"
1377+
weight = 38
1378+
1379+
[[menu.main]]
1380+
name = "Send digital pin value"
1381+
url = "/pybytes/api/send_digital_pin_value"
1382+
identifier = "pybytes@api@send_digital_pin_value"
1383+
parent = "pybytes@api"
1384+
weight = 39
1385+
1386+
[[menu.main]]
1387+
name = "Send info message"
1388+
url = "/pybytes/api/send_info_message"
1389+
identifier = "pybytes@api@send_info_message"
1390+
parent = "pybytes@api"
1391+
weight = 40
1392+
1393+
[[menu.main]]
1394+
name = "Send ping message"
1395+
url = "/pybytes/api/send_ping_message"
1396+
identifier = "pybytes@api@send_ping_message"
1397+
parent = "pybytes@api"
1398+
weight = 41
1399+
1400+
[[menu.main]]
1401+
name = "Send scan info message"
1402+
url = "/pybytes/api/send_scan_info_message"
1403+
identifier = "pybytes@api@send_scan_info_message"
1404+
parent = "pybytes@api"
1405+
weight = 42
1406+
1407+
[[menu.main]]
1408+
name = "Send signal"
1409+
url = "/pybytes/api/send_signal"
1410+
identifier = "pybytes@api@send_signal"
1411+
parent = "pybytes@api"
1412+
weight = 43
1413+
1414+
[[menu.main]]
1415+
name = "Send virtual pin value"
1416+
url = "/pybytes/api/send_virtual_pin_value"
1417+
identifier = "pybytes@api@send_virtual_pin_value"
1418+
parent = "pybytes@api"
1419+
weight = 44
1420+
1421+
[[menu.main]]
1422+
name = "Set config"
1423+
url = "/pybytes/api/set_config"
1424+
identifier = "pybytes@api@set_config"
1425+
parent = "pybytes@api"
1426+
weight = 45
1427+
1428+
[[menu.main]]
1429+
name = "Start"
1430+
url = "/pybytes/api/start"
1431+
identifier = "pybytes@api@start"
1432+
parent = "pybytes@api"
1433+
weight = 46
1434+
1435+
[[menu.main]]
1436+
name = "Update config"
1437+
url = "/pybytes/api/update_config"
1438+
identifier = "pybytes@api@update_config"
1439+
parent = "pybytes@api"
1440+
weight = 47
1441+
1442+
[[menu.main]]
1443+
name = "Write config"
1444+
url = "/pybytes/api/write_config"
1445+
identifier = "pybytes@api@write_config"
1446+
parent = "pybytes@api"
1447+
weight = 48
1448+
11761449
[[menu.main]]
11771450
name = "Add a device to Pybytes"
11781451
url = "/pybytes/connect/"

content/pybytes/api/_index.md

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

7-
* [Connect Wifi](connect_wifi)
7+
* [Add custom method](add_custom_method)
8+
9+
* [Activate](activate)
10+
11+
* [Connect](connect)
812

913
* [Connect LTE](connect_lte)
1014

@@ -14,70 +18,66 @@ aliases:
1418

1519
* [Connect Sigfox](connect_sigfox)
1620

17-
* [Disconnect](disconnect)
18-
19-
* [Send custom message](send_custom_message)
20-
21-
* [Set custom message callback](set_custom_message_callback)
22-
23-
* [Send ping message](send_ping_message)
21+
* [Connect Wifi](connect_wifi)
2422

25-
* [Send info message](send_info_message)
23+
* [Deepsleep](deepsleep)
2624

27-
* [Send scan info message](send_scan_info_message)
25+
* [Disconnect](disconnect)
2826

29-
* [Send digital pin value](send_digital_pin_value)
27+
* [Dump ca](dump_ca)
3028

31-
* [Send analog pin value](send_analog_pin_value)
29+
* [Enable lte](enable_lte)
3230

33-
* [Send virtual pin value](send_virtual_pin_value)
31+
* [Enable ssl](enable_ssl)
3432

35-
* [Send signal](send_signal)
33+
* [Enable terminal](enable_terminal)
3634

37-
* [Register periodical digital pin publish](register_periodical_digital_pin_publish)
35+
* [Export config](export_config)
3836

39-
* [Register periodical analog pin publish](register_periodical_analog_pin_publish)
37+
* [Get config](get_config)
4038

41-
* [Add custom method](add_custom_method)
39+
* [Is connected](is_connected)
4240

43-
* [Enable terminal](enable_terminal)
41+
* [isconnected](isconnected)
4442

45-
* [Send battery level](send_battery_level)
43+
* [Print cfg msg](print_cfg_msg)
4644

47-
* [Send custom location](send_custom_location)
45+
* [Print config](print_config)
4846

49-
* [Is connected](is_connected)
47+
* [Read config](read_config)
5048

51-
* [isconnected](isconnected)
49+
* [Reconnect](reconnect)
5250

53-
* [Connect](connect)
51+
* [Register periodical analog pin publish](register_periodical_analog_pin_publish)
5452

55-
* [Write config](write_config)
53+
* [Register periodical digital pin publish](register_periodical_digital_pin_publish)
5654

57-
* [Print cfg msg](print_cfg_msg)
55+
* [Send analog pin value](send_analog_pin_value)
5856

59-
* [Print config](print_config)
57+
* [Send battery level](send_battery_level)
6058

61-
* [Get config](get_config)
59+
* [Send custom message](send_custom_message)
6260

63-
* [Set config](set_config)
61+
* [Set custom message callback](set_custom_message_callback)
6462

65-
* [Update config](update_config)
63+
* [Send custom location](send_custom_location)
6664

67-
* [Read config](read_config)
65+
* [Send digital pin value](send_digital_pin_value)
6866

69-
* [Reconnect](reconnect)
67+
* [Send info message](send_info_message)
7068

71-
* [Export config](export_config)
69+
* [Send ping message](send_ping_message)
7270

73-
* [Enable ssl](enable_ssl)
71+
* [Send scan info message](send_scan_info_message)
7472

75-
* [Enable lte](enable_lte)
73+
* [Send signal](send_signal)
7674

77-
* [Deepsleep](deepsleep)
75+
* [Send virtual pin value](send_virtual_pin_value)
7876

79-
* [Dump ca](dump_ca)
77+
* [Set config](set_config)
8078

8179
* [Start](start)
8280

83-
* [Activate](activate)
81+
* [Update config](update_config)
82+
83+
* [Write config](write_config)

0 commit comments

Comments
 (0)