doc: new api documentation added

alipsilv · alipsilv · commit 7cac853d87b1 · 2020-01-14T19:04:42.000+01:00
diff --git a/content/pybytes/api/activate.md b/content/pybytes/api/activate.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Activate device
 
-
 **Method**
 ----
 **pybytes.activate(activation_string)**
@@ -21,7 +20,6 @@ aliases:
 | activation string   | generated by Pybytes  | Yes   | - |
 
 
-
 **Example**
 ----
 pybytes.activate("eyJhIjoiNTYzM...")
diff --git a/content/pybytes/api/connect.md b/content/pybytes/api/connect.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Initialize connection based on default parameters
 
-
 **Method**
 ----
 **pybytes.connect()**
diff --git a/content/pybytes/api/connect_lora_abp.md b/content/pybytes/api/connect_lora_abp.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Initialize LoRa ABP connection
 
-
 **Method**
 ----
 **pybytes.connect_lora_abp()**
diff --git a/content/pybytes/api/connect_lora_otaa.md b/content/pybytes/api/connect_lora_otaa.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Initialize LoRa OTAA connection
 
-
 **Method**
 ----
 **pybytes.connect_lora_otaa()**
diff --git a/content/pybytes/api/connect_lte.md b/content/pybytes/api/connect_lte.md
@@ -8,7 +8,6 @@ aliases:
 ----
   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
@@ -8,7 +8,6 @@ aliases:
 ----
   Initialize Sigfox connection
 
-
 **Method**
 ----
 **pybytes.connect_sigfox()**
diff --git a/content/pybytes/api/connect_wifi.md b/content/pybytes/api/connect_wifi.md
@@ -8,7 +8,6 @@ aliases:
 ----
   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
@@ -8,7 +8,6 @@ aliases:
 ----
   Start deepsleep mode for the given period
 
-
 **Method**
 ----
 **pybytes.deepsleep(ms, pins, mode, enable_pull)**
diff --git a/content/pybytes/api/disconnect.md b/content/pybytes/api/disconnect.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Disconnect device
 
-
 **Method**
 ----
 **pybytes.disconnect()**
diff --git a/content/pybytes/api/dump_ca.md b/content/pybytes/api/dump_ca.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Make a dump_ca
 
-
 **Method**
 ----
 **pybytes.dump_ca(ca_file)**
diff --git a/content/pybytes/api/enable_lte.md b/content/pybytes/api/enable_lte.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Enable LTE connection
 
-
 **Method**
 ----
 **pybytes.enable_lte(carrier, cid, band, apn, type, reset, fallback)**
diff --git a/content/pybytes/api/enable_ssl.md b/content/pybytes/api/enable_ssl.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Enable SSL
 
-
 **Method**
 ----
 **pybytes.enable_ssl(ca_file, dump_ca)**
diff --git a/content/pybytes/api/enable_terminal.md b/content/pybytes/api/enable_terminal.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Enable Terminal
 
-
 **Method**
 ----
 **pybytes.enable_terminal()**
diff --git a/content/pybytes/api/export_config.md b/content/pybytes/api/export_config.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Export configuration file
 
-
 **Method**
 ----
 **pybytes.export_config(file)**
diff --git a/content/pybytes/api/get_config.md b/content/pybytes/api/get_config.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Returns configuration data
 
-
 **Method**
 ----
 **pybytes.get_config(key)**
diff --git a/content/pybytes/api/is_connected.md b/content/pybytes/api/is_connected.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Returns true if connected
 
-
 **Method**
 ----
 **pybytes.is_connected()**
diff --git a/content/pybytes/api/isconnected.md b/content/pybytes/api/isconnected.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Returns true if connected
 
-
 **Method**
 ----
 **pybytes.isconnected()**
diff --git a/content/pybytes/api/print_config.md b/content/pybytes/api/print_config.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Prints current configuration in the terminal
 
-
 **Method**
 ----
 **pybytes.print_config()**
