dotbot.rest module#

Module containing client code to interact with the controller REST API.

class dotbot.rest.RestClient(hostname, port, https)[source]#

Bases: object

Client to interact with the controller REST API.

async clear_position_history(address)[source]#: Clear the position history of a DotBot.

async close()[source]#

async fetch_dotbots(query=None)[source]#

Fetch DotBots matching the query.

Parameters:: query (DotBotQueryModel | None)
Return type:: List[DotBotModel]

async fetch_map_size()[source]#

Fetch DotBot area map size.

Return type:: DotBotMapSizeModel

async send_move_raw_command(address, application, command)[source]#: Send a move raw command to a DotBot.

async send_rgb_led_command(address, command)[source]#: Send an RGB LED command to a DotBot.

async send_waypoint_command(address, application, command)[source]#: Send an waypoint command to a DotBot.

property base_url#: Returns the base URL of the controller REST API.

dotbot.rest.rest_client(host, port, https)[source]#