getDevices(accessToken)

tries to get device list associated to accessToken.

If successful,

• returns device list of type Array{Dict}.
• assigns accessToken to currentAccessToken, the local variable.
• if non-empty device list is found, updates currentDevices and defaultDevice. Namely,
• assigns found device list to currentDevices, the local variable.
• assigns the first element of currentDevices to defaultDevice, the local variable, if currentDevices is not empty.

getAccessToken()

returns the current access token, i.e., currentAccessToken, the local variable of this package.

getCurrentDevices()

returns the current device list, i.e., getCurrentDevices, the local variable of this package.

getDefaultDevice()

returns the default device to which the WebAPI directs when target device is not specified in the call of askAction function.

getDefaultDeviceId()

returns the deviceId of the default device.

getDefaultDeviceNickname()

returns the nickname of the default device.

findDevice(;deviceId=nothing, nickname=nothing)

returns a device whose deviceID and/or nickname key(s) match(es) the corresponding parameter(s).

• Returns the result of getDefaultDevice() if both parameters are omitted.
• Returns Dict() if such a device is absent.

setDefaultDeviceNickname(;target_deviceId=nothing, target_nickname=nothing)

assigns the default device to the result of findDevice(deviceId=target_deviceId, nickname=target_nickname).

• The default device remains unchanged if such a device is absent.

askActionSimple(
  api_name,
  arguments,
  target_deviceId,
  timeoutLimit = 10)

asks a device to perform an action, and returns the result by Dict().

• api_name and arguments specify the action and arguments.

• target_deviceId specifies the deviceId of the target device.

• If timeoutLimit <= 0, immediately returns executionId.

• Otherwise, invokes getExecution(executionId, timeoutLimit).

• timeoutLimit specifies the limit of timeouts in seconds, and defaults to 10 (seconds).

