# ab

**Repository Path**: roamr/ab

## Basic Information

- **Project Name**: ab
- **Description**: “留言牌”是 墨水屏模块，有2g功能 可以使用 app 远程更新 “留言牌” 内容；同时提供定位功能；
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-09-06
- **Last Updated**: 2023-09-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ab

#### 介绍
电子“留言牌”， 支持远程刷新 “留言牌” 内容。

---
## 进入微信讨论群  
![微信群](guide/wx.group.jpg)


---
## 开发板淘宝店铺  
![淘宝](guide/taobao.png)

---
## 接口
一共有3个接口，token和auth是认证接口获取设备控制token，控制设备通过一个api实现所有类型设备指令的控制；


## （1）**请求临时密钥**

```
curl -XGET "https://x.top16.top/tb/token"
```


> 返回值
```
{
    "ret":1,
    "code":"123456",
    "token":"1193b9eb1fda44b7846aaa249daf2ef7"
}
```

|Field|Type|Optional|Comment|
|-----|-----|-----|-----|
|ret |string  |N  | 1/0 => success/failed |
|code |string  |N  | <font color=yellow>随机编码</font> |
|token |string  |N  | <font color=yellow>临时密钥</font>  |



## （2）**申请设备控制 token**

```
curl -XPOST -H "Content-Type:application/json;charset=utf-8" -H "BXTOKEN:1193b9eb1fda44b7846aaa249daf2ef7" -d "{\"ref0\":\"1\",\"ref1\":\"0\",\"ref2\":\"0\",\"user\":\"17700000001\",\"code\":\"2345\" }" "https://x.top16.top/tb/auth"
```

|Field|Type|Optional|Comment|
|-----|-----|-----|-----|
|BXTOKEN |string  |N  | <font color=yellow>临时密钥</font>  |
|code |string  |N  | <font color=yellow>随机编码</font> 的中间4位 |
|user |string  |N  | 账号名称 |
|ref0 |string  |N  | 账号口令 |
|ref1 |string  |N  | 固定 1 |
|ref2 |string  |N  | 固定 0 |

> 返回值
```
{
    "ret":1,
    "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJVVVRfSUQiOiIzIiwiaXNzIjoiYm94IiwiVVVUX0FUVFIiOiIiLCJleHAiOjE2MjE1OTY4NTMsIlVVVF9OQU1FIjoiMTc3MDAwMDAwMDEifQ.-bILMOxwsa2cmGktc9-dTSMTKqQIkhSn3RK64O3kwx4"
}
```

|Field|Type|Optional|Comment|
|-----|-----|-----|-----|
|ret |string  |N  | 1/0 => success/failed |
|token |string  |N  | <font color=yellow>Token</font>  |



## （3）**设备控制**

```
curl -X POST -H "Content-Type:application/json;charset=utf-8" -H "BXHMAC:" -d "{\"_code\":\"A0\",\"cmd\":\"api_cmd\",\"dev\":\"100011\",\"cn\":\"ab1\",\"extParams\":{\"fs\":20,\"txt\":\"mydevice\",\"x\":0,\"y\":16,\"h\":104,\"w\":104}}" "https://x.top16.top/tb/api"
```
|Field|Type|Optional|Comment|
|-----|-----|-----|-----|
|BXHMAC |string  |N  | <font color=yellow>Token</font>  |
|dev |string  |N  | 设备编码 |
|cn |string  |N  | 参考“指令表” |
|extParams |object|N  | 参考“指令表” |
|* |-  |-  | 其他参数固定 |

### 指令表
|指令|cn|extParams|
|-----|-----|-----|
|清屏|clear |无|
|二维码|ab0  |{"data":"hello","x":0,"y":16,"h":104,"w":104} |
|文本|ab1 | {"fs":20,"txt":"mydevice","x":0,"y":16,"h":104,"w":104} |
|图片|ab3 | {"imgbase64":"","x":0,"y":16,"h":104,"w":104} |


> 返回值

```
{
    "ret":1
}
```

|Field|Type|Optional|Comment|
|-----|-----|-----|-----|
|ret |string  |N  | 1/0 => success/failed |