scpi_helper.h File Reference

SCPI helper header file. More...

#include "config.h"
#include "scpi_parser.h"

Include dependency graph for scpi_helper.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_SCPI_choice_def_t
	Defines a structure for SCPI choice options. More...

Typedefs
typedef struct _SCPI_choice_def_t	SCPI_choice_def_t

Functions
uint8_t	ScpiParamString (SCPI_P &parameters, String &param)
	Extracts a string parameter from the SCPI parameter list.
uint8_t	ScpiParamUInt8 (SCPI_P &parameters, uint8_t &param)
	Extracts an unsigned 8-bit integer parameter from the SCPI parameter list.
uint8_t	ScpiParamUInt32 (SCPI_P &parameters, uint32_t &param)
	Extracts an unsigned 32-bit integer parameter from the SCPI parameter list.
uint8_t	ScpiParamDouble (SCPI_P &parameters, double &param)
	Extracts a double-precision floating-point parameter from the SCPI parameter list.
uint8_t	ScpiParamBool (SCPI_P &parameters, bool &param)
	Extracts a boolean parameter ('ON', '1', 'OFF', or '0') from the SCPI parameter list.
uint8_t	ScpiParamInt8 (SCPI_P &parameters, int8_t &param)
uint8_t	ScpiParamChoice (SCPI_P &parameters, const SCPI_choice_def_t *options, size_t optionsSize, uint8_t &param)
	Extracts a choice parameter from the SCPI parameter list and maps it to a numerical tag.
uint8_t	ScpiChoiceToName (const SCPI_choice_def_t *options, size_t optionsSize, int8_t value, String &name)
	Converts a numerical choice tag back to its string representation.

Detailed Description

SCPI helper header file.

This header file declares a set of helper functions designed to simplify the process of extracting and converting parameters from the SCPI parser and mapping choice values to their string representations. These functions are intended to be used in the implementation of SCPI commands.

Author

Nexperia: http://www.nexperia.com

Support Page

For additional support, visit: https://www.nexperia.com/support

Author

Aanas Sayed

Date

2025/04/21

Definition in file scpi_helper.h.

Function Documentation

ScpiChoiceToName()

uint8_t ScpiChoiceToName	(	const SCPI_choice_def_t *	options,
		size_t	optionsSize,
		int8_t	value,
		String &	name )

Converts a numerical choice tag back to its string representation.

This function iterates through the provided list of valid choices and compares the input numerical tag with the tag of each choice. If a match is found, the stem and suffix of the corresponding choice are concatenated and stored in the output string.

Parameters

options	A pointer to an array of SCPI_choice_def_t structures defining the valid choices.
optionsSize	The number of elements in the options array.
value	The numerical tag to convert to a string.
name	A reference to a String variable where the string representation of the tag will be stored.

Returns

1 if a matching choice was found and its name was stored in name, 0 otherwise (if no matching tag is found).

Definition at line 172 of file scpi_helper.cpp.

{
    for (size_t i = 0; i < optionsSize; i++)
    {
        if (options[i].tag == value)
        {
            name = options[i].stem + options[i].suffix;
            return TRUE;
        }
    }
    return FALSE;
}

Here is the caller graph for this function:

ScpiParamBool()

uint8_t ScpiParamBool	(	SCPI_P &	parameters,
		bool &	param )

Extracts a boolean parameter ('ON', '1', 'OFF', or '0') from the SCPI parameter list.

This function checks if there are any parameters available. If so, it pops the last parameter from the list, converts it to uppercase, and checks if it matches "ON", "1" (for true) or "OFF", "0" (for false).

Parameters

parameters	A reference to the SCPI parameter list.
param	A reference to a bool variable where the extracted parameter will be stored.

Returns

1 if a valid boolean parameter was successfully extracted, 0 otherwise (if no parameters are available or the parameter is invalid).

Definition at line 109 of file scpi_helper.cpp.

