nibcq.errors.SMUParameterError
==============================

.. py:exception:: nibcq.errors.SMUParameterError(message: str = 'SMU Parameters are set incorrectly.')

   Bases: :py:obj:`BCQError`


   Exception raised when some parameter related to the SMU is incorrect.

   These, for example, can show that voltage or current limits are incorrect or exceeded
   or that some pre-required steps are not done yet on the SMU's workflow.

   :param message: Custom error message. Defaults to a standard message.
   :type message: str, optional

   .. rubric:: Examples

   The following are examples of how this error can be raised:

   - **General: Incorrect Parameter**

       >>> raise SMUParameterError("SMU Parameters are set incorrectly.")

   - **Specific: Measurement not finished before wanting to access it**

       >>> raise SMUParameterError("SMU Measurement is not available.")

   - **Specific: Voltage limit exceeded**

       >>> raise SMUParameterError(
       >>>     f"Voltage limit {voltage_limit_hi} V exceeds
       >>>     the allowed maximum of {max_voltage} V."
       >>> )