Aaron Allar / RS485

A basic library for RS485 communication

Dependencies:   BufferedSerial

Dependents:   mbed_blinko

Diff: RS485.h

Revision:
4:6a8a69b660c2
Parent:
3:9af77202cc27
--- a/RS485.h	Sun May 21 20:37:59 2017 +0000
+++ b/RS485.h	Sun May 21 20:41:37 2017 +0000
@@ -24,8 +24,16 @@
 #include "BufferedSerial.h"
 #include "mbed.h"
 
-/** A serial port (UART) is used for RS485
+/** RS485 Library
  *  
+ * Can send from 1 to 255 bytes from one node to another with:
+ *
+ * Packet start indicator (STX)
+ * Each data byte is doubled and inverted to check validity
+ * Packet end indicator (ETX)
+ * Packet CRC (checksum)
+ *
+ * Using MAX485 modules or the MAX485 CSA+
  *
  * Example:
  * @code
@@ -68,7 +76,7 @@
 
 /**
  *  @class RS485
- *  @communicating using MAX485 modules
+ *  @communicating 
  */
 
 class RS485 : public BufferedSerial