scpi_types.h File Reference

SCPI types header file. More...

#include <Arduino.h>
#include "scpi_config.h"

Include dependency graph for scpi_types.h:

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

Go to the source code of this file.

Classes
class	SCPI_String_Array
	Variable size string array class. More...
class	SCPI_Commands
	Stores parsed command tokens. More...
class	SCPI_Parameters
	Stores parsed command parameters. More...

Typedefs
using	SCPI_C = SCPI_Commands
	Alias for SCPI_Commands.
using	SCPI_P = SCPI_Parameters
	Alias for SCPI_Parameters.
using	scpi_hash_t = uint8_t
	Alias for SCPI integer hash type defined in SCPI_HASH_TYPE.

Enumerations
enum class	ErrorCode {   NoError = 0 , UnknownCommand , Timeout , BufferOverflow ,   MissingOrInvalidParameter }
	SCPI Error codes. More...

Detailed Description

SCPI types header file.

This file contains the declaration of helper classes used for SCPI command parsing, including string array management and tokenization of command and parameter messages.

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

Typedef Documentation

SCPI_C

using SCPI_C = SCPI_Commands

Alias for SCPI_Commands.

Definition at line 102 of file scpi_types.h.

scpi_hash_t

using scpi_hash_t = uint8_t

Alias for SCPI integer hash type defined in SCPI_HASH_TYPE.

Definition at line 110 of file scpi_types.h.

SCPI_P

using SCPI_P = SCPI_Parameters

Alias for SCPI_Parameters.

Definition at line 106 of file scpi_types.h.

Enumeration Type Documentation

ErrorCode

enum class ErrorCode

strong

SCPI Error codes.

Represents possible error conditions that can occur during SCPI message parsing or execution.

Enumerator
NoError	No error occurred.
UnknownCommand	An unknown command was received that could not be matched to a known handler.
Timeout	A timeout occurred before receiving the expected termination characters.
BufferOverflow	The message buffer was exceeded during message reception.
MissingOrInvalidParameter	A required parameter was missing or an invalid parameter was provided.

Definition at line 117 of file scpi_types.h.

{
  NoError = 0,

  UnknownCommand,

  Timeout,

  BufferOverflow,

  MissingOrInvalidParameter,
};