Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: CallbackAPIVersion is not exported from module paho.mqtt.client #852

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: CallbackAPIVersion is not exported from module paho.mqtt.client #852

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ Here is a very simple example that subscribes to the broker $SYS topic tree and
.. code:: python

import paho.mqtt.client as mqtt
from paho.mqtt.enums import CallbackAPIVersion

# The callback for when the client receives a CONNACK response from the server.
def on_connect(client, userdata, flags, reason_code, properties):
Expand All @@ -133,7 +134,7 @@ Here is a very simple example that subscribes to the broker $SYS topic tree and
def on_message(client, userdata, msg):
print(msg.topic+" "+str(msg.payload))

mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
mqttc = mqtt.Client(CallbackAPIVersion.VERSION2)
mqttc.on_connect = on_connect
mqttc.on_message = on_message

Expand Down Expand Up @@ -271,6 +272,7 @@ Subscriber example
.. code:: python

import paho.mqtt.client as mqtt
from paho.mqtt.enums import CallbackAPIVersion

def on_subscribe(client, userdata, mid, reason_code_list, properties):
# Since we subscribed only for a single channel, reason_code_list contains
Expand Down Expand Up @@ -304,7 +306,7 @@ Subscriber example
# our subscribed is persisted across reconnections.
client.subscribe("$SYS/#")

mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
mqttc = mqtt.Client(CallbackAPIVersion.VERSION2)
mqttc.on_connect = on_connect
mqttc.on_message = on_message
mqttc.on_subscribe = on_subscribe
Expand All @@ -322,6 +324,7 @@ publisher example

import time
import paho.mqtt.client as mqtt
from paho.mqtt.enums import CallbackAPIVersion

def on_publish(client, userdata, mid, reason_code, properties):
# reason_code and properties will only be present in MQTTv5. It's always unset in MQTTv3
Expand All @@ -341,7 +344,7 @@ publisher example
print("but remember that mid could be re-used !")

unacked_publish = set()
mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
mqttc = mqtt.Client(CallbackAPIVersion.VERSION2)
mqttc.on_publish = on_publish

mqttc.user_data_set(unacked_publish)
Expand Down Expand Up @@ -380,10 +383,11 @@ Example:

import logging
import paho.mqtt.client as mqtt
from paho.mqtt.enums import CallbackAPIVersion

logging.basicConfig(level=logging.DEBUG)

mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
mqttc = mqtt.Client(CallbackAPIVersion.VERSION2)
mqttc.enable_logger()

mqttc.connect("mqtt.eclipseprojects.io", 1883, 60)
Expand All @@ -397,12 +401,13 @@ It's also possible to define a on_log callback that will receive a copy of all l
.. code:: python

import paho.mqtt.client as mqtt
from paho.mqtt.enums import CallbackAPIVersion

def on_log(client, userdata, paho_log_level, messages):
if paho_log_level == mqtt.LogLevel.MQTT_LOG_ERR:
print(message)

mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
mqttc = mqtt.Client(CallbackAPIVersion.VERSION2)
mqttc.on_log = on_log

mqttc.connect("mqtt.eclipseprojects.io", 1883, 60)
Expand Down