dotbot package

Pydotbot module.

dotbot.pydotbot_version()

Returns the version of the pydotdot package.

Return type:

str

Submodules

• dotbot.adapter module
  • DotBotSimulatorAdapter
    • DotBotSimulatorAdapter.create_simulator()
  • GatewayAdapterBase
    • GatewayAdapterBase.close()
    • GatewayAdapterBase.send_payload()
    • GatewayAdapterBase.start()
  • MarilibCloudAdapter
    • MarilibCloudAdapter.close()
    • MarilibCloudAdapter.send_payload()
    • MarilibCloudAdapter.start()
  • MarilibEdgeAdapter
    • MarilibEdgeAdapter.close()
    • MarilibEdgeAdapter.send_payload()
    • MarilibEdgeAdapter.start()
  • SailBotSimulatorAdapter
    • SailBotSimulatorAdapter.create_simulator()
  • SerialAdapter
    • SerialAdapter.close()
    • SerialAdapter.on_byte_received()
    • SerialAdapter.send_payload()
    • SerialAdapter.start()
  • SimulatorAdapterBase
    • SimulatorAdapterBase.close()
    • SimulatorAdapterBase.create_simulator()
    • SimulatorAdapterBase.send_payload()
    • SimulatorAdapterBase.start()
    • SimulatorAdapterBase.simulator
• dotbot.controller module
  • ControllerException
  • CalibrationHomography
    • CalibrationHomography.homography_matrix
  • Controller
    • Controller.get_dotbots()
    • Controller.handle_received_frame()
    • Controller.notify_clients()
    • Controller.run()
    • Controller.send_payload()
    • Controller.web()
  • ControllerSettings
    • ControllerSettings.adapter
    • ControllerSettings.background_map
    • ControllerSettings.baudrate
    • ControllerSettings.controller_http_port
    • ControllerSettings.csv_data_output
    • ControllerSettings.gw_address
    • ControllerSettings.log_level
    • ControllerSettings.log_output
    • ControllerSettings.map_size
    • ControllerSettings.mqtt_host
    • ControllerSettings.mqtt_password
    • ControllerSettings.mqtt_port
    • ControllerSettings.mqtt_use_tls
    • ControllerSettings.mqtt_username
    • ControllerSettings.network_id
    • ControllerSettings.port
    • ControllerSettings.simulator_init_state
    • ControllerSettings.verbose
    • ControllerSettings.webbrowser
  • gps_distance()
  • lh2_distance()
  • load_calibration()
• dotbot.controller_app module
• dotbot.dotbot_simulator module
  • ControlLoopWaypoint
    • ControlLoopWaypoint.x
    • ControlLoopWaypoint.y
  • DotBotSimulator
    • DotBotSimulator.advertise()
    • DotBotSimulator.control_thread()
    • DotBotSimulator.diff_drive_model_update()
    • DotBotSimulator.rx_frame()
    • DotBotSimulator.start()
    • DotBotSimulator.stop()
    • DotBotSimulator.update_state()
    • DotBotSimulator.header
  • DotBotSimulatorCommunicationInterface
    • DotBotSimulatorCommunicationInterface.flush()
    • DotBotSimulatorCommunicationInterface.handle_dotbot_frame()
    • DotBotSimulatorCommunicationInterface.run()
    • DotBotSimulatorCommunicationInterface.start()
    • DotBotSimulatorCommunicationInterface.stop()
    • DotBotSimulatorCommunicationInterface.write()
  • InitStateToml
    • InitStateToml.dotbots
    • InitStateToml.model_config
    • InitStateToml.network
  • MariNetworkSimulator
    • MariNetworkSimulator.schedule_downlink()
    • MariNetworkSimulator.schedule_uplink()
    • MariNetworkSimulator.start()
    • MariNetworkSimulator.stop()
  • RobotControl
    • RobotControl.all_done
    • RobotControl.direction
    • RobotControl.encoder_left
    • RobotControl.encoder_right
    • RobotControl.pos_x
    • RobotControl.pos_y
    • RobotControl.pwm_left
    • RobotControl.pwm_right
    • RobotControl.waypoint_idx
    • RobotControl.waypoint_reached
    • RobotControl.waypoint_x
    • RobotControl.waypoint_y
  • SimulatedDotBotSettings
    • SimulatedDotBotSettings.address
    • SimulatedDotBotSettings.battery_model_path
    • SimulatedDotBotSettings.calibrated
    • SimulatedDotBotSettings.custom_control_loop_library
    • SimulatedDotBotSettings.direction
    • SimulatedDotBotSettings.gru_model_path
    • SimulatedDotBotSettings.model_config
    • SimulatedDotBotSettings.motor_left_error
    • SimulatedDotBotSettings.motor_right_error
    • SimulatedDotBotSettings.network_mode
    • SimulatedDotBotSettings.pos_x
    • SimulatedDotBotSettings.pos_y
  • SimulatedNetworkMode
    • SimulatedNetworkMode.DEFAULT
    • SimulatedNetworkMode.MARI
  • SimulatedNetworkSettings
    • SimulatedNetworkSettings.downlink_pdr
    • SimulatedNetworkSettings.model_config
    • SimulatedNetworkSettings.mqtt_latency_ms
    • SimulatedNetworkSettings.pdr
    • SimulatedNetworkSettings.slot_duration_ms
    • SimulatedNetworkSettings.uplink_pdr
  • Waypoint
    • Waypoint.x
    • Waypoint.y
  • battery_discharge_model()
  • packaged_init_state_path()
  • resolve_init_state_path()
  • wheel_speed_from_pwm()
