# 数据转发接收接口

**Repository Path**: walkline/data_receiving_interface

## Basic Information

- **Project Name**: 数据转发接收接口
- **Description**: 用于接收 MQTT 平台转发的数据
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2019-12-30
- **Last Updated**: 2023-05-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 数据转发接收接口

### 项目介绍

这是配合 [WeatherStation](https://gitee.com/walkline/WeatherStation) 项目使用的平台数据接收接口，用于接收 MQTT 平台转发的数据，用户可以保存并调用数据

项目基于`RESTfull`接口规范开发，方便用户使用

> 目前只针对[扇贝物联](http://bigiot.xyz)的转发数据提供保存功能

### 项目部署前提

* 使用`Apache`提供网页服务，并开启重定向功能（即支持`.htaccess`配置文件）
* 支持`PHP`和`MySQL`

### 项目部署说明

部署分为以下几个步骤：

* 克隆项目到本地
* 导入数据库结构
* 修改配置文件
* 上传项目源文件
* 开始使用

#### 克隆项目到本地

克隆或[下载](https://gitee.com/walkline/data_receiving_interface/repository/archive/master.zip)主分支到本地

```bash
git clone https://gitee.com/walkline/data_receiving_interface.git
```

目录树如下图

```bash
├── favicon.png
├── inc
│   ├── api
│   │   ├── data
│   │   │   └── index_v1.php
│   │   ├── exception.php
│   │   └── query_list.php
│   ├── connect2db.php
│   └── connect2db.sample.php
├── index.php
├── LICENSE
├── README.md
├── sql
│   └── mqtt_data_receiving_records.sql
└── web
    ├── css
    │   └── main.css
    ├── interface
    │   └── index.html
    └── js
        ├── index.js
        └── vendor
            ├── echarts.js
            │   ├── echarts.min.js
            │   └── theme
            │       ├── dark.js
            │       └── shine.js
            └── jquery
                ├── jquery.ba-resize.min.js
                └── jquery.min.js

```

#### 导入数据库结构

1. 使用数据库管理软件远程连接到你的空间数据库，如：

	* phpMyAdmin
	* Navicat for MySQL
	* 网站提供的数据库管理工具

2. 如果支持新建数据库，则新建一个名为`mqtt_data_receiving_records`的数据库（使用`utf8`编码方式）

3. 打开新建的数据库（如果无法新建数据库则打开空间指定的数据库）

4. 右键点击数据库选择`执行数据库脚本`菜单（或其它类似名称的），浏览选择`/sql/mqtt_data_receiving_records.sql`文件并运行

5. 无报错运行完毕后按`F5`刷新数据库，查看是否生成了新表`mqtt_drr_bigiot_xyz`

#### 修改配置文件

修改配置文件内容主要是填写数据库连接信息，找到`/inc/connect2db.sample.php`文件将其**重命名**为`connect2db.php`

打开该文件找到如下内容并按照提示填写信息，保存后完成配置文件修改

```php
} else {
	$mysql_config = array (
		'host'	  => '', // 数据库服务器地址
		'db_user' => '', // 数据库用户名
		'db_pwd'  => '', // 数据库密码
		'db'	  => 'mqtt_data_receiving_records' // 数据库名称
	);
}
```

> 如果你的空间不支持新建数据库，则`数据库名称`填写你的空间指定的数据库名称

#### 上传项目源文件

至此准备工作全部完成，将修改好的项目文件上传到空间的合适位置即可


#### 开始使用

假设你的域名是：

	http://bigiot.xyz

你上传项目文件的位置是：

	/mqtt/

那么在下边这个页面的`转发地址`里需要填写的就是

	http://bigiot.xyz/mqtt/inc/api/data/v1/bigiot_receiving

<p align="center"><img src="https://gitee.com/walkline/WeatherStation/raw/docs/images/wikis/iot_platform/bigiot.xyz/interface_add.png" alt="添加接口"></p>

#### 数据浏览

为了方便浏览已上传的数据，简单制作了一个 [ECHARTS](https://echarts.apache.org/examples/zh/index.html?theme=dark) 图表，直接访问项目文件地址即可，如：

	http://bigiot.xyz/mqtt

<p align="center"><img src="https://gitee.com/walkline/WeatherStation/raw/docs/images/wikis/data_receiving_interface/screenshot_01.png" alt="页面预览"></p>

> 为防止数据过多占用存储空间，每隔 4 天会清理一次数据，只保留最近 24 小时内的数据

### 合作交流

* 联系邮箱：<walkline@163.com>
* QQ 交流群：
    * [走线物联](https://jq.qq.com/?_wv=1027&k=xtPoHgwL)：163271910
    * [扇贝物联](https://jq.qq.com/?_wv=1027&k=yp4FrpWh)：31324057

<p align="center"><img src="https://gitee.com/walkline/WeatherStation/raw/docs/images/qrcode_walkline.png" width="300px" alt="走线物联"><img src="https://gitee.com/walkline/WeatherStation/raw/docs/images/qrcode_bigiot.png" width="300px" alt="扇贝物联"></p>