BlueDot 项目教程

1. 项目目录结构及介绍

BlueDot 项目的目录结构如下：

BlueDot/
├── bluedot/
│   ├── __init__.py
│   ├── bluedot.py
│   ├── btcomm.py
│   ├── colors.py
│   ├── mock.py
│   └── utils.py
├── examples/
│   ├── basic_example.py
│   ├── color_example.py
│   ├── mock_example.py
│   └── multi_dot_example.py
├── tests/
│   ├── __init__.py
│   ├── test_bluedot.py
│   ├── test_btcomm.py
│   ├── test_colors.py
│   ├── test_mock.py
│   └── test_utils.py
├── setup.py
├── README.md
└── LICENSE

目录结构介绍

• bluedot/: 包含 BlueDot 项目的主要代码文件。

  • __init__.py: 初始化文件，使 bluedot 成为一个 Python 包。
  • bluedot.py: 主要逻辑文件，处理与蓝牙设备的通信。
  • btcomm.py: 蓝牙通信模块。
  • colors.py: 颜色处理模块。
  • mock.py: 模拟模块，用于在没有实际硬件的情况下进行测试。
  • utils.py: 工具函数模块。

• examples/: 包含多个示例代码，展示了如何使用 BlueDot 项目。

  • basic_example.py: 基本示例。
  • color_example.py: 颜色示例。
  • mock_example.py: 模拟示例。
  • multi_dot_example.py: 多设备示例。

• tests/: 包含项目的测试代码。

  • __init__.py: 初始化文件，使 tests 成为一个 Python 包。
  • test_bluedot.py: 测试 bluedot.py 模块。
  • test_btcomm.py: 测试 btcomm.py 模块。
  • test_colors.py: 测试 colors.py 模块。
  • test_mock.py: 测试 mock.py 模块。
  • test_utils.py: 测试 utils.py 模块。

• setup.py: 项目的安装脚本。

• README.md: 项目的说明文档。

• LICENSE: 项目的开源许可证。

2. 项目启动文件介绍

项目的启动文件是 examples/basic_example.py。该文件展示了如何使用 BlueDot 项目与蓝牙设备进行基本通信。

basic_example.py 文件内容

from bluedot import BlueDot

def say_hello():
    print("Hello from BlueDot!")

bd = BlueDot()
bd.when_pressed = say_hello

bd.wait_for_press()

启动文件介绍

• 导入模块: from bluedot import BlueDot 导入了 BlueDot 模块。
• 定义回调函数: def say_hello(): 定义了一个简单的回调函数，当 BlueDot 被按下时会执行该函数。
• 创建 BlueDot 实例: bd = BlueDot() 创建了一个 BlueDot 实例。
• 设置回调: bd.when_pressed = say_hello 设置了当 BlueDot 被按下时的回调函数。
• 等待按下: bd.wait_for_press() 使程序进入等待状态，直到 BlueDot 被按下。

3. 项目配置文件介绍

BlueDot 项目没有专门的配置文件，所有的配置和设置都在代码中完成。例如，在 basic_example.py 中，通过 bd = BlueDot() 创建实例时，可以传递参数来配置 BlueDot 的行为。

配置示例

bd = BlueDot(port=1, auto_start_server=True)

配置参数介绍

• port: 指定蓝牙设备的端口号，默认为 1。
• auto_start_server: 是否自动启动蓝牙服务器，默认为 True。

通过这些参数，可以在创建 BlueDot 实例时进行配置，以满足不同的需求。