get_status()
  • 1 Minute to read

get_status()


Article summary

Gets a dictionary representing the robot's navigation state.

Reference

Arguments

None

Return

Returns a dict in the form of:

ArgumentsTypeDefault valueDescription
localizedboolFalseTrue if robot is localized.
navigatingboolFalseTrue if robot is navigating.
mappingboolFalseTrue if robot is mapping.
map_namestringActive map name.

Exceptions

  • RayaNavUnkownError

See the complete list of navigation exceptions.

Usage Example

Code:

...

class RayaApplication(RayaApplicationBase):

    async def setup(self):
        self.navigation = await self.enable_controller('navigation')
        self.status = await self.navigation.get_status()
        ....
    async def loop(self):
        self.log.info(self.status)
      ...
        

Was this article helpful?