>qav,dZddlmZddlmZddlmZdZdZd Z d Z dd d d ddd d d ej ddd f dZ dddd d ddd d d ej ddd fdZ d S)a This module provides some helper functions to allow straightforward subscribing to topics and retrieving messages. The two functions are simple(), which returns one or messages matching a set of topics, and callback() which allows you to pass a callback for processing of messages. )absolute_import)mqtt)clientc*|dkr&tjtj|t |dt r)|dD]}|||ddS||d|ddS)Internal callbackrtopicsqosN)r MQTTExceptionpahoconnack_string isinstancelist subscribe)ruserdataflagsrc propertiestopics G/opt/windhager/venv/lib/python3.11/site-packages/paho/mqtt/subscribe.py_on_connect_v5rs Qww !4R!8!8999(8$d++>h' 5 5E   UHUO 4 4 4 4 5 5 (+Xe_=====c,t||||ddS)zInternal v5 callbackN)r)rrrrs r _on_connectr&s68UB55555rc8|d||d|dS)r callbackrNrrmessages r_on_message_callbackr!+s&HZ*!5w?????rc8|ddkrdS|jr |dsdS|ddz |d<|d'|ddkr||d<|dS|d||ddkr|dSdS)r msg_countrNretainedrmessages)retain disconnectappendrs r_on_message_simpler)0s !!~hz2$[1A5H[ #(=(B(B& Z((( !!"!rN localhosti[<tcpTc|dks|dkrtd||||d}tj||| | | }t|_| t jjkr t|_ n t|_ | |j d i|| rR| d}|r,| d}| ||ntd | |jd i|| et!| t"r;| d d }|jd i| |r||n|| |||||dS) a Subscribe to a list of topics and process them in a callback function. This function creates an MQTT client, connects to a broker and subscribes to a list of topics. Incoming messages are processed by the user provided callback. This is a blocking function and will never return. callback : function of the form "on_message(client, userdata, message)" for processing the messages received. topics : either a string containing a single topic to subscribe to, or a list of topics to subscribe to. qos : the qos to use when subscribing. This is applied to all topics. userdata : passed to the callback hostname : a string containing the address of the broker to connect to. Defaults to localhost. port : the port to connect to the broker on. Defaults to 1883. client_id : the MQTT client id to use. If "" or None, the Paho library will generate a client id automatically. keepalive : the keepalive timeout value for the client. Defaults to 60 seconds. will : a dict containing will parameters for the client: will = {'topic': "", 'payload':", 'qos':, 'retain':}. Topic is required, all other parameters are optional and will default to None, 0 and False respectively. Defaults to None, which indicates no will should be used. auth : a dict containing authentication parameters for the client: auth = {'username':"", 'password':""} Username is required, password is optional and will default to None if not provided. Defaults to None, which indicates no authentication is to be used. tls : a dict containing TLS configuration parameters for the client: dict = {'ca_certs':"", 'certfile':"", 'keyfile':"", 'tls_version':"", 'ciphers':", 'insecure':""} ca_certs is required, all other parameters are optional and will default to None if not provided, which results in the client using the default behaviour - see the paho.mqtt.client documentation. Alternatively, tls input can be an SSLContext object, which will be processed using the tls_set_context method. Defaults to None, which indicates that TLS should not be used. transport : set to "tcp" to use the default setting of transport which is raw TCP. Set to "websockets" to use WebSockets as the transport. clean_session : a boolean that determines the client type. If True, the broker will remove all information about this client when it disconnects. If False, the client is a persistent client and subscription information and queued messages will be retained when the client disconnects. Defaults to True. proxy_args: a dictionary that will be given to the client. rrzqos must be in the range 0-2)rr r r) client_idrprotocol transport clean_sessionNusernamepasswordz;The 'username' key was not found, this is required for authinsecureFr) ValueErrorr Clientr! on_messagerrMQTTv5r on_connectr proxy_setgetusername_pw_setKeyErrorwill_setrdictpoptls_settls_insecure_settls_set_contextconnect loop_forever)rr r rhostnameportr/ keepalivewillauthtlsr0r1r2 proxy_argscallback_userdatarr3r4r5s rrrFsF Qww#''7888  [97H"*i'4666F-F4;%%%*'&&:&&& 088J''  0xx ++H  " "8X 6 6 6 6/00 0 $  c4 (wwz511H FN ! !S ! ! ! 2''111  " "3 ' ' ' NN8T9--- rc|dkrtd|dkrd}ng}|||d}tt||||||||| | | | | ||dS)a Subscribe to a list of topics and return msg_count messages. This function creates an MQTT client, connects to a broker and subscribes to a list of topics. Once "msg_count" messages have been received, it disconnects cleanly from the broker and returns the messages. topics : either a string containing a single topic to subscribe to, or a list of topics to subscribe to. qos : the qos to use when subscribing. This is applied to all topics. msg_count : the number of messages to retrieve from the broker. if msg_count == 1 then a single MQTTMessage will be returned. if msg_count > 1 then a list of MQTTMessages will be returned. retained : If set to True, retained messages will be processed the same as non-retained messages. If set to False, retained messages will be ignored. This means that with retained=False and msg_count=1, the function will return the first message received that does not have the retained flag set. hostname : a string containing the address of the broker to connect to. Defaults to localhost. port : the port to connect to the broker on. Defaults to 1883. client_id : the MQTT client id to use. If "" or None, the Paho library will generate a client id automatically. keepalive : the keepalive timeout value for the client. Defaults to 60 seconds. will : a dict containing will parameters for the client: will = {'topic': "", 'payload':", 'qos':, 'retain':}. Topic is required, all other parameters are optional and will default to None, 0 and False respectively. Defaults to None, which indicates no will should be used. auth : a dict containing authentication parameters for the client: auth = {'username':"", 'password':""} Username is required, password is optional and will default to None if not provided. Defaults to None, which indicates no authentication is to be used. tls : a dict containing TLS configuration parameters for the client: dict = {'ca_certs':"", 'certfile':"", 'keyfile':"", 'tls_version':"", 'ciphers':", 'insecure':""} ca_certs is required, all other parameters are optional and will default to None if not provided, which results in the client using the default behaviour - see the paho.mqtt.client documentation. Alternatively, tls input can be an SSLContext object, which will be processed using the tls_set_context method. Defaults to None, which indicates that TLS should not be used. transport : set to "tcp" to use the default setting of transport which is raw TCP. Set to "websockets" to use WebSockets as the transport. clean_session : a boolean that determines the client type. If True, the broker will remove all information about this client when it disconnects. If False, the client is a persistent client and subscription information and queued messages will be retained when the client disconnects. Defaults to True. proxy_args: a dictionary that will be given to the client. rzmsg_count must be > 0N)r$r#r%r%)r6rr))r r r#r$rGrHr/rIrJrKrLr0r1r2rMr%rs rsimplerPsP1}}0111A~~#xPPH h$  4sHi J((( J r)__doc__ __future__rr+rrr rrr!r)MQTTv311rrPrrrrTs  '&&&&& > > >666 @@@ ,$%tk"D DqqqqhA{bt$dmu$X X X X X X r