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|function} i_handler\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  * <p>\r
  39  * コールバック関数を指定した場合、RPCが完了したときに呼び出されます。メンバ関数のイベントハンドラは個別に設定する必要があります。\r
  40  * </p>\r
  41  * @return {mbedJS.DigitalIn}\r
  42  * @example //Callback\r
  43  * var mcu=new mbedJS.Mcu("192.168.128.39",\r
  44  * {\r
  45  *   onNew:function(){\r
  46  *     var pin=new mbedJS.DigitalIn(mcu,mbedJS.PinName.P0_22,{\r
  47  *     onNew:function(){\r
  48  *       pin.mode(mbedJS.PinMode.PullUp);\r
  49  *     },\r
  50  *     onMode:function()\r
  51  *     {\r
  52  *       pin.read();\r
  53  *     },\r
  54  *     onRead:function(v){\r
  55  *       mcu.close();\r
  56  *     }});\r
  57  *   },\r
  58  *   onClose:function(){\r
  59  *   },\r
  60  *   onError:function(){\r
  61  *   }\r
  62  * });\r
  63  * @example //Generator\r
  64  * var g=function*(){\r
  65  * try{\r
  66  *   var mcu=new mbedJS.Mcu("192.168.128.39",g);\r
  67  *   yield mcu.waitForNew();\r
  68  *   var pin=new mbedJS.DigitalIn(mcu,mbedJS.PinName.P0_22,g);\r
  69  *   yield pin.waitForNew();\r
  70  *   var v=yield pin.read();\r
  71  *   yield pin.mode(mbedJS.PinMode.PullDown);\r
  72  *   yield mcu.close();\r
  73  * }catch(e){\r
  74  *   mcu.shutdown();\r
  75  * }}();\r
  76  * g.next();\r
  77  */\r
  78 var CLASS=function DigitalIn(i_mcu,i_params,i_handler)\r
  79 {\r
  80         try{\r
  81                 var _t=this;\r
  82                 _t._mcu=i_mcu;\r
  83                 _t._lc=CLASS;\r
  84                 var cb=MI._initHandler.call(_t,i_handler);\r
  85                 MI.assertInt(i_params);\r
  86                 _t._mcu.rpc(_t.RPC_NS+":_new1",i_params,\r
  87                         function(j)\r
  88                         {\r
  89                                 _t._oid=j.result[0];\r
  90                                 if(cb){cb();}\r
  91                                 if(_t._gen){_t._gen.next(_t);}\r
  92                                 _t._lc=null;\r
  93                         }\r
  94                 );\r
  95                 \r
  96         }catch(e){\r
  97                 throw new MI.MiMicException(e);\r
  98         }\r
  99 }\r
 100 CLASS.prototype=\r
 101 {\r
 102         /** @private */\r
 103         RPC_NS:"mbedJS:DigitalIn",\r
 104         /** @private 最後にコールしたAPIです。*/\r
 105         _lc:null,\r
 106         /** @private Generatorモードの場合にGeneratorオブジェクトを保持します。*/\r
 107         _gen:null,\r
 108         /** @private コールバック関数の連想配列です。要素はコンストラクタを参照してください。*/\r
 109         _event:{},\r
 110         /** @private リモートインスタンスのオブジェクトIDです。*/\r
 111         _oid:null,\r
 112         /**\r
 113          * Generatorモードのときに使用する関数です。\r
 114          * Generatorモードの時は、yieldと併用してnew DigitalIn()の完了を待ちます。\r
 115          * @name mbedJS.DigitalIn#waitForNew\r
 116          * @function\r
 117          */\r
 118         waitForNew:function DigitalIn_waitForNew()\r
 119         {\r
 120                 try{\r
 121                         if(this._lc!=CLASS){throw new MI.MiMicException(MI.Error.NG_ILLEGAL_CALL);}\r
 122                         this._lc=CLASS.waitForNew;\r
 123                 }catch(e){\r
 124                         throw new MI.MiMicException(e);\r
 125                 }\r
 126         },\r
 127         /**\r
 128          * ピンからアナログ値を読み込みます。\r
 129          * 関数の完了時にonReadイベントが発生します。\r
 130          * Generatorモードの時は、yieldと併用して完了を待機できます。\r
 131          * @name mbedJS.DigitalIn#read\r
 132          * @function\r
 133          * @return　{int}\r
 134          * Callbackモードの時はRPCメソッドのインデクスを返します。\r
 135          * @return　{int}\r
 136          * Generatorモードの時はピンの値を返します。\r
 137          */\r
 138         read:function DigitalIn_read()\r
 139         {\r
 140                 try{\r
 141                         var _t=this;\r
 142                         var cb=MI._getCb(arguments,_t._event.onRead);\r
 143                         MI._assertYield.call(_t);\r
 144                         _t._lc=CLASS.read;\r
 145                         return _t._mcu.rpc(_t.RPC_NS+":read",_t._oid,\r
 146                         function (j)\r
 147                         {\r
 148                                 var v=j.result[0];\r
 149                                 if(cb){cb(v);}\r
 150                                 if(_t._gen){_t._gen.next(v);}\r
 151                                  _t._lc=null;\r
 152                         }\r
 153                         );\r
 154                 }catch(e){\r
 155                         throw new MI.MiMicException(e);\r
 156                 }\r
 157         },\r
 158         /**\r
 159          * ピンモードを設定します。\r
 160          * 関数の完了時にonModeイベントが発生します。\r
 161          * Generatorモードの時は、yieldと併用して完了を待機できます。\r
 162          * @name mbedJS.DigitalIn#mode\r
 163          * @function\r
 164          * @param {PinMode} i_value\r
 165          * PinModeの値です。\r
 166          * @return　{int}\r
 167          * Callbackモードの時はRPCメソッドのインデクスを返します。\r
 168          */\r
 169         mode:function DigitalIn_mode(i_value)\r
 170         {\r
 171                 try{\r
 172                         var _t=this;\r
 173                         var cb=MI._getCb(arguments,_t._event.onMode);\r
 174                         MI._assertYield.call(_t);\r
 175                         _t._lc=CLASS.mode;\r
 176                         MI.assertInt(i_value);\r
 177                         return _t._mcu.rpc(_t.RPC_NS+":mode",_t._oid+","+i_value,\r
 178                         function (j)\r
 179                         {\r
 180                                 var v=j.result[0];\r
 181                                 if(cb){cb(v);}\r
 182                                 if(_t._gen){_t._gen.next(v);}\r
 183                                  _t._lc=null;\r
 184                         }\r
 185                         );\r
 186                 }catch(e){\r
 187                         throw new MI.MiMicException(e);\r
 188                 }\r
 189         }       \r
 190 }\r
 191 NS.DigitalIn=CLASS;\r
 192 }());