scpi.h File Reference

SCPI implementation header file. More...

#include "scpi_helper.h"
#include "config.h"

Include dependency graph for scpi.h:

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

Go to the source code of this file.

Macros
#define	MOTOR_DIRECTION_OPTIONS   2
	Motor direction options array.
#define	INPUT_SOURCE_OPTIONS   2
	Motor direction options array.

Functions
void	ScpiInit (void)
	Initializes the SCPI command parser and registers all supported commands.
void	ScpiInput (Stream &interface)
	Processes incoming data from a serial interface for SCPI commands.

Variables
const SCPI_choice_def_t	motorDirections [2]
	Number of motor direction options.
const SCPI_choice_def_t	inputSources [2]
	Number of speed input source options.
SCPI_Parser	scpiParser
	Speed input source options array.

Detailed Description

SCPI implementation header file.

This file contains the command definitions for the SCPI parser to recognize and execute.

Most of this code was originally written by Diego González Chávez as part of the Vrekrer SCPI Parser project.

It has been merged into the main codebase for customization and linking limitations of the Arduino IDE.

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.h.

Macro Definition Documentation

INPUT_SOURCE_OPTIONS

#define INPUT_SOURCE_OPTIONS   2

Motor direction options array.

Definition at line 39 of file scpi.h.

MOTOR_DIRECTION_OPTIONS

#define MOTOR_DIRECTION_OPTIONS   2

Motor direction options array.

Definition at line 35 of file scpi.h.

Function Documentation

ScpiInit()

void ScpiInit

(

void

)

Initializes the SCPI command parser and registers all supported commands.

This function sets up the SCPI parser instance and registers the core IEEE mandated commands, required SCPI commands, and the custom motor control and measurement commands.

Definition at line 71 of file scpi.cpp.

{
    /* IEEE Mandated Commands (SCPI std V1999.0 4.1.1) */
    // "*CLS" and "*RST" are not supported
    scpiParser.RegisterCommand(F("*IDN?"), &ScpiCoreIdnQ);
 
    /* Required SCPI commands (SCPI std V1999.0 4.2.1) */
    // "SYSTem:VERSion?" and "SYSTem:ERRor:NEXT?" are not supported
    scpiParser.SetCommandTreeBase(F("SYSTem"));
    scpiParser.RegisterCommand(F(":ERRor?"), &ScpiSystemErrorNextQ);
    scpiParser.RegisterCommand(F(":ERRor:COUNt?"), &ScpiSystemErrorCountQ);
 
    /* Motor Configuration Commands */
    scpiParser.SetCommandTreeBase(F("CONFigure"));
    scpiParser.RegisterCommand(F(":ENABle"), &ConfigureMotorEnable);
    scpiParser.RegisterCommand(F(":ENABle?"), &GetMotorEnable);
#if (SPEED_CONTROL_METHOD == SPEED_CONTROL_OPEN_LOOP)
    scpiParser.RegisterCommand(F(":DUTYcycle:SOURce"), &ConfigureMotorDutyCycleSource);
    scpiParser.RegisterCommand(F(":DUTYcycle:SOURce?"), &GetConfigureMotorDutyCycleSource);
    scpiParser.RegisterCommand(F(":DUTYcycle"), &ConfigureMotorDutyCycle);
#else
    scpiParser.RegisterCommand(F(":SPEED:SOURce"), &ConfigureMotorSpeedSource);
    scpiParser.RegisterCommand(F(":SPEED:SOURce?"), &GetMotorSpeedSource);
    scpiParser.RegisterCommand(F(":SPEED"), &ConfigureMotorSpeed);
#endif
    scpiParser.RegisterCommand(F(":FREQuency"), &ConfigureMotorFrequency);
    scpiParser.RegisterCommand(F(":FREQuency?"), &GetConfigureMotorFrequency);
    scpiParser.RegisterCommand(F(":DIREction"), &ConfigureMotorDirection);
    scpiParser.RegisterCommand(F(":DIREction?"), &GetConfigureMotorDirection);
 
    /* Motor Measurement Commands */
    scpiParser.SetCommandTreeBase(F("MEASure"));
    scpiParser.RegisterCommand(F(":SPEEd?"), &MeasureMotorSpeed);
    scpiParser.RegisterCommand(F(":CURRent:IBUS?"), &MeasureMotorCurrentVBus);
    scpiParser.RegisterCommand(F(":CURRent:IPHU?"), &MeasureMotorCurrentPhaseU);
    scpiParser.RegisterCommand(F(":CURRent:IPHV?"), &MeasureMotorCurrentPhaseV);
    scpiParser.RegisterCommand(F(":CURRent:IPHW?"), &MeasureMotorCurrentPhaseW);
    scpiParser.RegisterCommand(F(":VOLTage?"), &MeasureMotorVoltage);
    scpiParser.RegisterCommand(F(":DIREction?"), &MeasureMotorDirection);
    scpiParser.RegisterCommand(F(":DUTYcycle?"), &MeasureGateDutyCycle);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ScpiInput()

void ScpiInput

(

Stream &

interface

)

Processes incoming data from a serial interface for SCPI commands.

This function takes a Stream object (like Serial) and processes any received data, looking for complete SCPI commands terminated by a newline character. It then passes the command to the SCPI parser for execution.

Parameters

interface

The serial stream interface to read commands from.

Definition at line 122 of file scpi.cpp.

{
    scpiParser.ProcessInput(interface, SCPI_CMD_TERM);
}

Here is the caller graph for this function:

Variable Documentation

inputSources

const SCPI_choice_def_t inputSources[2]

extern

Number of speed input source options.

Number of speed input source options.

This array is used by the SCPI parser to interpret and represent the source of the motor's speed or duty cycle control ('LOCA' for local, 'REMO' for remote). Each entry associates a textual representation with a numerical value (e.g., SPEED_INPUT_SOURCE_LOCAL, SPEED_INPUT_SOURCE_REMOTE).

Definition at line 665 of file scpi.cpp.

                                                             {
    {"LOCA", "l", SPEED_INPUT_SOURCE_LOCAL},
    {"REMO", "te", SPEED_INPUT_SOURCE_REMOTE},
};

motorDirections

const SCPI_choice_def_t motorDirections[2]

extern

Number of motor direction options.

Number of motor direction options.

This array is used by the SCPI parser to interpret and represent the motor's direction ('FORW' for forward, 'REVE' for reverse). Each entry in the array associates a textual representation with a numerical value defined elsewhere (e.g., DIRECTION_FORWARD, DIRECTION_REVERSE).

Definition at line 652 of file scpi.cpp.

                                                                   {
    {"FORW", "ard", DIRECTION_FORWARD},
    {"REVE", "rse", DIRECTION_REVERSE},
};

scpiParser

SCPI_Parser scpiParser

extern

Speed input source options array.

Definition at line 62 of file scpi.cpp.