Class MiMicRemoteMcuInterface

Defined in: MiMicCore.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	MiMicRemoteMcuInterface(server) MiMicRemoteMcuInterfaceクラスのコンストラクタ。 MiMicRemoteMcuInterfaceクラスは、MCUで動作するMiMicRemoteMcuとの通信機能と、接続状態の監視機能を提供する。低レベルAPI全てを実装する。低レベルAPIは、MiMicRemoteMcuとの通信を、関数コールに変換する。インスタンス生成直後は、MiMicRemoteMcuとの接続は断状態である。connect関数を実行して、接続する必要がある。通信仕様については、MiMicVM.pdf Appendix 1.MiMicVM HTTP Interfaceを参照すること。

Method Summary
Method Attributes	Method Name and Description
	connect(i_callback) MiMicRemoteMCUへ接続する。既に接続済みの場合は何もしない。
	disconnect() 接続中のMiMicRemoteMCUから切断する。接続されていなければ何もしない。
	execBc(i_bc) 接続中のMiMicremoteMCUへ、整形済みのMiMicBCを送信する。関数の利用前に、connect関数でMiMicremoteMCUへ接続する必要がある。何らかのエラーが発生してMiMicRemoteMCUからの応答が得られない場合、関数は例外を発生する。この状況は、TCP/IPエラー、HTTPエラー、HTTPステータスエラー、MiMicVMのラインタイムエラー、MiMicRemoteMCUのフォールト等の原因で発生する。関数は同期実行でのため、RemoteMCUが応答しないと制御がブロックする。非同期関数は今後実装する。
	isConnected() 接続状態を真偽値で返す。接続状態の場合、execBc等の低レベルAPIを使用できる。状態は、インスタンスが定期的に実行するプローブ信号でチェックされ、更新される。

Class Detail

MiMicRemoteMcuInterface(server)

MiMicRemoteMcuInterfaceクラスのコンストラクタ。 MiMicRemoteMcuInterfaceクラスは、MCUで動作するMiMicRemoteMcuとの通信機能と、接続状態の監視機能を提供する。低レベルAPI全てを実装する。低レベルAPIは、MiMicRemoteMcuとの通信を、関数コールに変換する。インスタンス生成直後は、MiMicRemoteMcuとの接続は断状態である。connect関数を実行して、接続する必要がある。通信仕様については、MiMicVM.pdf Appendix 1.MiMicVM HTTP Interfaceを参照すること。

//create a controlable MCU via network.
var mcu=new MiMicRemoteMcuInterface(“192.168.0.39”);

Parameters:
{string} server: 接続するMiMicRemoteMcuのホストアドレスを指定する。IPアドレス、ホスト名等。 ex. “127.0.0.1” , “127.0.0.1:3939”

Method Detail

connect(i_callback)

MiMicRemoteMCUへ接続する。既に接続済みの場合は何もしない。

//show connection status
var mri=new  MiMicRemoteMcuInterface(“192.168.0.1”);
mri.connect(function(b){if(!b){alert(“disconnected!”);}});

Parameters:

{function} i_callback

回線状態を定期的に通知するコールバックハンドラ。

function(b:{boolean})

disconnect関数を呼び出すまでの間、回線の状態を定期的に受け取る。 bは接続状態を表す真偽値である。trueの時、接続中である。falseの場合、外部要因により切断されている。 falseが通知されるのは、disconnectが呼び出されるまでに非同期切断を検出したときだけである。disconnectで切断した場合には呼び出されない。

disconnect()

接続中のMiMicRemoteMCUから切断する。接続されていなければ何もしない。

//connect and disconnect
var mri=new  MiMicRemoteMcuInterface(“192.168.0.1”);
mri.connect(function(b){if(!b){alert(“disconnected!”);}});
mri.disconnect();

execBc(i_bc)

接続中のMiMicremoteMCUへ、整形済みのMiMicBCを送信する。関数の利用前に、connect関数でMiMicremoteMCUへ接続する必要がある。何らかのエラーが発生してMiMicRemoteMCUからの応答が得られない場合、関数は例外を発生する。この状況は、TCP/IPエラー、HTTPエラー、HTTPステータスエラー、MiMicVMのラインタイムエラー、MiMicRemoteMCUのフォールト等の原因で発生する。
関数は同期実行でのため、RemoteMCUが応答しないと制御がブロックする。非同期関数は今後実装する。

//execute NOP.
var mri=new  MiMicRemoteMcuInterface(“192.168.0.1”);
mri.connect(function(){});
mri.execBc(“ZAZZ.E”);//NOP;EXIT;

Parameters:
{string} i_bc: 整形済みのMiMicBC文字列。MiMicBCについては、MiMicVM.pdf の、MiMicBCの章を参照。

Returns:

MiMicVMのパース済みJavascriptObjectである。形式は以下の通り。

{version: string,result: int,stream int[]}

詳細は、 MiMicVM.pdf Appendix 1. MiMicVM HTTP Interfaceを参照。

{boolean} isConnected()

接続状態を真偽値で返す。接続状態の場合、execBc等の低レベルAPIを使用できる。状態は、インスタンスが定期的に実行するプローブ信号でチェックされ、更新される。

//show connection status
var mri=new  MiMicRemoteMcuInterface(“192.168.0.1”);
alert(mri.isConnected());

Returns:: {boolean} 接続状態。trueなら、MCUインタフェイスは利用可能。

MiMic javascript API specification

Classes

Class MiMicRemoteMcuInterface