Motor Driver Evaluation Kit NEVB-MTR1-t01-1.1.0
Firmware for NEVB-MTR1-KIT1 for trapezoidal control of BLDC motors using Hall-effect sensors
Loading...
Searching...
No Matches
scpi_config.h File Reference

SCPI parser configuration header file. More...

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

Go to the source code of this file.

Macros

#define SCPI_MAX_TOKENS   20
 Maximum number of valid SCPI tokens (keywords) that the parser can recognize.
 
#define SCPI_MAX_COMMANDS   20
 Maximum number of distinct SCPI commands that can be registered with the parser.
 
#define SCPI_MAX_SPECIAL_COMMANDS   0
 Maximum number of special SCPI commands (without parameters) that can be registered.
 
#define SCPI_BUFFER_LENGTH   64
 Length of the buffer used to store incoming SCPI messages from the communication interface.
 
#define SCPI_ARRAY_SYZE   6
 Maximum branch size of the command tree and the maximum number of parameters that can be parsed from a command.
 
#define SCPI_HASH_TYPE   uint8_t
 Integer data type used for calculating and storing command hash codes.
 
#define SCPI_IDN_MANUFACTURER   "NEXPERIA"
 Manufacturer identification string for the *IDN? command.
 
#define SCPI_IDN_MODEL   "NEVB-MTR1-xx"
 Model number identification string for the *IDN? command.
 
#define SCPI_IDN_DEFAULT_SERIAL   ""
 Revision level identification string for the *IDN? command (optional).
 
#define SCPI_IDN_FIRMWARE_VERSION   "NEVC-MTR1-t01-1.1.0"
 Firmware version identification string for the *IDN? command.
 
#define SCPI_CMD_TERM   "\n"
 Command termination character used to identify the end of a SCPI command.
 

Detailed Description

SCPI parser configuration header file.

Header file for SCPI parser configuration.

This header file defines various configuration constants for the SCPI parser library. These constants control the sizes of internal buffers and arrays, the maximum number of supported tokens and commands, and the data type used for command hashing. Users can modify these definitions to adjust the parser's capabilities and memory usage according to their specific application requirements.

Author
Nexperia: http://www.nexperia.com
Support Page
For additional support, visit: https://www.nexperia.com/support
Author
Aanas Sayed
Date
2025/04/21


This header file defines various configuration constants for the SCPI parser library. These constants control the sizes of internal buffers and arrays, the maximum number of supported tokens and commands, and the data type used for command hashing. Users can modify these definitions to adjust the parser's capabilities and memory usage according to their specific application requirements.

Definition in file scpi_config.h.

Macro Definition Documentation

◆ SCPI_ARRAY_SYZE

#define SCPI_ARRAY_SYZE   6

Maximum branch size of the command tree and the maximum number of parameters that can be parsed from a command.

This constant serves two purposes: it limits the depth of the hierarchical command tree that can be defined using the SetCommandTreeBase function, and it also limits the maximum number of parameters that the parser will attempt to extract from a received command. Default value is 6.

Definition at line 94 of file scpi_config.h.

◆ SCPI_BUFFER_LENGTH

#define SCPI_BUFFER_LENGTH   64

Length of the buffer used to store incoming SCPI messages from the communication interface.

This constant determines the maximum size of a single SCPI message that the parser can receive and process. Messages exceeding this length will be truncated, and a buffer overflow error will be triggered. Adjusting this value should be based on the expected length of the SCPI commands used by the instrument. Default value is 64 bytes.

Definition at line 83 of file scpi_config.h.

◆ SCPI_CMD_TERM

#define SCPI_CMD_TERM   "\n"

Command termination character used to identify the end of a SCPI command.

This constant defines the character that signifies the end of a SCPI command in the input stream. The parser uses this character to determine when a complete command has been received and is ready for processing. Default value is "\n" (newline character).

Definition at line 155 of file scpi_config.h.

◆ SCPI_HASH_TYPE

#define SCPI_HASH_TYPE   uint8_t

Integer data type used for calculating and storing command hash codes.

This constant defines the underlying integer type used for the hash values generated for registered SCPI commands. The size of this data type affects the range of possible hash values and thus the likelihood of hash collisions. Common choices include uint8_t, uint16_t, or uint32_t. Default value is uint8_t.

Definition at line 105 of file scpi_config.h.

◆ SCPI_IDN_DEFAULT_SERIAL

#define SCPI_IDN_DEFAULT_SERIAL   ""

Revision level identification string for the *IDN? command (optional).

This constant defines the third field of the identification string returned by the standard SCPI *IDN? command. It is often left empty if no specific revision information is needed. Default value is "".

Definition at line 134 of file scpi_config.h.

◆ SCPI_IDN_FIRMWARE_VERSION

#define SCPI_IDN_FIRMWARE_VERSION   "NEVC-MTR1-t01-1.1.0"

Firmware version identification string for the *IDN? command.

This constant defines the fourth field of the identification string returned by the standard SCPI *IDN? command, typically representing the firmware version. Default value is "NEVC-MTR1-t01-1.0.0".

Definition at line 144 of file scpi_config.h.

◆ SCPI_IDN_MANUFACTURER

#define SCPI_IDN_MANUFACTURER   "NEXPERIA"

Manufacturer identification string for the *IDN? command.

This constant defines the first field of the identification string returned by the standard SCPI *IDN? command. Default value is "NEXPERIA".

Definition at line 115 of file scpi_config.h.

◆ SCPI_IDN_MODEL

#define SCPI_IDN_MODEL   "NEVB-MTR1-xx"

Model number identification string for the *IDN? command.

This constant defines the second field of the identification string returned by the standard SCPI *IDN? command. Default value is "NEVB-MTR1-xx".

Definition at line 124 of file scpi_config.h.

◆ SCPI_MAX_COMMANDS

#define SCPI_MAX_COMMANDS   20

Maximum number of distinct SCPI commands that can be registered with the parser.

This constant defines the capacity of the internal storage for registered command hash codes and their associated callback functions. Increasing this value allows the parser to handle a larger set of unique SCPI commands, but also increases memory usage. Default value is 20.

Definition at line 60 of file scpi_config.h.

◆ SCPI_MAX_SPECIAL_COMMANDS

#define SCPI_MAX_SPECIAL_COMMANDS   0

Maximum number of special SCPI commands (without parameters) that can be registered.

This constant defines the capacity of the internal storage for registered special command hash codes and their associated callback functions. Special commands are typically used for actions or queries that do not require parameters. Setting this value to 0 disables the support for special commands, which can save memory if not needed. Default value is 0.

Definition at line 72 of file scpi_config.h.

◆ SCPI_MAX_TOKENS

#define SCPI_MAX_TOKENS   20

Maximum number of valid SCPI tokens (keywords) that the parser can recognize.

This constant determines the size of the internal storage for unique command tokens extracted from registered commands. Increasing this value allows for more complex command structures with a larger vocabulary of keywords, but also increases memory usage. Default value is 20.

Definition at line 49 of file scpi_config.h.