运行 Yunba Socket.IO Python Demo

本文以 Python 为例,演示 Yunba Socket.IO API 的使用。

本文涉及的运行环境如下。

Mac 平台:

  • Mac OS X 10.11.1
  • virtualenv 13.1.2
  • socketIO-client 0.6.5

Windows 平台:

  • Windows 8.1
  • python-2.7.10
  • pip-7.1.2
  • socketIO-client 0.6.5

准备工作——Mac 平台

1. 安装 virtualenv

安装 virtualenv。安装后,可先不设置虚拟环境,根据第 2 步进行设置。

2. 安装 socket.IO-client

打开 Mac 的 Terminal,按照 socketIO-client 官方网站 的说明,输入如下命令:

设置环境变量:

$ VIRTUAL_ENV=$HOME/.virtualenv

如果想在下次打开 Terminal 时仍能使用该变量,可用下面的命令,将变量保存到“.bash_profile”文件里:

$ echo "export VIRTUAL_ENV=$HOME/.virtualenv" >> ~/.bash_profile

设置虚拟路径:

$ virtualenv $VIRTUAL_ENV

激活虚拟路径:

$ source $VIRTUAL_ENV/bin/activate

激活后,命令行的开头处会显示出虚拟环境的名称“.virtualenv”,此时,用下面的命令安装 socketIO-client, 将会安装到该目录中去:

$ pip install -U socketIO-client

有关 virtualenv 的详细用法,请参考 virtualenv 的官方文档

3. 注册云巴开发者账号

打开 云巴官方网站,点击右上角的“注册”按钮创建账号。

准备工作——Windows 平台

1. 配置 python 运行环境

下载相应版本的 msi 文件:官网下载地址。安装并配置 python 的运行环境。

2. 安装 socket.IO-client

打开 CMD,按照 socketIO-client 官方网站 的说明,输入如下命令:

创建一个虚拟路径:

virtualenv VIRTUAL_ENV

执行成功后会生成一个 VIRTUAL_ENV 文件夹。

激活虚拟路径:

执行CMD 进入 activate.bat 所在路径,输入

start activate.bat

激活后,命令行的开头处会显示出虚拟环境的名称“VIRTUAL_ENV”。

用下面的命令安装 socketIO-client:

pip install -U socketIO-client

有关 virtualenv 的详细用法,请参考 virtualenv 的官方文档

详细步骤

1. 申请 AppKey

为了演示消息收发的功能,我们先准备好一个集成了云巴 SDK 的客户端程序,之后与 Python 的 Demo 进行通讯。

例如,就使用 Yunba Android SDK 中提供的 Demo 程序, 其创建方法可参考 运行 Yunba Android Demo 一文。在 Portal 上创建新应用后,会获得一个 AppKey。

2. 创建 Python 程序

新建一个文本文件,保存下面的 Python 示例程序。比如取名为 python_demo.py。 将代码中的“appkey”替换为步骤 1 中获得的 AppKey。只有这两个客户端使用同一个 AppKey,才能相互通信。

:下文给出的 AppKey 功能受限,仅供文档举例使用。

...
from socketIO_client import SocketIO
import logging
logging.basicConfig(level=logging.INFO)

def on_socket_connect_ack(args):
    print 'on_socket_connect_ack', args
    socketIO.emit('connect_v2', {'appkey': '567a4a754407a3cd028aaf6b', 'customid': 'python_demo'})

def on_connack(args):
    print 'on_connack', args
    socketIO.emit('subscribe', {'topic': 'testtopic2'})

    print "publish2_to_alias"
    socketIO.emit('publish2_to_alias', {'alias': 'alias_mqttc_sub', 'msg': "hello to alias from publish2_to_alias"});

def on_puback(args):
    print 'on_puback', args
    if args['messageId'] == '11833652203486491112':
        print '  [OK] publish with given messageId'

