Skip to content

Commit

Permalink
New readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Diego committed Jun 10, 2020
1 parent 4b7fdfb commit 6a4359c
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 6a4359c

Please sign in to comment.