跳转到主要内容

Smallpeice暑期学校的机器人API

项目描述

sbot

Lint & build PyPI version Documentation Status MIT license Bees

sbot - SourceBots机器人API

这是SourceBots库的API,用于编写机器人API。它将首先在Smallpeice 2023中部署。

安装

如果您想通过包管理器安装openCV,可以使用以下命令安装基本包:

pip install sbot

要安装包含openCV在内的完整包,可以使用以下命令:

pip install sbot[vision]

用法

API的主要入口点是Robot类。实例化此类将自动检测并连接到设备上连接的任何SR v4板。默认情况下,Robot类将在继续之前等待电源板上按下启动按钮。

from sbot import Robot

r = Robot()

要禁用等待启动按钮,可以将wait_for_start=False传递给构造函数。在可用元数据之前需要调用wait_for_start方法。

from sbot import Robot

r = Robot(wait_for_start=False)

# Setup in here

r.wait_start()

开发者须知

在设计此API时已经考虑了许多因素。其中一些可能不是立即明显的,因此以下进行了记录。

  • API设计为对错误操作引发异常,例如尝试修改输出字典或直接将值赋给电机对象。
  • MappingProxyType用于防止用户向API返回字典的任何部分添加、删除或覆盖键。
  • tuple用于防止用户向API返回列表的任何部分添加、删除或覆盖项。
  • __slots__用于防止用户在API的任何部分添加、删除或覆盖属性。
  • sbot.serial_wrapper.SerialWrapper处理在连接丢失时自动重新连接到串行端口,并在引发BoardDisconnectionError之前执行任何串行操作的重试。

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪一个,请了解更多关于安装包的信息。

源分布

sbot-2024.0.2.tar.gz (52.7 kB 查看散列)

上传

构建分布

sbot-2024.0.2-py3-none-any.whl (45.8 kB 查看散列)

上传 Python 3

由以下支持

AWSAWS云计算和安全赞助商DatadogDatadog监控FastlyFastlyCDNGoogleGoogle下载分析MicrosoftMicrosoftPSF赞助商PingdomPingdom监控SentrySentry错误日志StatusPageStatusPage状态页面