emintes-testframework 0.1.0__tar.gz

emintes_testframework-0.1.0/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: emintes-testframework
+Version: 0.1.0
+Summary: Autogenerated host-side stubs for the CHECKBOX testframework API
+Requires-Python: >=3.10

emintes_testframework-0.1.0/pyproject.toml

@@ -0,0 +1,15 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "emintes-testframework"
+version = "0.1.0"
+description = "Autogenerated host-side stubs for the CHECKBOX testframework API"
+requires-python = ">=3.10"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.package-data]
+testframework = ["py.typed"]

emintes_testframework-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

emintes_testframework-0.1.0/src/emintes_testframework.egg-info/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: emintes-testframework
+Version: 0.1.0
+Summary: Autogenerated host-side stubs for the CHECKBOX testframework API
+Requires-Python: >=3.10

emintes_testframework-0.1.0/src/emintes_testframework.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+pyproject.toml
+src/emintes_testframework.egg-info/PKG-INFO
+src/emintes_testframework.egg-info/SOURCES.txt
+src/emintes_testframework.egg-info/dependency_links.txt
+src/emintes_testframework.egg-info/top_level.txt
+src/testframework/__init__.py
+src/testframework/py.typed
+src/testframework/testreport.py

emintes_testframework-0.1.0/src/emintes_testframework.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

emintes_testframework-0.1.0/src/emintes_testframework.egg-info/top_level.txt

@@ -0,0 +1 @@
+testframework

emintes_testframework-0.1.0/src/testframework/__init__.py

