document

1. 系统运行 2. 系统部署 3. Docker安装部署 4. 设备接入教程 5. 硬件端SDK说明 6. 消息流转和存储 7. 使用教程 8. 常见问题 9. 小程序和APP

一、系统运行环境

JDK >= 1.8 (推荐1.8版本)
Mysql >= 5.7.0 (推荐5.7版本)
Redis >= 3.0
Maven >= 3.0
Node >= 12
EMQX =4.0

运行环境很重要，低于该版本运行不了。JDK版本高于1.8缺少部分依赖，要单独安装。EMQX安装后需要配置HTTP认证和WebHook。

二、后端运行

创建wumei-smart数据库，导入项目中的 springboot/sql/wumei.sql 数据库脚本。（Linux中安装mysql，配置大小写敏感，在 /etc/my.cnf 添加 lower_case_table_names=1 重启MYSQL服务。）
开发工具IDEA打开springboot文件夹，会自动安装Maven依赖，等待安装完成，速度取决于网络。
修改数据库连接，文件位于： springboot/wumei-admin/src/main/resources/application-druid.yml

# 数据源配置
spring:
    datasource:
        type: com.alibaba.druid.pool.DruidDataSource
        driverClassName: com.mysql.cj.jdbc.Driver
        druid:
            # 主库数据源
            master:
                url: 数据库地址
                username: 数据库账号
                password: 数据库密码

服务配置，文件位于：springboot/wumei-admin/src/main/resources/application.yml。注意配置文件的格式，缩进一定要对齐。

  ## 文件上传路径 示例（ Windows配置D:/wumei-smart/uploadPath，Linux配置 /var/wumei-smart/java/uploadPath）
  profile: /var/wumei-smart/java/uploadPath
 
  ## redis 配置
  redis:
    # 地址
    host: localhost
    # 端口，默认为6379
    port: 6379
    # 数据库索引
    database: 0
    # 密码
    password: wumei-smart
  
  ## EMQX 配置
  mqtt:
    username: wumei-smart                    # 账号（设备简单认证的用户名）
    password: wumei-smart                    # 密码 (设备简单认证的密码)
    host-url: tcp://localhost:1883           # EMQX的部署地址

日志路径配置，文件位于：springboot/wumei-admin/src/main/resources/logback.xml

# 示例（ Windows配置D:/wumei-smart/logs，Linux配置 /var/wumei-smart/java/logs）
<property name="log.path" value="/var/wumei-smart/java/logs" />

运行项目 WumeiSmartApplication.java ，出现下图表示启动成功。

                               _                            _   
                              (_)                          | |             
