Changeset 143 for rtos_arduino/trunk/arduino_lib/libraries/ESP8266/README.md

Timestamp:

Dec 5, 2015, 7:18:45 PM (8 years ago)

Author:

ertl-honda

Message:

Milkcocoa用に更新

File:

• rtos_arduino/trunk/arduino_lib/libraries/ESP8266/README.md (modified) (4 diffs)

rtos_arduino/trunk/arduino_lib/libraries/ESP8266/README.md

@@ -1 +1 @@
 @mainpage
 
-# WeeESP8266
+# WeeESP8266 updated for Milkcoca SDK
 
 An ESP8266 library for Arduino providing an easy-to-use way to manipulate ESP8266.
+Updated to support Milkcoca SDK<>, M0 and TOPPERS/R2CA.
 
 # Source 
-
-Source can be download at <https://github.com/itead/ITEADLIB_Arduino_WeeESP8266>.
+Source can be download at <>.
+Original source can be download at <https://github.com/itead/ITEADLIB_Arduino_WeeESP8266>.
 
 You can clone it by:
@@ -93 +94 @@
     uint32_t    recv (uint8_t *coming_mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000) : Receive data from all of TCP or UDP builded already in multiple mode. 
 
+# Added API List
+
+    void        begin(SoftwareSerial &uart, uint32_t baud = 115200); : Begin ESP8266.
+
+    void        begin(SoftwareSerial &uart, uint32_t baud = 115200); : Begin ESP8266.
+
+    bool        send(String &str); : Send data based on TCP or UDP builded already in single mode. 
+
+    bool        send(uint8_t mux_id, String &str); : Send data based on one of TCP or UDP builded already in multiple mode. 
+
+    int         dataAvailable(void); : Check data is available.
 
 # Mainboard Requires
@@ -103 +115 @@
   - Arduino UNO and its derivatives
   - Arduino MEGA and its derivatives
+  - Arduino M0 and its derivatives
   - [Iteaduino UNO](http://imall.iteadstudio.com/im130312001.html)
   - [WBoard Pro](http://imall.iteadstudio.com/im141125005.html)
@@ -165 +178 @@
 defined in HardwareSerial.h is too small.
 
+UNO or MEGA or WBoard Pro
 Open the file from `\arduino\hardware\arduino\avr\cores\arduino\HardwareSerial.h`. 
-See the follow line in the HardwareSerial.h file.
+
+M0
+Open the file from `\arduino\hardware\arduino\avr\cores\arduino\RingBuffer.h`. 
+See the follow line in the file.
 
     #define SERIAL_BUFFER_SIZE 64