API: orb

ここでは、Sphero.js の orb でなく、Orb クラスのインスタンスについて解説します。

メソッド

orb.link(key)

client と link します。

引数

• key (string) : link する client の key

戻り値

なし

orb.unlink(key)

client との link を解除します。

引数

• key (string) : link を解除する client の key

戻り値

なし

注意

指定した key が無効な場合、key に対する client と link されていない場合は、
エラーをスローします。

orb.command(name, args)

roll などの command を実行します。

引数

• name (string) : コマンド名。ex: roll、color
• args (Array) : コマンドに対する引数。

戻り値

なし

注意

command が無効であると、エラーをスローします。
command が有効かを調べるときは、hasCommand メソッドを使用してください。

orb.hasCommand(name)

指定した name の command が存在するかを返します。

引数

• name (string) : 検証するコマンド名

戻り値

boolean (コマンドが存在するか)

orb.disconnect()

外部からは使用しないでください。
外部から使用するときは、spheroServer.removeOrb を使用してください。

orb.name [readonly]

orbの名前

型

string

orb.instance [readonly]

Sphero.js の orb。 command の実行などは、orb.command を使用してください。 これは、orb.instance.on などで使用します。

型

Sphero.js の orb

orb.port

orb のシリアルポート

型

string

orb.linkedClients

orb に link されている client の一覧

型

Array

orb.on("disconnect", callback)

orb が disconnect された時に発生します。

callback の引数

なし