picoware.system.http.HTTPUART

class documentation

class HTTPUART:

Constructor: HTTPUART(uart, chunk_size, timeout_ms)

HTTPUART - Handle HTTP requests over UART.

Method	`__init__`	Initialize the HTTP class.
Method	`close`	Close the UART connection.
Method	`ping`	Check for pong response
Method	`request`	Make an HTTP request.
Method	`request_async`	Handle async requests.
Instance Variable	`chunk_size`	Undocumented
Instance Variable	`error`	Undocumented
Instance Variable	`timeout_ms`	Undocumented
Instance Variable	`uart`	Undocumented
Property	`response`	Get the latest HTTP response received from the UART.
Method	`__send_and_wait`	Send a command to the UART and wait for a response.
Instance Variable	`_response`	Undocumented

def __init__(self, uart=None, chunk_size: int = 1024 * 4, timeout_ms: int = 5000): ¶

Initialize the HTTP class.

Parameters
uart:`UART`	The UART instance. Defaults to None.
chunk_size:`int`	Transfer chunk size in bytes. Defaults to 4096.
timeout_ms:`int`	The timeout for UART receiving in milliseconds. Defaults to 5000.

def close(self): ¶

Close the UART connection.

def ping(self) -> bool: ¶

Check for pong response

def request(self, method, url, data=None, json_data=None, headers=None, auth=None, timeout=None, parse_headers=True, uart=None, save_to_file=None, storage=None, send_file=None) -> Response: ¶

Make an HTTP request.

Parameters
method:`str`	HTTP method (GET, POST, etc.).
url:`str`	URL to request.
data:`str or bytes`	Request body data. Defaults to None.
json_data:`dict`	JSON data to send (will be serialized). Defaults to None.
headers:`dict`	HTTP headers dict. Defaults to None.
auth:`tuple`	Authentication tuple (username, password). Defaults to None.
timeout:`float`	Request timeout in seconds. Defaults to None.
parse_headers:`bool or callable`	Whether to parse response headers. Defaults to True.
uart:`UART`	UART object for streaming output. Defaults to None.
save_to_file:`str`	File path to save response data to (requires storage). Defaults to None.
storage:`Storage`	Storage object for file operations. Defaults to None.
send_file:`str`	File path to send as request body (requires storage). Defaults to None.

Returns
`Response`	The HTTP response.

def request_async(self, method, url, payload=None, headers=None, timeout: float = 10.0, save_to_file=None, storage=None, send_file=None, stack_size: int = 8 * 1024) -> bool: ¶

Handle async requests.

Parameters
method:`str`	HTTP method (GET, POST, etc.).
url:`str`	URL to request.
payload:`str, bytes, or dict`	Request payload. Defaults to None.
headers:`dict`	HTTP headers dict. Defaults to None.
timeout:`float`	Request timeout in seconds. Defaults to 10.0.
save_to_file:`str`	File path to save response data to (requires storage). Defaults to None.
storage:`Storage`	Storage object for file operations. Defaults to None.
send_file:`str`	File path to send as request payload (requires storage). Defaults to None.
stack_size:`int`	Undocumented

Returns
`bool`	True if the request was started.

chunk_size = ¶

Undocumented

error = ¶

Undocumented

timeout_ms = ¶

Undocumented

uart = ¶

Undocumented

@property

response: Response = ¶

Get the latest HTTP response received from the UART.

Returns
`Response`	The latest HTTP response received from the UART.

def __send_and_wait(self, command, add_newline: bool = True) -> str: ¶

Send a command to the UART and wait for a response.

Parameters
command:`str/bytes`	The command to send.
add_newline:`bool`	Undocumented

Returns
`str`	The response from the UART.

_response = ¶

Undocumented