c3

sola.lu

2025-04-11 e0ba90babd928f210bd2cfa0ff513569e686d0e2

 README.md

@@ -1,156 +1,61 @@
SCPI parser library
SCPI parser library v2
===========

[SCPI](http://en.wikipedia.org/wiki/Standard_Commands_for_Programmable_Instruments) Parser library aims to provide parsing ability of SCPI commands on instrument side. All commands are defined by its patterns eg: "STATus:QUEStionable:EVENt?".
![Build status](https://github.com/j123b567/scpi-parser/actions/workflows/main.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/j123b567/scpi-parser/badge.svg?branch=master&service=github)](https://coveralls.io/github/j123b567/scpi-parser?branch=master)

Source codes are published with open source Simplified BSD license.
Documentation
--------
Documentation is available at [http://j123b567.github.io/scpi-parser](http://j123b567.github.io/scpi-parser).

Command pattern definition
-----------
Command pattern is defined by well known representation from SCPI instruments. Pattern is case insensitive but uses lower and upper case letters to show short and long form of the command.
Examples
--------
Library contains several [examples](https://github.com/j123b567/scpi-parser/tree/master/examples) of usage but please note, that this code is just for educational purpose and not production ready.
Examples are from several contributors and they are not tested and it is also not known, if they really work or can compile at all.

    Pattern "SYSTem" matches strings "SYST", "syst", "SyStEm", "system", ...
The core library itself is well tested and has more then 93% of the code covered by unit tests and integration tests and tries to be SCPI-99 compliant as much as possible.

Command pattern is devided by colon ":" to show command hierarchy
About
--------

    Pattern "SYSTem:VERsion?" mathes strings "SYST:version?", "system:ver?", "SYST:VER?", ...
[SCPI](http://en.wikipedia.org/wiki/Standard_Commands_for_Programmable_Instruments) Parser library aims to provide parsing ability of SCPI commands on **instrument side**. All commands are defined by its patterns eg: `"STATus:QUEStionable:EVENt?"`.

SCPI standard also uses brackets "[]" to define unnecesery parts of command. This behaviour is not implemented yet.
Source codes are published with open source BSD 2-Clause License.

    Pattern "SYSTem:ERRor[:NEXT]?" should match "SYST:ERR?", "system:err?" and also "system:error:next?", ...
SCPI parser library is based on these standards

In current implementation, you should write two patterns to implement this behaviour

    Pattern "SYSTem:ERRor?" and "SYSTem:ERRor:NEXT?"
* [SCPI-99](https://www.ivifoundation.org/downloads/SCPI/scpi-99.pdf)
* [IEEE 488.2-2004](http://dx.doi.org/10.1109/IEEESTD.2004.95390)


Command callback
-----------
Command callbac is defined as function with context parameter, e.g.:

    int DMM_MeasureVoltageDcQ(scpi_context_t * context)

The "Q" at the end of the function name indicates, that this function is Query function (command with "?").

The command callback can use predefined function to parse input parameters and to write output.

Reading input parameter is done by functions "SCPI_ParamInt", "SCPI_ParamDouble", "SCPI_ParamString".

Writing output is done by functions "SCPI_ResultInt", "SCPI_ResultDouble", "SCPI_ResultString", "SCPI_ResultText". You can write multiple output variables. They are automaticcaly separated by coma ",".

Source code organisation
------------

Source codes are devided into few files to provide better portability to other systems.

- *scpi_parser.c* - provides the core parser library
- *scpi_error.c* - provides basic error handling (error queue of the instrument)
- *scpi_ieee488.c* - provides basic implementation of IEEE488.2 mandatory commands
- *scpi_minimal.c* - provides basic implementation of SCPI mandatory commands
- *scpi_utils.c* - provides string handling routines and conversion routines
- *scpi_units.c* - provides handling of special numners (DEF, MIN, MAX, ...) and units
- *scpi_fifo.c* - provides basic implementation of error queue FIFO
- *scpi_debug.c* - provides debug functions

- *test-parser.c* - is the basic non-interactive demo of the parser

Implementation to your instrument
-------------
First of all you need to fill structure of SCPI command definitions
	
   scpi_command_t scpi_commands[] = {
      { .pattern = "*IDN?", .callback = SCPI_CoreIdnQ,},
      { .pattern = "*RST", .callback = SCPI_CoreRst,},
      { .pattern = "MEASure:VOLTage:DC?", .callback = DMM_MeasureVoltageDcQ,},
      SCPI_CMD_LIST_END
   };

Than you need to initialize interface callbacks structure. If you don't want to provide some callbacks, just initialize it as NULL. write callback is mandatory and is used to output data from the library.

   scpi_interface_t scpi_interface = {
      .write = myWrite,
      .error = NULL,
      .reset = NULL,
      .test = NULL,
      .srq = NULL,
   };

Important thing is command buffer. Maximum size is up to you and it should be larger than any possible largest command. 

   #define SCPI_INPUT_BUFFER_LENGTH 256
   static char scpi_input_buffer[SCPI_INPUT_BUFFER_LENGTH];
**SCPI version compliance**
<table>
<tr><td>SCPI version<td>v1999.0</tr>
</table>


The last structure is scpi context used in parser library.
**Supported command patterns**
<table>
<tr><th>Feature<th>Pattern example</tr>
<tr><td>Short and long form<td><code>MEASure</code> means <code>MEAS</code> or <code>MEASURE</code> command</tr>
<tr><td>Common command<td><code>*CLS</code></td>
<tr><td>Compound command<td><code>CONFigure:VOLTage</code><tr>
<tr><td>Query command<td><code>MEASure:VOLTage?</code>, <code>*IDN?</code></tr>
<tr><td>Optional keywords<td><code>MEASure:VOLTage[:DC]?</code></tr>
<tr><td>Numeric keyword suffix<br>Multiple identical capabilities<td><code>OUTput#:FREQuency</code></tr>
</table>

   scpi_t scpi_context = {
      .cmdlist = scpi_commands,
      .buffer = {
         .length = SCPI_INPUT_BUFFER_LENGTH,
         .data = scpi_input_buffer,
      },
      .interface = &scpi_interface,
      .registers = scpi_regs,
      .units = scpi_units_def,
      .special_numbers = scpi_special_numbers_def,
   };

All these structures should be global variables of the c file or allocated by function like malloc. It is common mistake to create these structures inside a function as local variables of this function. This will not work. If you don't know why, you should read something about [function stack.](http://stackoverflow.com/questions/4824342/returning-a-local-variable-from-function-in-c).


Now we are ready to initialize SCPI context. It is possible to use more SCPI contexts and share some configurations (command list, registers, units list, error callback...)

   SCPI_Init(&scpi_context);

Test implementation of function myWrite, which outputs everything to stdout, can be
	
   size_t myWrite(scpi_context_t * context, const char * data, size_t len) {
      (void) context;
      return fwrite(data, 1, len, stdout);
   }

Interactive demo can beimplemented using this loop

   #define SMALL_BUFFER_LEN
   char smbuffer[SMALL_BUFFER_LEN];
   while(1) {
      fgets(smbuffer, SMALL_BUFFER_LEN, stdin);
      SCPI_Input(&scpi_context, smbuffer, strlen(smbuffer));
   }



Implementation of command callback
-------------

Command callback is defined as function with result of type scpi_result_t and one parameter - scpi context
   scpi_result_t DMM_MeasureVoltageDcQ(scpi_t * context)

Command callback should return SCPI_RES_OK if everything goes well.

You can read command parameters and write command results. There are several functions to do this.

Every time, you call function to read parameter, it shifts pointers to the next parameter. You can't read specified parameter directly by its index - e.g. 
   // pseudocode
   param3 = read_param(3); // this is not possible

   read_param();           // discard first parameter
   read_param();           // discard second parameter
   param3 = read_param();  // read third parameter

If you discard some parameters, there is no way to recover them.

These are the functions, you can use to read parameters
 - SCPI_ParamInt - read signed 32bit integer value (dec or hex with 0x prefix)
 - SCPI_ParamDouble - read double value
 - SCPI_ParamNumber - read double value with or without units or represented by special number (DEF, MIN, MAX, ...). This function is more universal then SCPI_ParamDouble.
 - SCPI_ParamText - read text value - may be encapsuled in ""
 - SCPI_ParamString - read unspecified parameter not encapsulated in ""

These are the functions, you can use to write results
 - SCPI_ResultInt - write integer value
 - SCPI_ResultDouble - write double value
 - SCPI_ResultText - write text value encapsulated in ""
 - SCPI_ResultString - directly write string value

You can use function SCPI_NumberToStr to convert number with units to textual representation and then use SCPI_ResultString to write this to the user.
**Supported parameter types**
<table>
<tr><th>Type<th>Example</tr>
<tr><td>Decimal<td><code>10</code>, <code>10.5</code></tr>
<tr><td>Decimal with suffix<td><code>-5.5 V</code>, <code>1.5 KOHM</code></tr>
<tr><td>Hexadecimal<td><code>#HFF</code></tr>
<tr><td>Octal<td><code>#Q77</code></tr>
<tr><td>Binary<td><code>#B11</code></tr>
<tr><td>String<td><code>"text"</code>, <code>'text'</code></tr>
<tr><td>Arbitrary block<td><code>#12AB</code></tr>
<tr><td>Program expression<td><code>(1)</code></tr>
<tr><td>Numeric list<td><code>(1,2:50,80)</code></tr>
<tr><td>Channel list<td><code>(@1!2:3!4,5!6)</code></tr>
<tr><td>Character data<td><code>MINimum</code>, <code>DEFault</code>, <code>INFinity</code></tr>
</table>