大作业 - 6 文档

2016-04-12  本文已影响161人  lmzqwer2

项目地址: Exotic-experiment

快速使用

  1. 以下所说的网址对应的服务器在玉泉经常性抽风，如果连不上的话，可以尝试着去西湖四处看看风景（来把梯子）。

  2. 当前部署在exotic.lmin.me上

socket端口可以通过访问/api/status获得。

  1. 树莓派端需要进行身份验证后才能收发信息

验证方式为使用socket发送验证包，需要两个字段设备id及其验证码。

在client.py中为了简便，可以使用命令行3、4号参数指定device_id以及auth_key，并输入auth发送验证包。

当前默认有一个设备id为fpga的设备存储于数据库中，使用有管理员权限的账号登录/api/admin/query?device_id=fpga即可获取。同时，使用管理员权限访问/api/admin/add可以添加新的设备id。

  1. 推流使用rtmp协议

推流命令与地址后续有详细介绍。

如果要本地测试，需要自己搭建RTMP服务器，具体方法参考大作业 - 2 rtmp服务器配置。server.py只作为信息中转站，目前没有处理RTMP流的能力。

梯子转发ffmpeg的流似乎会出很多问题，不推荐通过梯子推流。

消息格式

通信使用json格式，消息分为控制消息、状态消息，操作消息，信息消息以及其他。

服务器接受控制消息并返回状态消息，同时在某些情况下会发出信息消息。

除去一些特殊情况，服务器默认广播所有从树莓派端发送来的消息，同时屏蔽所有非操作者发送来的消息。操作者发送的消息将会被发往树莓派端。广播的范围是当前连入设备界面的所有浏览器端。

控制消息

控制消息为含有type且为0的json对象，而另一个字段action表明所需要干的事情。

其中服务器有响应的action字段，有如下几种值：

值得一提的是，不论是从树莓派端还是浏览器端发送来的其余的所有type为0的json对象也都会被拦截，既不会被发送到树莓派端，也不会被广播至其他的浏览器端。

状态消息

状态消息是type为1的消息，有字段status表示状态。

status字段有如下的值：

操作消息

操作消息是type为2的消息，含有operation字段。服务器不会主动发出这类消息。

信息消息

信息消息是type为3的消息，含有字段info。

服务器会发出两种信息消息，其info字段分别为：

树莓派端demo使用

该demo程序接收5个命令行参数：

1、2用于定位服务器位置，3、4用于身份验证，5用于消息发送。

在树莓派连入服务器之后，需要一次身份验证命令将身份信息发往服务器端进行验证。处于无身份的状态在服务器链接过多的时候会被优先断开。

在身份验证成功后，服务器会发送一个json对象，表示当前连入的相关信息，下方就是一个例子。

{
    "status": 0, 
    "index": 0, 
    "rtmp_host": "localhost", 
    "rtmp_push_port": 6666, 
    "stream_name": "0", 
    "webport": 8080, 
    "filelink": "/live/0/file/download"
}

在连接上服务器并验证身份之后，可以在命令行下输入命令即可。部分格式的命令会被转义，大部分的命令会直接发送至服务器。

转义命令格式如下：

服务器使用

在使用之前，需要确保含有tornado的包。可以使用pip命令安装所有的依赖。

pip install -r requirement.txt

配置

配置调试

使用命令

python config.py

可以获取到所有服务器的配置参数，与直接运行服务器时的参数一致。可以使用该文件进行配置调整。

可调整参数及其默认值如下：

options =  {
    "config": null, 

    "_user": "user", 
    "_identity": "identity", 
    "_password": "password", 
    "_nickname": "nickname", 

    "webport": 8080, 
    "filesize": 1048576, 
    "cookie_secret": "XmuwPAt8wHdnik4Xvc3GXmbXLifVmPZYhoc9Tx4x1iZ", 
    "database": "exotic.db", 
    "messageInterval": 2, 

    "socketport": 8081, 
    "unauthsize": 32, 
    "separator": "\n", 

    "rtmpHost": "localhost", 
    "rtmpPushPort": 6666,
    "rtmpPullPort": 1935,
    "rtmpAppName": "live",

    "userCountSend": false, 
    "sendPeriod": 5000, 
    "sendHost": "localhost", 
    "sendPort": 8080, 
    "sendURL": "/api/report", 
    "device_id": 10000, 
    "auth_key": "None", 
}

配置解析

本工程使用Tornado的options.parse_command_line()解析。该函数有一些特性在此先说明。

在命令行的解析过程中，命令行参数允许重复出现，同时后续出现的参数会覆盖先前输入的同名参数。

而如同config这样指定配置文件的参数，会在遇到的那一刻将配置文件内的所有项目执行完毕并赋值。后续的命令行参数会在此后继续进行解析。当然，依然是后续的覆盖先行的。

配置文件

服务器自身配置

Socket 相关配置

RTMP 相关配置

对于浏览器端，拉流的URI为

rtmp://rtmpHost:rtmpPullPort/rtmpAppName/streamName

其中，所有项均会由服务器给出。streamName由服务器根据某些规则计算得到，其余项均为配置。

对于树莓派端，推流的命令为

ffmpeg -i ... -f flv -metadata streamName="streamName" tcp://rtmpHost:rtmpPushPort

其中，所有项均会由服务器给出。streamName由服务器根据某些规则计算得到，其余项均为配置。

中心服务器相关配置

以上信息结合起来就是，如果设置了userCountSend字段为真，服务器会以sendPeriod为间隔向 http://sendHost:sendPort/sendURL 这个地址发送数据包，数据包如下：

{
    "auth_id" : "auth_id",
    "auth_key" : "auth_key",
    "device_id" : "auth_id",
    "userCount" : 在线人数
}

使用

  1. 使用config_override.py

config_override.py主要用法是覆盖默认配置。当然在命令行下输入也是可以的，但是每次都输入不仅烦还有可能出错，所以推荐还是使用配置文件写入。

配置文件所用的就是python语法，将某个字段直接赋值即可。

exotic.lmin.me所用的配置文件节选如下

socketport = 9007
webport = 8007
unauthsize = 4
rtmpHost = "lmin.me"
rtmpPushPort = 6666
rtmpPullPort = 1935
rtmpAppName = "live"

此时可以使用

python config.py --config=config_override.py

查看配置

  1. 使用models.py初始化数据库
python models.py --config=config_override.py
  1. 运行服务器端程序
python server.py --config=config_override.py
  1. 开始使用

使用client.py连入服务器并通过身份验证后，使用浏览器连入服务器即可。

url详解

下方所有的$1均表示连入设备的索引值，为验证成功后由服务器发送的index值

版本更新

todo list

断线重连
save slot

server_v0.4

修改通信协议
增加多类型文件上传功能

server_v0.3

添加浏览器端非权限用户广播功能
添加在线用户数报告功能
服务器在树莓派端及浏览器端连入时返回RTMP地址
添加了socket传输下信息之间的间隔符
添加requirements.txt
上传时存储文件至指定位置

server_v0.2

修改了树莓派文件传输的方式
添加用户登录身份验证
添加树莓派连入身份验证
添加管理员权限账户
添加README.md

server_v0.1

支持浏览器与服务器间通信
支持树莓派与服务器间通信
支持多树莓派连入
支持文件上传

上一篇 下一篇

猜你喜欢

热点阅读