4. API - DLL

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

4.1.1. DLL

class lannerpsp.DLL

Dynamic Link Library.

get_version() → DLLVersionModel

Load the Lanner board-level library.

Example:

>>> dll = DLL()
>>> version = dll.get_version()
>>> version
DLLVersionModel(dll_major=2, dll_minor=1, dll_build=2, platform_id='LEB-7242', board_major=1, board_minor=0, board_build=2)
>>> version.to_dict()
{'dll_major': 2, 'dll_minor': 1, 'dll_build': 2, 'platform_id': 'LEB-7242', 'board_major': 1, 'board_minor': 0, 'board_build': 2}
>>> str(version)
'PSP/SDK version: 2.1.2\nIODRV   version: LEB-7242.1.0.2'
>>> version.dll_major
2
>>> version.dll_minor
1
>>> version.dll_build
2
>>> version.platform_id
'LEB-7242'
>>> version.board_major
1
>>> version.board_minor
0
>>> version.board_build
2

Returns:

the DLL and Board Library version information

Return type:

DLLVersionModel

Raises:

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

• PSPNotSupport – This platform does not support this function.

• PSPError – General PSP functional error.

get_bios_id() → str

Get the Lanner mother-board BIOS infromation.

Example:

>>> dll = DLL()
>>> dll.get_bios_id()
'LEB-7242B BIOS V1.12 "03/09/2022"'

Returns:

the mother board BIOS information

Return type:

str

Raises:

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

• PSPNotSupport – This platform does not support this function.

• PSPError – General PSP functional error.

4.2. Models

The following models are used to store data for data modeling.

4.2.1. DLLVersionModel

class lannerpsp.DLLVersionModel(dll_major: int, dll_minor: int, dll_build: int, platform_id: str, board_major: int, board_minor: int, board_build: int)

To store DLL and Board Library version information.

to_dict() → Dict[str, Any]

Convert to dict.

4.3. Supported Platforms

Note

For all versions of Lanner PSP on all platforms.