From ef2855ef79cf97421eb32489235eeaf8612dd2d9 Mon Sep 17 00:00:00 2001
From: Jan Breuer <jan.breuer@jaybee.cz>
Date: 周三, 25 12月 2013 04:54:12 +0800
Subject: [PATCH] Refactor bool_t to scpi_bool_t
---
README.md | 62 +++++++++++++++++++++++-------
1 files changed, 47 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index 0c3b6dc..d284238 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,39 @@
Source codes are published with open source Simplified BSD license.
+
+Usage
+---------------
+Download source package or clone repository
+ - v1.0 - https://github.com/j123b567/scpi-parser/archive/v1.0.zip
+ - git clone https://github.com/j123b567/scpi-parser.git
+
+Go to the `libscpi` directory
+
+Build library, results are in `dist` folder
+
+ make
+
+You can test library functions by
+
+ make test
+
+You can use any of the examples in the `examples` directory
+
+
+Version history
+----------------
+Version v1.0 released 24.6.2013
+ - support basic command pattern matching (no optional keywoards)
+ - support basic data types (no expressions, no nondecimal numbers, no arbitrary program data, ...)
+ - last version before refactoring of the parser and before extending parameter handling
+
+Future Version v2.0 released ????????
+ - parsing more compliant with SCPI-1999
+ - support all parameter types defined in the spec - separate them and identifie them
+ - support for optional command headers (Richard.hmm)
+
+
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.
@@ -15,13 +48,9 @@
Pattern "SYSTem:VERsion?" mathes strings "SYST:version?", "system:ver?", "SYST:VER?", ...
-SCPI standard also uses brackets "[]" to define unnecesery parts of command. This behaviour is not implemented yet.
+SCPI standard also uses brackets "[]" to define unnecesery parts of command.
- Pattern "SYSTem:ERRor[:NEXT]?" should match "SYST:ERR?", "system:err?" and also "system:error:next?", ...
-
-In current implementation, you should write two patterns to implement this behaviour
-
- Pattern "SYSTem:ERRor?" and "SYSTem:ERRor:NEXT?"
+ Pattern "SYSTem:ERRor[:NEXT]?" matches strings "SYST:ERR?", "system:err?" and also "system:error:next?", ...
Command callback
@@ -45,14 +74,17 @@
Source codes are devided into few files to provide better portability to other systems.
-- *libscpi/parser.c* - provides the core parser library
-- *libscpi/error.c* - provides basic error handling (error queue of the instrument)
-- *libscpi/ieee488.c* - provides basic implementation of IEEE488.2 mandatory commands
-- *libscpi/minimal.c* - provides basic implementation of SCPI mandatory commands
-- *libscpi/utils.c* - provides string handling routines and conversion routines
-- *libscpi/units.c* - provides handling of special numners (DEF, MIN, MAX, ...) and units
-- *libscpi/fifo.c* - provides basic implementation of error queue FIFO
-- *libscpi/debug.c* - provides debug functions
+- *libscpi/src/parser.c* - provides the core parser library
+- *libscpi/src/lexer.c* - provides identification of keywoards and data types
+- *libscpi/src/error.c* - provides basic error handling (error queue of the instrument)
+- *libscpi/src/ieee488.c* - provides basic implementation of IEEE488.2 mandatory commands
+- *libscpi/src/minimal.c* - provides basic implementation of SCPI mandatory commands
+- *libscpi/src/utils.c* - provides string handling routines and conversion routines
+- *libscpi/src/units.c* - provides handling of special numners (DEF, MIN, MAX, ...) and units
+- *libscpi/src/fifo.c* - provides basic implementation of error queue FIFO
+- *libscpi/src/debug.c* - provides debug functions
+
+- *libscpi/test/* - Unit test for the library
- *examples/test-parser* - is the basic non-interactive demo of the parser
- *examples/test-interactive* - is the basic interactive demo of the parser
@@ -177,4 +209,4 @@
- `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.
\ No newline at end of file
+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.
--
Gitblit v1.9.1