Skip to content

4.5.1 websocket commands

James Collins edited this page Jul 17, 2018 · 1 revision

Commands

self.cmds["cadet_pong"] = {"proxy":"self", "function":"cadet_pong", "noauth":True, "runonly":False, "result":"pong", "parameters":[{"name":"client", "type":"client"}]} self.cmds["cadet_setup"] = {"proxy":"self", "function":"cadet_setup", "noauth":True, "runonly":False, "result":"id", "parameters":[{"name":"domain", "type":"str"},{"name":"admin", "type":"str"},{"name":"root", "type":"str"}, {"name":"client", "type":"client"}]} self.cmds["cadet_restart"] = {"proxy":"self", "function":"cadet_restart", "noauth":True, "runonly":False, "parameters":[{"name":"client", "type":"client"}]} self.cmds["cadet_quit"] = {"proxy":"self", "function":"cadet_quit", "noauth":True, "runonly":False, "parameters":[{"name":"client", "type":"client"}]} self.cmds["cadet_cmdrunning"] = {"proxy":"self", "function":"cadet_cmdRunning", "result":"running", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"client", "type":"client"}]} self.cmds["cadet_runlock"] = {"proxy":"self", "function":"cadet_runLock", "runonly":False, "parameters":[{"name":"lock", "type":"bool"}, {"name":"client", "type":"client"}]} self.cmds["cadet_touchState"] = {"proxy":"self", "function":"nao_touchState", "result":"state", "parameters":[{"name":"name", "type":"str"}, {"name":"client", "type":"client"}]} self.cmds["cadet_msec"] = {"proxy":"self", "function":"cadet_msec", "result":"msec", "parameters":[{"name":"client", "type":"client"}]} self.cmds["cadet_naoreboot"] = {"proxy":"system", "function":"reboot", "runonly":False} self.cmds["cadet_naoshutdown"] = {"proxy":"system", "function":"shutdown", "runonly":False}

    self.cmds["cadet_settinglist"] = {"proxy":"self", "function":"cadet_settingList", "result":"settings", "runonly":False, "parameters":[{"name":"client", "type":"client"}]}
    self.cmds["cadet_settingget"] = {"proxy":"self", "function":"cadet_settingGet", "noauth":True, "result":"value", "runonly":False, "parameters":[{"name":"setting", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_settingset"] = {"proxy":"self", "function":"cadet_settingSet", "noauth":True, "runonly":False, "parameters":[{"name":"setting", "type":"str"}, {"name":"value", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_settingdelete"] = {"proxy":"self", "function":"cadet_settingDelete", "runonly":False, "parameters":[{"name":"setting", "type":"str"}, {"name":"client", "type":"client"}]}

    self.cmds["cadet_domainlist"] = {"proxy":"self", "function":"cadet_domainList", "result":"domains", "runonly":False, "parameters":[{"name":"client", "type":"client"}]}
    self.cmds["cadet_domainget"] = {"proxy":"self", "function":"cadet_domainGet", "noauth":True, "result":"domain", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_domainset"] = {"proxy":"self", "function":"cadet_domainSet", "result":"id", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"name", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_domaindelete"] = {"proxy":"self", "function":"cadet_domainDelete", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_domainrestore"] = {"proxy":"self", "function":"cadet_domainRestore", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_domainunlink"] = {"proxy":"self", "function":"cadet_domainUnlink", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}

    self.cmds["cadet_userlist"] = {"proxy":"self", "function":"cadet_userList", "result":"users", "runonly":False, "noauth":True, "parameters":[{"name":"domain", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_userget"] = {"proxy":"self", "function":"cadet_userGet", "noauth":True, "result":"user", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_userset"] = {"proxy":"self", "function":"cadet_userSet", "result":"id", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"name", "type":"str", "default":""}, {"name":"domain", "type":"int", "default":0}, {"name":"options", "type":"str", "default":""}, {"name":"password", "type":"str", "default":""}, {"name":"currentPassword", "type":"str", "default":""}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_userlogin"] = {"proxy":"self", "function":"cadet_userLogin", "noauth":True, "result":"user", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"password", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_userdelete"] = {"proxy":"self", "function":"cadet_userDelete", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_userrestore"] = {"proxy":"self", "function":"cadet_userRestore", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_userunlink"] = {"proxy":"self", "function":"cadet_userUnlink", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}

    self.cmds["cadet_scriptlist"] = {"proxy":"self", "function":"cadet_scriptList", "noauth":True, "result":"scripts", "runonly":False, "parameters":[{"name":"domain", "type":"int"}, {"name":"tutorial", "type":"bool", "default":False}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_scriptget"] = {"proxy":"self", "function":"cadet_scriptGet", "result":"script", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_scriptset"] = {"proxy":"self", "function":"cadet_scriptSet", "result":"id", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"name", "type":"str", "default":""}, {"name":"user", "type":"int", "default":0}, {"name":"options", "type":"str", "default":""}, {"name":"xml", "type":"str", "default":""}, {"name":"lock", "type":"int", "default":-1}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_scriptdelete"] = {"proxy":"self", "function":"cadet_scriptDelete", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_scriptrestore"] = {"proxy":"self", "function":"cadet_scriptRestore", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_scriptunlink"] = {"proxy":"self", "function":"cadet_scriptUnlink", "runonly":False, "parameters":[{"name":"id", "type":"int"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_scriptchangedir"] = {"proxy":"self", "function":"cadet_scriptChangeDir", "runonly":False, "parameters":[{"name":"olddir", "type":"str"}, {"name":"newdir", "type":"str"}, {"name":"domain", "type":"int"}, {"name":"client", "type":"client"}]}

    self.cmds["cadet_filelist"] = {"proxy":"self", "function":"cadet_fileList", "result":"files", "runonly":False, "parameters":[{"name":"client", "type":"client"}]}
    self.cmds["cadet_fileupload"] = {"proxy":"self", "function":"cadet_fileUpload", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"offset", "type":"int"}, {"name":"data", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_filerename"] = {"proxy":"self", "function":"cadet_fileRename", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"newname", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_filedelete"] = {"proxy":"self", "function":"cadet_fileDelete", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_filerestore"] = {"proxy":"self", "function":"cadet_fileRestore", "result":"name", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_fileunlink"] = {"proxy":"self", "function":"cadet_fileUnlink", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_fileexists"] = {"proxy":"self", "function":"cadet_fileExists", "result":"exists", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_filecleartmp"] = {"proxy":"self", "function":"cadet_fileClearTemp", "runonly":False}

    self.cmds["cadet_motionlist"] = {"proxy":"self", "function":"cadet_motionList", "runonly":False, "result":"motions", "parameters":[{"name":"client", "type":"client"}]}
    self.cmds["cadet_motionget"] = {"proxy":"self", "function":"cadet_motionGet", "runonly":False, "result":"motion", "parameters":[{"name":"name", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_motionexists"] = {"proxy":"self", "function":"cadet_motionExists", "runonly":False, "result":"exists", "parameters":[{"name":"name", "type":"str"}]}
    self.cmds["cadet_motionset"] = {"proxy":"self", "function":"cadet_motionSet", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"newname", "type":"str", "default":""}, {"name":"movements", "type":"array", "default":None}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_motiondelete"] = {"proxy":"self", "function":"cadet_motionDelete", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_motionrestore"] = {"proxy":"self", "function":"cadet_motionRestore", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"newname", "type":"str", "default":""}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_motionunlink"] = {"proxy":"self", "function":"cadet_motionUnlink", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_motionrun"] = {"proxy":"self", "function":"cadet_motionRun", "runonly":False, "parameters":[{"name":"motion", "type":"str"}, {"name":"client", "type":"client"}]}
    self.cmds["cadet_motionstop"] = {"proxy":"self", "function":"cadet_motionStop", "runonly":False, "parameters":[{"name":"client", "type":"client"}]}
    self.cmds["cadet_motionrunning"] = {"proxy":"self", "function":"cadet_motionRunning", "runonly":False, "result":"motion", "parameters":[{"name":"client", "type":"client"}]}

    self.cmds["cadet_backup"] = {"proxy":"self", "function":"cadet_backup", "runonly":False, "parameters":[{"name":"client", "type":"client"}]}
    self.cmds["cadet_restore"] = {"proxy":"self", "function":"cadet_restore", "runonly":False, "parameters":[{"name":"name", "type":"str"}, {"name":"client", "type":"client"}]}

    self.cmds["animatedspeech_say"] = {"proxy":"animatedSpeech", "function":"say", "parameters":[{"name":"string", "type":"str"}, {"name":"configuration", "type":"array", "default":"{\"bodyLanguageMode\":\"contextual\"}"}]}

    self.cmds["audiodevice_getoutputvolume"] = {"proxy":"audioDevice", "function":"getOutputVolume", "result":"volume", "runonly":False}
    self.cmds["audiodevice_setoutputvolume"] = {"proxy":"audioDevice", "function":"setOutputVolume", "runonly":False, "parameters":[{"name":"volume", "type":"int"}]}
    self.cmds["audiodevice_startmicrophonesrecording"] = {"proxy":"self", "function":"audioDevice_startMicrophonesRecording", "runonly":False, "parameters":[{"name":"name", "type":"file"}, {"name":"client", "type":"client"}]}
    self.cmds["audiodevice_stopmicrophonesrecording"] = {"proxy":"self", "function":"audioDevice_stopMicrophonesRecording", "runonly":False, "parameters":[{"name":"client", "type":"client"}]}
    self.cmds["audiodevice_muteaudioout"] = {"proxy":"audioDevice", "function":"muteAudioOut", "parameters":[{"name":"mute", "type":"bool"}]}

    self.cmds["audioplayer_playfile"] = {"proxy":"audioPlayer", "function":"playFile", "post":True, "allowidle":True, "parameters":[{"name":"name", "type":"file"}, {"name":"volume", "type":"float", "default":1}, {"name":"pan", "type":"float", "default":0}]}
    self.cmds["audioplayer_playsine"] = {"proxy":"audioPlayer", "function":"playSine", "parameters":[{"name":"hertz", "type":"int"}, {"name":"gain", "type":"int"}, {"name":"pan", "type":"int"}, {"name":"duration", "type":"float"}]}

    self.cmds["behavior_getinstalledbehaviors"] = {"proxy":"behavior", "function":"getInstalledBehaviors", "result":"behaviors", "runonly":False}
    self.cmds["behavior_getrunningbehaviors"] = {"proxy":"behavior", "function":"getRunningBehaviors", "result":"behaviors", "runonly":False}
    self.cmds["behavior_startbehavior"] = {"proxy":"behavior", "function":"startBehavior", "allowidle":True, "parameters":[{"name":"name", "type":"str"}]}
    self.cmds["behavior_isbehaviorrunning"] = {"proxy":"behavior", "function":"isBehaviorRunning", "result":"running", "runonly":False, "parameters":[{"name":"name", "type":"str"}]}
    self.cmds["behavior_stopbehavior"] = {"proxy":"behavior", "function":"stopBehavior", "result":"running", "runonly":False, "parameters":[{"name":"name", "type":"str"}]}

    self.cmds["battery_getcharge"] = {"proxy":"battery", "function":"getBatteryCharge", "result":"percent", "runonly":False, "virtual":100}

    self.cmds["leds_fade"] = {"proxy":"leds", "function":"fade", "parameters":[{"name":"name", "type":"str"}, {"name":"intensity", "type":"float"}, {"name":"duration", "type":"float"}]}
    self.cmds["leds_fadergb"] = {"proxy":"leds", "function":"fadeRGB", "parameters":[{"name":"name", "type":"str"}, {"name":"rgb", "type":"int16"}, {"name":"duration", "type":"float"}]}
    self.cmds["leds_off"] = {"proxy":"leds", "function":"off", "parameters":[{"name":"name", "type":"str"}]}
    self.cmds["leds_on"] = {"proxy":"leds", "function":"on", "parameters":[{"name":"name", "type":"str"}]}
    self.cmds["leds_randomeyes"] = {"proxy":"leds", "function":"randomEyes", "parameters":[{"name":"duration", "type":"float"}]}
    self.cmds["leds_rasta"] = {"proxy":"leds", "function":"rasta", "parameters":[{"name":"duration", "type":"float"}]}
    self.cmds["leds_reset"] = {"proxy":"leds", "function":"reset", "parameters":[{"name":"name", "type":"str"}]}
    self.cmds["leds_rotateeyes"] = {"proxy":"leds", "function":"rotateEyes", "parameters":[{"name":"rgb", "type":"int"}, {"name":"speed", "type":"float"}, {"name":"duration", "type":"float"}]}
    self.cmds["leds_setintensity"] = {"proxy":"leds", "function":"setIntensity", "parameters":[{"name":"name", "type":"str"}, {"name":"intensity", "type":"float"}]}

    self.cmds["motion_getrobotconfig"] = {"proxy":"motion", "function":"getRobotConfig", "result":"config", "runonly":False}
    self.cmds["motion_move"] = {"proxy":"motion", "function":"move", "parameters":[{"name":"x", "type":"float"}, {"name":"y", "type":"float"}, {"name":"theta", "type":"float"}]}
    self.cmds["motion_stop"] = {"proxy":"motion", "function":"stopMove"}
    self.cmds["motion_moveisactive"] = {"proxy":"motion", "function":"moveIsActive", "result":"active"}
    self.cmds["motion_openhand"] = {"proxy":"motion", "function":"openHand", "parameters":[{"name":"name", "type":"str"}]}
    self.cmds["motion_closehand"] = {"proxy":"motion", "function":"closeHand", "parameters":[{"name":"name", "type":"str"}]}
    self.cmds["motion_getstiffnesses"] = {"proxy":"motion", "function":"getStiffnesses", "result":"stiffnesses", "parameters":[{"name":"name", "type":"str"}]}
    self.cmds["motion_setstiffnesses"] = {"proxy":"motion", "function":"setStiffnesses", "allowidle":True, "parameters":[{"name":"name", "type":"array"}, {"name":"stiffness", "type":"float"}]}
    self.cmds["motion_setangles"] = {"proxy":"motion", "function":"setAngles", "parameters":[{"name":"name", "type":"str"}, {"name":"radians", "type":"float"}, {"name":"speed", "type":"float"}]}
    self.cmds["motion_angleinterpolation"] = {"proxy":"motion", "function":"angleInterpolation", "allowidle":True, "parameters":[{"name":"name", "type":"array"}, {"name":"radians", "type":"array"}, {"name":"speed", "type":"float"}, {"name":"absolute", "type":"bool"}]}
    self.cmds["motion_setfootsteps"] = {"proxy":"self", "function":"setFootSteps", "parameters":[{"name":"legNames", "type":"array"}, {"name":"footSteps", "type":"array"}, {"name":"timeList", "type":"array"}, {"name":"clearExisting", "type":"bool"}]}
    self.cmds["motion_wakeup"] = {"proxy":"motion", "function":"wakeUp"}
    self.cmds["motion_rest"] = {"proxy":"motion", "function":"rest"}
    self.cmds["motion_waituntilmoveisfinished"] = {"proxy":"motion", "function":"waitUntilMoveIsFinished", "runonly":False}

    self.cmds["photocapture_takepicture"] = {"proxy":"self", "function":"photoCapture_takePicture", "parameters":[{"name":"name", "type":"str"}]}

    self.cmds["posture_gotoposture"] = {"proxy":"posture", "function":"goToPosture", "allowidle":True, "parameters":[{"name":"name", "type":"str"}, {"name":"speed", "type":"float"}]}

    self.cmds["system_robotname"] = {"proxy":"system", "function":"robotName", "result":"name", "runonly":False, "virtual":"virtual-nao"}
    self.cmds["system_systemversion"] = {"proxy":"system", "function":"systemVersion", "result":"version", "runonly":False, "virtual":0}
    self.cmds["system_timezone"] = {"proxy":"system", "function":"timezone", "result":"timezone", "runonly":False, "virtual":""}
    self.cmds["system_freememory"] = {"proxy":"system", "function":"freeMemory", "result":"size", "runonly":False, "virtual":0}

    self.cmds["textToSpeech_say"] = {"proxy":"textToSpeech", "function":"say", "parameters":[{"name":"string"}]}
    self.cmds["textToSpeech_done"] = {"proxy":"self", "function":"textToSpeech_done", "result":"running", "runonly":False}

videorecorder_startrecording

Item Detail
Description Starts recording video using the camera on the NAO and saves it as an .avi in the scriptdocs folder using the specified name. This will override any previous files of the same name that exist.
Auth req yes
Runlock req yes
Returns none

Parameters:

Parameter Type Description
name STR file name to save the video recording. .avi will be appended if it does not exist in the string.

videorecorder_stoprecording

Item Detail
Description Stops recording video previously started using the videorecorder_startrecording command.
Auth req yes
Runlock req yes
Returns none

Parameters: none

Clone this wiki locally