# rulex

**Repository Path**: opensource_ipcamera/rulex

## Basic Information

- **Project Name**: rulex
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-16
- **Last Updated**: 2022-02-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RULEX

<div style="text-align:center">
<img src="./README_RES/structure.png"/>
</div>

RULEX 是一个轻量级工业类边缘网关开发框架。

## 快速开始
### 构建(Linux)
```sh
git clone https://github.com/wwhai/rulex.git
cd rulex
make
```

## 支持的平台

| 平台    | 架构   | 编译测试 |
| ------- | ------ | -------- |
| Windows | X86-64 | 通过     |
| Linux   | X86-64 | 通过     |
| ARM64   | ARM-64 | 通过     |
| ARM32   | ARM-32 | 通过     |
| MacOS   | X86-64 | 通过     |
| 其他    | 未知   | 未知     |

## 跨平台编译

注意:` Arm32位`下编译步骤请参考 `.github\workflows\4_build-arm-32-v7.yml` 里面的脚本。

### 启动
启动需要带2个参数，`db` 是保存配置数据的位置，该参数指定的路径最后会生成个 sqlite 文件，`config` 参数是 ini 的路径
```sh
./rulex run -db=main.db -config=conf/rulex.ini
```
> config 文件如果不存在会退出.

## Dashboard
```
浏览器输入：http://127.0.0.1:2580
```
<div style="text-align:center">
<img src="./README_RES/1.png"/>
</div>
<div style="text-align:center">
<img src="./README_RES/2.png"/>
</div>
<div style="text-align:center">
<img src="./README_RES/3.png"/>
</div>
<div style="text-align:center">
<img src="./README_RES/4.png"/>
</div>
<div style="text-align:center">
<img src="./README_RES/5.png"/>
</div>

## 规则引擎
### 规则定义
```lua

function Success()
    -- do some things
end

function Failed(error)
    -- do some things
end

Actions = {
    function(data)
        return true, data
    end
}

```

### 数据筛选
```lua
function Success()
    -- do some things
end

function Failed(error)
    -- do some things
end

Actions = {
    function(data)
        print("return => ", rulexlib:JqSelect(".[] | select(.hum < 20)", data))
        return true, data
    end
}
```
### 数据中转

```lua
function Success()
    -- do some things
end

function Failed(error)
    -- do some things
end

Actions = {
    function(data)
        -- 持久化到 MongoDb:
        rulexlib:DataToMongo("OUTEND_83775a94-9f64-4d37-be17-45dd0c90f56d", data)
        -- 持久化到 Mysql:
        rulexlib:DataToMysql("OUTEND_83775a94-9f64-4d37-be17-45dd0c90f56d", data)
        -- 推送化到 Kafka:
        rulexlib:DataToKafka("OUTEND_83775a94-9f64-4d37-be17-45dd0c90f56d", data)
        return true, data
    end
}
```
### 云端计算
```lua
function Success()
    -- do some things
end

function Failed(error)
    -- do some things
end

Actions = {
    function(data)
        -- PyTorch 训练数据:
        cloud:PyTorchTrainCNN(data)
        -- PyTorch 识别:
        local V = cloud:PyTorchCNN(data)
        print(V)
        return true, data
    end
}
```

## 详细文档

<a href="https://wwhai.github.io/rulex_doc_html">[点我查看详细文档]</a>


## 社区
- QQ群：608382561
- 微信：bignullnull( 加好友后进群, 暗号：RULEX )

    <div style="text-align:center">
    <img src="./README_RES/wx.jpg" width="150px" />
    </div>

- 博客1：https://wwhai.gitee.io
- 博客2：https://wwhai.github.io

## Star
<img src="https://starchart.cc/wwhai/rulex.svg">