13. API - System LED

13.1. Regular Classes

The following classes are intended for general use with the devices they represent. All classes in this section are concrete (not abstract).

13.1.1. SystemLED

class lannerpsp.SystemLED(check_platform: bool = False)[source]

System LED.

The LED colors is dependent on the platform hardware configuration.

Parameters:

check_platform (bool) – Set to True to check if the platform supports this feature. Defaults to False for better compatibility.

Raises:
get_status() int[source]

Get the system LED display mode status.

Example:

>>> system_led = SystemLED()
>>> system_led.get_status()
2
Returns:

system LED status

Return type:

int

Raises:
off() None[source]

Set the system LED display mode to off.

Example:

>>> system_led = SystemLED()
>>> system_led.off()
Raises:
green() None[source]

Set the system LED display mode to green.

Example:

>>> system_led = SystemLED()
>>> system_led.green()
Raises:
red() None[source]

Set the system LED display mode to red/amber.

Example:

>>> system_led = SystemLED()
>>> system_led.red()
Raises:

13.2. Supported Platforms

The following platforms have been verified and confirmed to be supported: