picoware.system.decorator

module documentation

Decorators for feature availability checks.

Function	`audio_required`	Decorator to check if Audio is available.
Function	`bluetooth_required`	Decorator to check if Bluetooth is available.
Function	`infrared_rx_required`	Decorator to check if infrared reception support is available.
Function	`infrared_tx_required`	Decorator to check if infrared transmission support is available.
Function	`keyboard_required`	Decorator to check if keyboard support is available.
Function	`native`	Decorator to wrap a function with micropython.native.
Function	`psram_required`	Decorator to check if PSRAM is available.
Function	`server_settings_required`	Decorator to check if server settings are available.
Function	`storage_required`	Decorator to check if storage is available.
Function	`viper`	Decorator to wrap a function with micropython.viper.
Function	`wifi_required`	Decorator to check if WiFi is available.

def audio_required(func: callable) -> callable: ¶

Decorator to check if Audio is available.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The wrapped function, or a stub that raises when audio is missing.

Raises
`RuntimeError`	If the decorated function is called without audio support.

def bluetooth_required(func: callable) -> callable: ¶

Decorator to check if Bluetooth is available.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The wrapped function, or a stub that raises when Bluetooth is missing.

Raises
`RuntimeError`	If the decorated function is called without Bluetooth support.

def infrared_rx_required(func: callable) -> callable: ¶

Decorator to check if infrared reception support is available.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The wrapped function, or a stub that raises when infrared reception is missing.

Raises
`RuntimeError`	If the decorated function is called without infrared reception support.

def infrared_tx_required(func: callable) -> callable: ¶

Decorator to check if infrared transmission support is available.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The wrapped function, or a stub that raises when infrared transmission is missing.

Raises
`RuntimeError`	If the decorated function is called without infrared transmission support.

def keyboard_required(func: callable) -> callable: ¶

Decorator to check if keyboard support is available.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The wrapped function, or a stub that raises when keyboard support is missing.

Raises
`RuntimeError`	If the decorated function is called without keyboard support.

def native(func: callable) -> callable: ¶

Decorator to wrap a function with micropython.native.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The function, wrapped with micropython.native on supported boards.

def psram_required(func: callable) -> callable: ¶

Decorator to check if PSRAM is available.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The wrapped function, or a stub that raises when PSRAM is missing.

Raises
`RuntimeError`	If the decorated function is called without PSRAM support.

def server_settings_required(func: callable) -> callable: ¶

Decorator to check if server settings are available.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The wrapped function, or a stub that raises when server settings are missing.

Raises
`RuntimeError`	If the decorated function is called without server settings support.

def storage_required(func: callable) -> callable: ¶

Decorator to check if storage is available.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The wrapped function, or a stub that raises when storage is missing.

Raises
`RuntimeError`	If the decorated function is called without SD storage support.

def viper(func: callable) -> callable: ¶

Decorator to wrap a function with micropython.viper.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The function, wrapped with micropython.viper on supported boards.

def wifi_required(func: callable) -> callable: ¶

Decorator to check if WiFi is available.

Parameters
func:`callable`	The function to decorate.

Returns
`callable`	The wrapped function, or a stub that raises when WiFi is missing.

Raises
`RuntimeError`	If the decorated function is called without WiFi connected.