Update README - describe parameters and results handling

Jan Breuer

2012-12-04 f0f8202f77a42f470f767692b22f0ad0254c038f

 test-parser.c

@@ -38,32 +38,31 @@
#include <stdlib.h>
#include <string.h>
#include "scpi/scpi.h"
#include "scpi/scpi_ieee488.h"
#include "scpi/scpi_error.h"
#include "scpi/scpi_constants.h"
#include "scpi/scpi_minimal.h"

int DMM_MeasureVoltageDcQ(scpi_context_t * context) {
    double param1, param2;
    fprintf(stderr, "meas:volt:dc "); // debug command name
    
    // read first parameter
    if (SCPI_ParamDouble(context, &param1, false)) {
        fprintf(stderr, "P1=%lf ", param1);
    }
    
    // read second paraeter
    if (SCPI_ParamDouble(context, &param2, false)) {
        fprintf(stderr, "P2=%lf ", param2);
scpi_result_t DMM_MeasureVoltageDcQ(scpi_t * context) {
    scpi_number_t param1, param2;
    char bf[15];
    fprintf(stderr, "meas:volt:dc\r\n"); // debug command name   

    // read first parameter if present
    if (SCPI_ParamNumber(context, &param1, false)) {
        SCPI_NumberToStr(context, &param1, bf, 15);
        fprintf(stderr, "\tP1=%s\r\n", bf);
    }

    fprintf(stderr, "\r\n");
    // read second paraeter if present
    if (SCPI_ParamNumber(context, &param2, false)) {
        SCPI_NumberToStr(context, &param2, bf, 15);
        fprintf(stderr, "\tP2=%s\r\n", bf);
    }

    SCPI_ResultDouble(context, 0);
    return 0;
    
    return SCPI_RES_OK;
}

scpi_command_t scpi_commands[] = {
    /* Required IEEE488.2 Common Commands (see SCPI Standard V1999.0 ch4.1.1) */
static const scpi_command_t scpi_commands[] = {
    /* IEEE Mandated Commands (SCPI std V1999.0 4.1.1) */
    { .pattern = "*CLS", .callback = SCPI_CoreCls,},
    { .pattern = "*ESE", .callback = SCPI_CoreEse,},
    { .pattern = "*ESE?", .callback = SCPI_CoreEseQ,},
@@ -78,9 +77,10 @@
    { .pattern = "*TST?", .callback = SCPI_CoreTstQ,},
    { .pattern = "*WAI", .callback = SCPI_CoreWai,},

    /* Required SCPI commands (see SCPI Standard V1999.0 ch 4.2.1) */
    /* Required SCPI commands (SCPI std V1999.0 4.2.1) */
    {.pattern = "SYSTem:ERRor?", .callback = SCPI_SystemErrorNextQ,},
    {.pattern = "SYSTem:ERRor:NEXT?", .callback = SCPI_SystemErrorNextQ,},
    {.pattern = "SYSTem:ERRor:COUNt?", .callback = SCPI_SystemErrorCountQ,},
    {.pattern = "SYSTem:VERSion?", .callback = SCPI_SystemVersionQ,},

    //{.pattern = "STATus:OPERation?", .callback = scpi_stub_callback,},
@@ -111,35 +111,50 @@
    SCPI_CMD_LIST_END
};

size_t SCPI_Write(scpi_context_t * context, const char * data, size_t len) {
static size_t SCPI_Write(scpi_t * context, const char * data, size_t len) {
    (void) context;
    return fwrite(data, 1, len, stdout);
}

int SCPI_Error(scpi_context_t * context, int_fast16_t err) {
static int SCPI_Error(scpi_t * context, int_fast16_t err) {
    (void) context;
    

    fprintf(stderr, "**ERROR: %d, \"%s\"\r\n", (int32_t) err, SCPI_ErrorTranslate(err));
    return 0;
}

scpi_interface_t scpi_interface = {
static scpi_result_t SCPI_Srq(scpi_t * context) {
    scpi_reg_val_t stb = SCPI_RegGet(context, SCPI_REG_STB);
    fprintf(stderr, "**SRQ: 0x%X (%d)\r\n", stb, stb);
    return SCPI_RES_OK;
}


static scpi_interface_t scpi_interface = {
    .write = SCPI_Write,
    .error = SCPI_Error,
    .reset = NULL,
    .test = NULL,
    .srq = SCPI_Srq,
};

#define SCPI_BUFFER_LENGTH 256
char buffer[SCPI_BUFFER_LENGTH];
#define SCPI_INPUT_BUFFER_LENGTH 256
static char scpi_input_buffer[SCPI_INPUT_BUFFER_LENGTH];

scpi_buffer_t scpi_buffer = {
    .length = SCPI_BUFFER_LENGTH,
    .data = buffer,
    //    .data = (char[SCPI_BUFFER_LENGTH]){},
static scpi_reg_val_t scpi_regs[SCPI_REG_COUNT];


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,
};

scpi_context_t scpi_context;

/*
 * 
@@ -148,37 +163,48 @@
    (void) argc;
    (void) argv;
    int result;

    SCPI_Init(&scpi_context);

#define TEST_SCPI_INPUT(cmd)    result = SCPI_Input(&scpi_context, cmd, strlen(cmd))

    TEST_SCPI_INPUT("*CLS\r\n");
    TEST_SCPI_INPUT("*RST\r\n");
    TEST_SCPI_INPUT("MEAS:volt:DC? 12,50;*OPC\r\n");
    TEST_SCPI_INPUT("*IDN?\r\n");
    TEST_SCPI_INPUT("SYST:VERS?");
    TEST_SCPI_INPUT("\r\n*ID");
    TEST_SCPI_INPUT("N?");
    TEST_SCPI_INPUT(""); // emulate command timeout

    TEST_SCPI_INPUT("*ESE\r\n"); // cause error -109, missing parameter
    TEST_SCPI_INPUT("*ESE 0x20\r\n");

    TEST_SCPI_INPUT("*SRE 0xFF\r\n");
    
    TEST_SCPI_INPUT("IDN?\r\n"); // cause error -113, undefined header

    TEST_SCPI_INPUT("SYST:ERR?\r\n");
    TEST_SCPI_INPUT("SYST:ERR?\r\n");
    TEST_SCPI_INPUT("*STB?\r\n");
    TEST_SCPI_INPUT("*ESR?\r\n");
    TEST_SCPI_INPUT("*STB?\r\n");

    TEST_SCPI_INPUT("meas:volt:dc? 0.01 V, Default\r\n");
    TEST_SCPI_INPUT("meas:volt:dc?\r\n");
    TEST_SCPI_INPUT("meas:volt:dc? def, 0.00001\r\n");
    TEST_SCPI_INPUT("meas:volt:dc? 0.00001\r\n");


    //printf("%.*s %s\r\n",  3, "asdadasdasdasdas", "b");
    
    SCPI_Init(&scpi_context, scpi_commands, &scpi_buffer, &scpi_interface);
    // interactive demo
    //char smbuffer[10];
    //while (1) {
    //     fgets(smbuffer, 10, stdin);
    //     SCPI_Input(&scpi_context, smbuffer, strlen(smbuffer));
    //}

    // // interactive demo
    //  char smbuffer[10];
    //  while(1) {
    //          fgets(smbuffer, 10, stdin);
    //          SCPI_Input(&scpi_context, smbuffer, strlen(smbuffer));      
    //  }
       
    result = SCPI_Input(&scpi_context, "*CLS\r\n", 6);
    result = SCPI_Input(&scpi_context, "*RST\r\n", 6);
    result = SCPI_Input(&scpi_context, "MEAS:volt:DC? 12,50;*OPC\r\n", 26);
    result = SCPI_Input(&scpi_context, "*IDN?\r\n", 7);
    result = SCPI_Input(&scpi_context, "SYST:VERS?", 10);
    result = SCPI_Input(&scpi_context, "\r\n*ID", 5);
    result = SCPI_Input(&scpi_context, "N?", 2);
    result = SCPI_Input(&scpi_context, NULL, 0); // emulate command timeout

    result = SCPI_Input(&scpi_context, "*ESE\r\n", 6);
    result = SCPI_Input(&scpi_context, "*ESE 0x20\r\n", 11);

    result = SCPI_Input(&scpi_context, "IDN?\r\n", 6); // cause error -113, undefined header

    result = SCPI_Input(&scpi_context, "SYST:ERR?\r\n", 11);
    result = SCPI_Input(&scpi_context, "SYST:ERR?\r\n", 11);
    result = SCPI_Input(&scpi_context, "*STB?\r\n", 6);
    result = SCPI_Input(&scpi_context, "*ESR?\r\n", 6);
    result = SCPI_Input(&scpi_context, "*STB?\r\n", 6);
    return (EXIT_SUCCESS);
}