OSDN Git Service

バイナリ文字列(BSTR)転送に関する機能追加
[mimic/MiMicSDK.git] / misc / mbedJS / mbddJS.API / mbedJS / mbed.DigitalIn.js
1 /**\r
2  * @fileOverview DigitalInクラスを定義します。\r
3  */\r
4 (function(){\r
5 var NS=mbedJS;\r
6 var MI=MiMicJS;\r
7 \r
8 /**\r
9  * DigitalInクラスです。\r
10  * <a href="https://mbed.org/handbook/DigitalIn">mbed::DigitalIn</a>と同等の機能を持ちます。\r
11  * @name mbedJS.DigitalIn\r
12  * @constructor\r
13  * @param {mbedJS.Mcu} i_mcu\r
14  * インスタンスをバインドするMCUオブジェクトです。\r
15  * @param {PinName} i_params\r
16  * ピンIDを指定します。\r
17  * @param {HashMap|Generator} i_event\r
18  * 非同期イベントハンドラの連想配列、又はGeneratorです。\r
19  * <p>\r
20  * 非同期イベントハンドラの場合、関数はイベントハンドラで結果を通知します。\r
21  * <ul>\r
22  * <li>{function()} onNew -\r
23  * インスタンスが使用可能になった時に呼び出されます。\r
24  * </li>\r
25  * <li>{function(v)} onRead  -\r
26  * read関数のコールバック関数です。\r
27  *      <ul>\r
28  *              <li>{int} v - 現在のピンの値です。</li>\r
29  *      </ul>\r
30  * </li>\r
31  * <li>{function()} onMode -\r
32  * mode関数のコールバック関数です。\r
33  * </li>\r
34  * </ul>\r
35  * <p>\r
36  * Generatorを指定した場合、コールバック関数の引数はyiledの戻り値として取得できます。\r
37  * <p>\r
38  * @return {mbedJS.DigitalIn}\r
39  * @example //Callback\r
40  * var mcu=new mbedJS.Mcu("192.168.128.39",\r
41  * {\r
42  *   onNew:function(){\r
43  *     var pin=new mbedJS.DigitalIn(mcu,mbedJS.PinName.P0_22,{\r
44  *     onNew:function(){\r
45  *       pin.mode(mbedJS.PinMode.PullUp);\r
46  *     },\r
47  *     onMode:function()\r
48  *     {\r
49  *       pin.read();\r
50  *     },\r
51  *     onRead:function(v){\r
52  *       mcu.close();\r
53  *     }});\r
54  *   },\r
55  *   onClose:function(){\r
56  *   },\r
57  *   onError:function(){\r
58  *   }\r
59  * });\r
60  * @example //Generator\r
61  * var g=function*(){\r
62  * try{\r
63  *   var mcu=new mbedJS.Mcu("192.168.128.39",g);\r
64  *   yield mcu.waitForNew();\r
65  *   var pin=new mbedJS.DigitalIn(mcu,mbedJS.PinName.P0_22,g);\r
66  *   yield pin.waitForNew();\r
67  *   var v=yield pin.read();\r
68  *   yield pin.mode(mbedJS.PinMode.PullDown);\r
69  *   yield mcu.close();\r
70  * }catch(e){\r
71  *   mcu.shutdown();\r
72  * }}();\r
73  * g.next();\r
74  */\r
75 var CLASS=function DigitalIn(i_mcu,i_params,i_handler)\r
76 {\r
77         try{\r
78                 var _t=this;\r
79                 _t._mcu=i_mcu;\r
80                 _t._lc=CLASS;\r
81                 if(MI.isGenerator(i_handler)){_t._gen=i_handler;}\r
82                 else if(i_handler){_t._event=i_handler}\r
83                 function cb(j)\r
84                 {\r
85                         _t._oid=j.result[0];\r
86                         if(_t._event.onNew){_t._event.onNew();}\r
87                         if(_t._gen){_t._gen.next(_t);}\r
88                         _t._lc=null;\r
89                 }\r
90                 MI.assertInt(i_params);\r
91                 return _t._mcu.rpc(_t.RPC_NS+":_new1",i_params,cb);\r
92         }catch(e){\r
93                 throw new MI.MiMicException(e);\r
94         }\r
95 }\r
96 CLASS.prototype=\r
97 {\r
98         /** @private */\r
99         RPC_NS:"mbedJS:DigitalIn",\r
100         /** @private 最後にコールしたAPIです。*/\r
101         _lc:null,\r
102         /** @private Generatorモードの場合にGeneratorオブジェクトを保持します。*/\r
103         _gen:null,\r
104         /** @private コールバック関数の連想配列です。要素はコンストラクタを参照してください。*/\r
105         _event:{},\r
106         /** @private リモートインスタンスのオブジェクトIDです。*/\r
107         _oid:null,\r
108         /**\r
109          * Generatorモードのときに使用する関数です。\r
110          * Generatorモードの時は、yieldと併用してnew DigitalIn()の完了を待ちます。\r
111          * @name mbedJS.DigitalIn#waitForNew\r
112          * @function\r
113          */\r
114         waitForNew:function DigitalIn_waitForNew()\r
115         {\r
116                 try{\r
117                         if(this._lc!=CLASS){throw new MI.MiMicException(MI.Error.NG_ILLEGAL_CALL);}\r
118                         this._lc=CLASS.waitForNew;\r
119                 }catch(e){\r
120                         throw new MI.MiMicException(e);\r
121                 }\r
122         },\r
123         /**\r
124          * ピンからアナログ値を読み込みます。\r
125          * 関数の完了時にonReadイベントが発生します。\r
126          * Generatorモードの時は、yieldと併用して完了を待機できます。\r
127          * @name mbedJS.DigitalIn#read\r
128          * @function\r
129          * @return {int}\r
130          * Callbackモードの時はRPCメソッドのインデクスを返します。\r
131          * @return {int}\r
132          * Generatorモードの時はピンの値を返します。\r
133          */\r
134         read:function DigitalIn_read()\r
135         {\r
136                 try{\r
137                         var _t=this;\r
138                         if(this._gen && this._lc){throw new MI.MiMicException(MI.Error.NG_YIELD_NOT_COMPLETED);}\r
139                         _t._lc=CLASS.read;\r
140                         return _t._mcu.rpc(_t.RPC_NS+":read",_t._oid,\r
141                         function (j)\r
142                         {\r
143                                 var v=j.result[0];\r
144                                 if(_t._event.onRead){_t._event.onRead(v);}\r
145                                 if(_t._gen){_t._gen.next(v);}\r
146                                  _t._lc=null;\r
147                         }\r
148                         );\r
149                 }catch(e){\r
150                         throw new MI.MiMicException(e);\r
151                 }\r
152         },\r
153         /**\r
154          * ピンモードを設定します。\r
155          * 関数の完了時にonModeイベントが発生します。\r
156          * Generatorモードの時は、yieldと併用して完了を待機できます。\r
157          * @name mbedJS.DigitalIn#mode\r
158          * @function\r
159          * @param {PinMode} i_value\r
160          * PinModeの値です。\r
161          * @return {int}\r
162          * Callbackモードの時はRPCメソッドのインデクスを返します。\r
163          */\r
164         mode:function DigitalIn_mode(i_value)\r
165         {\r
166                 try{\r
167                         var _t=this;\r
168                         if(this._gen && this._lc){throw new MI.MiMicException(MI.Error.NG_YIELD_NOT_COMPLETED);}\r
169                         _t._lc=CLASS.mode;\r
170                         MI.assertInt(i_value);\r
171                         return _t._mcu.rpc(_t.RPC_NS+":mode",_t._oid+","+i_value,\r
172                         function (j)\r
173                         {\r
174                                 var v=j.result[0];\r
175                                 if(_t._event.onMode){_t._event.onMode(v);}\r
176                                 if(_t._gen){_t._gen.next(v);}\r
177                                  _t._lc=null;\r
178                         }\r
179                         );\r
180                 }catch(e){\r
181                         throw new MI.MiMicException(e);\r
182                 }\r
183         }       \r
184 }\r
185 NS.DigitalIn=CLASS;\r
186 }());