pyGSM 模块使用指南

本文档将为您提供详细的 pyGSM 模块安装和使用说明，帮助您通过 GSM 模块发送和接收短信。

1. 安装指南

1.1 环境要求

在安装 pyGSM 之前，请确保您的系统中已安装以下软件：

• Python（版本至少为 2.7）
• pySerial（用于串行通信）

1.2 安装步骤

1. 克隆 pyGSM 仓库到本地：

   git clone https://github.com/adammck/pygsm.git
   

2. 进入 pyGSM 目录：

   cd pygsm
   

3. 安装 pySerial（如果尚未安装）：

   pip install pyserial
   

4. 运行以下命令安装 pyGSM：

   python setup.py install
   

2. 项目使用说明

2.1 创建 GsmModem 对象

要使用 pyGSM 发送和接收短信，首先需要创建一个 GsmModem 对象。以下是一个示例：

modem = pygsm.GsmModem(port="/dev/ttyUSB0")

其中，port 参数为 GSM 模块的串行接口路径。

2.2 发送短信

使用 send_sms 方法发送短信。以下是一个示例：

modem.send_sms("1234567890", "Hello, World!")

其中，1234567890 是接收者的手机号码，"Hello, World!" 是短信内容。

2.3 接收短信

使用 next_message 方法接收短信。以下是一个示例：

message = modem.next_message()
if message:
    print(f"Received message from {message.sender}: {message.text}")
else:
    print("No new messages.")

这将打印出接收到的短信内容及其发送者。

3. 项目 API 使用文档

以下是 pyGSM 模块的部分 API 方法及其功能描述：

• __init__(self, *args, **kwargs): 构造函数，用于初始化 GsmModem 对象。
• boot(self, reboot=False): 连接到调制解调器并配置它，以便标准化不同厂商和型号的行为。
• command(self, cmd, read_term=None, read_timeout=None, write_term='\r', raise_errors=True): 向调制解调器发送 AT 命令，并返回经过处理的响应。
• connect(self, reconnect=False): 通过 pySerial 连接到调制解调器。
• disconnect(self): 断开与调制解调器的连接。
• hardware(self): 返回包含调制解调器硬件信息的字典。
• next_message(self, ping=True, fetch=True): 返回等待中的下一个 IncomingMessage 对象，如果队列为空，则返回 None。
• ping(self): 向设备发送 "AT" 命令，如果设备确认，则返回 True。
• query(self, cmd, prefix=None): 向调制解调器发送 AT 命令，并返回相关部分的响应。
• query_list(self, cmd, prefix=None): 向调制解调器发送单个 AT 命令，并返回包含响应行的列表。
• reboot(self): 断开连接，重新连接并重启调制解调器。
• send_sms(self, recipient, text): 向指定接收者发送包含文本的短信。
• signal_strength(self): 返回表示当前 GSM 网络信号强度的整数，如果不知道或调制解调器无法报告，则返回 False 或 None。
• wait_for_network(self): 阻塞直到信号强度表明设备已激活在 GSM 网络上。

4. 项目安装方式

pyGSM 模块可以通过以下方式安装：

• 从源代码仓库克隆并手动安装（请参考第 1 节“安装指南”）。

• 使用 pip 包管理器安装：

  pip install pygsm
  

请确保在安装过程中遵循所有必要的依赖和指南。