domochip/sms2mqtt

sms2mqtt Docker镜像文档

镜像概述和主要用途

sms2mqtt是一个通过USB GSM调制解调器（兼容Gammu）实现SMS与MQTT协议转换的网关工具。它允许用户通过MQTT消息代理发送和接收短信，实现SMS与物联网系统的集成，适用于需要远程短信控制或通知的场景。

核心功能和特性

• 支持通过MQTT发送和接收SMS
• 兼容Gammu支持的GSM调制解调器（未在列表中的设备通常也可工作）
• 支持多号码发送（分号分隔）
• 支持长短信（超过160字符）
• 支持包含表情符号的Unicode消息
• 提供信号质量监控并通过MQTT发布

使用场景和适用范围

• 物联网设备的短信通知功能
• 远程控制系统的短信指令接收
• 需要SMS网关的智能家居系统
• 自动化脚本的短信发送需求

前提条件

需要一个兼容Gammu的GSM调制解调器（查看兼容列表：[***]

工作原理

!https://raw.githubusercontent.com/Domochip/sms2mqtt/master/diagram.svg

使用方法和配置说明

安装部署

Docker方式

执行以下命令启动容器：

bash
docker run \
    -d \
    --name sms2mqtt \
    --restart=always \
    --device=/dev/ttyUSB0:/dev/mobile \
    -e PIN="1234" \
    -e HOST="192.168.1.x" \
    -e PORT=1883 \
    -e PREFIX="sms2mqtt" \
    -e CLIENTID="sms2mqttclid" \
    -e USER="usr" \
    -e PASSWORD="pass" \
    domochip/sms2mqtt

Docker Compose方式

使用以下yaml配置：

yaml
version: '3'
services:
  sms2mqtt:
    container_name: sms2mqtt
    image: domochip/sms2mqtt
    devices:
    - /dev/serial/by-id/usb-HUAWEI_HUAWEI_Mobile-if00-port0:/dev/mobile
    environment:
    - PIN=1234
    - HOST=10.0.0.2
    - PORT=1883
    - PREFIX=sms2mqtt
    - CLIENTID=sms2mqttclid
    - USER=mqtt_username
    - PASSWORD=mqtt_password
    restart: always

配置说明

设备配置

• device: GSM调制解调器的位置，需映射到容器内的/dev/mobile路径

注意：GSM调制解调器的/dev/ttyUSBx路径在重启后可能变化，建议使用/dev/serial/by-id/路径或配置udev规则创建符号链接以避免此问题。

环境变量

• PIN: 可选，SIM卡的PIN码
• HOST: MQTT代理的IP地址或主机名（必填）
• PORT: 可选，MQTT代理端口（默认值未指定）
• PREFIX: 可选，MQTT主题前缀（默认：sms2mqtt）
• CLIENTID: 可选，MQTT客户端ID
• USER: 可选，MQTT用户名
• PASSWORD: 可选，MQTT密码

功能使用

发送SMS

默认主题前缀为sms2mqtt。发送短信步骤：

1. 向主题sms2mqtt/send发布以下格式的消息：

   json
   {"number":"+33612345678", "text":"This is a test message"}
   

2. 系统发送SMS
3. 发送结果将通过MQTT发布到主题sms2mqtt/sent：

   json
   {"result":"success", "datetime":"2021-01-23 13:00:00", "number":"+33612345678", "text":"This is a test message"}
   

支持功能：

• ✔️ 使用分号(;)分隔的多号码发送（每个号码都会返回确认）
• ✔️ 长消息（超过160字符）
• ✔️ 包含表情符号的Unicode消息，如：{"number":"+33612345678", "text":"It's working fine 👌"}
• ✔️ 包含表情符号的长消息

接收SMS

接收到的SMS将发布到主题sms2mqtt/received，格式如下：

json
{"datetime":"2021-01-23 13:30:00", "number":"+31415926535", "text":"Hi, Be the Pi with you"}

支持功能：

• ✔️ 长SMS消息
• ❌ MMS消息（不支持）

其他主题

• sms2mqtt/signal: 当信号质量变化时发布信号质量信息，示例：

  json
  {"SignalStrength": -71, "SignalPercent": 63, "BitErrorRate": -1}
  

故障排除

查看日志

使用以下命令查看容器日志：

bash
docker logs sms2mqtt

更新镜像

更新到最新Docker镜像的步骤：

bash
docker stop sms2mqtt
docker rm sms2mqtt
docker rmi domochip/sms2mqtt
# 重新运行容器，Docker将自动拉取最新镜像

参考与感谢

感谢以下仓库提供的代码灵感：

• https://github.com/pajikos/sms-gammu-gateway
• https://github.com/pkropf/mqtt2sms