Class: Myo

Members

fwVersion :string

Firmware version of the Myo device (e.g. "1.1.4")

Type:

• string

Source:

• myoapi.js, line 159

macAddress :string

MAC address of the Myo device

Type:

• string

Source:

• myoapi.js, line 156

name :string

Given name of the Myo device

Type:

• string

Source:

• myoapi.js, line 153

Methods

equals(myo2) → {Boolean}

Comparison function

Parameters:

Name	Type	Description
myo2	Myo	Device to compare to

Source:

• myoapi.js, line 169

Returns:

true if it's the same Myo device, false otherwise.

Type

Boolean

getConnectionState(sCb, eCb)

Request the current connection state of the device

Parameters:

Name	Type	Description
sCb	ConnStateCallback	Success callback, which receives a MyoApi.ConnectionState representing the connection state of the device
eCb	ErrorCallback	Error callback

Source:

• myoapi.js, line 240

isConnected(sCb, eCb)

Check if the device is currently connected

Parameters:

Name	Type	Description
sCb	BooleanCallback	Success callback, which receives a boolean representing if the device is connected
eCb	ErrorCallback	Error callback

Source:

• myoapi.js, line 249

isUnlocked(sCb, eCb)

Request to get the current locking state of the device.

Parameters:

Name	Type	Description
sCb	SuccessCallback	Success callback, which will receive a boolean as result
eCb	ErrorCallback	Error callback

Source:

• myoapi.js, line 181

lock(sCb, eCb)

Request to lock the device.

Parameters:

Name	Type	Description
sCb	SuccessCallback	Success callback
eCb	ErrorCallback	Error callback

Source:

• myoapi.js, line 190

Fires:

• module:MyoApi#event:lock

notifyUserAction(sCb, eCb)

Request the device to notify the user (short vibration)

Parameters:

Name	Type	Description
sCb	SuccessCallback	Success callback
eCb	ErrorCallback	Error callback

Source:

• myoapi.js, line 226

requestRssi(sCb, eCb)

Request RSSI (received signal strength indication). The data is received via the callback registered with MyoApi.on for the "rssi" event.

Parameters:

Name	Type	Description
sCb	SuccessCallback	Success callback
eCb	ErrorCallback	Error callback

Source:

• myoapi.js, line 209

Fires:

• module:MyoApi#event:rssi

unlock(sCb, eCb)

Request to unlock the device.

Parameters:

Name	Type	Description
sCb	SuccessCallback	Success callback
eCb	ErrorCallback	Error callback

Source:

• myoapi.js, line 199

Fires:

• module:MyoApi#event:unlock

vibrate(vibrationType, sCb, eCb)

Send command to vibrate this device.

Parameters:

Name	Type	Description
vibrationType	MyoApi.VibrationType	Vibration type to be requested
sCb	SuccessCallback	Success callback
eCb	ErrorCallback	Error callback

Source:

• myoapi.js, line 218