• dotbot.joystick module
  • JoystickController
    • JoystickController.fetch_active_dotbots()
    • JoystickController.pos_from_joystick()
    • JoystickController.start()
    • JoystickController.selected_dotbot
  • cli()
• dotbot.keyboard module
  • KeyboardController
    • KeyboardController.fetch_active_dotbots()
    • KeyboardController.refresh_speeds()
    • KeyboardController.speeds_from_keys()
    • KeyboardController.start()
    • KeyboardController.update_active_keys()
    • KeyboardController.selected_dotbot
  • KeyboardEvent
    • KeyboardEvent.key
    • KeyboardEvent.type_
  • KeyboardEventType
    • KeyboardEventType.PRESSED
    • KeyboardEventType.RELEASED
  • MotorSpeeds
    • MotorSpeeds.BOOST
    • MotorSpeeds.NORMAL
    • MotorSpeeds.SUPERBOOST
  • cli()
  • rgb_from_key()
• dotbot.logger module
  • setup_logging()
• dotbot.models module
  • DotBotAddressModel
    • DotBotAddressModel.address
    • DotBotAddressModel.model_config
  • DotBotBackgroundMapModel
    • DotBotBackgroundMapModel.data
    • DotBotBackgroundMapModel.model_config
  • DotBotControlModeModel
    • DotBotControlModeModel.mode
    • DotBotControlModeModel.model_config
  • DotBotGPSPosition
    • DotBotGPSPosition.latitude
    • DotBotGPSPosition.longitude
    • DotBotGPSPosition.model_config
  • DotBotLH2Position
    • DotBotLH2Position.model_config
    • DotBotLH2Position.x
    • DotBotLH2Position.y
  • DotBotMapSizeModel
    • DotBotMapSizeModel.height
    • DotBotMapSizeModel.model_config
    • DotBotMapSizeModel.width
  • DotBotModel
    • DotBotModel.address
    • DotBotModel.application
    • DotBotModel.battery
    • DotBotModel.calibrated
    • DotBotModel.direction
    • DotBotModel.gps_position
    • DotBotModel.last_seen
    • DotBotModel.lh2_position
    • DotBotModel.mode
    • DotBotModel.model_config
    • DotBotModel.move_raw
    • DotBotModel.position_history
    • DotBotModel.rgb_led
    • DotBotModel.rudder_angle
    • DotBotModel.sail_angle
    • DotBotModel.status
    • DotBotModel.swarm
    • DotBotModel.waypoints
    • DotBotModel.waypoints_threshold
    • DotBotModel.wind_angle
  • DotBotMoveRawCommandModel
    • DotBotMoveRawCommandModel.left_x
    • DotBotMoveRawCommandModel.left_y
    • DotBotMoveRawCommandModel.model_config
    • DotBotMoveRawCommandModel.right_x
    • DotBotMoveRawCommandModel.right_y
  • DotBotNotificationCommand
    • DotBotNotificationCommand.NEW_DOTBOT
    • DotBotNotificationCommand.NONE
    • DotBotNotificationCommand.PIN_CODE_UPDATE
    • DotBotNotificationCommand.RELOAD
    • DotBotNotificationCommand.UPDATE
  • DotBotNotificationModel
    • DotBotNotificationModel.cmd
    • DotBotNotificationModel.data
    • DotBotNotificationModel.model_config
    • DotBotNotificationModel.pin_code
  • DotBotNotificationUpdate
    • DotBotNotificationUpdate.address
    • DotBotNotificationUpdate.battery
    • DotBotNotificationUpdate.direction
    • DotBotNotificationUpdate.gps_position
    • DotBotNotificationUpdate.gps_waypoints
    • DotBotNotificationUpdate.lh2_position
    • DotBotNotificationUpdate.lh2_waypoints
    • DotBotNotificationUpdate.model_config
    • DotBotNotificationUpdate.position_history
    • DotBotNotificationUpdate.rgb_led
    • DotBotNotificationUpdate.rudder_angle
    • DotBotNotificationUpdate.sail_angle
    • DotBotNotificationUpdate.waypoints_threshold
    • DotBotNotificationUpdate.wind_angle
  • DotBotQueryModel
    • DotBotQueryModel.address
    • DotBotQueryModel.application
    • DotBotQueryModel.limit
    • DotBotQueryModel.max_battery
    • DotBotQueryModel.max_position_x
    • DotBotQueryModel.max_position_y
    • DotBotQueryModel.max_positions
    • DotBotQueryModel.min_battery
    • DotBotQueryModel.min_position_x
    • DotBotQueryModel.min_position_y
    • DotBotQueryModel.model_config
    • DotBotQueryModel.status
  • DotBotReplyModel
    • DotBotReplyModel.data
    • DotBotReplyModel.model_config
    • DotBotReplyModel.request
  • DotBotRequestModel
    • DotBotRequestModel.model_config
    • DotBotRequestModel.reply
    • DotBotRequestModel.request
  • DotBotRequestType
    • DotBotRequestType.DOTBOTS
    • DotBotRequestType.MAP_SIZE
  • DotBotRgbLedCommandModel
    • DotBotRgbLedCommandModel.blue
    • DotBotRgbLedCommandModel.green
    • DotBotRgbLedCommandModel.model_config
    • DotBotRgbLedCommandModel.red
  • DotBotStatus
    • DotBotStatus.ACTIVE
    • DotBotStatus.INACTIVE
    • DotBotStatus.LOST
  • DotBotWaypoints
    • DotBotWaypoints.model_config
    • DotBotWaypoints.threshold
    • DotBotWaypoints.waypoints
  • DotBotXGOActionCommandModel
    • DotBotXGOActionCommandModel.action
    • DotBotXGOActionCommandModel.model_config
  • MqttPinCodeModel
    • MqttPinCodeModel.model_config
    • MqttPinCodeModel.pin
  • WSBase
    • WSBase.address
    • WSBase.application
    • WSBase.cmd
    • WSBase.model_config
  • WSMoveRaw
    • WSMoveRaw.cmd
    • WSMoveRaw.data
    • WSMoveRaw.model_config
  • WSRgbLed
    • WSRgbLed.cmd
    • WSRgbLed.data
    • WSRgbLed.model_config
  • WSWaypoints
    • WSWaypoints.cmd
    • WSWaypoints.data
    • WSWaypoints.model_config