{
    if (parameters.Size() == 0)
        return FALSE;
    String rawParam = String(parameters.Pop());
    rawParam.toUpperCase();
 
    if (rawParam == "ON" || rawParam == "1")
        param = TRUE;
    else if (rawParam == "OFF" || rawParam == "0")
        param = FALSE;
    else
        return FALSE;
    return TRUE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ScpiParamChoice()

uint8_t ScpiParamChoice	(	SCPI_P &	parameters,
		const SCPI_choice_def_t *	options,
		size_t	optionsSize,
		uint8_t &	param )

Extracts a choice parameter from the SCPI parameter list and maps it to a numerical tag.

This function first extracts a string parameter. If successful, it iterates through the provided list of valid choices and compares the extracted string (case-insensitively) with the stem or the full stem and suffix of each choice. If a match is found, the corresponding numerical tag is stored in the output parameter.

Parameters

parameters	A reference to the SCPI parameter list.
options	A pointer to an array of SCPI_choice_def_t structures defining the valid choices.
optionsSize	The number of elements in the options array.
param	A reference to a uint8_t variable where the numerical tag of the matched choice will be stored.

Returns

1 if a valid choice parameter was found and its tag was extracted, 0 otherwise (if no parameters are available or no match is found).

Definition at line 139 of file scpi_helper.cpp.

{
    String paramStr;
    uint8_t result = ScpiParamString(parameters, paramStr);
    if (result)
    {
        // Check if the parsed string matches any of the valid choices
        for (size_t i = 0; i < optionsSize; i++)
        {
            if (paramStr.equalsIgnoreCase(options[i].stem) || paramStr.equalsIgnoreCase(options[i].stem + options[i].suffix))
            {
                param = options[i].tag;
                return TRUE;
            }
        }
    }
    return FALSE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ScpiParamDouble()

uint8_t ScpiParamDouble	(	SCPI_P &	parameters,
		double &	param )

Extracts a double-precision floating-point parameter from the SCPI parameter list.

This function checks if there are any parameters available. If so, it pops the last parameter from the list and converts it to a double.

Parameters

parameters	A reference to the SCPI parameter list.
param	A reference to a double variable where the extracted parameter will be stored.

Returns

1 if a double-precision floating-point parameter was successfully extracted, 0 otherwise (if no parameters are available).

Definition at line 90 of file scpi_helper.cpp.

{
    if (parameters.Size() == 0)
        return FALSE;
    param = String(parameters.Pop()).toDouble();
    return TRUE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ScpiParamString()

uint8_t ScpiParamString	(	SCPI_P &	parameters,
		String &	param )

Extracts a string parameter from the SCPI parameter list.

This function checks if there are any parameters available. If so, it pops the last parameter from the list and converts it to a String.

Parameters

parameters	A reference to the SCPI parameter list.
param	A reference to a String variable where the extracted parameter will be stored.

Returns

1 if a string parameter was successfully extracted, 0 otherwise (if no parameters are available).

Definition at line 36 of file scpi_helper.cpp.

{
    if (parameters.Size() == 0)
        return FALSE;
    param = String(parameters.Pop());
    return TRUE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ScpiParamUInt32()

uint8_t ScpiParamUInt32	(	SCPI_P &	parameters,
		uint32_t &	param )

Extracts an unsigned 32-bit integer parameter from the SCPI parameter list.

This function checks if there are any parameters available. If so, it pops the last parameter from the list and converts it to an unsigned 32-bit integer.

Parameters

parameters	A reference to the SCPI parameter list.
param	A reference to a uint32_t variable where the extracted parameter will be stored.

Returns

1 if an unsigned 32-bit integer parameter was successfully extracted, 0 otherwise (if no parameters are available).

Definition at line 72 of file scpi_helper.cpp.

{
    if (parameters.Size() == 0)
        return FALSE;
    param = String(parameters.Pop()).toInt();
    return TRUE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ScpiParamUInt8()

uint8_t ScpiParamUInt8	(	SCPI_P &	parameters,
		uint8_t &	param )

Extracts an unsigned 8-bit integer parameter from the SCPI parameter list.

This function checks if there are any parameters available. If so, it pops the last parameter from the list and converts it to an unsigned 8-bit integer.

Parameters

parameters	A reference to the SCPI parameter list.
param	A reference to a uint8_t variable where the extracted parameter will be stored.

Returns

1 if an unsigned 8-bit integer parameter was successfully extracted, 0 otherwise (if no parameters are available).

Definition at line 54 of file scpi_helper.cpp.

{
    if (parameters.Size() == 0)
        return FALSE;
    param = String(parameters.Pop()).toInt();
    return TRUE;
}

Here is the call graph for this function: