string[]
Internal data
Internal data 💾
string
Allow multiple mission for the same button
Allow multiple mission for the same button
boolean
Buttons Informations
Buttons Informations
Call recevied from a button in configuration mode
Call recevied from a button in configuration mode
number
Missions lists updated
Missions lists updated
Vehicles information
Vehicles information
VehInfos[]
In maintenance mode
In maintenance mode
boolean
Daily stats
Daily stats
Active map updated
Triggered when active map is updated, boolean returns the information that map images have changed 🗺
boolean
Mapping error
Error occured in mapping mode
Mapping is started
Mapping is started or not
boolean
Mapping map origin
Under construction map origin
Mapping vehicle pose
Vehicle pose in under construction map
Active module
Vehicle active module, false if not active module
false | Module
Active module params
Vehicle active module configuration
Autopilot current step
Autopilot current config set on vehicle
Autopilot current step
Autopilot current step executed on the vehicle
Autopilot status
Autopilot current status
Autopilot step result
Last autopilot step result
Docking status
Vehicle docking status docked, undocked or in between state 🔌
Current active path
Current path executed by the vehicle
Current areas
Areas's behaviour in which the vehicle is currently located, behaviour of global area if vehicle is not in a specific area
Current areas Uuid
Area's uuid in which the vehicle is currently located, 0 if vehicle is not in a specific area
number[]
Follow me status
Status of the follow me feature 👣
Movement prohibited
Movement prohibited from module 🚫
boolean
Navigation started
Triggered when navigation status is updated, boolean returns the status of navigation 🧭
boolean
Routes graph obstacles
List of obstacles across the routes
Position[]
Veh to feedback
Feedback on current move order to an element
Vehicle direction
Vehicle direction ↔️
Vehicle pose
Vehicle pose on its map, relevant only if navigation is running 🚗
Application version
Application version
string
Buttons configuration
Buttons configuration
Controller LoRas
Controller LoRas
Custom commands
Custom commands
Docked pose configurations
Docked pose configurations
In configuration mode
In configuration mode
boolean
Is manager
Is manager
boolean
Is Touch Screen
Is Touch Screen
boolean
Is vehicle
Is vehicle
boolean
LoRa SP
LoRa SP
number
Map
Map
Map element restrictions
Map element restrictions
New softwares versions
New softwares versions
boolean
Response deadline
Response deadline
ROC Security
ROC Security
Softwares versions
Softwares versions
Vehicles configuration
Vehicles configuration
Waiting poses
Waiting poses
Mission log
Mission log
string
Hotspot enabled
Hotspot enabled
boolean
Connected to vehicle
Triggered when app is connected to vehicle API
boolean
Import configuration done
Import configuration done
LoRa connected
LoRa connected
boolean
LoRa Message
LoRa Message
LoRa Message error
LoRa Message error
string
LoRa ping
LoRa ping
boolean
Battery state
Battery information with power status and some electrical data 🔋
Critical battery
Critical battery level threshold reached 🪫
boolean
Hibernate
Vehicle in hibernation mode or not
boolean
Operational battery
Operational battery level threshold reached 🔋
boolean
Sleeping
Vehicle in sleeping mode or not
boolean
Allow move from dock
Allow move from dock
boolean
Controller LoRa Contacts configuration
Controller LoRa Contacts configuration
Default Wait Release Sound
Default Wait Release Sound
string
Dock direction
Dock direction
Event sounds
List of event sound
External speaker
Use external speaker
boolean
Follow me allowed
Follow me allowed
boolean
List of groups
List of groups
Group[]
Module LoRa ID
Module LoRa ID
number
Mission step title
Mission step title
string
Map element config
Map element config
Max button ID search
Max button ID search
number
Mission step title
Mission step title
string
Operating hours
Operating hours
Port redirection
Port redirection
Vehicle delay configuration
Vehicle delay configuration
Vehicle direction - mast position
Vehicle direction - mast position
Waiting contact
Waiting contact from LoRa controller
boolean
Waiting sounds
List of waiting sound
Ongoing action
Vehicle ongoing action, false if no current action
Human intervention required
Human intervention required event, human_intervention_required field is set to true if human assistance needed to unlock robot, the others boolean defines which kind of intervention is required 👨🏽🔧
Mapping feature operational
Wether a mapping can be performed or not
boolean
Safety diagnostic
Diagnostic state with diagnostic error set to true if an error occured, with critical level associated 📋
System information
System information
LED command
LED displayed on the vehicle with animation, color, corner animation, etc. 🚥
Maintenance mode on
Maintenance mode is enabled or not 🚧
boolean
Current destination
Current destination
number
In Multi Destinations
In Multi Destinations
boolean
In pause
In pause
boolean
Mission title
Mission title
string
Module type
Module type
Move failed, retrying
Move failed, retrying
boolean
Only release
Only release
boolean
Wait on waiting pose
Wait on waiting pose
boolean
Wait release
Wait release
boolean
Network global state
Network global state 🌐
Network hotspot state
Sent upon vehicle hotspot configuration update 🛜
Network wan state
Sent upon WAN configuration update 🌐
Sound command
Sound command played by the vehicle, with sample ID, volume and loop count 🔉
External speaker
Use an external speaker for sound
boolean
Sound is playing
Sound is playing or not 🔉
boolean
Sound scenario
Sound scenario ID 🔉
Bad lift configuration
Bad lift configuration
boolean
Bad lift position
Bad lift position
boolean
Current origin
Current origin uuid
number
Invalid data list
Lift of invalid data
Lift connected
Lift conected
boolean
Error on lift
Error on lift
boolean
Lift have box on
Lift have box on
boolean
Lift box is a shelf
Lift box is a shelf
boolean
Lift state
Lift state
Loaded module params
Loaded module params
LoRa ping robot
LoRa ping robot
boolean
Specific data of the current mission
Specific data of the current mission
number
Hibernate
Hibernate
boolean
Sleeping
Sleeping
boolean
On uuid
Current position uuid of robot
number
Predefined messages
Predefined messages
string[]
ROC Automatic updates
ROC Automatic updates activated
boolean
ROC Soft update
Current status of update
Sleep screen
Sleep screen
boolean
Tare module params
Tare module params
Blocked ip
Last blocked ip
string
Flash MCU requested
The teensy/pico mcu will be flashed at next reboot
boolean
Flash Roboteq requested
The roboteq motor controller will be flashed at next reboot
boolean
Secuirty configuration
Security information
Cycle started
Vehicle cycle has started or not, cycle must be started at each boot before any order
boolean
Freewheel
Vehicle freewheel status
boolean
Lidar points in robot frame
Lidar points in robot frame
Position[]
Lidar points in map
Lidar points in map
Position[]
Lidar markers in map
Markers points in map
Marker[]
Odometer
Vehicle total odometer in meters
number
Odometer since boot
Odometer since last boot in meters
number
Stop sources
Sources that is currently stopping vehicle motion
Velocity
Vehicle velocity
Automatic updates
Automatic updates are enabled or disabled
boolean
Update status
System update information
Generated using TypeDoc
List of sound
List of sound in library