# liteip_post_java

**Repository Path**: Yogile/liteip_post_java

## Basic Information

- **Project Name**: liteip_post_java
- **Description**: 由于有经常迁移设备进行实验的需求，设备的 IP 经常变化，同时也无权登录路由后台，为了节省时间，写了一个自行上传 IP 的工具。
- **Primary Language**: Java
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-15
- **Last Updated**: 2023-10-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Liteip

### 背景

由于有经常迁移设备进行实验的需求，设备的 IP 经常变化，同时也无权登录路由后台，为了节省时间，写了一个自行上传 IP 的工具。

>  设备：树莓派4b

<!-- more -->

## 客户端

### 数据格式

采用 POST Request 的 `application/json` 格式。

```json
{
  "device_id": "",
  "hostname": "",
  "lite_ip": "",
  "device_key": "",
  "update_type": ""
}
```

`update_type` 只有两个值 `"LOGIN_TIME"` 和 `"LOGOUT_TIME"` 。

### 编译

Java 版本的客户端使用 Maven 工具构建。

#### 命令行编译

```shell
mvn clean package
```

#### IDEA

下载项目后，若使用 IDEA 构建命令，请自行于 `File -> Settings -> Build,Execution,Deployment -> Build Tools -> Maven` 修改 Maven 相关配置。

### 运行

#### 命令行运行

```shell
java -jar xxx.jar <param>
```

#### `<param>` 参数

```
- init
    创建 conf 文件夹及 conf/_config.xml 文件，便于写入配置信息
- on
    执行设备上线 IP 上传程序
- off
    执行设备下线 IP 上传程序
```

### 配置

首先执行：

```shell
java -jar xxx.jar init
```

对于生成 `conf/_config.xml` 修改其中的值。

> 由程序获取并写入的 Tag ，请谨慎修改。

```
<?xml version="1.0" encoding="UTF-8"?>

<nas>
  <liteip>
    <server>
      <!-- 服务端 http(s) 地址，用于接收客户端发送 POST 请求并响应 -->
      <url></url>
    </server>
    <client>
      <!-- 设备 ID 自定 -->
      <device_id></device_id>
      <!-- 设备 HOSTNAME ，由程序获取并写入 -->
      <hostname>XXX</hostname>
      <!-- 设备 局域网 IP ，由程序获取并写入，默认匹配为 "192.168.1." ，请修改匹配程序 -->
      <lite_ip>X.X.X.X</lite_ip>
      <!-- 设备 KEY 自定 -->
      <device_key>XXXXXX</device_key>
    </client>
  </liteip>
</nas>
```

至此配置完成，执行 `on/off` 参数指令即可发送 POST 请求，并输出响应结果到控制台。