ZBOS MQTT API 2.2.0

• Introduction
• Servers

Operations

speech
Pub Makes the current speech configuration permanent Sub response: Config has been stored Pub Set the current speech config Sub response: Speech config was set Pub Get the current speech config Sub response: Current dialog config Pub Reset the current speech config Sub response: Config has been reset Sub ODP event: Speech engine starts or stops Pub ODP: speak a message Pub ODP: get config Sub ODP response: get config Pub ODP: reset config Sub ODP response: reset config Pub ODP: store config Sub ODP response: store config Pub ODP: pause hotword Pub ODP: resume hotword Sub ODP event: hotword recognised Pub ODP: load grammars Sub ODP response: load grammars Sub ODP event: asr recognition Pub ODP: get tts languages Sub ODP response: get tts languages Pub ODP: enable ASR Pub ODP: disable ASR Pub ODP: get ASR languages Sub ODP response: get ASR languages Sub ODP event: current language Sub ODP event: listen started Sub ODP event: listen stopped Pub ODP: start listening Pub ODP: stop listening Sub ODP event: ASR Sub ODP event: tts phoneme reached Pub ODP: start tts phoneme Pub ODP: stop tts phoneme Pub ODP: add multiple grammars Sub ODP response: add multiple grammars Pub ODP: remove multiple grammars Sub ODP response: remove multiple grammars Pub ODP: match grammars Pub ODP: get custom grammar rules Sub ODP response: get custom grammar rules Sub event: Context parsing triggered by ODP Pub New request for user input Pub ODP: tts say Sub ODP response: tts say Sub ODP event: tts started Sub ODP event: tts stopped Pub Beep Sub response: Beep Pub Offer help Pub Get available languages Sub response: Get available languages Pub Get current language Sub response: Get current language Pub Set current language Pub Speak a message Pub Speak a message with parameters Sub event: Current language Pub Enable animated speech Pub Disable animated speech Pub Get status of animated speech Sub response: Get status of animated speech Pub event: TTS started Pub pause hotword recognition Pub resume hotword recognition Sub event: TTS ended Sub event: robot starts listening Sub event: robot stops listening Pub Start listening Pub Stop listening Pub Start dialog service Pub Stop dialog service Sub Event: dialog service stopped Sub Event: dialog service started Sub Iflytek rotation started Sub Iflytek rotation stopped Sub event. Phoneme reached Pub Grammars: add multiple Sub response: grammar add Pub Grammars: remove multiple Sub response: grammar add Pub Event: grammar match Pub Gets all custom grammar rules Sub response: Get all custom grammar rules Pub Get TTS languages Sub response: TTS languages list Pub Get current TTS language Pub Set TTS language Pub Get ASR languages Sub response: ASR languages list Pub Get current ASR language Pub Set ASR language Sub Speech recognised event Pub Grammars: load Sub response: loaded grammars Pub Start speech provider Pub Stop speech provider Pub Send a text message to dialog system Pub Start language setup Pub Stop language setup
motion
Pub Fires specific animation ID Pub Stops all animations Pub Get available animations Sub response: Get available animations Pub Starts dance Pub Stops dance Pub Get available dances Sub response: Get available dances Pub Get available animations Pub Move head Pub Move a specific part of the robot Sub Event: started/stopped Sub Event: animation started/stopped Pub Run animation for the eyes Pub Get list of available emotions for the eyes Sub response: Get list of available emotions for the eyes Pub Enable follow me Pub Disable follow me Sub response: follow me status Pub Gestures data Pub Enable gestures Pub Disable gestures Pub Get all the gym movements that can be used in the composer Sub response: Get all gym movements
audio
Pub Play media Pub Stop media Sub Media ended Pub Pause media Pub Resume media Pub Set volume Pub Get volume Sub response: Get volume Sub event: Volume change Pub Play beep
status
Sub Notify everything Sub Notify information Sub Notify warnings Sub Notify errors
system
Pub Call for help Sub event: Trigger alarm and call for help Sub Alarm call started Sub Alarm call established Sub Alarm call ended Pub Set alarm call Sub response: Set alarm call Sub Alarm has been received Pub Get alarm configs Sub Get alarm configs response Pub Set alarm config Sub Set alarm config response Pub Get alarm database Sub Get alarm database response Pub Remove alarm database Sub Remove alarm database response Pub Remove alarm images Sub Remove alarm images response Pub Remove alarm images and database Sub Remove alarm images and database response Pub Get battery status Sub response: Get battery status Sub event: Battery change Pub Set the battery low level threshold Pub Get the battery low level threshold Sub Response: battery low level Pub Set the battery critical level threshold Pub Get the battery critical level threshold Sub Response: battery critical level Pub Request robot identification Sub response: Robot identification Pub Set robot name Sub event: System ready Pub Get system ready Sub response: System ready Pub Get system version Sub response: Get system version Pub Get system serial number Sub response: Get system serial number Sub Poke robot Pub Enable hotword rotation Sub Hotword rotation changed event Pub Get hotword rotation Sub Response: hotword rotation Pub Enable adb logs upload Sub Adb logs changed event Pub Get adb logs Sub Response: Get adb logs Pub Enable cloud broker Sub Cloud broker enable changed event Pub Get cloud broker enabled state Sub Response: cloud broker enabled state Pub Rename file Sub response: Rename file Pub Remove a file from the robot Sub response: Remove a file from the robot Sub event: Broker status
sensors
Pub Get all touch sensors Sub response: Get all touch sensors Sub event: Sensor
leds
Pub Set chest light color
composer
Pub Start composition Pub Start composition by id Sub event: Composition started Pub Stop composition Sub event: Composition stopped Sub event: Composition finished Pub Pause composition Sub event: Composition paused Pub Resume composition Sub event: Composition Resumed Sub event: Composition loop state Pub Settings for a given composition Pub Save composition Pub Save multiple compositions Sub event: Composition Saved Sub response: Save multiple compositions Pub Load composition Sub event: Composition loaded Pub Get list of compositions Sub event: Get list of compositions Pub Delete composition by id Pub Deletes all compositions Sub response: Delete composition Sub event: Composition changed Pub Stop audio composition Pub Stop video composition Pub Stop image composition Sub event: Composition encountered error Pub Get api Sub response: Get api Pub Get default composition variables Sub response: Get default composition variables Pub Get composition status Sub response: Composition status Pub Start composition block Sub event: Composition block started Pub Stop composition block Sub event: Composition block ended Sub event: Composition block paused
kiosk
Pub Start application Sub event: Application started Pub Stop all applications Sub Response: Stop application Pub Get a list of all the available applications Sub response: Get all applications Pub Get the content of a specific application datasource file Sub response: Get datasource Pub Save the datasource Sub event: Datasource saved Sub event: Application error Pub Pin an app, if installed Pub Unpin an app. Pub Request the current pin status & pinned app. Sub response: pin status & pinned app Pub Pin a composition Pub Unpin a composition Pub Request the current pin status & pinned composition. Sub response: pin status & pinned composition Pub Get all datasources Sub response: Get all datasources Pub Get specific datasources Sub response: Get specific datasources Pub Get active datasources Sub response: Get active datasources Pub Set current Kiosk datasources Pub Save or add a datasource Sub response: Get active datasources Pub Delete a datasource Sub response: Delete a datasource Pub Open home screen Pub Start application remotely on Kiosk Pub Get installed applications on Kiosk Sub response: Get installed applications on Kiosk Pub Get installed applications on Kiosk Sub response: Get installed applications on Kiosk Sub event: Kiosk is active Sub event: Kiosk crashed Pub Show multimedia Sub response: Show multimedia Pub Show input prompt Sub response: Show input prompt Pub Show microphone in composition Pub Multimedia reset Pub Show image Sub response: Show image Pub Stop showing image Sub event: Image ended Pub Show video Sub response: Show video Pub Stop video Sub event: Video ended Pub Show page in kiosk Sub response: Show page in kiosk Pub Start action Pub Get current lockstate Sub response: Get current lockstate Pub Unlock settings page Pub Lock settings page Sub response: Lock settings page Sub response: Unlock settings page Sub response: Change current pincode Pub Remove current pincode Sub response: Remove current pincode Pub List all media libraries Sub event: Listing all media libraries Pub Get a list of media items Sub response: Get a list of media items Sub Library item changed event Pub Get media sync devices Sub event: Media sync devices Pub Get all media exports Sub event: All media exported Pub Install APK Pub Delete all media
video stream
Pub Get picture Pub Start the camera stream of the selected camera. Pub Stop camera stream Sub Camera stream has stopped Pub Initialize camera stream Pub Handsake offer for camera stream Sub Handsake answer for camera stream Sub RTC ICE Candidate Core Sub RTC ICE Candidate Control Pub Take picture and save Sub response: Picture taken and saved
domotics
Pub Get devices Sub response: Get devices Pub Add device Pub Delete device Pub Delete all devices Pub Enable notifications on device state changes Sub event: Domotica state changes Sub event: Domotica device Sub event: Domotica plugin Pub Set device Sub Domotics response Pub Get rooms Sub response: Get rooms Pub Set scene Pub Get settings Sub response: Get settings Pub Set settings Pub Delete all settings Pub Get light Pub Set light Pub Get dimmer Pub Set dimmer Pub Get switch Pub Set switch Pub Get door Pub Set door Pub Get Shutter Pub Set shutter Pub Get speaker Pub Set speaker Pub Get doorsensor Pub Get motionsensor Pub Get floodsensor Pub Get lightsensor Pub Get temperature Pub Get status Sub response: Get status
cloud
Pub Login to the cloud Sub response: Login to the cloud Pub Get cloud config Sub respone: Get cloud config Pub Set cloud config Sub event: Config cloud Pub Resync all media libraries Sub response: Resync all media libraries Pub Upload file in media library Sub response: Upload file in media library Pub Ask robot to approve linking to a cloud account Pub Confirm robot linked to cloud account Pub Retrieve all cloud accounts for a robot Sub response: Retrieve all cloud accounts for a robot Pub Remove link Sub response: Remove link
SLAM
Sub Charging required Sub Battery is not critical Pub Go to charging station Sub Move to charging station started Sub Move to charging station stopped Sub Move to charging station failed Pub Undock Sub Undocking started Sub Undocking finished Sub Undocking failed Pub Move robot to coordinates Sub MoveTo started Sub MoveTo stopped Sub MoveTo failed Sub MoveTo aborted Sub MoveTo Blocked Sub MoveTo retrying Pub Stop moving Sub event: Movement stopped Pub Enable laserscan Pub disable laserscan Sub event: Laserscan changed Sub event: Location changed Pub Get robot location Sub response: Get robot location Pub Set robot location Sub response: Set robot location Pub Recover robot location Sub Location revocery started Sub Location revocery stopped Sub Location revocery failed Pub Reset robot to charging station Sub Reset robot to charging station started Sub Reset robot to charging station stopped Sub Home location changed Pub Get home location Sub response: Get home location Pub Enable SLAM mapping Pub Disable SLAM mapping Pub Start extending SLAM mapping Pub Stop extending SLAM mapping Pub Get extending SLAM mapping Sub response: Get extending SLAM mapping Sub event: SLAM mapping extending started Sub event: SLAM mapping extending stopped Sub event: SLAM mapping extending failed Sub event: SLAM mapping extending canceled Pub Get maps Sub event: Get all maps Pub Get current maps Sub event: Get current maps Pub Load map Sub event: Load map Pub Save map Sub event: Save map Pub Delete map Pub Deletes all maps Sub event: Delete map Pub Clear current map view Sub event: Map view cleared Sub event: Map view changed Pub Get current map view Sub response: Get current map view Sub Path remaining changed Sub event: POI changed Pub Clear all pois Sub event: Clear all pois Pub Get list of pois for all maps Sub event: Get list of pois for all maps Pub Get list of pois for current map Sub event: Get list of pois for current map Pub Add poi Sub event: Add poi Pub Edit poi Sub event: Edit poi Pub Remove poi by name Sub event: Remove poi by name Pub Remove poi by uuid Sub event: Remove poi by uuid Pub Move robot to poi Pub Get SLAM status Sub response: Get SLAM status Sub event: Status SLAM Pub clear all walls Sub response: Clear all walls Sub Walls changed Pub Get current walls Sub response: Get current walls Pub Add wall Sub event: Add wall Pub Remove wall Sub event: Remove wall Pub Update wall Sub event: Update wall Pub Start slam service Sub response: Start slam Pub Stop slam service Sub response: Stop slam Sub ERROR in Slam Sub One or more collisions have started Sub One or more collisions have stopped
wifi
Pub Request WiFi scan Sub event: Wifi scan Pub Connect to wifi Sub event: Wifi connected Sub event: Wifi disconnected Pub get Wifi status Sub response: Wifi status Sub event: Wifi status Sub Wifi error Pub Forget network Sub event: Wifi forgotten Pub Repair Wifi Pub Set hotspot password Pub Get hotspot password Sub response: Get hotspot password Pub Set wifi hotspot Sub response: Set wifi hotspot Pub Get wifi hotspot Sub response: Get wifi hotspot
connection
Pub Get the connection status Sub response: Get the connection status Pub Scan for WiFi networks Sub response: Scan for WiFi networks Pub Connect to a network Sub event: Connect to a network Pub Forget a network Sub event: Forget a network Pub Get the saved networks Sub response: Get the saved networks Pub Set network configuration Sub response: Set network configuration Pub Get DNS configuration Sub response: Get DNS configuration Pub Set DNS configuration Sub response: Set DNS configuration Pub Get access point configuration Sub response: Get access point configuration Pub Set access point configuration Sub response: Set access point configuration Sub event: Access point enabled Sub event: Access point disabled
survey
Pub Get survey Sub response: Get survey Pub Get all surveys Sub response: Get all surveys Pub Add/save survey Sub event: Survey added/saved Pub Delete survey Sub event: Survey deleted
social
Motion detection
Pub Start motion detection Pub Stop motion detection Sub event: Motion detected Sub Motion detection started Sub Motion detection stopped
Face tracking
Pub event: Get picture Sub event: Detected faces Sub response: Face Pub Add face Sub response: Add face Pub Update face Sub response: Update face Pub Update person Sub response: Update person Pub Delete face Sub response: Delete face Pub Request name Sub response: Request name Pub Request data from person Sub response: Request data from person
SIP
Sub SIP config changed Pub Get SIP errors Sub response: SIP errors Pub End the current SIP call Sub The current SIP call has ended
time
Pub Quiet hours Pub Save schedule Sub event: Schedule saved Pub Get schedule Sub response: Get schedule Pub Delete schedule Sub event: Schedule deleted Pub Get all schedules Sub response: Get all schedules Pub Start schedule by name Sub event: Started schedule Pub Start schedule by id Sub event: Pub Stop schedule Sub event: Schedule stopped Pub Stop timeline scheduler Sub event: Pub Get current schedule Sub response: Get current schedule Pub Get Time information, such as the accuracy Sub response: Time information
variables
Pub Get all variables Sub response: Get all variables Pub Set variables Sub response: indicates if the save was successful or not
diagnostics
Pub Get diagnostics for chassis Sub event: Chassis state changed Sub response: Diagnostics chassis Pub Get diagnostics for servos Sub event: Servo state changed Sub response: Diagnostics servos

