ErrorHeader Class Reference

ErrorHeader are all command headers used in ErrorPacket. More...

Inheritance diagram for ErrorHeader:

Collaboration diagram for ErrorHeader:

Public Member Functions
def	__new__ (cls, value, doc=None)
	overwrite to enable doc strings for enum elements as second argument. More...

Static Public Attributes
int	OUT_ALIGN_SUCCESS_VERSION
int	OUT_ERROR
int	OUT_ERROR_ASYNC_HS_TIMEOUT
int	OUT_ERROR_CONFIGURATION_OUT_OF_BOUNDS
int	OUT_ERROR_DATA_OUT_OF_BOUNDS
int	OUT_ERROR_INPUT_FULL
int	OUT_ERROR_INTERFACE_ALREADY_ACTIVE
int	OUT_ERROR_INTERFACE_NOT_ACTIVE
int	OUT_ERROR_OUTPUT_FULL
int	OUT_ERROR_PERIPHERAL_INTERFACE_NOT_READY
int	OUT_ERROR_PIN_ALREADY_INUSE
int	OUT_ERROR_PIN_NOT_CONFIGURED
int	OUT_ERROR_UNKNOWN_CONFIGURATION
int	OUT_ERROR_UNKNOWN_INSTRUCTION
int	OUT_WARNING_DATA_COLLECTION_SQUEUED

Detailed Description

ErrorHeader are all command headers used in ErrorPacket.

Errors are issued by the uC to tell the user what went wrong. The description explains the meaning of the individual errors.

the causing errors can be found in org_header and org_sub_header the causeing valuse is stored in value, if a value does not make sense for that error class it is the current timestamp of the uC.

Definition at line 581 of file header.py.

Member Function Documentation

__new__()

def __new__	(		cls,
			value,
			doc = None
	)

overwrite to enable doc strings for enum elements as second argument.

Definition at line 593 of file header.py.

Member Data Documentation

OUT_ALIGN_SUCCESS_VERSION

int OUT_ALIGN_SUCCESS_VERSION

static

Initial value:

=  253, """
    This response to the alignment request confirms the connection with the microcontroller and includes the 
    firmware version to verify the correct version is running. The format is as follows (uses the error_package struct):
    - org_header: major version (8-bit)
    - sub_header: minor version (8-bit)
    - value: patch version (32-bit)
    """

Definition at line 668 of file header.py.

OUT_ERROR

int OUT_ERROR

static

Initial value:

=  200,    """
    Unspecified error. Something went wrong, and the microcontroller doesn't know why. 
    """

Definition at line 603 of file header.py.

OUT_ERROR_ASYNC_HS_TIMEOUT

int OUT_ERROR_ASYNC_HS_TIMEOUT

static

Initial value:

=  209, """
    The asynchronous sending interface has not received an acknowledgment for some time and 
    has reset the request. Please restart or reset the Device Under Test (DuT).
    """

Definition at line 645 of file header.py.

OUT_ERROR_CONFIGURATION_OUT_OF_BOUNDS

int OUT_ERROR_CONFIGURATION_OUT_OF_BOUNDS

static

Initial value:

=  211, """
    The configuration ID sent exceeds the available microcontroller resources. Please check the ID, as it is invalid.
    """

Definition at line 654 of file header.py.

OUT_ERROR_DATA_OUT_OF_BOUNDS

int OUT_ERROR_DATA_OUT_OF_BOUNDS

static

Initial value:

=  212, """
    The data sent exceeds the configured bit/byte word length of the interface. Please check the data, as it is invalid.
    """

Definition at line 658 of file header.py.

OUT_ERROR_INPUT_FULL

int OUT_ERROR_INPUT_FULL

static

Initial value:

=  203, """
    The timed instruction buffer is full, so new instructions cannot be stored and will be discarded.
    """

Definition at line 617 of file header.py.

OUT_ERROR_INTERFACE_ALREADY_ACTIVE

int OUT_ERROR_INTERFACE_ALREADY_ACTIVE

static

Initial value:

=  205, """
    The interface you’re trying to activate is already configured and active. To reconfigure, call close_connection() 
    on the uC_api, then create a new uC_api instance to reconnect after the microcontroller resets.
    """

Definition at line 625 of file header.py.

OUT_ERROR_INTERFACE_NOT_ACTIVE

int OUT_ERROR_INTERFACE_NOT_ACTIVE

static

Initial value:

=  207, """
    The interface you're trying to use is not yet configured. Please initialize it by calling 
    <interface>[X].activate(<options>) or sending the necessary configuration packets.
    """

Definition at line 635 of file header.py.

OUT_ERROR_OUTPUT_FULL

int OUT_ERROR_OUTPUT_FULL

static

Initial value:

=  204, """
    The output buffer is full, causing packets to be dropped. The value shown is the count of dropped packets.
    """

Definition at line 621 of file header.py.

OUT_ERROR_PERIPHERAL_INTERFACE_NOT_READY

int OUT_ERROR_PERIPHERAL_INTERFACE_NOT_READY

static

Initial value:

=  210,    """
    This error occurs when a peripheral interface is not ready, such as when the I2C for the MCP23017 is not available. 
    """

Definition at line 650 of file header.py.

OUT_ERROR_PIN_ALREADY_INUSE

int OUT_ERROR_PIN_ALREADY_INUSE

static

Initial value:

=  201, """
    The pin or interface you’re trying to activate is already in use or was previously configured. To reset, 
    call close_connection() on the uC_api, then create a new uC_api instance to reconnect after the microcontroller resets.
    """

Definition at line 607 of file header.py.

OUT_ERROR_PIN_NOT_CONFIGURED

int OUT_ERROR_PIN_NOT_CONFIGURED

static

Initial value:

=  202, """
    The pin you’re attempting to use isn’t configured. Please initialize it first by calling pin[X].activate(<options>) 
    or sending the necessary configuration packets.
    """

Definition at line 612 of file header.py.

OUT_ERROR_UNKNOWN_CONFIGURATION

int OUT_ERROR_UNKNOWN_CONFIGURATION

static

Initial value:

=  208, """
    The configuration header sent is unrecognized or invalid for the microcontroller, 
    possibly due to an API and firmware version mismatch.
    """

Definition at line 640 of file header.py.

OUT_ERROR_UNKNOWN_INSTRUCTION

int OUT_ERROR_UNKNOWN_INSTRUCTION

static

Initial value:

=  206, """
    The instruction header sent is unrecognized or invalid for the microcontroller, 
    possibly due to an API and firmware version mismatch.
    """

Definition at line 630 of file header.py.

OUT_WARNING_DATA_COLLECTION_SQUEUED

int OUT_WARNING_DATA_COLLECTION_SQUEUED

static

Initial value:

=  213, """
    Data collection is taking too long due to excessive requests, preventing the microcontroller from transmitting data to the PC. 
    Consequently, the uC will temporarily pause data collection to send approximately 10 packets to the PC before resuming data collection. 
    This warning will be issued only once.
    """

Definition at line 662 of file header.py.

---

The documentation for this class was generated from the following file:

• /github/workspace/uC_api/header.py