# roar_client-micropython

**Repository Path**: duzc2/roar_client-micropython

## Basic Information

- **Project Name**: roar_client-micropython
- **Description**: 狮偶服务器客户端的 micropython 实现
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-22
- **Last Updated**: 2025-12-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Roar MicroPython Client

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![MicroPython](https://img.shields.io/badge/MicroPython-ESP32-brightgreen.svg)](https://micropython.org/)

这是一个专为 ESP32 及其它运行 MicroPython 固件的硬件设计的轻量级客户端，用于向 [OpenBlock Roar Server](https://openblock.online/) 发送消息。

## 🚀 特性

- **轻量化设计**: 核心代码仅一个文件 `roar_client.py`，极低内存占用。
- **类型安全**: 自动处理 MicroPython 到 Roar Server 之间的数据类型转换。
- **SSL 支持**: 可选的 SSL 证书验证，支持生产环境与开发环境切换。
- **面向对象**: 直观的 API 设计，支持便捷方法发送整数、字符串、布尔值、颜色等。
- **容错性**: 自动处理不同固件版本中 `urequests` 库的参数差异。

## 🛠️ 环境要求

- 硬件：ESP32, ESP8266 或其它支持 MicroPython 的开发板。
- 固件：MicroPython v1.12+。
- 依赖库：内置 `urequests`。

## 📦 安装步骤

1. 连接您的开发板到电脑。
2. 使用 Thonny, mpremote 或其它工具将 `roar_client.py` 上传到开发板的根目录或 `lib` 目录。

```bash
# 使用 mpremote 示例
mpremote cp roar_client.py :
```

## 🚥 快速开始

```python
from roar_client import RoarClient

# 1. 初始化客户端
# 参数：工程ID, 场景ID, 是否验证SSL(默认True)
client = RoarClient("your_project_id", "your_scene_id", verify_ssl=False)

# 2. 发送一个整数消息
client.send_int("score", 100)

# 3. 发送一个布尔消息 (自动转为 "1"/"0")
client.send_bool("light_on", True)

# 4. 发送一个字符串
client.send_string("status", "System Running")
```

## 📖 API 参考

### `RoarClient(project_id, scene_id, verify_ssl=True)`
构造函数，初始化与特定工程和场景的连接。

### `send_int(msg_title, val)`
发送整数类型消息。

### `send_float(msg_title, val)`
发送浮点数类型消息。

### `send_string(msg_title, val)`
发送字符串类型消息。

### `send_bool(msg_title, val)`
发送布尔类型消息。

### `send_colour(msg_title, val)`
发送颜色消息（16进制字符串，如 `FF0000`）。

### `send_binary(msg_title, val)`
发送原始二进制流消息。

## 📄 文档

更多详细信息请参考：
- [API 详细指南](docs/api.md)
- [硬件配置与环境搭建](docs/setup.md)

## 📄 许可证

本项目采用 [MIT 许可证](LICENSE)。