check_board_configuration

Summary

check_board_configuration(descriptor: MapDescriptor = None, frbs: list[BoardFile] = None, skip: bool = False, skip_warnings: bool = False) → CheckResult

An entry-point for checks related to the current board configuration as defined in the .frb board file and/or .yaml descriptor file. Both descriptor and frb are optional parameters, but at least one of them needs to be present. Additional checks are performed if both are present.

Parameters:

  • descriptor (MapDescriptor, optional) – A MapDescriptor object representing a .yaml file.

  • frb – A BoardFile object representing an .frb file.

  • skip (bool, optional) – If set to True, the check will be skipped, but a valid resultobject with no messages and SKIPPED as its status will still be returned. Defaults to False.

  • skip_warnings (bool, optional) – If set, skips tests resulting in “Warning” messages.

Returns:

A CheckResult object containing the check status as well as any messages and additional data.

Return type:

CheckResult

Importing

from cs_board_tools.validation.board import check_board_configuration