improved readme and added scpi.h with all headers included

README.md

@@ -4,21 +4,39 @@ This library provides a simple ("KISS") SCPI implementation for embedded devices
 
 The implementation is not 100% complete, but it's sufficient for basic SCPI communication.
 
-## What's supported
+- Easy configuration with one const array and callbacks
+- Implements SCPI99 (minimal requirements) - including common commands and status registers
+- Mandatory parts of the SYST and STAT subsystems are built in (ie. error handling)
+- Easy, straightforward API
 
-- The hierarchical header model (commands with colon)
+## Feature overview
-- Long and short header variants (eg. `SYSTem?`)
+
-- Easy configuration with one const array of structs and callback functions (see `main.c`)
+### What's supported
+
+- Commands with colon (hierarchical header model)
 - Semicolon for chaining commands on the same level
-- String, Int, Float, Bool arguments
+- Long and short command variants (eg. `SYSTem?`)
-- Block data argument with callback each N received bytes (configurable)
+- String, Int, Float, Bool, CharData arguments
-- Status Register model
+- **Block data argument** with callback each N received bytes - allows virtually unlimite binary data length
-- Error queue including error messages from the SCPI spec
+- Status Registers
-- All mandatory SCPI commands (headers) are implemented as built-ins
+- Error queue with error numbers and messages (and the required SYST:ERR subsystem)
+
+Built-in commands can be overriden by matching user commands.
+
+### Limitations
+
+- Binary block must be the last argument of a command (callback is run after reading the binary block preamble)
+
+### What's missing
+
+- Number units (mV,V,kW,A,Ohm) and metric suffixes (k,M,G,m,u,n)
+- DEF, MIN, MAX, INF, NINF argument values for numbers
+- Numbered virtual instruments (DAC1:OUT, DAC2:OUT) - currently you need to define the commands twice
+
+Feel free to propose a pull request implementing any missing features.
 
-Built-in commands can be overriden in user command array.
 
-## How to use
+## How to use it
 
 To test it with regular gcc, run the Makefile in the `example` directory.
 
@@ -29,7 +47,7 @@ The main Makefile builds a library for ARM Cortex M4 (can be easily adjusted for
 Here's an overview of stubs you have to implement (at the time of writing this readme):
 
 ```c
-#include "scpi_parser.h"
+#include "scpi.h"
 
 // Receive byte - call:
 //   scpi_handle_byte()
@@ -93,12 +111,3 @@ void scpi_user_TSTq(void) { /*...*/ }
 ```
 
 See the header files for more info.
-
-## What is missing
-
-- Number units and metric suffixes (k,M,G,m,u,n)
-- DEF, MIN, MAX, INF, NINF argument values for numbers
-
-Support for units and "constants" (DEF etc) in numeric fields will need some larger changes to the numeric parser and `SCPI_argval_t`.
-
-Feel free to propose a pull request implementing any missing features.

example/example.c

@@ -2,7 +2,7 @@
 #include <string.h>
 #include <stdlib.h>
 
-#include "scpi_parser.h"
+#include "scpi.h"
 
 // ------- TESTING ----------
 

include/scpi.h

@@ -0,0 +1,8 @@
+#pragma once
+
+// Include this file when using the library
+
+#include "scpi_regs.h"
+#include "scpi_errors.h"
+#include "scpi_builtins.h"
+#include "scpi_parser.h"

include/scpi_builtins.h

@@ -2,11 +2,6 @@
 #include <stdint.h>
 #include <stdbool.h>
 
-#include "scpi_parser.h"
-#include "scpi_errors.h"
-#include "scpi_regs.h"
-
-
 /** *CLS command callback - clear non-SCPI device state */
 extern __attribute__((weak)) void scpi_user_CLS(void);
 

include/scpi_parser.h

@@ -2,10 +2,6 @@
 #include <stdint.h>
 #include <stdbool.h>
 
-#include "scpi_errors.h"
-#include "scpi_builtins.h"
-#include "scpi_regs.h"
-
 #define SCPI_MAX_CMD_LEN 16 // 12 according to spec
 #define SCPI_MAX_STRING_LEN 64 // 12 according to spec
 #define SCPI_MAX_LEVEL_COUNT 4

scpi.pro

@@ -3,14 +3,16 @@ CONFIG += console
 CONFIG -= app_bundle
 CONFIG -= qt
 
-INCLUDEPATH += source/
+INCLUDEPATH += source/ \
+	include/
 
 SOURCES += \
 	main.c \
 	source/scpi_parser.c \
 	source/scpi_errors.c \
 	source/scpi_regs.c \
-	source/scpi_builtins.c
+	source/scpi_builtins.c \
+	example/example.c
 
 DISTFILES += \
 	style.astylerc \
@@ -23,4 +25,9 @@ HEADERS += \
 	source/scpi_parser.h \
 	source/scpi_errors.h \
 	source/scpi_regs.h \
-	source/scpi_builtins.h
+	source/scpi_builtins.h \
+	include/scpi_builtins.h \
+	include/scpi_errors.h \
+	include/scpi_parser.h \
+	include/scpi_regs.h \
+    include/scpi.h