Private #defaultPrivate #fragmentedPrivate #timeoutPrivate #wsPrivate #wsstateProtected _actionProtected _eventProtected _eventProtected _eventProtected _serviceProtected subscribedPrivate #forcePrivate #processPrivate #subscribePrivate #throwPrivate #unsubscribePrivate #wsPrivate #wsPrivate #wsPrivate #wsProtected _sendProtected _subscribeOptional feedback_cb: EventCallback<ActionFeedbackType[T]>Subscribe to a topic event and attach callback
Subscribe to a topic event and attach callback
Reset database
Reset all the database 🗑
Optional feedback_cb: EventCallback<ResetDatabaseFeedback>Feedback callback of action
RoboccDocs for further information
Add sound
Add new sound in library
Parameters
Optional feedback_cb: EventCallback<AddSoundFeedback>Feedback callback of action
RoboccDocs for further information
Delete sound
Delete sound from library
Name of sound to delete
RoboccDocs for further information
Set internal data
Set internal data that are stored in the vehicle. API client can use this to store any data it wishes 💾
Data
RoboccDocs for further information
Delete charging station
Delete charging station via its ID 🗑
Id charging station
RoboccDocs for further information
Get new charging station from a marker
Ask vehicle for a charging station object from a given marker
Marker
Set charging station
Set a charging station by giving all its attributes. Set id to -1 to create a new one
Charging station
Update charging station from new config
Update a charging station object from a given distance
Charging station object and distances
Delete custom area
Delete custom area via its ID 🗑
Id custom area
RoboccDocs for further information
Set custom area
Set a custom area by giving all its attributes. Set id to -1 to create a new one
Custom area
Delete docked pose
Delete docked pose via its ID 🗑
Id docked pose
RoboccDocs for further information
Get new docked pose from a marker
Ask vehicle for a docked pose object from a given marker
Marker
Set docked pose
Set a docked pose by giving all its attributes. Set id to -1 to create a new one
Docked pose,
Update docked pose from config
Update a docked pose object from a given distance
Docked pose object and distances
Erase active map
Apply eraser polygons on the current map
Parameters
Optional feedback_cb: EventCallback<EraseActiveMapFeedback>Feedback callback of action
RoboccDocs for further information
Delete forbidden area
Delete forbidden area via its ID 🗑
Id forbidden area
RoboccDocs for further information
Generate forbidden areas
Automatically creates forbidden areas for the active map
Parameters for auto generate forbidden areas
Optional feedback_cb: EventCallback<null>Feedback callback of action
Set forbidden area
Set a forbidden area by giving all its attributes. Set id to -1 to create a new one
Forbidden area
Check pose
Check if a pose is correct for vehicle in its current map. If no pose provided it will check vehicle's current pose 🔍
Optional check_pose_data: CheckPoseParamsPose parameters. Don't send params to use the current robot pose
Delete map
Delete map via its ID 🗑
Id map
RoboccDocs for further information
Get active map
Get the vehicle's current map 🗺️
Get active map elements
Get map elements for active map
Get active map without images
Get map without images for active map 🗺️
Get map
Get a map for a given id 🗺️
id map
Get map elements
Get map elements for given map's ID
id map
Get map without images
Get map without images for given map's ID 🗺️
id map
List maps
Get all maps in site for given site's ID 🗺️
Id site
Merge maps
Merge maps
Parameters for merge maps
Optional feedback_cb: EventCallback<MergeMapsFeedback>Feedback callback of action
RoboccDocs for further information
Set active map
Set given ID map as active vehicle's map. It will also change active site if different than current 🗺️
Id of map
Optional feedback_cb: EventCallback<SetActiveMapFeedback>Feedback callback of action
RoboccDocs for further information
Set map
Set map by giving all its attributes and elements. Set id to -1 to create a new element, omit some attributes to not change them 🗺️
Map object
Optional feedback_cb: EventCallback<SetMapFeedback>Feedback callback of action
Get markers around the vehicle
Get markers visible by the vehicle at its current position 🚨
Reference
Optional feedback_cb: EventCallback<GetMarkersFeedback>Feedback callback of action
Get shelves around the vehicle
Get list of shelves relative to the vehicle
Shelf size
Delete saved pose
Delete saved pose via its ID 🗑
Id saved pose
RoboccDocs for further information
Set saved pose
Set a saved pose by giving all its attributes. Set id to -1 to create a new one
Saved pose
Delete site
Delete site via its ID 🗑
Id site
RoboccDocs for further information
Export site
Export a site by providing its ID 📁
Export multiple sites
Export sites by providing array of ids. Returns an array of files with site ids 🗃️
Get active site
Get the vehicle's current active site
Get active site with maps
Get the vehicle's current active site with maps
Get site
Get a vehicle's site for given id
id site
Get site with maps
Get a vehicle's site with maps for given id
id site
Import site
Import site onto the vehicle from a Robocc exported file 📁
Base 64 of export file
Import sounds config
Import sounds config onto the vehicle from a Robocc exported file 📁
Base 64 of export file
List sites
Get all vehicle's sites
List sites with maps
Get all vehicle's sites with maps
Set site
Set a vehicle site
site
Start mapping
Start a mapping from a given site ID and map name to save it at the end of the process ▶️
Parameters
Optional feedback_cb: EventCallback<MappingStartFeedback>Feedback callback of action
RoboccDocs for further information
Stop mapping
Stop mapping and save the created map if save_map is true ⏹
Save mapping
Optional feedback_cb: EventCallback<MappingStopFeedback>Feedback callback of action
Authenticate module
Authenticate module using API key 🔐
API Key
RoboccDocs for further information
Disable module
Disable active module, it will be forced to authenticate itself again ⛔
Optional feedback_cb: EventCallback<DisableModuleFeedback>Feedback callback of action
RoboccDocs for further information
Install module
Install module from module file and API key 🛠
Module data
Optional feedback_cb: EventCallback<InstallModuleFeedback>Feedback callback of action
RoboccDocs for further information
Set module data
Set module data that are stored in the vehicle. The module can use this to store any data it wishes 💾
Data
RoboccDocs for further information
Set module parameters
Set dynamically module parameters, i.e. max speed, height and weight ⚙
Parameters
RoboccDocs for further information
Set autopilot config
Set autopilot sequence
Configuration
RoboccDocs for further information
Start autopilot
Start configured autopilot sequence ▶
Resume
RoboccDocs for further information
Stop autopilot
Stop current autopilot sequence ⏹
RoboccDocs for further information
Undock
Undock the vehicle from a docked pose or a charging station
Optional override_battery_safety: booleanOverride battery safety
Optional feedback_cb: EventCallback<string>Feedback callback of action
RoboccDocs for further information
Undock from shelf
Undock the vehicle from a shelf
Optional d: numberUndock distance
Optional feedback_cb: EventCallback<string>Feedback callback of action
RoboccDocs for further information
Check 3D box
Check if a box is free
Pose parameters. Don't send params to use the current robot pose
Check 3D box
Check if a box is free
Pose parameters. Don't send params to use the current robot pose
Optional feedback_cb: EventCallback<Check3dBoxActionFeedback>Feedback callback of action
FollowMe
Start or Stop the follow me feature 👣
Start Stop command
RoboccDocs for further information
Follow Me Reset tracking
Reset tracking of follow me
Direction of person to follow
RoboccDocs for further information
FollowMe Set Mode
Set follow mode
Follow mode
RoboccDocs for further information
Get path
Ask vehicle for the path between start and target pose. If start pose is not provided, current vehicle pose will be used instead
Parameters
Optional feedback_cb: EventCallback<GetPathFeedback>Feedback callback of action
Stop navigation
Stop the navigation on the vehicle, it will no longer be able to move autonomously ⛔
RoboccDocs for further information
Set prohibit movement
Set this to prohibit all movements of vehicle. Only callable from module 🚫
Prohibit movement
RoboccDocs for further information
Set vehicle pose
Indicate to the vehicle where it's located on the map. Can be used if the vehicle lost its localization, although relocation via docked pose or charging station provides better accuracy. Navigation will be started if needed 🎯
Parameters
Optional feedback_cb: EventCallback<SetVehiclePoseFeedback>Feedback callback of action
RoboccDocs for further information
Veh to charging station
Ask vehicle to move to given uuid charging_station. Set -1 for preferred charging station
Parameters
Optional feedback_cb: EventCallback<VehToChargingStationFeedback>Feedback callback of action
RoboccDocs for further information
Veh to charging station approach
Ask vehicle to move to given uuid charging_station approach. Set -1 for preferred charging station
Parameters
Optional feedback_cb: EventCallback<VehToChargingStationApproachFeedback>Feedback callback of action
RoboccDocs for further information
Veh to docked pose
Ask vehicle to move and dock to given uuid docked pose
Parameters
Optional feedback_cb: EventCallback<VehToDockedPoseFeedback>Feedback callback of action
RoboccDocs for further information
Veh to docked pose approach
Ask vehicle to move to given uuid docked pose approach
Parameters
Optional feedback_cb: EventCallback<VehToDockedPoseApproachFeedback>Feedback callback of action
RoboccDocs for further information
Veh to pose
Ask vehicle to move to the given pose 🎯
Parameters
Optional feedback_cb: EventCallback<VehToPoseFeedback>Feedback callback of action
RoboccDocs for further information
Veh to saved pose
Ask vehicle to move to given uuid saved pose
Parameters
Optional feedback_cb: EventCallback<VehToSavedPoseFeedback>Feedback callback of action
RoboccDocs for further information
Nav segment
Ask vehicle to move straight between two poses ↗️
Parameters
Optional feedback_cb: EventCallback<VehToSegmentFeedback>Feedback callback of action
RoboccDocs for further information
Recovery
Start the recovery process, vehicle will scan for markers around it, and set its position correctly from a known marker in map 🔍
Optional feedback_cb: EventCallback<RecoveryFeedback>Feedback callback of action
RoboccDocs for further information
Get teleop Active
Check if teleop is active or not
Set telop active
Activate or deactivate teleop, vehicle will accept or ignore teleop orders
Set or not teleop active
RoboccDocs for further information
Teleop
Send move orders to vehicle via angular and linear speed
Teleop command
RoboccDocs for further information
Teleop - Assisted with map
Send move orders to vehicle via angular and linear speed, assistance allows tracking of walls and prohibited areas
Teleop command
RoboccDocs for further information
Teleop - Assisted without map
Send move orders to vehicle via angular and linear speed, assistance allows tracking of walls
Teleop command
RoboccDocs for further information
Simulation - Add shelf
Add shelf in simulation world
Parameters
RoboccDocs for further information
Simulation - Set charge power delivery
Set the charge power delivered by the fake charging stations in simulation for developement purpose 🔌
Charge power delivery
RoboccDocs for further information
Simulation - Set charger of charging stations on
Enable or disable power on the fake charging stations in simulation for developement purpose 🔌
Charger is on
RoboccDocs for further information
Simulation - Set battery percentage
Set the battery percentage in simulation for developement purpose 🔋
Battery percentage
RoboccDocs for further information
Simulation - Set robot power consumption
Set the power consumption of the battery in simulation for developement purpose 🔌
Power consumption
RoboccDocs for further information
Simulation - Clear shelfs
Clear shelfs in simulation world
RoboccDocs for further information
Simulation - Reset gazebo world 🔄
Reset simulation world
RoboccDocs for further information
Simulation - Set diff driver state
Set diff drive state in simulation to simulate some vehicule errors
Diff driver state
RoboccDocs for further information
Simulate set sound is playing
In simulation mode, set that a sound is currently playing for developement purpose ⏯️
Set sound is playing
RoboccDocs for further information
Simulate set external speaker
In simulation mode, set external speaker is present purpose ⏯️
Set external speaker present
RoboccDocs for further information
Authenticate user
Authenticate user using API key 🔐
API Key
Login
Check user credentials and retrieve api key and other infos from user login and password 🔍
Parameters
Logout
Logout
RoboccDocs for further information
Delete user
Delete user via its ID 🗑️
Id user
RoboccDocs for further information
Get user
Get user for given id 👨🏽🦱
id user
List users
Get all users from vehicle configuration application
Set user
Create or edit an user for the vehicle configuration application 👨🏽🦱
User data
Set hibernate
Start or stop the hibernate mode
Start Stop command
RoboccDocs for further information
Set OBT CBT
Set operational battery threshold (the vehicle is allowed to execute mission) and critical battery threshold (the vehicle is forced to charge itself) 🪫
Battery parameters
RoboccDocs for further information
Set sleeping
Start or stop the sleeping mode
Start Stop command
RoboccDocs for further information
Cancel actions
Cancel ongoing action on vehicle ⏹
RoboccDocs for further information
Get vehicle elements list
Get all vehicle elements
Set car mode on leds
Enable or disable car mode (front LED corners in white, back LED corners in red) 🚗
Mode on
RoboccDocs for further information
Set custom led
Set a custom LED display by giving a led animation, a color (optional depending on animation), an optional duration for the custom display 🚥
Parameters
RoboccDocs for further information
Set maintenance mode
Enable or disable maintenance mode that blocks module orders but allows teleop and configuration application orders. Required for some API orders 🚧
Mode maintenance on
RoboccDocs for further information
Start cycle
Allow vehicle to move, need to be called at vehicle start or end of maintenance ▶
RoboccDocs for further information
Enable dynamic filters
Enable/disable dynamic filters
Enable/disable
RoboccDocs for further information
Hotspot enable
Enable or disable vehicle emitted hotspot 🛜
Enable hotspot
Optional feedback_cb: EventCallback<null>Feedback callback of action
RoboccDocs for further information
Set Hotspot passowrd
Set vehicle the password for the emitted wifi hotspot 🛜
New password
RoboccDocs for further information
Network redirect port
Start or stop redirect port form noeme to ip
Parameters
RoboccDocs for further information
WAN network configuration
Set wifi and IP configuration for WAN network 🌐
Parameters for WAN configuration
Optional feedback_cb: EventCallback<null>Feedback callback of action
RoboccDocs for further information
WAN network enable
Enable or disable WAN network 🌐
Enable WAN connection
Optional feedback_cb: EventCallback<null>Feedback callback of action
RoboccDocs for further information
WAN scan APs
Start scan and list all detected Wi-Fi access points by the vehicle. Can take up to 10 seconds 🛜
Optional feedback_cb: EventCallback<WifiAp[]>Feedback callback of action
Wifi list APs
List all detected Wi-Fi access points by the vehicle. This doesn't trigger a scan so list can be outdated. See network_wan_scan_aps 🛜
Get scenario sound maximum volumes
Get maximum volume between 0 and 100 for each vehicle's sound scenarios 🔊
Get scenario sound sample
Get sample for each vehicle's sound scenarios 🔊
Set custom sound
Set a custom sound action by giving a sound sample, an optional volume between 0 and 100, an optional loop number to repeat the sample, and an optional loop delay to define the duration between each loop 🔉
Parameters
RoboccDocs for further information
Set scenario sound maximum volumes
Set maximum volume between 0 and 100 for each vehicle's sound scenarios 🔊
Array of scenarios and associated volumes
RoboccDocs for further information
Set scenario sample
Set sample for each vehicle's sound scenarios 🔊
Array of scenarios and associated samples
RoboccDocs for further information
Set security configuration
Set security configuration
Security configuration
RoboccDocs for further information
Request firmware flash of MCU
Will request a flash of the firmware of the Teensy/Pico
RoboccDocs for further information
Request firmware flash of Roboteq
Will request a flash of the firmware of the roboteq motor controller at next reboot
RoboccDocs for further information
Restart system
Restart the system
Parameters for restart
RoboccDocs for further information
Set camera streaming
Start streaming front and back camera video stream over WebRTC
Enable or disable streaming
RoboccDocs for further information
Force system update
Force a system update
RoboccDocs for further information
Set automatic updates
Enable/disable automatic update
Enable/disable
RoboccDocs for further information
Generated using TypeDoc
Manually call a service via its ActionOperationCode. Prefer direct method call for actions