def on_suback(args):
    print 'on_suback', args
    socketIO.emit('publish', {'topic': 'testtopic2', 'msg': 'from python', 'qos': 1})

    socketIO.emit('publish', {
        'topic': 'testtopic2',
        'msg': 'from python with given messageId',
        'qos': 1,
        'messageId': '11833652203486491112'
        })

    socketIO.emit('publish2', {
        'topic': 't2thi',
        'msg': 'from publish2',
        "opts": {
            'qos': 1,
            'apn_json':  {"aps":{"sound":"bingbong.aiff","badge": 3, "alert":"douban"}},
            'messageId': '11833652203486491113'
        }
    })

    socketIO.emit('set_alias', {'alias': 'mytestalias1'})

def on_message(args):
    print 'on_message', args

def on_set_alias(args):
    print 'on_set_alias', args

    socketIO.emit('publish2', {
        'topic': 'testtopic2',
        'msg': 'from publish2',
        "opts": {
            'qos': 1,
            'apn_json':  {"aps":{"sound":"bingbong.aiff","badge": 3, "alert":"douban"}}
        }
    })


    socketIO.emit('get_alias')
    socketIO.emit('publish_to_alias', {'alias': 'mytestalias1', 'msg': "hello to alias"})
    socketIO.emit('get_topic_list', {'alias': 'mytestalias1'})
    socketIO.emit('get_state', {'alias': 'mytestalias1'})

def on_get_alias(args):
    print 'on_get_alias', args

def on_alias(args):
    socketIO.emit('get_alias_list', {'topic': 'testtopic2'})
    print 'on_alias', args

def on_get_topic_list_ack(args):
    print 'on_get_topic_list_ack', args

def on_get_alias_list_ack(args):
    print 'on_get_alias_list_ack', args

def on_publish2_ack(args):
    print 'on_publish2_ack', args
    if args['messageId'] == '11833652203486491113':
        print '  [OK] publish2 with given messageId'

def on_publish2_recvack(args):
    print 'on_publish2_recvack', args

def on_get_state_ack(args):
    print 'on_get_state_ack', args

socketIO = SocketIO('sock.yunba.io', 3000)
socketIO.on('socketconnectack', on_socket_connect_ack)
socketIO.on('connack', on_connack)
socketIO.on('puback', on_puback)
socketIO.on('suback', on_suback)
socketIO.on('message', on_message)
socketIO.on('set_alias_ack', on_set_alias)
socketIO.on('get_topic_list_ack', on_get_topic_list_ack)
socketIO.on('get_alias_list_ack', on_get_alias_list_ack)
socketIO.on('puback', on_publish2_ack)
socketIO.on('recvack', on_publish2_recvack)
socketIO.on('get_state_ack', on_get_state_ack)
socketIO.on('alias', on_alias)                # get alias callback

socketIO.wait()

3. 收发消息

为了收到 python_demo 发来的消息,需在 Android Demo 端订阅“testtopic2”、“t2thi”, 并将别名设置为 “alias_mqttc_sub”,如图所示:

socketiopng_demo_setting.png

准备好后,开始运行 Python 的 Demo。在 Mac Terminal 中,激活虚拟环境。假设 Python 文件就在当前路径下,在虚拟环境下,运行 python_demo.py,如下:

$ source $VIRTUAL_ENV/bin/activate

$ python python_demo.py

运行成功后,会在 Terminal 中打印出执行的信息。而 Android Demo 端,也可以收到消息,如下:

socketiopng_demo_client_receive.png

同样地,可以通过 Android Demo 的 MAIN 标签页下的“Msg to publish”项向 python_demo 订阅的频道发送消息。 另外,在代码中可以看到,python_demo 的别名已设置为“mytestalias1”。 可以通过 Android Demo 的 API 标签页下的 “Msg to Alias” 项发送一对一消息给 python_demo。 发送和接收的截图如下:

socketiopng_demo_publish2_topic.png

socketiopng_demo_publish2_alias.png

socketiopng_demo_term_receive.png

更多用法和功能,请参考 Socket.IO API 手册