From 6a4359c4eebe99b92b01884b0b567c195f5730af Mon Sep 17 00:00:00 2001 From: Diego Date: Tue, 9 Jun 2020 23:56:53 -0300 Subject: [PATCH] New readme --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b6a896..6db5d72 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # Vrekrer scpi parser -Simple SCPI parser for small Arduino projects +A simple SCPI parser for small Arduino projects. + +## Features +- Small memory footprint, implemented for reduced RAM usage. +- Minimal, clean code API. +- Can process char* strings or input from any [Stream](https://www.arduino.cc/reference/en/language/functions/communication/stream/) interface like [Serial](https://www.arduino.cc/reference/en/language/functions/communication/serial) or [Ethernet](https://www.arduino.cc/en/Reference/Ethernet). +- Flash strings ([F() macro](https://www.arduino.cc/reference/en/language/variables/utilities/progmem/#_the_f_macro)) support for lower RAM usage. + + +## SCPI features: + - Commands defined using stings + E.g. `"MEASure:VOLTage:DC?"` + - Short and long token forms, and upper and lower case commands + E.g. `"MEASURE:VOLTAGE:DC?"`, `"meas:VoLt:DC?"` + - Numeric suffixes using the `#` character: + E.g. definition : `"CHANnel#:SELect"` + E.g. usage : `"CHAN0:SEL"`, `"chan5:sel"`, `"chan13:sel"` + - Comma separated parameters recognition. + - Parameters treated as text, processed by the user program. +