diff --git a/content/pybytes/api/read_config.md b/content/pybytes/api/read_config.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Reads configuration from file
 
-
 **Method**
 ----
 **pybytes.read_config(file', reconnect)**
diff --git a/content/pybytes/api/reconnect.md b/content/pybytes/api/reconnect.md
@@ -8,7 +8,6 @@ aliases:
 ----
   Reconnects device
 
-
 **Method**
 ----
 **pybytes.reconnect()**
diff --git a/content/pybytes/api/register_periodical_analog_pin_publish.md b/content/pybytes/api/register_periodical_analog_pin_publish.md
@@ -8,23 +8,21 @@ aliases:
 ----
   Publish periodically on the given analog pin
 
-
 **Method**
 ----
-**pybytes.register_periodical_digital_pin_publish(persistent, pin_number, pull_mode, period)**
+**pybytes.register_periodical_analog_pin_publish(persistent, pin_number, 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   | -  |
+| persistent   | Bool  | No   | False  |
+| pin number   | Analog pin number  TBD| Yes   | -  |
+| period   | Interval in seconds  | Yes   | -  |
 
 **Example**
 ----
-`pybytes.register_periodical_digital_pin_publish(TBD, TBD, TBD, 1000)`
+`pybytes.register_periodical_analog_pin_publish(False, 13, 2)`
 
 **Success Response**
 TBD
diff --git a/content/pybytes/api/register_periodical_digital_pin_publish.md b/content/pybytes/api/register_periodical_digital_pin_publish.md
@@ -0,0 +1,30 @@
+---
+title: "Pybytes library API"
+aliases:
+  - pybytes/api/register_periodical_digital_pin_publish
+---
+
+**Register periodical digital pin publish**
+----
+  Publish periodically on the given digital pin
+
+
+**Method**
+----
+**pybytes.register_periodical_digital_pin_publish(persistent, pin_number, pull_mode, period)**
+
+**Parameters**
+----
+| name  | Description   | is Required    | Default value
+| ------------- |:-------------:|:-------------:|:-------------:|
+| persistent   | Bool  | No   | False  |
+| pin number   | Analog pin number  | Yes   | -  |
+| pull mode   | PULL_UP or TBD  | Yes   | PULL_UP  |
+| period   | Interval in seconds  | Yes   | -  |
+
+**Example**
+----
+`pybytes.register_periodical_digital_pin_publish(False, PIN_NUMBER, Pin.PULL_UP, 2)`
+
+**Success Response**
+TBD
diff --git a/content/pybytes/api/send_analog_pin_value.md b/content/pybytes/api/send_analog_pin_value.md
@@ -0,0 +1,27 @@
+---
+title: "Pybytes library API"
+aliases:
+  - pybytes/api/send_analog_pin_value
+---
+
+**Send analog pin value**
+----
+  Send analog pin value
+
+**Method**
+----
+**pybytes.send_analog_pin_value(persistent, pin_number)**
+
+**Parameters**
+----
+| name  | Description   | is Required    | Default value
+| ------------- |:-------------:|:-------------:|:-------------:|
+| persistent   | Bool  | No   | False  |
+| pin number   | Analog pin number  TBD| Yes   | -  |
+
+**Example**
+----
+`pybytes.send_analog_pin_value(False, 13)`
+
+**Success Response**
+TBD
diff --git a/content/pybytes/api/send_battery_level.md b/content/pybytes/api/send_battery_level.md
@@ -0,0 +1,26 @@
+---
+title: "Pybytes library API"
+aliases:
+  - pybytes/api/send_battery_level
+---
+
+**Send battery level**
+----
+  Send battery level
+
+**Method**
+----
+**pybytes.send_battery_level(battery_level)**
+
+**Parameters**
+----
+| name  | Description   | is Required    | Default value
+| ------------- |:-------------:|:-------------:|:-------------:|
+| battery_level   | battery level  | Yes   | False  |
+
+**Example**
+----
+`pybytes.send_battery_level(False, 50)`
+
+**Success Response**
+TBD
diff --git a/content/pybytes/api/send_custom_location.md b/content/pybytes/api/send_custom_location.md
@@ -0,0 +1,28 @@
+---
+title: "Pybytes library API"
+aliases:
+  - pybytes/api/send_custom_location
+---
+
+**Send custom location**
+----
+  Send custom location
+
+**Method**
+----
+**pybytes.send_custom_location(pin, x, y)**
+
+**Parameters**
+----
+| name  | Description   | is Required    | Default value
+| ------------- |:-------------:|:-------------:|:-------------:|
+| pin   | TBD  | Yes   | -  |
+| x   | Longitude | Yes   | -  |
+| y   | Latitude  | Yes   | -  |
+
+**Example**
+----
+`pybytes.send_custom_location(pin, 0, 0)`
+
+**Success Response**
+TBD
diff --git a/content/pybytes/api/send_custom_message.md b/content/pybytes/api/send_custom_message.md
@@ -0,0 +1,27 @@
+---
+title: "Pybytes library API"
+aliases:
+  - pybytes/api/send_custom_message
+---
+
+**Send custom location**
+----
+  Send custom location
+
+**Method**
+----
+**pybytes.send_custom_message(message_type, message)**
+
+**Parameters**
+----
+| name  | Description   | is Required    | Default value
+| ------------- |:-------------:|:-------------:|:-------------:|
+| message_type   | TBD 0x00 0x07 | Yes   | -  |
+| message   | Longitude | Yes   | -  |
+
+**Example**
+----
+`pybytes.send_custom_message(TBD, TBD)`
+
+**Success Response**
+TBD
diff --git a/content/pybytes/api/send_digital_pin_value.md b/content/pybytes/api/send_digital_pin_value.md
@@ -0,0 +1,28 @@
+---
+title: "Pybytes library API"
+aliases:
+  - pybytes/api/send_digital_pin_value
+---
+
+**Send analog pin value**
+----
+  Send analog pin value
+
+**Method**
+----
+**pybytes.send_digital_pin_value(persistent, pin_number, pull_mode)**
+
+**Parameters**
+----
+| name  | Description   | is Required    | Default value
+| ------------- |:-------------:|:-------------:|:-------------:|
+| persistent   | Bool  | No   | False  |
+| pin number   | Analog pin number  TBD| Yes   | -  |
+| pull mode   | PULL_UP or TBD  | Yes   | PULL_UP  |
+
+**Example**
+----
+`pybytes.send_digital_pin_value(False, 12, Pin.PULL_UP)`
+
+**Success Response**
+TBD
diff --git a/content/pybytes/api/send_info_message.md b/content/pybytes/api/send_info_message.md
@@ -0,0 +1,20 @@
+---
+title: "Pybytes library API"
+aliases:
+  - pybytes/api/send_info_message
+---
+
+**Send info message**
+----
+  Send info message
+
+**Method**
+----
+**pybytes.send_info_message()**
+
+**Example**
+----
+`pybytes.send_info_message()`
+
+**Success Response**
+TBD
diff --git a/content/pybytes/api/send_ping_message.md b/content/pybytes/api/send_ping_message.md
diff --git a/content/pybytes/api/send_scan_info_message.md b/content/pybytes/api/send_scan_info_message.md
diff --git a/content/pybytes/api/send_signal.md b/content/pybytes/api/send_signal.md
diff --git a/content/pybytes/api/send_virtual_pin_value.md b/content/pybytes/api/send_virtual_pin_value.md
diff --git a/content/pybytes/api/set_config.md b/content/pybytes/api/set_config.md
diff --git a/content/pybytes/api/set_custom_message_callback.md b/content/pybytes/api/set_custom_message_callback.md
diff --git a/content/pybytes/api/start.md b/content/pybytes/api/start.md
diff --git a/content/pybytes/api/update_config.md b/content/pybytes/api/update_config.md
diff --git a/content/pybytes/api/write_config.md b/content/pybytes/api/write_config.md
