Python paho-mqtt使用心得

一、概述

一）基本概念

使用回调处理从MQTT代理返回的数据，要使用回调需要先定义回调函数然后将其指派给客户端实例（client）。

例如：

# 定义一个回调函数
def on_connect(client, userdata, flags, rc):
    print("Connection returned " + str(rc))

# 将回调函数指派给客户端实例
client.on_connect = on_connect

所有的回调函数都有client和userdata参数。

client是调用回调的客户端实例；

userdata可以使任何类型的用户数据，可以在创建新客户端实例时设置或者使用user_data_set(userdata)设置。

二）paho-mqtt总的说来分为三部分：

 **种类：**
  1.服务器连接on_connect()/服务器断开 on_disconnect()
  2.信息的回调 on_message()
  3.信息的发布on_publish()/信息的订阅on_subscribe()
 **介绍：**
  1. 使用connect()/connect_async() 连接MQTT代理
  2. 频繁的调用loop()来维持与MQTT代理之间的流量
    2.1. 或者使用loop_start()来设置一个线程为你调用loop()
    2.2. 或者在一个阻塞的函数中调用loop_forever()来为你调用loop()
  3.使用subscribe()订阅一个主题（topic）并接受消息（messages）
  4.使用publish()来发送消息
  5.使用disconnect()来断开与MQTT代理的连接

二、paho-mqtt 在Python中的安装方法

pip install paho-mqtt

三、on_connect()回调函数介绍

当代理响应连接请求时调用。
on_connect(client, userdata, flags, rc):
rc的值决定了连接成功或者不成功：

值	连接情况
0	连接成功
1	协议版本错误
2	无效的客户端标识
3	服务器无法使用
4	错误的用户名或密码
5	未经授权

import paho.mqtt.client as mqtt
#定义一个on_connect方法
def on_connect(client,userdata,flags,rc):
    return str(rc)

class IotSubDevViewSet(viewsets.ModelViewSet):
 #系统启动后，会把SUBSCRIBED状态的设备加入订阅进程
    def init_subscribe():
        iotsubdevs = IotSubDev.objects.all()
        for iotsubdev in iotsubdevs:
            try:
                devices_pk = iotsubdev.device.id
                client = mqtt.Client()
                client.username_pw_set(username=settings.MQTT_USERNAME, password=settings.MQTT_PASSWORD)#设置mqtt服务器用户名和密码

                client.on_connect = on_connect
                client.on_message = on_message
                rc = client.connect(settings.MQTT_HOST, port=1883, keepalive=60)

                if(rc==0 and iotsubdev.status=="SUBSCRIBED"):
                    print("初始化开始sub")
                    client.subscribe(topic=str(devices_pk),qos=0)
                    client.loop_start()
                    print("初始化sub结束")
                else:
                    # print("连接失败")
                    pass

            except:
                    pass

    init_subscribe()

三、on_message()回调函数介绍

import json
def on_message(client, userdata, msg):
    msg = msg.payload  #将信息转换成json格式
    try:
        params = json.loads(msg)
    except:
        return (False)

       #Beilai BL102
        if tmp =="sensorDatas":
            for dc_tmp in params[tmp]:
                print(dc_tmp)
                timestamp = datetime.now()
                try:
                    ctrlchannel = CtrlChannel.objects.filter(id=dc_tmp['flag']).first()
                    metricdata = MetricData(ctrlchannel=ctrlchannel,
                                            timestamp=timestamp,
                                            value=dc_tmp['value'],
                                            direction="UP")
                    metricdata.save()
                except:
                    pass
        else:
            tmp = "Wrong Parameters"
            return tmp
    print("Subscribed is OK")
    return True

四、on_publish()回调函数介绍

import paho.mqtt.publish as publish
class MetricDataViewSet(viewsets.ModelViewSet):
    """"
    list:
    查询数据点信息列表

    create:
    创建数据点信息
    如果方向为DOWN,支持MQTT发布信息

    retrieve:
    查询数据点信息详情

    update:
    更新数据点信息，不建议使用

    partial_update:
    更新数据点信息的部分属性，不建议使用

    destroy:
    删除数据点信息

    """
    serializer_class = MetricDataSerializer
    permission_classes = (permissions.IsAuthenticated,)
    # pagination_class = StanderResultsSetPagination
    authentication_classes = (authentication.JWTAuthentication,)
    queryset = MetricData.objects.all()

    def create(self,request , *args, **kwargs):
        serializer =self.get_serializer(data=request.data)
        if serializer.is_valid(raise_exception=True):
            self.perform_create(serializer)
            headers = self.get_success_headers(serializer.data)

            try:
                if request.data['direction'] == 'DOWN':
                    ctrlchannels_id = request.data["ctrlchannel"]
                    ctrlchannels_value = request.data["value"]
                    # payload = json.dumps(request.data)
                    #beilai BL102
                    jsonload ={"sensorDatas":[{"sensorsId":100,
                                              "flag":ctrlchannels_id,
                                              "value": str(ctrlchannels_value)}],
                              "down":"down"}
                    print(jsonload)
                    payload = json.dumps(jsonload)

                    # print(ctrlchannels_id)
                    publish.single(topic=ctrlchannels_id+"/100",
                                   payload=payload,
                                   hostname=settings.MQTT_HOST,
                                   auth={'username':settings.MQTT_USERNAME, 'password':settings.MQTT_PASSWORD})

                    # self.perform_create(serializer)
            except:
                pass

            return Response(serializer.data,status=status.HTTP_201_CREATED,headers=headers)
        return Response(serializer.errors,status=status.HTTP_400_BAD_REQUEST)