Enumeration TopicEventCode

Enumeration Members

AuthError: -6
AuthOK: -7
Ready: -2
ReceivedFragmentedMessage: -1
VehicleConnectionClose: -3
VehicleConnectionError: -5
VehicleConnectionOpen: -4

Internal - Internal data

InternalData: 98

Internal data

Internal data 💾

Data

string

Map - Map management

ActiveMapUpdated: 4

Active map updated

Triggered when active map is updated, boolean returns the information that map images have changed đŸ—ē

Data

boolean

Mapping - Mapping

MappingError: 53

Mapping error

Error occured in mapping mode

MappingIsStarted: 54

Mapping is started

Mapping is started or not

Data

boolean

MappingMapOrigin: 52

Mapping map origin

Under construction map origin

Data

Pose

MappingVehiclePose: 51

Mapping vehicle pose

Vehicle pose in under construction map

Data

Pose

Module - Module

ActiveModule: 107

Active module

Vehicle active module, false if not active module

Data

false | Module

ActiveModuleConfiguration: 130

Active module params

Vehicle active module configuration

Navigation - Autopilot

AutopilotConfig: 85

Autopilot current step

Autopilot current config set on vehicle

AutopilotCurrentStep: 70

Autopilot current step

Autopilot current step executed on the vehicle

AutopilotStatus: 69

Autopilot status

Autopilot current status

AutopilotStepResult: 68

Autopilot step result

Last autopilot step result

Navigation - Docking

DockingStatus: 6

Docking status

Vehicle docking status docked, undocked or in between state 🔌

Navigation - Navigation

CurrentActivePath: 96

Current active path

Current path executed by the vehicle

Data

Path

CurrentAreas: 63

Current areas

Areas's behaviour in which the vehicle is currently located, behaviour of global area if vehicle is not in a specific area

Data

Areas

CurrentAreasUuid: 110

Current areas Uuid

Area's uuid in which the vehicle is currently located, 0 if vehicle is not in a specific area

Data

number[]

FollowMeStatus: 113

Follow me status

Status of the follow me feature đŸ‘Ŗ

MovementProhibited: 88

Movement prohibited

Movement prohibited from module đŸšĢ

Data

boolean

NavigationStarted: 7

Navigation started

Triggered when navigation status is updated, boolean returns the status of navigation 🧭

Data

boolean

RoutesGraphObstacles: 118

Routes graph obstacles

List of obstacles across the routes

Data

Position[]

VehToFeedback: 97

Veh to feedback

Feedback on current move order to an element

VehicleDirection: 46

Vehicle direction

Vehicle direction â†”ī¸

VehiclePose: 5

Vehicle pose

Vehicle pose on its map, relevant only if navigation is running 🚗

Data

Pose

Vehicle - Battery management

BatteryState: 1

Battery state

Battery information with power status and some electrical data 🔋

CriticalBattery: 71

Critical battery

Critical battery level threshold reached đŸĒĢ

Data

boolean

Hibernate: 120

Hibernate

Vehicle in hibernation mode or not

Data

boolean

OperationalBattery: 72

Operational battery

Operational battery level threshold reached 🔋

Data

boolean

Sleeping: 119

Sleeping

Vehicle in sleeping mode or not

Data

boolean

Vehicle - Current action

OngoingAction: 47

Ongoing action

Vehicle ongoing action, false if no current action

Vehicle - Diagnostic

HumanInterventionRequired: 86

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 👨đŸŊ‍🔧

SafetyDiagnostic: 84

Safety diagnostic

Diagnostic state with diagnostic error set to true if an error occured, with critical level associated 📋

Vehicle - LED

LedCommand: 102

LED command

LED displayed on the vehicle with animation, color, corner animation, etc. đŸšĨ

Vehicle - Maintenance

MaintenanceMode: 83

Maintenance mode on

Maintenance mode is enabled or not 🚧

Data

boolean

Vehicle - Network

NetworkGlobalStatus: 81

Network global state

Network global state 🌐

NetworkHotspotStatus: 92

Network hotspot state

Sent upon vehicle hotspot configuration update 🛜

NetworkWanState: 91

Network wan state

Sent upon WAN configuration update 🌐

Vehicle - Sound

SoundCommand: 104

Sound command

Sound command played by the vehicle, with sample ID, volume and loop count 🔉

SoundIsPlaying: 95

Sound is playing

Sound is playing or not 🔉

Data

boolean

SoundMuted: 136

Sound muted

Sound is muted

Data

boolean

SoundScenario: 103

Sound scenario

Sound scenario ID 🔉

Data

number

Vehicle - System

FlashMcuRequested: 127

Flash MCU requested

The teensy/pico mcu will be flashed at next reboot

Data

boolean

FlashRoboteqRequested: 126

Flash Roboteq requested

The roboteq motor controller will be flashed at next reboot

Data

boolean

Vehicle - Vehicle state

CycleStarted: 99

Cycle started

Vehicle cycle has started or not, cycle must be started at each boot before any order

Data

boolean

Freewheel: 45

Freewheel

Vehicle freewheel status

Data

boolean

LidarFromRobot: 133

Lidar points in robot frame

Lidar points in robot frame

Data

Position[]

LidarInMap: 134

Lidar points in map

Lidar points in map

Data

Position[]

LidarMarkers: 135

Lidar markers in map

Markers points in map

Data

Marker[]

Odometer: 89

Odometer

Vehicle total odometer in meters

Data

number

OdometerSinceBoot: 90

Odometer since boot

Odometer since last boot in meters

Data

number

Velocity: 121

Velocity

Vehicle velocity

Vehicle - Version

AutomaticUpdates: 123

Automatic updates

Automatic updates are enabled or disabled

Data

boolean

UpdateStatus: 122

Update status

System update information

Generated using TypeDoc