From 46e07d157e1149f8741127a18198d1a08a5b7035 Mon Sep 17 00:00:00 2001 From: Aline Date: Fri, 20 Dec 2019 17:17:08 +0100 Subject: [PATCH] docs: pybytes api documentation --- config.toml | 31 ++++--- content/pybytes/api/_index.md | 83 +++++++++++++++++++ content/pybytes/api/activate.md | 0 content/pybytes/api/add_custom_method.md | 0 content/pybytes/api/connect.md | 0 content/pybytes/api/connect_lora_abp.md | 14 ++++ content/pybytes/api/connect_lora_otta.md | 0 content/pybytes/api/connect_lte.md | 14 ++++ content/pybytes/api/connect_sigfox.md | 0 content/pybytes/api/connect_wifi.md | 14 ++++ content/pybytes/api/deepsleep.md | 0 content/pybytes/api/disconnect.md | 0 content/pybytes/api/dump_ca.md | 0 content/pybytes/api/enable_lte.md | 0 content/pybytes/api/enable_ssl.md | 0 content/pybytes/api/enable_terminal.md | 0 content/pybytes/api/export_config.md | 0 content/pybytes/api/get_config.md | 0 content/pybytes/api/is_connected.md | 0 content/pybytes/api/isconnected.md | 0 content/pybytes/api/print_config.md | 0 content/pybytes/api/read_config.md | 0 content/pybytes/api/reconnect.md | 0 .../register_periodical_analog_pin_publish.md | 0 ...register_periodical_digital_pin_publish.md | 0 content/pybytes/api/send_analog_pin_value.md | 0 content/pybytes/api/send_battery_level.md | 0 content/pybytes/api/send_custom_location.md | 0 content/pybytes/api/send_custom_message.md | 0 content/pybytes/api/send_digital_pin_value.md | 0 content/pybytes/api/send_info_message.md | 0 content/pybytes/api/send_ping_message.md | 0 content/pybytes/api/send_scan_info_message.md | 0 content/pybytes/api/send_signal.md | 0 content/pybytes/api/send_virtual_pin_value.md | 0 content/pybytes/api/set_config.md | 0 .../api/set_custom_message_callback.md | 0 content/pybytes/api/start.md | 0 content/pybytes/api/update_config.md | 0 content/pybytes/api/write_config.md | 0 content/pybytes/print_cfg_msg.md | 0 41 files changed, 144 insertions(+), 12 deletions(-) create mode 100644 content/pybytes/api/_index.md create mode 100644 content/pybytes/api/activate.md create mode 100644 content/pybytes/api/add_custom_method.md create mode 100644 content/pybytes/api/connect.md create mode 100644 content/pybytes/api/connect_lora_abp.md create mode 100644 content/pybytes/api/connect_lora_otta.md create mode 100644 content/pybytes/api/connect_lte.md create mode 100644 content/pybytes/api/connect_sigfox.md create mode 100644 content/pybytes/api/connect_wifi.md create mode 100644 content/pybytes/api/deepsleep.md create mode 100644 content/pybytes/api/disconnect.md create mode 100644 content/pybytes/api/dump_ca.md create mode 100644 content/pybytes/api/enable_lte.md create mode 100644 content/pybytes/api/enable_ssl.md create mode 100644 content/pybytes/api/enable_terminal.md create mode 100644 content/pybytes/api/export_config.md create mode 100644 content/pybytes/api/get_config.md create mode 100644 content/pybytes/api/is_connected.md create mode 100644 content/pybytes/api/isconnected.md create mode 100644 content/pybytes/api/print_config.md create mode 100644 content/pybytes/api/read_config.md create mode 100644 content/pybytes/api/reconnect.md create mode 100644 content/pybytes/api/register_periodical_analog_pin_publish.md create mode 100644 content/pybytes/api/register_periodical_digital_pin_publish.md create mode 100644 content/pybytes/api/send_analog_pin_value.md create mode 100644 content/pybytes/api/send_battery_level.md create mode 100644 content/pybytes/api/send_custom_location.md create mode 100644 content/pybytes/api/send_custom_message.md create mode 100644 content/pybytes/api/send_digital_pin_value.md create mode 100644 content/pybytes/api/send_info_message.md create mode 100644 content/pybytes/api/send_ping_message.md create mode 100644 content/pybytes/api/send_scan_info_message.md create mode 100644 content/pybytes/api/send_signal.md create mode 100644 content/pybytes/api/send_virtual_pin_value.md create mode 100644 content/pybytes/api/set_config.md create mode 100644 content/pybytes/api/set_custom_message_callback.md create mode 100644 content/pybytes/api/start.md create mode 100644 content/pybytes/api/update_config.md create mode 100644 content/pybytes/api/write_config.md create mode 100644 content/pybytes/print_cfg_msg.md diff --git a/config.toml b/config.toml index 9314f66..5e0ba37 100644 --- a/config.toml +++ b/config.toml @@ -1159,6 +1159,13 @@ theme = "doc-theme" parent = "pybytes" weight = 10 +[[menu.main]] + name = "Pybytes library API" + url = "/pybytes/api/" + identifier = "pybytes@api" + parent = "pybytes" + weight = 15 + [[menu.main]] name = "Add a device to Pybytes" url = "/pybytes/connect/" @@ -1178,7 +1185,7 @@ theme = "doc-theme" url = "/pybytes/sigfox/" identifier = "pybytes@sigfox" parent = "pybytes" - weight = 30 + weight = 25 [[menu.main]] name = "DevKit contract" @@ -1199,21 +1206,14 @@ theme = "doc-theme" url = "/pybytes/releases/" identifier = "pybytes@releases" parent = "pybytes" - weight = 20 - -[[menu.main]] - name = "Pybytes iOS" - url = "/pybytes/smart/" - identifier = "pybytes@smart" - parent = "pybytes" - weight = 20 + weight = 30 [[menu.main]] name = "Create new release" url = "/pybytes/releases/new/" identifier = "pybytes@releases@new" parent = "pybytes@releases" - weight = 20 + weight = 10 [[menu.main]] name = "Deploy release" @@ -1222,19 +1222,26 @@ theme = "doc-theme" parent = "pybytes@releases" weight = 20 +[[menu.main]] + name = "Pybytes iOS" + url = "/pybytes/smart/" + identifier = "pybytes@smart" + parent = "pybytes" + weight = 35 + [[menu.main]] name = "Visualise data" url = "/pybytes/dashboard/" identifier = "pybytes@dashboard" parent = "pybytes" - weight = 30 + weight = 40 [[menu.main]] name = "Integrations" url = "/pybytes/integrations/" identifier = "pybytes@integrations" parent = "pybytes" - weight = 40 + weight = 45 [[menu.main]] name = "Amazon IoT" diff --git a/content/pybytes/api/_index.md b/content/pybytes/api/_index.md new file mode 100644 index 0000000..413367b --- /dev/null +++ b/content/pybytes/api/_index.md @@ -0,0 +1,83 @@ +--- +title: "Pybytes library API" +aliases: + - pybytes/api +--- + +* [Connect Wifi](connect_wifi) + +* [Connect LTE](connect_lte) + +* [Connect LoRa ABP](connect_lora_abp) + +* [Connect LoRa OTAA](connect_lora_otaa) + +* [Connect Sigfox](connect_sigfox) + +* [Disconnect](disconnect) + +* [Send custom message](send_custom_message) + +* [Set custom message callback](set_custom_message_callback) + +* [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 terminal](enable_terminal) + +* [Send battery level](send_battery_level) + +* [Send custom location](send_custom_location) + +* [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) + +* [Enable ssl](enable_ssl) + +* [Enable lte](enable_lte) + +* [Deepsleep](deepsleep) + +* [Dump ca](dump_ca) + +* [Start](start) + +* [Activate](activate) diff --git a/content/pybytes/api/activate.md b/content/pybytes/api/activate.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/add_custom_method.md b/content/pybytes/api/add_custom_method.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/connect.md b/content/pybytes/api/connect.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/connect_lora_abp.md b/content/pybytes/api/connect_lora_abp.md new file mode 100644 index 0000000..3b8afec --- /dev/null +++ b/content/pybytes/api/connect_lora_abp.md @@ -0,0 +1,14 @@ +--- +title: "Pybytes library API" +aliases: + - pybytes/api/connect_lora_abp +--- + +**Connect LoRa ABP** +---- + Initialize LoRa ABP connection + + +**Method** +---- +**pybytes.connect_lora_abp()** diff --git a/content/pybytes/api/connect_lora_otta.md b/content/pybytes/api/connect_lora_otta.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/connect_lte.md b/content/pybytes/api/connect_lte.md new file mode 100644 index 0000000..d059fd4 --- /dev/null +++ b/content/pybytes/api/connect_lte.md @@ -0,0 +1,14 @@ +--- +title: "Pybytes library API" +aliases: + - pybytes/api/connect_lte +--- + +**Connect LTE** +---- + Initialize watchdog for WiFi and LTE connection + + +**Method** +---- +**pybytes.connect_lte()** diff --git a/content/pybytes/api/connect_sigfox.md b/content/pybytes/api/connect_sigfox.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/connect_wifi.md b/content/pybytes/api/connect_wifi.md new file mode 100644 index 0000000..e5c582d --- /dev/null +++ b/content/pybytes/api/connect_wifi.md @@ -0,0 +1,14 @@ +--- +title: "Pybytes library API" +aliases: + - pybytes/api/connect_wifi +--- + +**Connect Wifi** +---- + Initialize watchdog for WiFi and LTE connection + + +**Method** +---- +**pybytes.connect_wifi()** diff --git a/content/pybytes/api/deepsleep.md b/content/pybytes/api/deepsleep.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/disconnect.md b/content/pybytes/api/disconnect.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/dump_ca.md b/content/pybytes/api/dump_ca.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/enable_lte.md b/content/pybytes/api/enable_lte.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/enable_ssl.md b/content/pybytes/api/enable_ssl.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/enable_terminal.md b/content/pybytes/api/enable_terminal.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/export_config.md b/content/pybytes/api/export_config.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/get_config.md b/content/pybytes/api/get_config.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/is_connected.md b/content/pybytes/api/is_connected.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/isconnected.md b/content/pybytes/api/isconnected.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/print_config.md b/content/pybytes/api/print_config.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/read_config.md b/content/pybytes/api/read_config.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/reconnect.md b/content/pybytes/api/reconnect.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/register_periodical_analog_pin_publish.md b/content/pybytes/api/register_periodical_analog_pin_publish.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/register_periodical_digital_pin_publish.md b/content/pybytes/api/register_periodical_digital_pin_publish.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/send_analog_pin_value.md b/content/pybytes/api/send_analog_pin_value.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/send_battery_level.md b/content/pybytes/api/send_battery_level.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/send_custom_location.md b/content/pybytes/api/send_custom_location.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/send_custom_message.md b/content/pybytes/api/send_custom_message.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/send_digital_pin_value.md b/content/pybytes/api/send_digital_pin_value.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/send_info_message.md b/content/pybytes/api/send_info_message.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/send_ping_message.md b/content/pybytes/api/send_ping_message.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/send_scan_info_message.md b/content/pybytes/api/send_scan_info_message.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/send_signal.md b/content/pybytes/api/send_signal.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/send_virtual_pin_value.md b/content/pybytes/api/send_virtual_pin_value.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/set_config.md b/content/pybytes/api/set_config.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/set_custom_message_callback.md b/content/pybytes/api/set_custom_message_callback.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/start.md b/content/pybytes/api/start.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/update_config.md b/content/pybytes/api/update_config.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/api/write_config.md b/content/pybytes/api/write_config.md new file mode 100644 index 0000000..e69de29 diff --git a/content/pybytes/print_cfg_msg.md b/content/pybytes/print_cfg_msg.md new file mode 100644 index 0000000..e69de29