• dotbot.protocol module
  • ApplicationType
    • ApplicationType.DotBot
    • ApplicationType.Freebot
    • ApplicationType.LH2_mini_mote
    • ApplicationType.SailBot
    • ApplicationType.XGO
  • ControlModeType
    • ControlModeType.AUTO
    • ControlModeType.MANUAL
  • PayloadAdvertisement
    • PayloadAdvertisement.application
    • PayloadAdvertisement.metadata
  • PayloadCommandMoveRaw
    • PayloadCommandMoveRaw.left_x
    • PayloadCommandMoveRaw.left_y
    • PayloadCommandMoveRaw.metadata
    • PayloadCommandMoveRaw.right_x
    • PayloadCommandMoveRaw.right_y
  • PayloadCommandRgbLed
    • PayloadCommandRgbLed.blue
    • PayloadCommandRgbLed.green
    • PayloadCommandRgbLed.metadata
    • PayloadCommandRgbLed.red
  • PayloadCommandXgoAction
    • PayloadCommandXgoAction.action
    • PayloadCommandXgoAction.metadata
  • PayloadControlMode
    • PayloadControlMode.metadata
    • PayloadControlMode.mode
  • PayloadDotBotAdvertisement
    • PayloadDotBotAdvertisement.battery
    • PayloadDotBotAdvertisement.calibrated
    • PayloadDotBotAdvertisement.direction
    • PayloadDotBotAdvertisement.encoder_left
    • PayloadDotBotAdvertisement.encoder_right
    • PayloadDotBotAdvertisement.metadata
    • PayloadDotBotAdvertisement.mode
    • PayloadDotBotAdvertisement.pos_x
    • PayloadDotBotAdvertisement.pos_y
    • PayloadDotBotAdvertisement.pwm_left
    • PayloadDotBotAdvertisement.pwm_right
    • PayloadDotBotAdvertisement.waypoint_idx
    • PayloadDotBotAdvertisement.waypoint_x
    • PayloadDotBotAdvertisement.waypoint_y
  • PayloadDotBotSimulatorData
    • PayloadDotBotSimulatorData.metadata
    • PayloadDotBotSimulatorData.pos_x
    • PayloadDotBotSimulatorData.pos_y
    • PayloadDotBotSimulatorData.theta
  • PayloadGPSPosition
    • PayloadGPSPosition.latitude
    • PayloadGPSPosition.longitude
    • PayloadGPSPosition.metadata
  • PayloadGPSWaypoints
    • PayloadGPSWaypoints.count
    • PayloadGPSWaypoints.metadata
    • PayloadGPSWaypoints.threshold
    • PayloadGPSWaypoints.waypoints
  • PayloadLH2Location
    • PayloadLH2Location.metadata
    • PayloadLH2Location.pos_x
    • PayloadLH2Location.pos_y
  • PayloadLH2Waypoints
    • PayloadLH2Waypoints.count
    • PayloadLH2Waypoints.metadata
    • PayloadLH2Waypoints.threshold
    • PayloadLH2Waypoints.waypoints
  • PayloadLh2CalibrationHomography
    • PayloadLh2CalibrationHomography.homography_matrix
    • PayloadLh2CalibrationHomography.index
    • PayloadLh2CalibrationHomography.metadata
  • PayloadLh2ProcessedLocation
    • PayloadLh2ProcessedLocation.lfsr_index
    • PayloadLh2ProcessedLocation.metadata
    • PayloadLh2ProcessedLocation.polynomial_index
    • PayloadLh2ProcessedLocation.timestamp_us
  • PayloadRawData
    • PayloadRawData.count
    • PayloadRawData.data
    • PayloadRawData.metadata
  • PayloadSailBotData
    • PayloadSailBotData.direction
    • PayloadSailBotData.latitude
    • PayloadSailBotData.longitude
    • PayloadSailBotData.metadata
    • PayloadSailBotData.rudder_angle
    • PayloadSailBotData.sail_angle
    • PayloadSailBotData.wind_angle
  • PayloadType
    • PayloadType.ADVERTISEMENT
    • PayloadType.CMD_MOVE_RAW
    • PayloadType.CMD_RGB_LED
    • PayloadType.CMD_XGO_ACTION
    • PayloadType.CONTROL_MODE
    • PayloadType.DOTBOT_ADVERTISEMENT
    • PayloadType.DOTBOT_SIMULATOR_DATA
    • PayloadType.GPS_POSITION
    • PayloadType.GPS_WAYPOINTS
    • PayloadType.LH2_CALIBRATION_HOMOGRAPHY
    • PayloadType.LH2_PROCESSED_DATA
    • PayloadType.LH2_WAYPOINTS
    • PayloadType.RAW_DATA
    • PayloadType.SAILBOT_DATA
