From 912f467c0bb1fd3e3e14b8693424f27ab33d984f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= Date: Sat, 5 Dec 2015 18:53:11 +0100 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 68e9a09..876d47f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# scpi_parser -SCPI C implementation for embedded devices +# SCPI parser + +This library provides a simple ("KISS") SCPI implementation for embedded devices (instruments). + +The implementation is not 100% complete, but it's sufficient for basic SCPI communication. + +## What's supported + +- The hierarchical header model (commands with colon) +- Semicolon for chaining commands on the same level +- String, Int, Float, Bool arguments +- Block data argument with callback each N received bytes (configurable) +- Status Register model +- Error queue including error messages from the SCPI spec +- All mandatory SCPI commands (headers) are implemented as built-ins + +Built-in commands can be overriden in user command array. + +See main.c for example of how to use the library. + +## What is missing + + +