Enumeration TopicEventCode

Enumeration Members

Database - Sound

Internal - Internal data

Manager - Configuration

Manager - Mission

Manager - State

Manager - Stats

Map - Map management

Mapping - Mapping

Module - Module

Navigation - Autopilot

Navigation - Docking

Navigation - Navigation

ROC - Configuration

ROC - Mission

ROC - Network

ROC - State

Vehicle - Battery management

Vehicle - Configuration

Vehicle - Current action

Vehicle - Diagnostic

Vehicle - LED

Vehicle - Maintenance

Vehicle - Mission

Vehicle - Network

Vehicle - Sound

Vehicle - State

Vehicle - System

Vehicle - Vehicle state

Vehicle - Version

Enumeration Members

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

Database - Sound

SoundSamples: 149

List of sound

List of sound in library

Data

string[]

Internal - Internal data

InternalData: 98

Internal data

Internal data 💾

Data

string

Manager - Configuration

AllowMultipleMissions: 7080

Allow multiple mission for the same button

Allow multiple mission for the same button

Data

boolean

ButtonsInfos: 7021

Buttons Informations

Buttons Informations

Data

ButtonInfos[]

Manager - Mission

CallFromButtonInConfigMode: 7014

Call recevied from a button in configuration mode

Call recevied from a button in configuration mode

Data

number

ListsUpdated: 7010

Missions lists updated

Missions lists updated

VehsInfos: 7016

Vehicles information

Vehicles information

Data

VehInfos[]

Manager - State

InMaintenanceMode: 7031

In maintenance mode

In maintenance mode

Data

boolean

Manager - Stats

DailyStats: 7025

Daily stats

Daily stats

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

ROC - Configuration

AppVersion: 7027

Application version

Application version

Data

string

ButtonsConfig: 7003

Buttons configuration

Buttons configuration

Data

ButtonConfig[]

ControllerLoras: 7035

Controller LoRas

Controller LoRas

CustomCommands: 7034

Custom commands

Custom commands

DockedPoseConfigs: 7039

Docked pose configurations

Docked pose configurations

InConfigMode: 7013

In configuration mode

In configuration mode

Data

boolean

IsManager: 7002

Is manager

Is manager

Data

boolean

IsTouchScreen: 7037

Is Touch Screen

Is Touch Screen

Data

boolean

IsVeh: 7001

Is vehicle

Is vehicle

Data

boolean

LoraSp: 7008

LoRa SP

LoRa SP

Data

number

Map: 7007

Map

Map

Data

Map

MapElementRestrictions: 7036

Map element restrictions

Map element restrictions

NewSoftVersions: 7043

New softwares versions

New softwares versions

Data

boolean

ResponseDeadline: 7028

Response deadline

Response deadline

RocSecurity: 7083

ROC Security

ROC Security

SoftVersions: 7042

Softwares versions

Softwares versions

VehsConfig: 7004

Vehicles configuration

Vehicles configuration

Data

VehConfig[]

WaitingPoses: 7032

Waiting poses

Waiting poses

Data

WaitingPose[]

ROC - Mission

MissionLog: 7009

Mission log

Mission log

Data

string

ROC - Network

HotspotEnabled: 7084

Hotspot enabled

Hotspot enabled

Data

boolean

ROC - State

ConnectedToVeh: 7000

Connected to vehicle

Triggered when app is connected to vehicle API

Data

boolean

ImportConfigDone: 7026

Import configuration done

Import configuration done

LoraConnected: 7029

LoRa connected

LoRa connected

Data

boolean

LoraMessage: 7049

LoRa Message

LoRa Message

LoraMessageError: 7050

LoRa Message error

LoRa Message error

Data

string

LoraPing: 7051

LoRa ping

LoRa ping

Data

boolean

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 - Configuration

AllowMoveFromDock: 7041

Allow move from dock

Allow move from dock

Data

boolean

ControllerLoraContactsConfig: 7065

Controller LoRa Contacts configuration

Controller LoRa Contacts configuration

DefaultWaitReleaseSound: 7072

Default Wait Release Sound

Default Wait Release Sound

Data

string

DockDirection: 7076

Dock direction

Dock direction

EventsSounds: 7082

Event sounds

List of event sound

Data

EventSound[]