• dotbot.rest module
  • RestClient
    • RestClient.clear_position_history()
    • RestClient.close()
    • RestClient.fetch_dotbots()
    • RestClient.fetch_map_size()
    • RestClient.send_move_raw_command()
    • RestClient.send_rgb_led_command()
    • RestClient.send_waypoint_command()
    • RestClient.base_url
  • rest_client()
• dotbot.sailbot_simulator module
  • Point
    • Point.x
    • Point.y
  • SailBotSimulator
    • SailBotSimulator.advertise()
    • SailBotSimulator.control_loop_update()
    • SailBotSimulator.decode_serial_input()
    • SailBotSimulator.encode_serial_output()
    • SailBotSimulator.simulation_update()
    • SailBotSimulator.header
  • SailBotSimulatorCommunicationInterface
    • SailBotSimulatorCommunicationInterface.run()
    • SailBotSimulatorCommunicationInterface.stop()
    • SailBotSimulatorCommunicationInterface.write()
  • SailBotSimulatorLineClass
    • SailBotSimulatorLineClass.distance2point()
    • SailBotSimulatorLineClass.line_side()
  • SailBotSimulatorMode
    • SailBotSimulatorMode.AUTOMATIC
    • SailBotSimulatorMode.MANUAL
  • cartesian2geographical()
  • geographical2cartesian()
• dotbot.server module
  • ReverseProxyMiddleware
    • ReverseProxyMiddleware.dispatch()
  • background_map()
  • dotbot()
  • dotbot_positions_history_clear()
  • dotbots()
  • dotbots_move_raw()
  • dotbots_rgb_led()
  • dotbots_waypoints()
  • map_size()
  • websocket_endpoint()
  • ws_dotbots()