ドキュメントの修正

[mimic/MiMicSDK.git] / misc / mbedJS / mbddJS.API / mbedJS / mbed.I2CSlave.js

diff --git a/misc/mbedJS/mbddJS.API/mbedJS/mbed.I2CSlave.js b/misc/mbedJS/mbddJS.API/mbedJS/mbed.I2CSlave.js
index 5c68a02..7ab644f 100644 (file)
--- a/misc/mbedJS/mbddJS.API/mbedJS/mbed.I2CSlave.js
+++ b/misc/mbedJS/mbddJS.API/mbedJS/mbed.I2CSlave.js
@@ -60,35 +60,77 @@ var MI=MiMicJS;
  * var mcu=new mbedJS.Mcu("192.168.128.39",\r
  * {\r
  *   onNew:function(){\r
- *     var pin=new mbedJS.I2CSlave(mcu,mbedJS.PinName.A0,{\r
+ *     var i2c=new mbedJS.I2CSlave(mcu,[mbedJS.PinName.p28,mbedJS.PinName.p27],{\r
  *     onNew:function(){\r
- *       pin.read();\r
+ *       i2c.frequency(100000);\r
  *     },\r
- *     onRead:function(v)\r
+ *     onFrequency:function()\r
  *     {\r
- *       pin.read_u16();\r
+ *       i2c.address(1);\r
  *     },\r
- *     onRead_u16:function(v){\r
+ *     onAddress:function()\r
+ *     {\r
+ *       i2c.receive();\r
+ *     },\r
+ *     onReceive:function(){\r
+ *       st=0;\r
+ *       i2c.write(1);\r
+ *     },\r
+ *     onWrite:function(v){\r
+ *       if(st==0){\r
+ *         i2c.write([1,2,3]);\r
+ *         st++;\r
+ *       }else{\r
+ *         i2c.read();\r
+ *         st=0;\r
+ *       }\r
+ *     },\r
+ *     onRead:function(v){\r
+ *       if(st==0){\r
+ *         i2c.read(2,false);\r
+ *         st++;\r
+ *       }else{\r
+ *         log("[PASS]onRead:"+v.ret+":"+v.data);\r
+ *         i2c.stop();\r
+ *       }\r
+ *       },\r
+ *     onStop:function(){\r
  *       mcu.close();\r
- *     }});\r
+ *     }\r
+ *     });\r
  *   },\r
- *   onClose:function(){},\r
- *   onError:function(){}\r
+ *   onClose:function(){\r
+ *   },\r
+ *   onError:function(){\r
+ *     alert("Error");\r
+ *   }\r
  * });\r
  * @example //Generator\r
  * var g=function*(){\r
  * try{\r
- *   var mcu=new mbedJS.Mcu("192.168.128.39",g);\r
- *   yield mcu.waitForNew();\r
- *   var pin=new mbedJS.I2CSlave(mcu,mbedJS.PinName.A0,g);\r
- *   yield pin.waitForNew();\r
- *   var v=yield pin.read();\r
- *   v=yield pin.read_u16();\r
- *   yield mcu.close();\r
+ *     var v;\r
+ *     var mcu=new mbedJS.Mcu("192.168.128.39",g);\r
+ *     yield mcu.waitForNew();\r
+ *     var i2c=new mbedJS.I2CSlave(mcu,[mbedJS.PinName.p28,mbedJS.PinName.p27],g);\r
+ *     yield i2c.waitForNew();\r
+ *     yield i2c.frequency(100000);\r
+ *     yield i2c.address(1);\r
+ *     v=yield i2c.receive();\r
+ *     v=yield i2c.write(1);\r
+ *     v=yield i2c.write([1,2,3]);\r
+ *     v=yield i2c.read();\r
+ *     v=yield i2c.read(2,false);\r
+ *     log("[PASS]onRead:"+v.ret+":"+v.data);\r
+ *     yield i2c.stop();\r
+ *     yield mcu.close();\r
  * }catch(e){\r
- *   mcu.shutdown();\r
- * }}();\r
+ *     mcu.shutdown();\r
+ *     alert(e);\r
+ *     throw e;\r
+ * }\r
+ * }();\r
  * g.next();\r
+ * return;\r
  */\r
 var CLASS=function I2CSlave(i_mcu,i_params,i_handler)\r
 {\r
@@ -115,6 +157,11 @@ CLASS.prototype=
 {\r
        /** @private */\r
        RPC_NS:"mbedJS:I2CSlave",\r
+       /**\r
+        * mbedJS.Serial#receiveの戻り値の種類です。\r
+        * NoData,ReadAddressed,WriteGeneral,WriteAddressedがあります。\r
+        * @name mbedJS.I2CSlave#RxStatus\r
+        */     \r
        RxStatus:{\r
                NoData:0,ReadAddressed:1,WriteGeneral:2,WriteAddressed:3},\r
        /** @private 最後にコールしたAPIです。*/\r