askAction(
  api_name,
  arguments = Dict(); 
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks a device to perform an action, and returns the result by Dict().

• api_name and arguments specify the action and arguments.
  • arguments is optional, defaults to Dict().
• target device to which the Web API directs are determined as follows using two optional keyword arguments, target_deviceId and target_nickname
  • the result of getDefaultDevice() if both parameters are omitted.
  • the result of findDevice(deviceId=target_deviceID, nickname=target_nickname) if either or both parameters are present.
• If timeoutLimit <= 0, immediately returns executionId.
• Otherwise, invokes getExecution(executionId, timeoutLimit).
• timeoutLimit specifies the limit of timeouts in seconds, and defauls to 10 (seconds).

getExecution(
  executionId; 
  timeoutLimit=10 )

receives the result of executionId.

• timeoutLimit specifies the limit of timeouts in seconds, and defaults to 10 (seconds).

isStatusSucceeded(result)

returns whether the status of the request result is "SUCCEEDED" or not.

askSetMode(
  modeName="NORMAL";
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks set_mode.

• askSetMode should be one of the following strings:
  • NORMAL
  • DEVELOPMENT

This method is equivalent to askAction("set_mode", Dict(ModeName=>modeName, Enqueue=>enqueue))

askHungryStatus(;
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks hungry_status.

This method is equivalent to askAction("hungry_status")

askSleepyStatus(;
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks sleepy_status.

This method is equivalent to askAction("sleepy_status")

askBodyTouchedStatus(;
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks body_touched_status.

This method is equivalent to askAction("body_touched_status")

askPawPadsStatus(;
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks paw_pads_status.

This method is equivalent to askAction("paw_pads_status")

askPostureStatus(;
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks posture_status.

This method is equivalent to askAction("posture_status")

askChangePosture(
  finalPosture="sit";
  enquee=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks change_posture.

• finalPosture should be one of the following constants:
  • back
  • crouch
  • down
  • down_and_lengthen_behind
  • down_and_shorten_behind
  • sit_and_raise__both_hands
  • sit
  • sleep
  • stand
  • stand_straight

This method is equivalent to askAction("change_posture", Dict(FinalPosture=>finalPosture, Enqueue=>enqueue))

askMoveHead(;
  azimuth=0,
  elevation=0,
  velocity=0,
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks move_head.

• azimuth : -80 – 80 (degree)
• elevation : -40 – 40 (degree)
• velocity : 10 – 80 (deg/sec)

This method is equivalent to askAction("move_head", Dict(Duration=>duration, Enqueue=>enqueue))

askStay(;
  duration=60,
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks stay for duration seconds.

• duration : 0–360 (seconds)

This method is equivalent to askAction("stay", Dict(Duration=>duration, Enqueue=>enqueue))

askBitingStatus(;
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks biting_status.

This method is equivalent to askAction("biting_status")

askPlayBone(
  category="holdMouth";
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks play_bone.

This method is equivalent to askAction("play_bone", Dict(Category=>holdMouth, Enqueue=>enqueue))

askPlayDice(
  category="holdMouthDice";
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks change_posture.

• category should be one of the following constants:
  • holdMouthDice
  • rollDiceLeft
  • rollDiceRight
  • rollDicePush
  • rollDicePull
  • stackDice

This method is equivalent to askAction("play_dice", Dict(Category=>category, Enqueue=>enqueue))

askPlayMotion(
  category="agree";
  enqueue=false,
  mode="NONE",
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks play_motion.

• category should be one of the following constants. Optional Mode parameters other than "NONE" are also listed.

  • agree

  • bad

  • bark

  • beckon

    • Mode: BODY_LEFT
    • Mode: BODY_RIGHT

  • belch

  • bentBack

  • breath

  • curious

  • dance

  • drawInOnesChin

  • dreaming

  • friendly

  • friendlyPolite

  • gasp

  • halfAsleep

  • handsUp

  • happyOrHot

  • heading

    • Mode: NONE
    • Mode: SPACE_LEFT
    • Mode: SPACE_RIGHT

  • helloIloveYou

  • highFive

    • Mode: NONE
    • Mode: BODY_LEFT
    • Mode: BODY_RIGHT

  • imFriendly

  • jiggle

  • kiss

  • lickBody

    • Mode: BODY_LEFT
    • Mode: BODY_RIGHT

  • lookAroundHead

  • lookOver

  • marking

    • Mode: BOY
    • Mode: GIRL

  • nodHead

  • openMouth

  • overJoyed

  • paw

    • Mode: BODY_LEFT
    • Mode: BODY_RIGHT

  • peace

    • Mode: SPACE_LEFT
    • Mode: SPACE_RIGHT

  • perceive

  • playBiting

  • prettyPlease

  • ready

  • relax

  • restless

  • rubBack

  • scratchFloor

  • scratchHead

    • Mode: HIND_LEFT
    • Mode: HIND_RIGHT

  • shakeHead

  • shakeHipsBehind

  • shudder

  • sideKick

    • Mode: FRONT_LEFT
    • Mode: FRONT_RIGHT

  • sideUp

    • Mode: BODY_LEFT
    • Mode: BODY_RIGHT

  • sing

  • sleepTalking

  • sneeze

  • sniff

  • sniffDown

  • sniffUp

  • startled

  • startledLittle

  • stretch

  • swing

  • touched

    • Mode: SPACE_CENTER

  • waiting

  • washFace

  • whine

  • wiggleEar

    • Mode : BODY_BOTH

  • woof

  • yap

  • yawn

This method is equivalent to askAction("play_motion", Dict(Category=>category, Mode=>mode, Enqueue=>enqueue))

askNameCalledStatus(;
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks name_called_status.

This method is equivalent to askAction("name_called_status")

askVoiceCommandStatus(;
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks voice_command_status.

This method is equivalent to askAction("voice_command_status")

askApproachPerson(
  distanceFromTarget=1;
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks approach_person.

• distanceFromTarget : 0.4 – 2 (meter)

This method is equivalent to askAction("approach_person", Dict(DistanceFromTarget=>distanceFromTarget, Enqueue=>enqueue))

askChasePerson(
  chasingDurationMsec=15*1000;
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks chase_person.

• chasingDurationMsec : 0 – 360000 (milliseconds)

This method is equivalent to askAction("chase_person", Dict(ChasingDurationMsec=>chasingDurationMsec, Enqueue=>enqueue))

askFindPerson(;
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks find_person.

This method is equivalent to askAction("find_person")

askExplore(
  duration=60;
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks explore.

• duration : 0 – 360 (seconds)

This method is equivalent to askAction("explore", Dict(Duration=>duration, Enqueue=>enqueue))

askMoveToPosition(
  targetType="charging_station";
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks move_to_position.

• targetType : one of the following constants:
  • charging_station
  • greeting_spot
  • toilet

This method is equivalent to askAction("move_to_position", Dict(TargetType=>targetType, Enqueue=>enqueue))

askTurnAround(;
  turnAngle=0,
  turnSpeed=1,
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks turn_around.

• turnSpeed : one of 0 (slow), 1, 2 (fast)
• turnAngle : -180 – 180, counterclockwise with respect to the current aibo angle.

This method is equivalent to askAction("turn_around", Dict(TurnSpeed=> turnSpeed, TurnAngle=> turnAngle, Enqueue=>enqueue))

askMoveAlongCircle(;
  movingAngle=360,
  radius=1,
  walkSpeed=1,
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks move_along_circle.

• walkSpeed : one of 0 (slow), 1, 2 (fast)
• radius : 0.5 – 3 (meter)
• movingAngle : 0 – 1080 (degree)

This method is equivalent to askAction("move_along_circle", Dict(WalkSpeed=> walkSpeed, Radius=> radius, MovingAngle=>movingAngle, Enqueue=>enqueue))

askMoveDirection(;
  targetAngle=0,
  targetDistance=1,
  walkSpeed=1,
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks move_direction.

• walkSpeed : one of 0 (slow), 1, 2 (fast)
• targetDistance : 0 – 6 (meter)
• targetAngle : -180 – 180, counterclockwise with respect to the current aibo angle.

This method is equivalent to askAction("move_direction", Dict(WalkSpeed=> walkSpeed, TargetDistance=> targetDistance, TargetAngle=> targetAngle, Enqueue=>enqueue))

askMoveForward(;
  walkDistance=1,
  walkSpeed=1,
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks move_forward.

• walkSpeed : one of 0 (slow), 1, 2 (fast)
• walkDistance : -6 – 6 (meter)

This method is equivalent to askAction("move_forward", Dict(WalkSpeed=> walkSpeed, WalkDistance=> walkDistance, Enqueue=>enqueue))

askMoveSideways(;
  walkDistance=0.5,
  walkSpeed=1,
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks move_sideways.

• walkSpeed : one of 0 (slow), 1, 2 (fast)
• walkDistance : -6 – 6 (meter)

This method is equivalent to askAction("move_sideways", Dict(WalkSpeed=> walkSpeed, WalkDistance=> walkDistance, Enqueue=>enqueue))

askFindObject(
  targetType="pinkball";
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks find_object.

• targetType : one of the following constants:
  • aibo
  • aibone
  • dice
  • pinkball

This method is equivalent to askAction("find_object", Dict(TargetType=>targetType, Enqueue=>enqueue))

askFoundObjectsStatus(;
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks found_objects_status.

This method is equivalent to askAction("found_objects_status")

askChaseObject(
  targetType="pinkball";
  chasingDurationMsec=30*1000,
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks chase_object.

• targetType : one of the following constants:
  • aibo
  • aibone
  • dice
  • pinkball
• chasingDurationMsec : 0 – 360000 (milliseconds)

This method is equivalent to askAction("chase_object", Dict(TargetType=>targetType, ChasingDurationMsec=> chasingDurationMsec, Enqueue=>enqueue))

askApproachObject(
  targetType="pinkball";
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks approach_object.

• targetType : one of the following constants:
  • aibo
  • aibone
  • dice
  • pinkball

This method is equivalent to askAction("approach_object", Dict(TargetType=>targetType, Enqueue=>enqueue))

askGetCloseToObject(
  targetType="pinkball";
  distance=0.2,
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks get_close_to_object. Invoke this method after askApproachObject.

• targetType : one of the following constants:

  • aibo
  • aibone
  • dice
  • pinkball

• distance : 0.1 – 0.3 (meter)

This method is equivalent to askAction("get_close_to_object", Dict(TargetType=>targetType, Distance=>distance, Enqueue=>enqueue))

askKickObject(
  targetType="pinkball";
  kickMotion="kick",
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks kick_object.

• targetType : one of the following constants:

  • pinkball

• kickMotion : one of the following constants:

  • kick
  • heading

This method is equivalent to askAction("kick_object", Dict(TargetType=>targetType, KickMotion=>kickMotion, Enqueue=>enqueue))

askReleaseObject(
  targetType="aibone";
  enqueue=false,
  target_deviceID=nothing,
  target_nickname=nothing,
  timeoutLimit=10)

asks release_object.

• targetType : one of the following constants:
  • aibone
  • dice

This method is equivalent to askAction("release_object", Dict(TargetType=>targetType, Enqueue=>enqueue))