@@ -0,0 +1,808 @@
+"""Autogenerated host-side stubs for the CHECKBOX testframework API."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from .testreport import report
+
+_RUNTIME_MESSAGE = "This package only provides autogenerated host-side stubs for the CHECKBOX MicroPython API."
+
+LOW: int = 0
+HIGH: int = 1
+RISING: int = 1
+FALLING: int = 2
+LEVEL_3V3: int = 0
+LEVEL_5V: int = 1
+REL1: int = 1
+REL2: int = 2
+AOUT1: int = 1
+AOUT2: int = 2
+AIN1: int = 1
+AIN2: int = 2
+AIN3: int = 3
+AIN4: int = 4
+AIN5: int = 5
+AIN6: int = 6
+AIN7: int = 7
+AIN8: int = 8
+OUT1: int = 1
+OUT2: int = 2
+OUT3: int = 3
+OUT4: int = 4
+OUT5: int = 5
+OUT6: int = 6
+OUT7: int = 7
+OUT8: int = 8
+OUT9: int = 9
+OUT10: int = 10
+OUT11: int = 11
+OUT12: int = 12
+IN1: int = 1
+IN2: int = 2
+IN3: int = 3
+IN4: int = 4
+IN5: int = 5
+IN6: int = 6
+IN7: int = 7
+IN8: int = 8
+IN9: int = 9
+IN10: int = 10
+IN11: int = 11
+IN12: int = 12
+
+class PWMResult:
+    """Autogenerated placeholder for PWMResult."""
+    period: Any
+    onTime: Any
+    frequency: Any
+    dutyCycle: Any
+
+    def __init__(self, period, onTime, frequency, dutyCycle):
+        """Autogenerated stub for PWMResult.__init__."""
+        self.period = period
+        self.onTime = onTime
+        self.frequency = frequency
+        self.dutyCycle = dutyCycle
+
+    def print(self):
+        """Autogenerated stub for PWMResult.print."""
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def setTestframeworkCoreReference(ref):
+    """Autogenerated stub for setTestframeworkCoreReference. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def prepareTest():
+    """Autogenerated stub for prepareTest. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def backToDefaults():
+    """Autogenerated stub for backToDefaults. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def abortTest(msg: str):
+    """
+    This function aborts the running test.
+    
+    :param msg: This message is displayed as the reason for cancellation in the test report.
+    :type msg: str
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def abortTestOnFailure(abort: bool):
+    """
+    Setup the behavior of the test if a test failed. The default value is ``False``.
+    
+    :param abort: Set this to ``True`` to stop the test on failed result. ``False`` means that the test will continue when a step failed.
+    :type abort: bool
+    
+    **Example usage:**
+    
+        .. highlight:: python
+        .. code-block:: python
+    
+            from testframework import *
+    
+            report.abortTestOnFailure(True)
+    
+    .. note::
+        You can change the behavior during test as often as you want. 
+        If you have a sequence in which an error should lead to the test being stopped immediately, 
+        you can activate this option at the start of the sequence and deactivate it at the end.
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def keepConfigurationAfterTest(keepConfig: bool):
+    """
+    After each test run, the framework resets the test box to default configuration (I/O Supply disabled, External Supply Relais disabled, ...).
+    If you want to debug the firmware of the DUT, this can lead to problems.
+    You can therefore manually activate/deactivate the reset to default values via this function call. 
+    
+    The setting is retained until the box is restarted.
+    
+    :param keepConfig: Set this to ``True`` and all configuration will be kept after Test. ``False`` (default value) will reset configuration after Test.
+    :type keepConfig: bool
+    
+    **Example usage:**
+    
+        .. highlight:: python
+        .. code-block:: python
+    
+            from testframework import *
+    
+            keepConfigurationAfterTest(True)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def enableIOSupply(level):
+    """
+    Activates the power supply for the IO-Pins.
+    You can choose which voltage level is used.
+    
+    :param level: LEVEL_3V3, or LEVEL_5V
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        enableIOSupply(LEVEL_3V3)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def disableIOSupply():
+    """
+    Disables the power supply for the IO-Pins.
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        disableIOSupply()
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def enableExternalSupply():
+    """Autogenerated stub for enableExternalSupply. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def disableExternalSupply():
+    """Autogenerated stub for disableExternalSupply. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def enableDUTSupply():
+    """Autogenerated stub for enableDUTSupply. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def disableDUTSupply():
+    """Autogenerated stub for disableDUTSupply. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def enableRelais():
+    """
+    Sets the Relaisoutput.
+    
+    Example usage:
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        enableRelais()
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def disableRelais():
+    """
+    Unset the Relaisoutput.
+    
+    Example usage:
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        disableRelais()
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def getInputVoltage(input):
+    """
+    Measures and returns the voltage at an analog input pin.
+    
+    :param input: Number of the analog input pin. You can use the constants (AIN1, AIN2, ..., AIN8) or integer numbers (1-8)
+    :type input: int
+    :returns: Measured voltage in unit Volt
+    :rtype: float
+    
+    Example usage:
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        voltage = getInputVoltage(AIN1)
+        print(voltage)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def setOutputVoltage(output, voltage: float):
+    """
+    Sets the output voltage of an analog output pin.
+    
+    :param output: Analog output pin. You can use the constants (AOUT1, AOUT2) or integer numbers (1-2)
+    :type output: int
+    :param voltage: Voltage in Volt
+    :type voltage: float
+    
+    .. note::
+        You have to enable the IO-Supply with function ``enableIOSupply`` first. 
+        Keep in mind, that the maximum output voltage for the analog output is limited by the voltage level you have choosen.
+    
+    **Example usage:** 
+    
+    Sets the AOUT1 pin to 2,8V:
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        enableIOSupply(LEVEL_3V3)
+        setOutputVoltage(AOUT1, 2.8)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def getInputs():
+    """
+    Returns the state of all digital inputs.
+    
+    :returns: array of 12 elements with following values: 0 if the corresponding input is low, 1 if the corresponding input is high
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        inputStates = getInputs()
+        if inputStates[0] == HIGH and inputStates[7] == LOW:
+            print("Pin 1 is high and pin 8 is low")
+        else:
+            print("wrong pin levels")
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def isInputHigh(input):
+    """
+    Checks if the geiven input has a hihg-level.
+    
+    :param input: Digital intput pin. You can use the constants (IN1, IN2, ... , IN12) or integer numbers (1-12)
+    :type input: int
+    :returns: ``True`` if the pin is high. ``False`` if the pin is low.
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        if isInputHigh(IN9):
+            print("Pin is high")
+        else:
+            print("Pin is low")
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def isInputLow(input: int):
+    """See :func:`~testframework.isInputHigh`"""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def getInput(input: int):
+    """
+    Returns the state of a digital input.
+    
+    :param input: Digital intput pin. You can use the constants (IN1, IN2, ... , IN12) or integer numbers (1-12)
+    :type input: int
+    :returns: 0 if input is low, 1 if input is high (you can  use constants ``LOW`` or ``HIGH`` to check the value), -1 on error
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        if getInput(IN9) == HIGH:
+            print("Pin is high")
+        else:
+            print("Pin is low")
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def waitForLow(input: int, timeout: int | str):
+    """
+    Waits until a given digital input pin is low. 
+    
+    For the timeout parameter you have two options:
+    
+    * Set a timeout in milliseconds. When reaching this timeout before the input gets low, this function returns False
+    * If you are waiting for an user-action at this point, you can give an usermessage as string which will be displayed on the screen (e.g.: user has to press a button on the DUT and the test wants to read the low level value). The user can abort this action by pressing the red button on the box. In this case, the function will return False.
+    
+    
+    :param input: Digital intput pin. You can use the constants (IN1, IN2, ... , IN12) or integer numbers (1-12)
+    :type input: int
+    :param timeout: Timeout in milliseconds or a string with a user message. If the user message is given, the user can abort the action by pressing the red button on the box.
+    :type timeout: int or str
+    :returns: ``True`` if the pin got low within given timeout. ``False`` if the timeout has expired or the user aborted with red button.
+    
+    .. warning::
+        this is an async function. You have to call it with ``await``.
+    
+    **Example usage:** 
+    
+    To wait for low level of digital input pin 5 with a timeout of 2 seconds:
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        result = await waitForLow(IN5, 2000)
+        if result == True:
+            print("Pin is now low")
+        else:
+            print("Timeout")
+    
+    
+    The User should press a button on the DUT to test if the signals on the DUT are working correctly.
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        result = await waitForLow(IN5, "Press push button 1 on DUT")
+        report.checkBool("push button 1 signal OK")
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def waitForHigh(input: int, timeout: int | str):
+    """See :func:`~testframework.waitForLow`"""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def setOutputLow(output: int):
+    """
+    Sets the Output to Low level (0V)
+    
+    :param output: Digital output pin. You can use the constants (OUT1, OUT2, ... , OUT12) or integer numbers (1-12)
+    :type input: int
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        enableIOSupply(LEVEL_5V)
+        setOutputLow(OUT3)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def setOutputHigh(output):
+    """
+    Sets the Output to High level. The voltage of high level is defined by the ``enableIOSupply`` call.
+    
+    :param output: Digital output pin. You can use the constants (OUT1, OUT2, ... , OUT12) or integer numbers (1-12)
+    :type input: int
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        enableIOSupply(LEVEL_3V3)
+        setOutputHigh(OUT3)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def setOutputPWM(output: int, dutyCycle: float, frequency: int = -1):
+    """
+    Outputs a PWM signal at the given Output Pin. The high-voltage level of the signal is defined by the ``enableIOSupply`` call.
+    
+    .. warning::
+        OUT1, OUT2 and OUT3 uses the same Timer. So all three PWM outputs always have the same frequency! Changing the frequency of one also changes frequency of the other.
+    
+        The same behavior also applies to OUT4 and OUT5. They also use the same timer (but they are completely independent to OUT1/OUT2/OUT3).
+    
+    :param output: Digital output pin which can generate a PWM signal. Allowed: OUT1, OUT2, OUT3, OUT4, OUT5.
+    :type input: int
+    :param dutyCycle: duty cycle of the PWM signal in percent (0-100)
+    :type dutyCycle: float
+    :param frequency: (optional) defines the frequency of the signal in Hz. If this parameter is omitted, the signal will keep the last set frequency. On first call the frequency will set to 1kHz.
+    :type frequency: int
+    
+    **Example usage:**
+    
+    Outputs a 5kHz PWM Signal with 25% duty cycle at Pin OUT1.
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        enableIOSupply(LEVEL_5V)
+        setOutputPWM(OUT1, 25.0, 5000)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def getDeviceTemperature():
+    """
+    Returns the current internal temperature of the Checkbox.
+    
+    :returns: Temperature in °C
+    :return type: float
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        devTemp = getDeviceTemperature()
+        report.infoValue("Device temperature", "%.1f °C" %devTemp)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def sleep_ms(x):
+    """Autogenerated stub for sleep_ms. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def sleep(x):
+    """Autogenerated stub for sleep. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def getSerialNumber():
+    """Autogenerated stub for getSerialNumber. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def getHWVersion():
+    """Autogenerated stub for getHWVersion. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def getSWVersion():
+    """Autogenerated stub for getSWVersion. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def getFrequency(input, timeout_ms):
+    """Autogenerated stub for getFrequency. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def getCurrent():
+    """Autogenerated stub for getCurrent. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def convertADCToCurrent(adcValue, refVoltage):
+    """Autogenerated stub for convertADCToCurrent. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def getUserInputBool(message: str) -> bool:
+    """
+    Shows an user input dialog where the user can answer a simple Yes/No question.
+    
+    :param message: Message that will be displayed
+    :type message: string
+    :returns: user input
+    :return type: bool
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        answer = await getUserInputBool("Is the green LED on?")
+        report.checkBool("Green LED on", answer)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def getUserInputString(message: str) -> str:
+    """
+    Shows an user input dialog where the user can enter Text.
+    
+    :param message: Message that will be displayed
+    :type message: string
+    :returns: user input
+    :return type: string
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        answer = await getUserInputString("Enter Serial Number")
+        if len(answer) == 8:
+            serialNumber = answer
+        else:
+            report.checkValue("Entered Serialnumber has wrong length.", len(answer), 8)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def getUserInputInt(message: str) -> str:
+    """
+    Shows an user input dialog where the user can enter an Integer Number.
+    
+    :param message: Message that will be displayed
+    :type message: string
+    :returns: user input
+    :return type: string
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        answer = await getUserInputInt("Enter your personal number")
+            report.putInfoValue("Personal Number of tester", answer)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def getUserInputFloat(message: str) -> str:
+    """
+    Shows an user input dialog where the user can enter an Floatingpoint Number.
+    
+    :param message: Message that will be displayed
+    :type message: string
+    :returns: user input
+    :return type: string
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        answer = await getUserInputFloat("Enter current exchange rate")
+            report.putInfoValue("Exchange Rate", answer)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def getUserInputSerialNumber(message: str, usb = True, pc = True, display = True) -> str:
+    """
+    Prompts the user to enter the serial number.
+    The serial number can be entered on the PC, via the display, or using a barcode scanner.
+    
+    :param message: Message that will be displayed
+    :type message: string
+    :param usb: If an USB-Module is connected, any input from the USB device will be accepted.
+    :type usb: bool
+    :param pc: a message on PC will be displayed on PC and the user can input the serial number on the PC. Set to ´´False´´ if you dont want a Message on PC side.
+    :type pc: bool
+    :param display: if this parameter is true, a keyboard ist displayed on the display and the user can enter the serial number there. Set to ´´False´´ if you just want to get a simple user message on the display.    
+    :type display: bool
+    :returns: user input
+    :return type: string
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        serialNumber = await getUserInputSerialNumber("Enter Serial Number")
+        report.putInfoValue("DUT Serial Number", serialNumber)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def showUserMessage(message: str):
+    """
+    Shows an user info-message which can be acknowledged by pressing OK.
+    
+    :param message: Message that will be displayed
+    :type message: string
+    :returns: nothing
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        await showUserMessage("Solder the cable now:\nPad P1: Black wire\nPad P2: Brown wire\nPad P3: Red Wire")
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def showProgressBar(description: str):
+    """
+    Shows a progress bar on the PC. This can be used to show the user a progress if a step during the test needs some time.
+    
+    :param description: Text which will be displayed
+    :type description: string
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        showProgressBar("Download Firmware")
+        for i in range(10):
+            updateProgressBar(i*10)
+            await sleep_ms(300)
+        hideProgressBar()
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def updateProgressBar(progress: float):
+    """
+    Sets the progress bar to given value. The progress value is in percent and have to be between 0-100%.
+    
+    :param progress: Progress which should be set.
+    :type progress: float
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        showProgressBar("Download Firmware")
+        for i in range(10):
+            updateProgressBar(i*10)
+            await sleep_ms(300)
+        hideProgressBar()
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def hideProgressBar():
+    """
+    Hides the progress bar on PC and display.
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        showProgressBar("Download Firmware")
+        for i in range(10):
+            updateProgressBar(i*10)
+            await sleep_ms(300)
+        hideProgressBar()
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def executeCommand(cmdNumber: int, argument: str = '') -> int:
+    """
+    Executes a command defined in the project settings on the connected computer. 
+    This can be used, for example, to download firmware to the device or to execute specific programmes on the PC that are required for the test. 
+    See also chapter :doc:`flashFirmware`.
+    
+    :param cmdNumber: selects which command from project settings should be executed.
+    :type cmdNumber: int
+    :param argument: (optional) Sets the argument values for the command.
+    :type argument: str
+    
+    
+    :returns: The code returned by the command after its execution.
+    :return type: int
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        abortTestOnFailure(True)
+        enableDUTSupply()
+        await sleep(1.5)
+        res = await executeCommand(1)
+        report.checkBool("Download Firmware to the Device", res==0)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+async def getPwm(input: int, timeout: int) -> PWMResult:
+    """
+    Measures a PWM Signal on Pin IN7. Returns a ``PWMResult`` Object, which contains the ``frequency``, ``period``, ``onTime``, ``dutyCycle``
+    
+    :param input: Digital intput pin. Only IN7 can be used at the moment.
+    :type input: int
+    :param timeout: Timeout in milliseconds. The function will always record over the full timeout-Time. After timeout it will return. If there was no edges detected - you will get a dutyCycle of 100% or 0%, depending if the signal level was high or low.
+    :type timeout: int
+    
+    :returns: None on error. Otherwise a PWMResult object, containing measured ``frequency``, ``period``, ``onTime``, ``dutyCycle``
+    :return type: PWMResult or None
+    
+    **Example usage:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from testframework import *
+    
+        enableIOSupply(LEVEL_3V3)
+        pwmResult = await getPwm(IN7, 100)
+        report.checkValueTollerance("Check Frequency", pwmResult.frequency, 50.0, 0.2, "Hz", 1)
+        report.checkValueTollerance("Check On-Time", pwmResult.onTime, 1.5, 0.2, "ms", 1)
+        report.checkValueTollerance("Check duty cycle", pwmResult.dutyCycle, 7.5, 0.2, "%", 1)
+    """
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+
+def doCalibration():
+    """Autogenerated stub for doCalibration. The runtime implementation is only available on the CHECKBOX device."""
+    raise NotImplementedError(_RUNTIME_MESSAGE)
+
+__all__ = ['LOW', 'HIGH', 'RISING', 'FALLING', 'LEVEL_3V3', 'LEVEL_5V', 'REL1', 'REL2', 'AOUT1', 'AOUT2', 'AIN1', 'AIN2', 'AIN3', 'AIN4', 'AIN5', 'AIN6', 'AIN7', 'AIN8', 'OUT1', 'OUT2', 'OUT3', 'OUT4', 'OUT5', 'OUT6', 'OUT7', 'OUT8', 'OUT9', 'OUT10', 'OUT11', 'OUT12', 'IN1', 'IN2', 'IN3', 'IN4', 'IN5', 'IN6', 'IN7', 'IN8', 'IN9', 'IN10', 'IN11', 'IN12', 'PWMResult', 'setTestframeworkCoreReference', 'prepareTest', 'backToDefaults', 'abortTest', 'abortTestOnFailure', 'keepConfigurationAfterTest', 'enableIOSupply', 'disableIOSupply', 'enableExternalSupply', 'disableExternalSupply', 'enableDUTSupply', 'disableDUTSupply', 'enableRelais', 'disableRelais', 'getInputVoltage', 'setOutputVoltage', 'getInputs', 'isInputHigh', 'isInputLow', 'getInput', 'waitForLow', 'waitForHigh', 'setOutputLow', 'setOutputHigh', 'setOutputPWM', 'getDeviceTemperature', 'sleep_ms', 'sleep', 'getSerialNumber', 'getHWVersion', 'getSWVersion', 'getFrequency', 'getCurrent', 'convertADCToCurrent', 'getUserInputBool', 'getUserInputString', 'getUserInputInt', 'getUserInputFloat', 'getUserInputSerialNumber', 'showUserMessage', 'showProgressBar', 'updateProgressBar', 'hideProgressBar', 'executeCommand', 'getPwm', 'doCalibration']

emintes_testframework-0.1.0/src/testframework/testreport.py

@@ -0,0 +1,448 @@
+"""Autogenerated host-side stubs for the CHECKBOX testreport API."""
+
+from __future__ import annotations
+
+from typing import Any
+
+_RUNTIME_MESSAGE = "This package only provides autogenerated host-side stubs for the CHECKBOX MicroPython API."
+
+PASSED: int = True
+FAILED: int = False
+
+class ClassTestreport:
+    """Autogenerated placeholder for ClassTestreport."""
+    def setTestframeworkCoreReference(self, ref):
+        """Autogenerated stub for ClassTestreport.setTestframeworkCoreReference."""
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def handleStop(self):
+        """Autogenerated stub for ClassTestreport.handleStop."""
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def incPassed(self):
+        """Autogenerated stub for ClassTestreport.incPassed."""
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def incFailed(self):
+        """Autogenerated stub for ClassTestreport.incFailed."""
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def checkBool(self, description: str, value: bool, expected: bool = True):
+        """
+        Checks for a boolean result.
+        
+        :param description: Testdescription which will be placed in the report
+        :type description: string
+        :param value: The result value which should be checked
+        :type value: bool
+        :param expected: The expected value
+        :type expected: bool          
+        
+        Example usage:
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            sensorSignal = getInput(IN3)
+            report.checkBool("Is sensor damped?", sensorSignal == HIGH)
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def checkValueMinMax(self, description, value, min, max, unit = '', digits = 3):
+        """
+        Checks if a value is within given value range.
+        
+        :param description: Testdescription which will be placed in the report
+        :type description: string
+        :param value: Value which should be checked
+        :type value: int | float
+        :param min: Lower limit which is allowed (inclusive this value)
+        :type min: int | float
+        :param max: Upper limit which is allowed (inclusive this value)
+        :type max: int | float
+        :param unit: Unit of the value. This is just for the report. An empty string is allowed.
+        :type unit: string
+        :param digits: number of digits for the value if the value has type float (digits has no effect in case of integer value).
+        :type digits: int
+        
+        **Example usage:**
+        
+        This code checks if the supply voltage, measured at analog input 6, is between 3,25V and 3,35V
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            supplyVoltage = getInputVoltage(AIN6)
+            report.checkValueMinMax("Check supply voltage", supplyVoltage, 3.25, 3.35, "V")
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def checkValueMin(self, description, value, min, unit = '', digits = 3):
+        """
+        Checks if a value is higher or equal of the given min value.
+        
+        :param description: Testdescription which will be placed in the report
+        :type description: string
+        :param value: Value which should be checked
+        :type value: int | float
+        :param min: Lower limit which should the value have minimum (inclusive this value)
+        :type min: int | float
+        :param unit: Unit of the value. This is just for the report. An empty string is allowed.
+        :type unit: string
+        :param digits: number of digits for the value if the value has type float (digits has no effect in case of integer value).
+        :type digits: int
+        
+        **Example usage:**
+        
+        This code checks if the supply voltage, measured at analog input 6, is between 3,25V and 3,35V
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            supplyVoltage = getInputVoltage(AIN6)
+            report.checkValueMin("Check supply voltage", supplyVoltage, 3.25, "V")
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def checkValueMax(self, description, value, max, unit = '', digits = 3):
+        """
+        Checks if a value is lower or equal of the given max value.
+        
+        :param description: Testdescription which will be placed in the report
+        :type description: string
+        :param value: Value which should be checked
+        :type value: int | float
+        :param max: Upper limit which should the value have maximum (inclusive this value)
+        :type max: int | float
+        :param unit: Unit of the value. This is just for the report. An empty string is allowed.
+        :type unit: string
+        :param digits: number of digits for the value if the value has type float (digits has no effect in case of integer value).
+        :type digits: int
+        
+        **Example usage:**
+        
+        This code checks if the supply voltage, measured at analog input 6, is between 3,25V and 3,35V
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            supplyVoltage = getInputVoltage(AIN6)
+            report.checkValueMax("Check supply voltage", supplyVoltage, 3.5, "V")
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def checkValueTollerance(self, description, value, expected, tol, unit = '', digits = 3):
+        """
+        Checks if a value is within given value range.
+        
+        :param description: Testdescription which will be placed in the report
+        :type description: string
+        :param value: Value which should be checked
+        :type value: int | float
+        :param expected: This is the expected value
+        :type expected: int | float
+        :param tol: Accepted tolerance for the value (+/-)
+        :type tol: int | float
+        :param unit: Unit of the value. This is just for the report. An empty string is allowed.
+        :type unit: string
+        :param digits: number of digits for the value if the value has type float (digits has no effect in case of integer value).
+        :type digits: int
+        
+        **Example usage:**
+        
+        This code checks if the supply voltage, measured at analog input 6, is in the tolerance 3,3V +/- 0,05V
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            supplyVoltage = getInputVoltage(AIN6)
+            report.checkValueTollerance("Check supply voltage", supplyVoltage, 3.3, 0.05, "V")
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def checkValueTolleranceCircular(self, description, value, expected, tol, endValue, unit = '', digits = 3):
+        """
+        Checks if a value is within given tollerance on a circular value range (0 - ``endValue``).
+        For example: If you have an angle which is between 0° and 360° and you expect a target angle of 350° with a tollerance of 20°. 
+        With this function you can set the expected value to 350, tollerance to 20 and the ``endValue`` to 360. The tollerance range will than automatically wrap around 360°. 
+        So all values below or equal 10° will lead to a passed result and all values above or equal 330° will lead to a passed result.
+        All values outside the given circular range of 0 - ``endValue`` will lead into a failed result.
+        
+        :param description: Testdescription which will be placed in the report
+        :type description: string
+        :param value: Value which should be checked
+        :type value: int | float
+        :param expected: This is the expected value
+        :type expected: int | float
+        :param tol: Accepted tolerance for the value (+/-)
+        :type tol: int | float
+        :param maxValue: The value on which the range wrapes around.
+        :type maxValue: int | float
+        :param unit: Unit of the value. This is just for the report. An empty string is allowed.
+        :type unit: string
+        :param digits: number of digits for the value if the value has type float (digits has no effect in case of integer value).
+        :type digits: int
+        
+        **Example usage:**
+        
+        This code checks if the supply voltage, measured at analog input 6, is in the tolerance 3,3V +/- 0,05V
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            #ext.init()     #only neccessary if you run this code in debug console, outside of a testrun
+            rs485 = ext.getRS485(0)
+            modbus = ModbusMaster(rs485)
+        
+            values = await modbus.readInputRegisters(1, 9, 1)   #read the arm-position from slave-ID 1, modbus register 9
+            angle = values[0]
+            report.checkValueTolleranceCircular("Check if arm is on correct position.", angle, 350, 20, 360)
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def checkValue(self, description, value, expected, unit = ''):
+        """
+        Checks whether the value corresponds exactly to the expected value
+        
+        :param description: Testdescription which will be placed in the report
+        :type description: string
+        :param value: Value which should be checked
+        :type value: int | float
+        :param expected: This is the expected value
+        :type expected: int | float
+        :param unit: Unit of the value. This is just for the report. An empty string is allowed.
+        :type unit: string
+        
+        **Example usage:**
+        
+        This code checks if the checkbox has Hardware Version 1.
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            hwVersion = getHWVersion()
+            report.checkValue("Check Hardware Version", hwVersion, 1)
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def checkString(self, description, value, expected):
+        """
+        Checks if the given string equates to the given string.
+        
+        :param description: Testdescription which will be placed in the report
+        :type description: string
+        :param value: String which should be checked
+        :type value: string
+        :param expected: This is the expected string
+        :type expected: string
+        
+        **Example usage:**
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            uart1.init(9600)
+            uart1.send("Wakeup")
+            answer = uart1.readline()
+            report.checkString("Acknowledge received", answer, "ACK")
+        
+            #Hint: You can do the same check with the following function too:
+            report.checkBool("Acknowledge received", answer == "ACK")
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def checkStringStartsWith(self, description, value, expected):
+        """
+        Checks if the given string starts with the expected string.
+        
+        :param description: Testdescription which will be placed in the report
+        :type description: string
+        :param value: String which should be checked
+        :type value: string
+        :param expected: This is the expected string
+        :type expected: string
+        
+        **Example usage:**
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            uart1.init(9600)
+            uart1.send("Wakeup")
+            answer = uart1.readline()
+            report.checkStringStartsWith("Acknowledge received", answer, "ACK")
+        
+            #Hint: You can do the same check with the following function too:
+            report.checkBool("Acknowledge received", answer == "ACK")
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def checkStringContains(self, description, value, expected):
+        """
+        Checks if the given string contains the expected string.
+        
+        :param description: Testdescription which will be placed in the report
+        :type description: string
+        :param value: String which should be checked
+        :type value: string
+        :param expected: This is the expected string
+        :type expected: string
+        
+        **Example usage:**
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            uart1.init(9600)
+            uart1.send("Wakeup")
+            answer = uart1.readline()
+            report.checkStringContains("Acknowledge received", answer, "ACK")
+        
+            #Hint: You can do the same check with the following function too:
+            report.checkBool("Acknowledge received", answer == "ACK")
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def putInfoValue(self, description, value, unit = '', digits = 3):
+        """
+        Enters an 'info only' value to the testreport.
+        
+        :param description: Description which will be placed in the report
+        :type description: string
+        :param value: value for the report
+        :type value: int | float | string
+        :param unit: Unit of the value (only for int and float values). This is just for the report. An empty string is allowed.
+        :type unit: string
+        :param digits: Number of digits for the value if the value has type float (digits has no effect in case of integer value).
+        :type unit: int            
+        
+        **Example usage:**
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            devTemp = getDeviceTemperature()
+            report.putInfoValue("Device temperature", "%.1f" %devTemp)
+        
+        .. warning::
+            Unfortunately at the moment the Testbox does not support special characters. So it is not possible to use "°C" as unit in the report.
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def putInfo(self, description):
+        """
+        Enters an 'info only' entry to the testreport.
+        
+        :param description: Description which will be placed in the report
+        :type description: string
+        
+        **Example usage:**
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            devTemp = getDeviceTemperature()
+            report.info("All answers received")
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def putPassed(self, description):
+        """
+        Inserts a passed result without any values into the testreport.
+        
+        With both functions :func:`~testreport.ClassTestreport.putPassed` and :func:`~testreport.ClassTestreport.putFailed` you can do your own test inspection.
+        
+        :param description: Description which will be placed in the report
+        :type description: string
+        
+        **Example usage:**
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            report.putPassed("Answer received")
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def putFailed(self, description):
+        """See :func:`~testreport.ClassTestreport.putPassed`"""
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def putPassedFailed(self, description, result):
+        """
+        Inserts a passed or failed result without any values into the testreport.
+        
+        With this function you can do a quick check if somethin went wrong.
+        
+        :param description: Description which will be placed in the report
+        :type description: string
+        :param result: ``True`` a *PASSED* result will put into the testreport. ``False`` a *FAILED* result will put into the testreport.
+        :type description: bool        
+        
+        **Example usage:**
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            val = await modbus.readDiscreteInputs(1,0,6)
+            report.putPassedFailed("Answer received", val!=None)
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def appendTrace(self, description, trace):
+        """
+        Inserts a trace at the end of the report.
+        
+        :param description: Description which will be used as title of the diagram.
+        :type description: string
+        :param trace: trace object which should be printed
+        :type trace: Trace        
+        
+        **Example usage:**
+        
+        .. highlight:: python
+        .. code-block:: python
+        
+            from testframework import *
+        
+            data = trace.TraceData(IN1,1000)
+            trace.start(data,1000)
+        
+            report.appendTrace("Analog Signal", data)
+        """
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+
+    def abortTest(self, msg):
+        """Autogenerated stub for ClassTestreport.abortTest."""
+        raise NotImplementedError(_RUNTIME_MESSAGE)
+report: ClassTestreport = ClassTestreport()
+
+__all__ = ['PASSED', 'FAILED', 'ClassTestreport', 'report']