ExternalSpeaker: 7074

External speaker

Use external speaker

Data

boolean

FollowMeAllowed: 7070

Follow me allowed

Follow me allowed

Data

boolean

Groups: 7054

List of groups

List of groups

Data

Group[]

IdModule: 7006

Module LoRa ID

Module LoRa ID

Data

number

InPauseTitle: 7069

Mission step title

Mission step title

Data

string

MapElementConfigs: 7064

Map element config

Map element config

MaxButtonIdSearch: 7071

Max button ID search

Max button ID search

Data

number

MissionStepTitle: 7068

Mission step title

Mission step title

Data

string

OperatingHours: 7047

Operating hours

Operating hours

PortRedirections: 7073

Port redirection

Port redirection

VehDelayConfig: 7020

Vehicle delay configuration

Vehicle delay configuration

VehDirection: 7024

Vehicle direction - mast position

Vehicle direction - mast position

WaitingContact: 7044

Waiting contact

Waiting contact from LoRa controller

Data

boolean

WaitingSounds: 7081

Waiting sounds

List of waiting sound

Data

WaitingSound[]

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 👨🏽‍🔧

MappingFeatureOperational: 140

Mapping feature operational

Wether a mapping can be performed or not

Data

boolean

SafetyDiagnostic: 84

Safety diagnostic

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

SystemInfo: 144

System information

System information

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 - Mission

CurrentDestination: 7048

Current destination

Current destination

Data

number

InMultiDestinations: 7015

In Multi Destinations

In Multi Destinations

Data

boolean

InPause: 7012

In pause

In pause

Data

boolean

MissionTitle: 7022

Mission title

Mission title

Data

string

ModuleType: 7017

Module type

Module type

MoveFailedRetrying: 7030

Move failed, retrying

Move failed, retrying

Data

boolean

OnlyRelease: 7023

Only release

Only release

Data

boolean

WaitOnWaitingPose: 7033

Wait on waiting pose

Wait on waiting pose

Data

boolean

WaitRelease: 7011

Wait release

Wait release

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 🔉

SoundExternalSpeaker: 136

External speaker

Use an external speaker for sound

Data

boolean

SoundIsPlaying: 95

Sound is playing

Sound is playing or not 🔉

Data

boolean

SoundScenario: 103

Sound scenario

Sound scenario ID 🔉

Vehicle - State

BadLiftConfiguration: 7078

Bad lift configuration

Bad lift configuration

Data

boolean

BadLiftPosition: 7040

Bad lift position

Bad lift position

Data

boolean

CurrentOrigin: 7062

Current origin

Current origin uuid

Data

number

InvalidDataList: 7077

Invalid data list

Lift of invalid data

LiftConnected: 7060

Lift connected

Lift conected

Data

boolean

LiftError: 7075

Error on lift

Error on lift

Data

boolean

LiftHaveBoxOn: 7067

Lift have box on

Lift have box on

Data

boolean

LiftIsShelfOn: 7079

Lift box is a shelf

Lift box is a shelf

Data

boolean

LiftState: 7061

Lift state

Lift state

LoadedModuleParams: 7059

Loaded module params

Loaded module params

LoraPingRobot: 7052

LoRa ping robot

LoRa ping robot

Data

boolean

MissionSpecificData: 7053

Specific data of the current mission

Specific data of the current mission

Data

number

ModuleHibernate: 7046

Hibernate

Hibernate

Data

boolean

ModuleSleeping: 7045

Sleeping

Sleeping

Data

boolean

OnUuid: 7055

On uuid

Current position uuid of robot

Data

number

PredefinedMessages: 7066

Predefined messages

Predefined messages

Data

string[]

RocAutomaticUpdates: 7057

ROC Automatic updates

ROC Automatic updates activated

Data

boolean

RocSoftUpdate: 7056

ROC Soft update

Current status of update

SleepScreen: 7063

Sleep screen

Sleep screen

Data

boolean

TareModuleParams: 7058

Tare module params

Tare module params

Vehicle - System

BlockedIp: 146

Blocked ip

Last blocked ip

Data

string

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

Security: 145

Secuirty configuration

Security information

Data

Security

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

StopSources: 143

Stop sources

Sources that is currently stopping vehicle motion

Data

StopSource[]

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