Messages

AnimationOptions
EmptyMessage
KeyResult
Array<AvailableAnimation>
DanceOptions
Array<AvailableDance>
MobilityActionOptions
Boolean
SipConfig
ZbosAlarm
SuccessMessage
Map
HashMap
AlarmConfigRequest
AlarmConfigResult
Array<MonitoringResult>
ApplicationOptions
String
Array<AvailableApplication>
DatasourceGetRequest
DatasourceSetRequest
ErrorMessage
AudioOptions
Int
BatteryEvent
BatterySetRequest
StreamStartRequest
VideoOptions
StreamAnswer
Candidate
SimpleComposition
LoopProperty
TimelinePropertiesWrapper
SaveMultipleCompositionRequest
Array<SimpleComposition>
CompositionError
ApiRequestBlock
Array<String>
CompositionStatus
Block
DiagnosticState
Array<DiagnosticState>
SetDialogConfigRequest
GetDialogConfigRequest
OdpParseContextMessage
OdpHotwordRecognisedPayload
Array<TtsVoiceInfo>
Array<OdpAsrLanguagesResponse>
Locale
OdpSpeechRecognisedMessage
OdpPhonemeInfo
OdpCustomGrammar
OdpRemoveCustomGrammarRequest
OdpGrammarMatchResponse
OdpContextParsed
OdpTtsSayMessage
DialogOptions
PhonemeInfo
Array<CustomGrammar>
Array<GrammarMatch>
SpeechToTextResult
Array<DomoticaDevice>
DomoticaDevice
DeviceState
PluginState
DomoticaSetDeviceOptions
Any
Room
DomoticaPlaySceneOptions
Settings
DomoticaGetOptions
DomoticaSetBooleanOptions
DomoticaSetIntOptions
DomoticaSetSpeakerOptions
Array<PluginState>
EmotionOptions
Array<AvailableEmotion>
Detection
Array<AvailableGymMovement>
PinnedApplication
PinnedApplicationState
PinnedComposition
PinnedCompositionState
Array<SimpleDataSource>
SimpleDataSource
ChangeDatasourceRequest
ApplicationStartRequest
Array<SimpleApplicationNodeDto>
InputBlock
InputResponse
Image
Video
OpenBrowserBlock
Action
LockStatus
LockResponse
LedOptions
LoginResponse
FileUploadRequest
CloudResult
ExportRequestDto
NotificationOptions
RegistrationRequest
Accounts
DeleteRequest
SimpleScheduler
Array<SimpleScheduler>
Timeline
MotionDetectionBlock
AvailableSensor
SensorEvent
Array<SipError>
CallEndInfo
ZbosMoveToPointRequest
ZbosLaserScan
ZbosLocation
ZbosSetLocationRequest
SlamMap
MapRequestOptions
RemoteMapResponseObject
ZbosRemainingPathObject
ZbosClearPoiRequest
Array<SlamMap>
ZbosMapDetailRequest
ZbosAddPoiRequest
Poi
ZbosEditPoiRequest
ZbosRemovePoiByNameRequest
ZbosRemovePoiByUUIDRequest
ZbosMoveToPoiByUUIDRequest
SlamStatus
WallClearRequest
Array<Wall>
Wall
WallRemoveRequest
SlamError
Array<AvailableSensor>
Array<SimpleSurvey>
SimpleSurvey
RobotIdentification
AppVersion
RenameRequest
DeleteResponse
BrokerStatus
TimeInfo
GlobalVariables
Array<AccessPoint>
AccessPoint
WispStatus
ForgetResponse
PostFieldsHotspot
ConnectionStatus
Array<ScannedNetwork>
ConnectToNetwork
ConnectionResponse
ForgetNetwork
Array<SavedNetwork>
NetworkConfig
DNSConfig
APConfig