U S3^C@sdZddlZddlZddlZddlmZddlmZddlm Z m Z m Z m Z m Z mZddlmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(ej)ddkre*Z+dZ,ed d d gZ-e.e/Z0Gd d d Z1dS)zFlask-MQTT Package. :author: Stefan Lehmann :license: MIT, see license file or https://opensource.org/licenses/MIT N) namedtuple)Flask)DictAnyCallableTupleOptionalList)ClientMQTT_ERR_SUCCESSMQTT_ERR_ACL_DENIEDMQTT_ERR_AGAIN MQTT_ERR_AUTHMQTT_ERR_CONN_LOSTMQTT_ERR_CONN_REFUSEDMQTT_ERR_ERRNOMQTT_ERR_INVALMQTT_ERR_NO_CONNMQTT_ERR_NOMEMMQTT_ERR_NOT_FOUNDMQTT_ERR_NOT_SUPPORTEDMQTT_ERR_PAYLOAD_SIZEMQTT_ERR_PROTOCOLMQTT_ERR_QUEUE_SIZE MQTT_ERR_TLSMQTT_ERR_UNKNOWNMQTT_LOG_DEBUG MQTT_LOG_ERR MQTT_LOG_INFOMQTT_LOG_NOTICEMQTT_LOG_WARNINGMQTTv311MQTTv31z1.1.1TopicQostopicqosc@s`eZdZdZd1eeeddddZedddd Zdd d d Zdd d dZ e e e e e feddddZe e eddddZe edddZd2e eeeefdddZe eeeefdddZdd ddZd3e eeeeeeefd d!d"Zed d#d$Zed d%d&Zed d'd(Zed d)d*Zed d+d,Zed d-d.Zed d/d0Z dS)4MqttzMain Mqtt class. :param app: flask application object :param connect_async: if True then connect_aync will be used to connect to MQTT broker :param mqtt_logging: if True then messages from MQTT client will be logged NF)app connect_async mqtt_loggingreturncCs||_d|_d|_||_t|_d|_i|_d|_d|_ d|_ d|_ d|_ d|_ d|_d|_d|_d|_d|_d|_d|_d|_d|_tj|_tj|_d|_d|_|r|jt|dk r| |dS)NFTZ localhosti[<r)!_connect_async_connect_handler_disconnect_handlerr(r client connectedtopics client_id clean_sessionusernamepassword broker_url broker_port tls_enabled keepalivelast_will_topiclast_will_message last_will_qoslast_will_retain tls_ca_certs tls_certfile tls_keyfilesslZ CERT_NONE tls_cert_reqsPROTOCOL_TLSv1 tls_version tls_ciphers tls_insecureZ enable_loggerloggerinit_app)selfr(r)r*rLV/var/www/html/flasktest/Project_env/lib/python3.8/site-packages/flask_mqtt/__init__.py__init__Bs< z Mqtt.__init__)r(r+cCsXt|jtr|jd|j_n |j|j_|jdd|j_ |jdt |j_ |j |j_ |j|j_|j|j_d|jkr|jd|_d|jkr|jd|_ d|jkr|jd|_d|jkr|jd|_d |jkr|jd |_d |jkr|jd |_d |jkr |jd |_d |jkr"|jd |_d |jkr:|jd |_d|jkrR|jd|_d|jkrj|jd|_d|jkr|jd|_|jr&d|jkr|jd|_d|jkr|jd|_d|jkr|jd|_d|jkr|jd|_d|jkr|jd|_ |jdt!j"|_#|jdt!j$|_%|jdk rL|j&|j|j|j|j|'dS)zInit the Flask-MQTT addon.zutf-8ZMQTT_TRANSPORTZtcpZMQTT_PROTOCOL_VERSIONZMQTT_CLIENT_IDZMQTT_CLEAN_SESSIONZ MQTT_USERNAMEZ MQTT_PASSWORDZMQTT_BROKER_URLZMQTT_BROKER_PORTZMQTT_TLS_ENABLEDZMQTT_KEEPALIVEZMQTT_LAST_WILL_TOPICZMQTT_LAST_WILL_MESSAGEZMQTT_LAST_WILL_QOSZMQTT_LAST_WILL_RETAINZMQTT_TLS_CA_CERTSZMQTT_TLS_CERTFILEZMQTT_TLS_KEYFILEZMQTT_TLS_CIPHERSZMQTT_TLS_INSECUREZMQTT_TLS_CERT_REQSZMQTT_TLS_VERSIONN)( isinstancer4unicodeencoder1Z _client_idconfiggetlowerZ _transportr!Z _protocolr5Z_clean_session_handle_connect on_connect_handle_disconnect on_disconnectr6r7r8r9r:r;r<r=r>r?r@rArBrGrHrCZ CERT_REQUIREDrDrErFZwill_set_connect)rKr(rLrLrMrJjsj                                        z Mqtt.init_app)r+cCs|jdk r|j|j|j|jrZ|jj|j|j|j|j |j |j d|j rZ|j |j |jrz|jj|j|j|jdnL|jj|j|j|jd}|dkrtd|j|j|jntd||jdS)N)Zca_certsZcertfileZkeyfileZ cert_reqsrFZciphers)r;rz(Connected client '{0}' to broker {1}:{2}z1Could not connect to MQTT Broker, Error Code: {0})r6r1Zusername_pw_setr7r:Ztls_setr@rArBrDrFrGrHZtls_insecure_setr.r)r8r9r;connectrIdebugformatr4errorZ loop_start)rKresrLrLrMrYsH  z Mqtt._connectcCs"|j|jtddS)NzDisconnected from Broker)r1Z loop_stopZ disconnectrIr[rKrLrLrM _disconnects  zMqtt._disconnect)r1userdataflagsrcr+cCsT|tkr6d|_|jD]\}}|jj|j|jdq|jdk rP|||||dS)NTr%r&) r r2r3itemsr1 subscriber%r&r/)rKr1rarbrckeyitemrLrLrMrUs  zMqtt._handle_connect)r1rarcr+cCsd|_|jdk r|dS)NF)r2r0)rKr1rarcrLrLrMrWs zMqtt._handle_disconnect)r%r+cs.ttgdfttgdfdfdd }|S)aDecorator. Decorator to add a callback function that is called when a certain topic has been published. The callback function is expected to have the following form: `handle_topic(client, userdata, message)` :parameter topic: a string specifying the subscription topic to subscribe to The topic still needs to be subscribed via mqtt.subscribe() before the callback function can be used to handle a certain topic. This way it is possible to subscribe and unsubscribe during runtime. **Example usage:**:: app = Flask(__name__) mqtt = Mqtt(app) mqtt.subscribe('home/mytopic') @mqtt.on_topic('home/mytopic') def handle_mytopic(client, userdata, message): print('Received message on topic {}: {}' .format(message.topic, message.payload.decode())) Nhandlerr+csj||SN)r1Zmessage_callback_addrjrKr%rLrM decoratorsz Mqtt.on_topic..decorator)rstr)rKr%rnrLrmrMon_topics*z Mqtt.on_topicr)r%r&r+cCs\|jj||d\}}|tkrBt||d|j|<td||ntd||||fS)a Subscribe to a certain topic. :param topic: a string specifying the subscription topic to subscribe to. :param qos: the desired quality of service level for the subscription. Defaults to 0. :rtype: (int, int) :result: (result, mid) A topic is a UTF-8 string, which is used by the broker to filter messages for each connected client. A topic consists of one or more topic levels. Each topic level is separated by a forward slash (topic level separator). The function returns a tuple (result, mid), where result is MQTT_ERR_SUCCESS to indicate success or (MQTT_ERR_NO_CONN, None) if the client is not currently connected. mid is the message ID for the subscribe request. The mid value can be used to track the subscribe request by checking against the mid argument in the on_subscribe() callback if it is defined. **Topic example:** `myhome/groundfloor/livingroom/temperature` rdz"Subscribed to topic: {0}, qos: {1}z#Error {0} subscribing to topic: {1}) r1rfr r$r3rIr[r\r])rKr%r&resultmidrLrLrMrfs zMqtt.subscribecCs^||jkrZ|j|\}}|tkr@|j|td|ntd||||fSdS)ao Unsubscribe from a single topic. :param topic: a single string that is the subscription topic to unsubscribe from :rtype: (int, int) :result: (result, mid) Returns a tuple (result, mid), where result is MQTT_ERR_SUCCESS to indicate success or (MQTT_ERR_NO_CONN, None) if the client is not currently connected. mid is the message ID for the unsubscribe request. The mid value can be used to track the unsubscribe request by checking against the mid argument in the on_unsubscribe() callback if it is defined. zUnsubscribed from topic: {0}z'Error {0} unsubscribing from topic: {1}N)r3r1 unsubscriber poprIr[r\)rKr%rqrrrLrLrMrs?s   zMqtt.unsubscribecCs&t|j}|D]}||qdS)zUnsubscribe from all topics.N)listr3keysrs)rKr3r%rLrLrMunsubscribe_allaszMqtt.unsubscribe_all)r%payloadr&retainr+cCsL|j||||\}}|tkr2td||ntd||||fS)a Send a message to the broker. :param topic: the topic that the message should be published on :param payload: the actual message to send. If not given, or set to None a zero length message will be used. Passing an int or float will result in the payload being converted to a string representing that number. If you wish to send a true int/float, use struct.pack() to create the payload you require. :param qos: the quality of service level to use :param retain: if set to True, the message will be set as the "last known good"/retained message for the topic :returns: Returns a tuple (result, mid), where result is MQTT_ERR_SUCCESS to indicate success or MQTT_ERR_NO_CONN if the client is not currently connected. mid is the message ID for the publish request. zPublished topic {0}: {1}zError {0} publishing topic {1})r1publishr rIr[r\r])rKr%rxr&ryrqrrrLrLrMrzgs z Mqtt.publishcsttdfdd }|S)zDecorator. Decorator to handle the event when the broker responds to a connection request. Only the last decorated function will be called. rics |_|Srk)r/rlr_rLrMrnsz"Mqtt.on_connect..decoratorrrKrnrLr_rMrVszMqtt.on_connectcsttdfdd }|S)zDecorator. Decorator to handle the event when client disconnects from broker. Only the last decorated function will be called. rics |_|Srk)r0rlr_rLrMrnsz%Mqtt.on_disconnect..decoratorr{r|rLr_rMrXszMqtt.on_disconnectcsttdfdd }|S)aVDecorator. Decorator to handle all messages that have been subscribed and that are not handled via the `on_message` decorator. **Note:** Unlike as written in the paho mqtt documentation this callback will not be called if there exists an topic-specific callback added by the `on_topic` decorator. **Example Usage:**:: @mqtt.on_message() def handle_messages(client, userdata, message): print('Received message on topic {}: {}' .format(message.topic, message.payload.decode())) rics |j_|Srk)r1 on_messagerlr_rLrMrnsz"Mqtt.on_message..decoratorr{r|rLr_rMr}szMqtt.on_messagecsttdfdd }|S)a=Decorator. Decorator to handle all messages that have been published by the client. **Example Usage:**:: @mqtt.on_publish() def handle_publish(client, userdata, mid): print('Published message with mid {}.' .format(mid)) rics |j_|Srk)r1 on_publishrlr_rLrMrnsz"Mqtt.on_publish..decoratorr{r|rLr_rMr~szMqtt.on_publishcsttdfdd }|S)a,Decorate a callback function to handle subscritions. **Usage:**:: @mqtt.on_subscribe() def handle_subscribe(client, userdata, mid, granted_qos): print('Subscription id {} granted with qos {}.' .format(mid, granted_qos)) rics |j_|Srk)r1 on_subscriberlr_rLrMrnsz$Mqtt.on_subscribe..decoratorr{r|rLr_rMrs zMqtt.on_subscribecsttdfdd }|S)aDecorate a callback funtion to handle unsubscribtions. **Usage:**:: @mqtt.unsubscribe() def handle_unsubscribe(client, userdata, mid) print('Unsubscribed from topic (id: {})' .format(mid)') rics |j_|Srk)r1on_unsubscriberlr_rLrMrnsz&Mqtt.on_unsubscribe..decoratorr{r|rLr_rMrs zMqtt.on_unsubscribecsttdfdd }|S)zDecorate a callback function to handle MQTT logging. **Example Usage:** :: @mqtt.on_log() def handle_logging(client, userdata, level, buf): print(client, userdata, level, buf) rics |j_|Srk)r1on_logrlr_rLrMrnszMqtt.on_log..decoratorr{r|rLr_rMrs z Mqtt.on_log)NFF)r)NrF)!__name__ __module__ __qualname____doc__rboolrNrJrYr`r rrrointrUrWrrprrfrrsrwbytesrzrVrXr}r~rrrrLrLrLrMr'9sR  (O(   *"  #r')2rsysrClogging collectionsrZflaskrtypingrrrrrr Zpaho.mqtt.clientr r r r rrrrrrrrrrrrrrrrrrr r!r" version_infororP __version__r$ getLoggerrrIr'rLrLrLrMs   l