14. API - GPS Status LED

14.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).

14.1.1. GPSStatusLED

class lannerpsp.GPSStatusLED(check_platform: bool = False)

GPS Status LED.

Parameters:

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

Raises:

• PSPNotSupport – This function is not supported (when check_platform is set to True).

• NotImplementedError – It has not been verified to run on this platform (when check_platform is set to True).

off() → None

Set the GPS status LED display mode to off.

Example:

>>> gps_status_led = GPSStatusLED()
>>> gps_status_led.off()

Raises:

• PSPNotOpened – The library is not ready or opened yet.

• PSPInvalid – The input parameter is out of range.

• PSPNotSupport – This function is not supported.

• PSPError – General PSP functional error.

on() → None

Set the GPS status LED display mode to on.

Example:

>>> gps_status_led = GPSStatusLED()
>>> gps_status_led.on()

Raises:

• PSPNotOpened – The library is not ready or opened yet.

• PSPInvalid – The input parameter is out of range.

• PSPNotSupport – This function is not supported.

• PSPError – General PSP functional error.

blink() → None

Set the GPS status LED display mode to blink.

Example:

>>> gps_status_led = GPSStatusLED()
>>> gps_status_led.blink()

Raises:

• PSPNotOpened – The library is not ready or opened yet.

• PSPInvalid – The input parameter is out of range.

• PSPNotSupport – This function is not supported.

• PSPError – General PSP functional error.

14.2. Supported Platforms

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

• LEC-7242