diff options
| author | Jakob Odersky <jodersky@gmail.com> | 2013-02-26 16:54:26 +0100 |
|---|---|---|
| committer | Jakob Odersky <jodersky@gmail.com> | 2013-02-26 16:54:26 +0100 |
| commit | 03edd62b745f225075fab0d96e0ec93f96c3466c (patch) | |
| tree | 10e19340c33063fb8d70b5937fb3d2120e372cf5 /c/arduino/ace.h | |
| parent | e8e5650006961593559b57176c4d2916b5c32d4e (diff) | |
| download | ace-03edd62b745f225075fab0d96e0ec93f96c3466c.tar.gz ace-03edd62b745f225075fab0d96e0ec93f96c3466c.tar.bz2 ace-03edd62b745f225075fab0d96e0ec93f96c3466c.zip | |
a little documentation
Diffstat (limited to 'c/arduino/ace.h')
| -rw-r--r-- | c/arduino/ace.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/c/arduino/ace.h b/c/arduino/ace.h index 75b178c..460b4ae 100644 --- a/c/arduino/ace.h +++ b/c/arduino/ace.h @@ -12,8 +12,22 @@ extern "C" { #define SERIAL_BUFFER_SIZE 64 +/** +* A reliable, reactive protocol implementation. Note that the default physical channel used is serial 0 and timer 1 on an Arduino. +* This may be changed in the .c file. +*/ + +/** Initialize ACE for serial 0. */ void init_ace0(uint32_t baud, uint32_t extra_time); + +/** Send a message over serial 0. */ void ace_send0(uint8_t size, const uint8_t* const message); + +/** Called on message event for serial 0. +* @param event event type, see arq.h for possible values +* @param size size of message (if given) +* @param message message if given or NULL +*/ void ace_event0(message_event event, int16_t size, const uint8_t* const message); #define init_ace init_ace0 |