Просмотр исходного кода

Add documentation for new methods

jblanked 1 год назад
Родитель
Сommit
812b3f8aee
1 измененных файлов с 36 добавлено и 19 удалено
  1. 36 19
      assets/FlipperHTTP/README.md

+ 36 - 19
assets/FlipperHTTP/README.md

@@ -21,7 +21,7 @@ HTTP library for Flipper Zero. Compatible with Wifi Dev Board for Flipper Zero (
 15. Click on FLASH - slow. If successful, you will see three green LED blinks on the Dev board.
 16. On the Dev Board, press the RESET button once.
 
-You are all set. Here's the initial guide: [https://www.youtube.com/watch?v=Y2lUVTMTABE](https://www.youtube.com/watch?v=AZfbrLKJMpM)
+You are all set. Here's the initial guide: [https://www.youtube.com/watch?v=AZfbrLKJMpM](https://www.youtube.com/watch?v=AZfbrLKJMpM)
 
 Star the repository (https://github.com/jblanked/WebCrawler-FlipperZero) and follow me for updates and upcoming Flipper apps.
 
@@ -37,15 +37,20 @@ Star the repository (https://github.com/jblanked/WebCrawler-FlipperZero) and fol
 | `flipper_http_ping`                              | `bool`           | None                                                                                                           | Sends a ping request to test connectivity.                                                         |
 | `flipper_http_scan_wifi`                         | `bool`           | `const char *ssid`, `const char *password`                                                                     | Scans for nearby WiFi networks.                                                                    |
 | `flipper_http_save_wifi`                         | `bool`           | `const char *ssid`, `const char *password`                                                                     | Saves WiFi credentials for future connections.                                                     |
+| `flipper_http_ip_address`                        | `bool`           | None                                                                                                           | Retrieves the IP address of the WiFi Devboard.                                                     |
+| `flipper_http_list_commands`                     | `bool`           | None                                                                                                           | Lists all available commands.                                                                      |
+| `flipper_http_led_on`                            | `bool`           | None                                                                                                           | Turns on the LED.                                                                                  |
+| `flipper_http_led_off`                           | `bool`           | None                                                                                                           | Turns off the LED.                                                                                 |
+| `flipper_http_parse_json`                        | `bool`           | `const char *key`, `const char *json_data`                                                                     | Parses JSON data for a specified key.                                                              |
+| `flipper_http_parse_json_array`                  | `bool`           | `const char *key`, `int index`, `const char *json_data`                                                        | Parses an array within JSON data for a specified key and index.                                    |
 | `flipper_http_send_data`                         | `bool`           | `const char *data`                                                                                             | Sends the specified data to the server.                                                            |
 | `flipper_http_rx_callback`                       | `void`           | `const char *line`, `void *context`                                                                            | Callback function for handling received data.                                                      |
 | `flipper_http_get_request`                       | `bool`           | `const char *url`                                                                                              | Sends a GET request to the specified URL.                                                          |
 | `flipper_http_get_request_with_headers`          | `bool`           | `const char *url`, `const char *headers`                                                                       | Sends a GET request with custom headers to the specified URL.                                      |
-| `flipper_http_post_request_with_headers`         | `bool`           | `const char *url`, `const char *headers`, `const char *payload`                                                 | Sends a POST request with custom headers and a payload to the specified URL.                       |
-| `flipper_http_put_request_with_headers`          | `bool`           | `const char *url`, `const char *headers`, `const char *payload`                                                 | Sends a PUT request with custom headers and a payload to the specified URL.                        |
-| `flipper_http_delete_request_with_headers`          | `bool`           | `const char *url`, `const char *headers`, `const char *payload`                                                 | Sends a DELETE request with custom headers and a payload to the specified URL.                        |
+| `flipper_http_post_request_with_headers`         | `bool`           | `const char *url`, `const char *headers`, `const char *payload`                                                | Sends a POST request with custom headers and a payload to the specified URL.                       |
+| `flipper_http_put_request_with_headers`          | `bool`           | `const char *url`, `const char *headers`, `const char *payload`                                                | Sends a PUT request with custom headers and a payload to the specified URL.                        |
+| `flipper_http_delete_request_with_headers`       | `bool`           | `const char *url`, `const char *headers`, `const char *payload`                                                | Sends a DELETE request with custom headers and a payload to the specified URL.                     |
 | `flipper_http_save_received_data`                | `bool`           | `size_t bytes_received`, `const char line_buffer[]`                                                            | Saves the received data to the SD card, with the specified size and buffer.                        |
-
 `In C, fhttp.received_data holds the received data from HTTP requests. In JavaScript and mPython, the response is returned directly from the function.`
 
 ## Usage in `JavaScript` (flipper_http.js):
@@ -56,15 +61,21 @@ Star the repository (https://github.com/jblanked/WebCrawler-FlipperZero) and fol
 | `fhttp.connect_wifi`                   | `bool`           | None                                                | Sends a command to connect to WiFi and returns whether the connection was successful.                 |
 | `fhttp.disconnect_wifi`                | `bool`           | None                                                | Sends a command to disconnect from WiFi and returns whether the disconnection was successful.          |
 | `fhttp.ping`                           | `bool`           | None                                                | Sends a ping request to test connectivity and returns whether a response was received.                |
-| `fhttp.scan_wifi`                      | `str`           | None                                                 | Scans for nearby WiFi access points and returns a string with each access point separated by a comma               |
+| `fhttp.scan_wifi`                      | `string`         | None                                                | Scans for nearby WiFi access points and returns a string with each access point separated by a comma.  |
 | `fhttp.save_wifi`                      | `bool`           | `ssid: string`, `password: string`                  | Saves WiFi credentials and returns whether the save operation was successful.                         |
+| `fhttp.ip_address`                     | `string`         | None                                                | Gets the IP address of the WiFi Devboard and returns it as a string.                                  |
+| `fhttp.list_commands`                  | `string`         | None                                                | Lists all available commands and returns them as a string.                                            |
+| `fhttp.led_on`                         | `void`           | None                                                | Sends a command to turn on the LED.                                                                   |
+| `fhttp.led_off`                        | `void`           | None                                                | Sends a command to turn off the LED.                                                                  |
+| `fhttp.parse_json`                     | `string`         | `key: string`, `data: string`                       | Parses JSON data for a specified key and returns the corresponding value as a string.                 |
+| `fhttp.parse_json_array`               | `string`         | `key: string`, `index: number`, `data: string`      | Parses an array within JSON data for a specified key and index, returning the corresponding value.    |
 | `fhttp.send_data`                      | `void`           | `data: string`                                      | Sends the specified data to the serial port.                                                          |
-| `fhttp.read_data`                      | `string`         | `delay_ms: number`                                  | Reads data from the serial port with a specified delay and returns the response received.      |
-| `fhttp.get_request`                    | `string`         | `url: string`                                       | Sends a GET request to the specified URL and returns the response of the response.             |
-| `fhttp.get_request_with_headers`       | `string`         | `url: string`, `headers: string`                    | Sends a GET request with headers and returns the response of the response.                    |
-| `fhttp.post_request_with_headers`      | `string`         | `url: string`, `headers: string`, `payload: string` | Sends a POST request with headers and payload, and returns the response of the response.       |
-| `fhttp.put_request_with_headers`       | `string`         | `url: string`, `headers: string`, `payload: string` | Sends a PUT request with headers and payload, and returns the response of the response.        |
-| `fhttp.delete_request_with_headers`       | `string`         | `url: string`, `headers: string`, `payload: string` | Sends a PUT request with headers and payload, and returns the response of the response.        |
+| `fhttp.read_data`                      | `string`         | `delay_ms: number`                                  | Reads data from the serial port with a specified delay and returns the response received.             |
+| `fhttp.get_request`                    | `string`         | `url: string`                                       | Sends a GET request to the specified URL and returns the response.                                    |
+| `fhttp.get_request_with_headers`       | `string`         | `url: string`, `headers: string`                    | Sends a GET request with specified headers and returns the response.                                  |
+| `fhttp.post_request_with_headers`      | `string`         | `url: string`, `headers: string`, `payload: string` | Sends a POST request with specified headers and payload, returning the response.                      |
+| `fhttp.put_request_with_headers`       | `string`         | `url: string`, `headers: string`, `payload: string` | Sends a PUT request with specified headers and payload, returning the response.                       |
+| `fhttp.delete_request_with_headers`    | `string`         | `url: string`, `headers: string`, `payload: string` | Sends a DELETE request with specified headers and payload, returning the response.                    |
 
 ## Usage in `Python` (flipper_http.py):
 | **Function Name**                      | **Return Value** | **Parameters**                                       | **Description**                                                                                      |
@@ -73,11 +84,17 @@ Star the repository (https://github.com/jblanked/WebCrawler-FlipperZero) and fol
 | `flipper_http_disconnect_wifi`                | `bool`           | None                                                | Sends a command to disconnect from WiFi and returns whether the disconnection was successful.          |
 | `flipper_http_ping`                           | `bool`           | None                                                | Sends a ping request to test connectivity and returns whether a response was received.                |
 | `flipper_http_save_wifi`                      | `bool`           | `ssid: str`, `password: str`                  | Saves WiFi credentials and returns whether the save operation was successful.                         |
-| `flipper_http_scan_wifi`                      | `str`            | None                                          | Scans for nearby WiFi access points and returns a string with each access point separated by a comma.  |
+| `flipper_http_scan_wifi`                      | `str`            | None                                          | Scans for nearby WiFi access points and returns a string listing each access point, separated by commas.  |
+| `flipper_http_ip_address`                     | `str`            | None                                          | Gets the IP address of the WiFi Devboard and returns it as a string.                                  |
+| `flipper_http_list_commands`                  | `str`            | None                                          | Lists all available commands and returns them as a string.                                            |
+| `flipper_http_led_on`                         | `void`           | None                                          | Sends a command to turn on the LED.                                                                   |
+| `flipper_http_led_off`                        | `void`           | None                                          | Sends a command to turn off the LED.                                                                  |
+| `flipper_http_parse_json`                     | `str`            | `key: str`, `json_data: str`                   | Parses JSON data for a specified key and returns the corresponding value as a string.                 |
+| `flipper_http_parse_json_array`               | `str`            | `key: str`, `index: int`, `json_data: str`       | Parses an array within JSON data for a specified key and index, returning the corresponding value.    |
 | `flipper_http_send_data`                      | `void`           | `data: str`                                      | Sends the specified data to the serial port.                                                          |
-| `flipper_http_read_data`                      | `str`         | `sleep_ms: int`                                  | Reads data from the serial port with a specified delay and returns the response received.      |
-| `flipper_http_get_request`                    | `str`         | `url: str`                                       | Sends a GET request to the specified URL and returns the response of the response.             |
-| `flipper_http_get_request_with_headers`       | `str`         | `url: str`, `headers: str`                    | Sends a GET request with headers and returns the response of the response.                    |
-| `flipper_http_post_request_with_headers`      | `str`         | `url: str`, `headers: str`, `data: str` | Sends a POST request with headers and data, and returns the response of the response.       |
-| `flipper_http_put_request_with_headers`       | `str`         | `url: str`, `headers: str`, `data: str` | Sends a PUT request with headers and data, and returns the response of the response.        |
-| `flipper_http_delete_request_with_headers`       | `str`         | `url: str`, `headers: str`, `data: str` | Sends a PUT request with headers and data, and returns the response of the response.        |
+| `flipper_http_read_data`                      | `str`            | `sleep_ms: int`                                  | Reads data from the serial port with a specified delay and returns the response received.             |
+| `flipper_http_get_request`                    | `str`            | `url: str`                                       | Sends a GET request to the specified URL and returns the response.                                    |
+| `flipper_http_get_request_with_headers`       | `str`            | `url: str`, `headers: str`                      | Sends a GET request with specified headers and returns the response.                                  |
+| `flipper_http_post_request_with_headers`      | `str`            | `url: str`, `headers: str`, `data: str`         | Sends a POST request with specified headers and data, returning the response.                         |
+| `flipper_http_put_request_with_headers`       | `str`            | `url: str`, `headers: str`, `data: str`         | Sends a PUT request with specified headers and data, returning the response.                          |
+| `flipper_http_delete_request_with_headers`    | `str`            | `url: str`, `headers: str`, `data: str`         | Sends a DELETE request with specified headers and data, returning the response.                       |