__      ___   _ _ __ ___   ___ _   ___ _ __ ___   __ _ _ __| |_            
\ \ /\ / / | | | '_ ` _ \ / _ \ | / __| '_ ` _ \ / _` | '__| __|     
 \ V  V /| |_| | | | | | |  __/ | \__ \ | | | | | (_| | |  | |_         
  \_/\_/  \__,_|_| |_| |_|\___|_| |___/_| |_| |_|\__,_|_|   \__|     

 ----------开源生活物联网平台----------
 =========wumei-smart启动成功=========

三、前端运行

开发工具Visual Studio Code 打开项目中vue目录

修改根目录的 vue.config.js 文件中的后端接口地址和Emqx安装地址，本地不用修改。

    proxy: {
      [process.env.VUE_APP_BASE_API]: {
        target: `http://localhost:8080`,  // 后端接口地址
        changeOrigin: true,
        pathRewrite: {
          ['^' + process.env.VUE_APP_BASE_API]: ''
        }
      },
      ['/api/v4']: {
        target: `http://localhost:8081`,   // Emqx安装地址
        changeOrigin: true,
      },
    },

修改 wumei-smart\vue\src\views\iot\device\mqtt-client.vue文件的mqtt连接地址，Emqx安装在本地不用修改。

    // 配置Mqtt连接地址，例如：ws://localhost:8083/mqtt
    let url = "ws://" + window.location.hostname + ":8083/mqtt";
    console.log("mqtt地址：", url);
    this.client = mqtt.connect(url, options);

修改完成后，开始安装依赖，可以通过重新指定 registry 来解决 npm 安装速度慢的问题。

# 安装依赖
npm install
# 强烈建议不要用直接使用 cnpm 安装，会有各种诡异的 bug
npm install --registry=https://registry.npm.taobao.org

# 本地开发 启动项目
npm run dev

打开浏览器，输入：http://localhost:80 默认账户/密码 admin/admin123 。若能正确展示登录页面，并能成功登录，菜单及页面展示正常，则表明环境搭建成功。

四、EMQX配置

HTTP认证

系统使用EMQX的HTTP认证插件，实现自定义认证逻辑。配置文件位于：etc/plugins/emqx_auth_http.conf

## 修改认证请求中的请求地址，其他保持默认
auth.http.auth_req = http://localhost:8080/iot/tool/mqtt/auth
auth.http.auth_req.method = post
auth.http.auth_req.params = clientid=%c,username=%u,password=%P

## 注释超级用户的请求地址、请求方式和参数
# auth.http.super_req = http://127.0.0.1:8991/mqtt/superuser 
# auth.http.super_req.method = post                                                                    
# auth.http.super_req.params = clientid=%c,username=%u

## 注释ACL鉴权的请求地址、请求方法和参数                                    
# auth.http.acl_req = http://127.0.0.1:8991/mqtt/acl                                                             
# auth.http.acl_req.method = get                                                                                  
# auth.http.acl_req.params = access=%A,username=%u,clientid=%c,ipaddr=%a,topic=%t,mountpoint=%m

认证请求地址为后端接口 http://localhost:8080/iot/tool/mqtt/auth ，后端运行在本地使用localhost或本机IP，端口默认8080，如果做了修改或者代理，需要对应修改。超级用户认证和ACL鉴权用不到，但是需要注释掉，不然会占用5秒左右的认证时间。

WebHook

系统使用EMQX的WebHook插件，实现设备上下线和IP定位功能。配置文件位于：etc/plugins/emqx_web_hook.conf

## 修改webhook地址
web.hook.api.url = http://localhost:8080/iot/tool/mqtt/webhook

# web.hook.rule.client.connect.1       = {"action": "on_client_connect"}
# web.hook.rule.client.connack.1       = {"action": "on_client_connack"}
web.hook.rule.client.connected.1     = {"action": "on_client_connected"}
web.hook.rule.client.disconnected.1  = {"action": "on_client_disconnected"}
# web.hook.rule.client.subscribe.1     = {"action": "on_client_subscribe"}
# web.hook.rule.client.unsubscribe.1   = {"action": "on_client_unsubscribe"}
# web.hook.rule.session.subscribed.1   = {"action": "on_session_subscribed"}
# web.hook.rule.session.unsubscribed.1 = {"action": "on_session_unsubscribed"}
# web.hook.rule.session.terminated.1   = {"action": "on_session_terminated"}
# web.hook.rule.message.publish.1      = {"action": "on_message_publish"}
# web.hook.rule.message.delivered.1    = {"action": "on_message_delivered"}
# web.hook.rule.message.acked.1        = {"action": "on_message_acked"}

WebHook地址为后端接口 http://localhost:8080/iot/tool/mqtt/webhook，后端运行在本地使用localhost或本机IP，端口默认8080，如果做了修改或者代理，需要对应修改。启用 web.hook.rule.client.connected.1 和 web.hook.rule.client.disconnected.1 其他项注释掉，节省后端资源。

关闭匿名认证

匿名认证不安全，建议关闭。EMQX同时使用多个认证方式，也会降低认证速度。配置文件位于： etc/emqx.conf ，文件比较大，大概位于第447行。

## Value: true | false
allow_anonymous = false

启用Http认证和WebHook插件

在 EMQX 启动时就默认启动插件，直接在 data/loaded_plugins 添加需要启动的插件名称 {emqx_auth_http,true}. {emqx_web_hook,true}. 。安装方式不同配置文件可能在 /var/lib/emqx/loaded_plugins 位置。emqx所有配置修改完后，重启emqx。

{emqx_management,true}.
{emqx_recon,true}.
{emqx_retainer,true}.
{emqx_dashboard,true}.
{emqx_rule_engine,true}.
{emqx_bridge_mqtt,false}.
{emqx_auth_http,true}.
{emqx_web_hook,true}.