103 lines
3.2 KiB
JavaScript
103 lines
3.2 KiB
JavaScript
/**
|
|
* @description Enum of skill disconnect reasons
|
|
* @typedef DisconnectReason
|
|
* @prop 4000 Skill closed by user
|
|
* @prop 4001 Skill closed due to robot error
|
|
* @prop 4002 Incoming connection is replacing previous connection
|
|
* @prop 4003 Connection closed due to inactivity
|
|
* @prop 4004 Session closed due to reconnection time out
|
|
* @prop 4005 Session closed due to failed reconnection
|
|
*/
|
|
|
|
/**
|
|
* Enum of Jibo's available attention modes.
|
|
* @typedef AttentionMode
|
|
* @prop Off
|
|
* @prop Idle
|
|
* @prop Disengage
|
|
* @prop Engaged
|
|
* @prop Speaking
|
|
* @prop Fixated
|
|
* @prop Attractable
|
|
* @prop Menu
|
|
* @prop Command
|
|
*/
|
|
|
|
/**
|
|
* @typedef DisplayViewType
|
|
* @description Enum of available display types
|
|
* @prop Eye Display Jibo's eye on screen.
|
|
* @prop Text Display text on screen.
|
|
* @prop Image Display an image on screen.
|
|
*/
|
|
|
|
/**
|
|
* @typedef CameraResolution
|
|
* @description Enum of camera resolutions
|
|
* @prop HighRes Currently unsupported
|
|
* @prop MedRes Higher res than default
|
|
* @prop LowRes Default
|
|
* @prop MicroRes Lower res than default
|
|
*/
|
|
|
|
/**
|
|
* Enum of available swipe directions.
|
|
* @typedef SwipeDirection
|
|
* @prop Up
|
|
* @prop Down
|
|
* @prop Right
|
|
* @prop Left
|
|
*/
|
|
|
|
/**
|
|
* Camera options.
|
|
* @typedef Camera
|
|
* @prop left Default
|
|
* @prop right Currently unsupported
|
|
*/
|
|
|
|
/**
|
|
* Enum of entity (face) types.
|
|
* @typedef EntityType
|
|
* @prop person Face is a loop member.
|
|
* @prop unknown Face is not a loop member.
|
|
*/
|
|
|
|
/**
|
|
* @typedef DisplayChangeType
|
|
* @description Enum of ways to change display
|
|
* @prop Swap Swap the current view for another
|
|
*/
|
|
|
|
/**
|
|
* @typedef ResponseCode
|
|
* @description Enum of response codes
|
|
* @prop OK `200` - The command was accepted and executed. Synchronous calls only.
|
|
* @prop Created `201` - The command was accepted and executed. Synchronous calls only.
|
|
* @prop Accepted `202` - The command was accepted and will begin execution. Most asynchronous commands will get a this response.
|
|
* @prop BadRequest `400` - Badly formatted request.
|
|
* @prop Forbidden `403` - The command request is not a supported command.
|
|
* @prop NotFound `404` - Command not found.
|
|
* @prop NotAcceptable `406` - The data in the command is not acceptable.
|
|
* @prop RequestTimeout `407 - Unable to marshal the resources and set up the command within the time limits set in the Controller.
|
|
* @prop Conflict `409` - There is a conflicting command already executing
|
|
* @prop PreconditionFailed `412` - The execution of the command requires the execution of a prior command.
|
|
* @prop InternalError `500` - The Controller has crashed or hit a different error that was unexpected.
|
|
* @prop ServiceUnavailable `503` - The Controller is temporarily unavailable. The Robot SSM may be rebooting something.
|
|
* @prop VersionNotSupported `505` - The Version requested is not supported.
|
|
* @prop VersionConflict `506` - The Version requested is not the same version of the current connection.
|
|
*/
|
|
|
|
/**
|
|
* @typedef VideoType
|
|
* @description Enum of video types
|
|
* @prop Normal `NORMAL` Default
|
|
* @prop Debug `DEBUG` Currently unsupported.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ProtocolVersions
|
|
* @description Two of everything! `JIBO.ProtocolVersions` lives in Phoenix repos.
|
|
* @prop v1 {JIBO.ProtocolVersions.v1} `1.0`
|
|
* @prop v2 {JIBO.ProtocolVersions.v2} `2.0`
|
|
*/ |