1.7/2.x扫码器配置字段说明文档

# 目录

一、[文档概述](#文档概述)

二、[配置字段说明](#配置字段说明)
1. [通用配置(common_config)](#title_common_config)
2. [信道配置(channel)](#title_channel)
3. [行为动作配置(action)](#title_action)
4. [音频配置(audio)](#title_audio)
5. [解码器配置(decoder)](#title_decoder)
6. [云证配置(eid)](#title_eid)
7. [ISP 配置(isp)](#title_isp)
8. [网络配置(net)](#title_net)
9. [NFC 配置(nfc)](#title_nfc)
10. [NTP 配置(ntp)](#title_ntp)
11. [OUTPUT 配置(output)](#title_output)
12. [配置密码(passwd)](#title_passwd)
13. [版本号(version)](#title_version)
14. [微光 485 协议配置(vg485)](#title_vg485)
15. [微光通信协议配置(vgpro)](#title_vgpro)
16. [按键配置(tkey)](#title_tkey)
17. [PSAM(psam)](#title_psam)
18. [安全模块配置(safe_relay)](#title_safe)

---

# 二、配置字段说明

## 1. [通用配置](#title_back)
```txt
	该模块的字段重要用于保存设备的信息，如 devmac 之类的设备唯一标识，或者devnum，devname等用户自定义设备信息。
	同时包含部分字段用于设备扫码升级，扫码重启等功能。
```
### 配置字段详情如下

| 字段名 | 类型 | 长度 | 外部可见性 | 读写性 | 功能描述 | 默认值 | 补充说明 |
| :-----------: | :---: | :---: | :--------: | :----: | :----------------------: | :-------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| uuid | str | 127 | √ | RW/RO | 设备SN | 不固定 | 标品固件此字段不可进行配置，门禁版本可在出厂烧录时进行唯一一次配置。 &nbsp;&nbsp;&nbsp;&nbsp;未配置时该字段等同于 `devmac` 字段 |
| uuid_sta | str | 16 | × | RW | 标识是否可以修改 devmac | unset(门禁)/set(标品) | 该字段为开发人员内部字段，用于标识 uuid 是否可被配置。 unset 表明可配， set 表明不可配 |
| userid | str | 255 | √ | RW | 用户自定义SN | userid | 用户自定义，可多次修改 |
| devmac | str | 127 | √ | RO | 设备的的唯一 ID | 不固定 | 根据设备chipid 计算出的更简短的唯一ID(16进制字符串),不可修改。 理论上每台设备此ID唯一，可认为是设备唯一标识 根据 Soc 型号不同该字段长度可能有变化 |
| devname | str | 127 | √ | RW | 为ui界面显示的公司名称 | 苏州酷豆物联 | 用户自定义，可多次修改 |
| devnum | int | 4 | √ | RW | 自定义 sn | 0 | 用户自定义，可多次修改 |
| update_haddr | str | 255 | × | RW | 扫码升级，升级包地址 | unset | 扫码升级保存升级地址的字段，该字段不对外开放 仅在本模块的update_flg字段为真时(`1`)，才会生效 |
| update_md5 | str | 32 | × | RW | 扫码升级，升级包 MD6 | unset | 扫码升级保存升级包MD5，该字段不对外开放 仅在本模块的update_flg字段为真时(`1`)，才会生效 |
| update_flg | bool | 4 | × | RW | 扫码升标志位 | 0 | 标识是否处于扫码升级模式，有以下有效值： &nbsp;&nbsp;&nbsp;&nbsp;true(1)：设备处于扫码升级模式 &nbsp;&nbsp;&nbsp;&nbsp;false(0)：设备不处于扫码升级模式 |
| update_reboot | bool | 4 | × | RW | 扫码升级，升级后是否重启 | 0 | 标识设备扫码升级后是否重启，有以下有效值： &nbsp;&nbsp;&nbsp;&nbsp;true(1)：设备升级后重启 &nbsp;&nbsp;&nbsp;&nbsp;false(0)：设备升级后不重启 |
| era_uboot | bool | 4 | × | RW | 擦除u-boot标志位 | 0 | 该字段标识是否擦除 u-boot，`暂未支持`，不对外开放 |
| reboot | bool | 4 | × | RW | 设备重启标志位 | 0 | 用于扫码重启 |
---

## 2. [信道配置](#title_back)
    该模块的配置为设备数据通道相关配置
- 配置字段详情如下

| 字段名 | 类型 | 长度 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :----------------: | :---------: | :---: | :--------: | :--------: | :-----------------: | :-----------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| p_uart1 | string | 20 | √ | RW | rs232 或 rs485 参数 | "115200-8-N-1" | [点此跳转](#p_uart1) |
| p_uart2 | string | 20 | √ | RW | ttl 参数 | "115200-8-N-1" | [点此跳转](#p_uart2) |
| wiegand_busy_delay | int | 4 | √ | RW | 韦根忙时时间 | 50 | 该参数可配置韦根通信忙时时间，单位为毫秒(ms) |
| wiegand_free_delay | int | 4 | √ | RW | 韦根闲时时间 | 100 | 该参数可配置韦根通信闲时时间，单位为毫秒(ms) |
| touttime | int | 4 | √ | RW | tcp 连接超时时间 | 2 | 该参数可配置值范围为 `0` ~ `5`, 单位是`秒(s)` |
| houttime | int | 4 | √ | RW | http 连接超时时间 | 2 | 该参数可配置值范围为 `0` ~ `5`, 单位是`秒(s)` |
| taddr | string[256] | 255 | √ | RW | tcp 服务器地址 | "192.168.1.1" | --- |
| port | short | 2 | √ | RW | 端口号 | 8080 | 其取值范围应与 端口号定义保持一致，为 `0-65535` |
| heart_en | bool | 4 | √ | RW | 网络心跳使能标志位 | 1 | 控制网络心跳起停，定义如下： &nbsp;&nbsp;&nbsp;&nbsp;1：启用 &nbsp;&nbsp;&nbsp;&nbsp;0：禁用 此字段控制的是网络心跳，应区别于微光通讯协议的协议心跳 |
| heart_time | int | 4 | √ | RW | 心跳间隔时间 | 60 | 设置网络心跳间隔时间，单位`秒(s)`，仅在 `heart_en=1` 时生效 |
| heart_data | string[40] | 40 | √ | RW | 心跳数据 | "www.vguang.cn" | 设置网络心跳数据，仅在 `heart_en=1` 时生效 |
| haddr | string[256] | 255 | √ | RW | http服务器地址 | "http://192.168.1.1:8080" | --- |

1.[p_uart1](#p_uart1_back)
- 该参数可配置 rs485 信道参数，可配置的参数及可配置值如下：
- 支持的波特率为`300`, `2400`, `4800`, `9600`, `38400`, `57600`, `115200`
- 支持的数据位为`5`, `6`, `7`, `8`
- 支持的校验位为`N`, `O`, `E`
- 支持的停止位为`1`, `2`

2.[p_uart2](#p_uart2_back)
- 该参数可配置 TTL 信道参数，可配置的参数及可配置值如下：
- 该字段类型为`字符串`，最大长度为`20`字节。
- 支持的波特率为`300`, `2400`, `4800`, `9600`, `38400`, `57600`, `115200`
- 支持的数据位为`5`, `6`, `7`, `8`
- 支持的校验位为`N`, `O`, `E`
- 支持的停止位为`1`, `2`
---

## 3. [行为动作配置](#title_back)

该模块的配置为设备行为动作相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :--------: | :---: | :--------: | :--------: | :--------------: | :----: | :--------------------------------------------------: |
| beepd | int | YES | RW | 蜂鸣器延时 | 30 | [点此跳转](#beepd) |
| wled | int | YES | RW | 灯光控制 | 1 | [点此跳转](#wled) |
| ledd | int | YES | RW | 闪灯延时 | 200 | [点此跳转](#ledd) |
| relayd | int | YES | RW | 继电器延时 | 1000 | [点此跳转](#relayd) |
| brightness | int | YES | RW | 白色补光灯亮度 | 200 | [点此跳转](#brightness) |
| volctl | int | YES | RW | 电平控制 | 1 | [点此跳转](#volctl) |
| ascan | int | YES | RW | 扫码后动作 | 1 | [点此跳转](#ascan) |
| awifi_s | int | YES | RW | 网络传输成功行为 | 1089 | [点此跳转](#awifi_s) |
| awifi_f | int | YES | RW | 网络传输失败行为 | 2049 | [点此跳转](#awifi_f) |
| anfc | int | YES | RW | 刷卡后动作 | 1 | [点此跳转](#anfc) |
| backlight | int | YES | RW | LCD 背光亮度 | 100 | [点此跳转](#backlight) |
| boot_music | int | YES | RW | 设备开机语音 | 0 | [点此跳转](#boot_music) |
| afinger | int | YES | RW | 识别到指纹数据后动作 | 1 | [点此跳转](#afinger) |

1.[beepd](#beepd_back)
- 该字段为配置设备蜂鸣器延时时间，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节，
- 该字段的有效值范围为`0 - 1000`， 默认值为`30`，单位为`毫秒(ms)`

2.[wled](#wled_back)
- 该字段为配置设备灯光行为，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节，
- 该字段是根据bit位值生效的标志位，对应bit位写1使能，写0禁用。其bit位定义如下：
  1.  bit1: 白灯控制位  
  2.  bit2: 红灯控制位
  3.  bit3: 绿灯控制位
  4.  bit4: 蓝灯控制位

3.[ledd](#ledd_back)
- 该字段可配置灯光闪烁延时时间，该参数可对用户开放，用户具有读写权限
- 该字段类型为`整型`， 长度为`4`字节
- 该字段的有效值范围为`0 - 1000`， 默认值为`200`，单位为`毫秒(ms)`

4.[relayd](#relayd_back)
- 该字段可配置继电器延时时间， 该参数可对用户开放，用户可具有读写权限
- 该字段类型为`整型`，长度为`4`字节，该参数的单位为 `毫秒(ms)`

5.[brightness](#brightness_back)
- 该字段可配置白色补光灯亮度， 该参数可对用户开放，用户可具有读写权限
- 该字段类型为`整型`，长度为`4`字节，该参数的单位为 `毫秒(ms)`
- 该字段的有效范围为`0 ~ 255`，默认值为`200`

6.[volctl](#volctl_back)
- 该字段可配置高电平输出的输出电压，该参数可对用户开放，用户可具有读写权限
- 该字段的类型为`整型`，长度为`4`字节
- 该参数默认值为`1`, 可配置值如下：
  1. 如果配置 `volctl=1`，则高电平输出电压为`3.3V`
  2. 如果配置 `volctl=0`，则高电平输出电压为`4.3V`
- 该字段需要先配置高电平输出生效

7.[ascan](#ascan_back)
- 该字段可配置扫码后动作，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段是根据bit位值生效的标志位，如下bit位写`1`使能，写`0`禁用。其bit位定义如下：
  1.  bit0: 蜂鸣器控制位
  2.  bit1: 白灯闪烁控制位
  3.  bit2: 红灯闪烁控制位
  4.  bit3: 绿灯闪烁控制位
  5.  bit4: 输出高电平控制位，该bit位使能后，扫码输出高电平，具体输出电压可通过`volctl`字段配置
  6.  bit5: 蓝灯闪烁控制位
  7.  bit6: 动作继电器控制
  8.  bit7: 该bit位并未有特殊含义，建议写`0`
  9.  bit8: 支付码闪灯控制位，该bit位使能后，根据支付码闪烁灯光
  10. bit9:  支付闪灯音频控制器控制位，该bit位使能后，根据支付码闪烁对应的灯光并播放音频
- 该字段默认值为`1`，即配置扫码后动作蜂鸣器

8.[awifi_s](#awifi_s_back)
- 该字段为配置网络传输成功行为，该参数可对用户开放，用户可具有读写权限。
- 网络传输指的是通过网络协议的方式传输数据，只有在通过网络 TCP 协议，网络 HTTP 协议收发数据时才会触发该行为
- 该字段类型为`整型`，大小为`4`字节。
- 该字段是根据bit位值生效的标志位，其bit位定义如下：
 1. bit0: 蜂鸣器控制位
 2. bit1: 白灯闪烁控制位
 3. bit2: 红灯闪烁控制位
 4. bit3: 绿灯闪烁控制位
 5. bit4: 输出高电平控制位
 6. bit5: 蓝灯闪烁控制位
 7. bit6: 动作继电器控制
 8. bit10：成功语音提示, 该bit位使能播放成功语音
 9. bit11：失败语音提示, 该bit位使能播放失败语音
- 该配置字段默认值为`1089`， 即 (0x01 << 0) + (0x01 << 5) + (0x01 << 11)，即使能 `蜂鸣器`，`继电器`和`成功语音提示`

9.[awifi_f](#awifi_f_back)
- 该字段为配置网络传输失败行为，该参数可对用户开放，用户可具有读写权限。
- 网络传输指的是通过网络协议的方式传输数据，只有在通过网络 TCP 协议，网络 HTTP 协议收发数据时才会触发该行为
- 该字段类型为`整型`，大小为`4`字节。
- 该字段是根据bit位值生效的标志位，其bit位定义如下：
 1. bit0: 蜂鸣器控制位
 2. bit1: 白灯闪烁控制位
 3. bit2: 红灯闪烁控制位
 4. bit3: 绿灯闪烁控制位
 5. bit4: 输出高电平控制位
 6. bit5: 蓝灯闪烁控制位
 7. bit6: 动作继电 器控制
 8. bit10：成功语音提示, 该bit位使能播放成功语音
 9. bit11：失败语音提示, 该bit位使能播放失败语音
- 该配置字段默认值为`2049`， 即 (0x01 << 0) + (0x01 << 11)，即使能 `蜂鸣器`和`失败语音提示`

10.[anfc](#anfc_back)
- 该字段为，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为``，大小为``字节。
- 该字段的有效值范围为``， 默认值为``，单位为`秒(s)`。
- 该字段是根据bit位值生效的标志位，其bit位定义如下：
 1. bit0: 蜂鸣器控制位
 2. bit1: 白灯闪烁控制位
 3. bit2: 红灯闪烁控制位
 4. bit3: 绿灯闪烁控制位
 5. bit4: 输出高电平控制位
 6. bit5: 蓝灯闪烁控制位
 7. bit6: 动作继电器控制
- 该配置字段默认值为`1`， 即`0x01 << 0`，使能 `蜂鸣器`

11.[backlight](#backlight_back)
- 该字段可配置 LCD 的背光亮度，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的有效值范围为`0 ~ 100`， 默认值为`100`
- 该字段只有设备在拥有 LCD 屏幕时生效。

12.[boot_music](#boot_music_back)
- 该字段可配置设备开机语音是否启用，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的有效值为`0`和`1`， 默认值为`0`。
- 该字段是可认为是 bool 类型的字段使用，其有效值含义如下：
  1.  如果配置 `boot_music=0`, 代表`禁用`开机语音，设备开机时无动作
  2.  如果配置 `boot_music=1`, 代表`启用`开机语音，设备开机时播放文件系统内 `/vgapp/etc/0.wav`这条音频。

12.[afinger](#afinger_back)
- 该字段可配置设备识别到指纹数据后动作，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段是根据bit位值生效的标志位，如下bit位写`1`使能，写`0`禁用。其bit位定义如下：
  1.  bit0: 蜂鸣器控制位
  2.  bit1: 白灯闪烁控制位
  3.  bit2: 红灯闪烁控制位
  4.  bit3: 绿灯闪烁控制位
  5.  bit4: 输出高电平控制位，该bit位使能后，扫码输出高电平，具体输出电压可通过`volctl`字段配置
  6.  bit5: 蓝灯闪烁控制位
  7.  bit6: 动作继电器控制
- 该字段默认值为`1`，即识别到指纹数据后动作蜂鸣器
---

## 4. [音频配置](#title_back)
    该模块的配置为音频相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :----: | :---: | :--------: | :--------: | :--------------: | :----: | :-------------------------------------: |
| volume | int | √ | RW | 音频播放声音大小 | 60 | [点此跳转](#valume) |

1.[volume](#valume_back)
- 该字段可配置设备音频声音大小，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的有效值为`0 ~ 60`， 默认值为`60`。

---

## 5. [解码器配置](#title_back)
    该模块的配置为解码器相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :-------------: | :---: | :--------: | :--------: | :----------------: | :---------------------------------: | :------------------------------------------------------------: |
| de_type | int | √ | RW | 码制类型 | 64511 | [点此跳转](#de_type) |
| decoder | int | √ | RW | 解码引擎类型 | 1 | [点此跳转](#decoder_key) |
| s_mode | int | √ | RW | 配置扫码模式 | 0 | [点此跳转](#s_mode) |
| interval | int | √ | RW | 扫码间隔时间 | 200 | [点此跳转](#interval) |
| search_timeout | int | × | - | 检索码的超时时间 | 80 | [点此跳转](#search_timeout) |
| decoder_timeout | int | × | - | 解码的超时时间 | 100 | [点此跳转](#decoder_timeout) |
| search_mode | int | × | - | 解码引擎对应策略 | 0 | [点此跳转](#search_mode) |
| decoder_mode | int | √ | RW | 解码引擎特性配置 | 3 | [点此跳转](#decoder_mode) |
| qr_mode | int | × | - | qr 码的参数配置 | 15 | [点此跳转](#qr_mode) |
| decoder_delay | int | × | - | 两次解码之间的延时 | 1 | [点此跳转](#decoder_delay) |
| ocr_mode | int | √ | RW | ocr 模式 | 1 | [点此跳转](#ocr_mode) |
| ocr_template | str | x | - | ocr 识别模板 | "1&8&14&30&2&8&14&30&2&8&14&30&2&0" | 无补充说明 |

1.[de_type](#de_type_back)
- 该字段可配置解码码制，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段是根据bit位值生效的标志位，其bit位定义如下：
 1. bit0：`QR` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_QRCODE - 1)） = `1`
 2. bit1：`EAN8` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_EAN8 - 1)） = `2`
 3. bit2：`EAN13` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_EAN13 - 1)） = `4`
 4. bit3：`ISBN13` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_CODE39 - 1)） = `8`
 5. bit4：`CODE39` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_CODE93 - 1)） = `16`
 6. bit5：`CODE93` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_CODE128 - 1)） = `32`
 7. bit6：`CODE128` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_DATABAR_EXP - 1)）= `64`
 8. bit7：`DATABAR` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_DATABAR - 1)） = `128`
 9. bit8：`DATABAR_EXP` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_DATABAR_EXP - 1)）= `256`
 10. bit9：`PDF417` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_PDF417 - 1)） = `512`
 11. bit10：`MATAMATRIX` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_DATAMATRIX - 1)） = `1024`
 12. bit11：`ITF` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_ITF - 1)） = `2048`
 13. bit12：`ISBN10` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_ISBN10 - 1)） = `4096`
 14. bit13：`UPCE` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_UPCE - 1)） = `8192`
 15. bit14：`UPCA` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_UPCA - 1)） = `16384`
 16. bit15：`AZTEC` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_AZTEC - 1)） = `32768`
 17. bit16：`CODABAR` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_CODABAR - 1)） = `65536`
 18. bit17：`CODE11` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_CODE11 - 1)） = `131072`
 19. bit18：`TRIOPTIC` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_TRIOPTIC - 1)） = `262144`
 20. bit19：`TELEPEN` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_TELEPEN - 1)） = `524288`
 21. bit20：`STRT25` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_STRT25 - 1)） = `1048576`
 22. bit21：`MATRIX25` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_MATRIX25 - 1)） = `2097152`
 23. bit22：`CHINAPOST` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_CHINAPOST - 1)） = `4194304`
 24. bit23：`MSI` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_MSI - 1)） = `8388608`
 25. bit24：`CODABLOCK` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_CODABLOCK - 1)） = `16777216`
 26. bit25：`MAXICODE` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_MAXICODE - 1)） = `33554432`
 27. bit26：`RSS` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_RSS - 1)） = `67108864`
 28. bit27：`OCR` 码控制位， 该位置 `1` 使能该码。对应的 int 值为 （0x01 << (VBAR_SYM_OCR - 1)） = `134217728`
- 该字段的默认值为 `64511`, 对应的使能码制度为 `QR`, `EAN8`, `EAN13`, `ISBN13`, `CODE39`, `CODE93`, `CODE128`, `DATABAR`, `DATABAR_EXP`, `ITF`, `ISBN10`, `UPCE`, `UPCA`, `AZTEC`

2.[decoder](#decoder_key_back)
- 该字段为，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段默认值为`1`，有效值为`1`，即现在仅有一种解码引擎

3.[s_mode](#s_mode_back)
- 该字段可配置扫码模式，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的有效值为`0`和`1`， 默认值为`0`。
- 该字段的有效值释义如下：
  1. `0`，配置扫码模式为`间隔模式`，即同一扫码间隔内只输出一次扫码数据（所有扫到的码只输出1个有效的）
  2. `1`，配置扫码模式为`单次模式`，即相同时间内，相同的码值只输出一次

4.[interval](#interval_back)
- 该字段可配置扫码间隔时间，该参数可对用户开放，用户可具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的单位为`毫秒(ms)`， 默认值为 `200` ms
- 该字段只有扫码模式配置为`间隔模式时生效`

5.[search_timeout](#search_timeout_back)
- 该字段可配置检索码的超时时间，该参数默认不对外开放。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的 默认值为`80`，单位为`毫秒(ms)`。

6.[decoder_timeout](#decoder_timeout_back)
- 该字段可配置解码的超时时间，该参数默认不对外开放。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的 默认值为`100`，单位为`毫秒(ms)`。

7.[search_mode](#search_mode_back)
- 该字段可配置解码引擎的策略，该参数默认不对外开放。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的 默认值为`0`。
- 不同引擎对应的解码策略不同，详情联系开发
#TODO:解码引擎策略后续补充

8.[decoder_mode](#decoder_mode_back)
- 该字段可配置解码引擎的特性，该参数可对外开放，权限为可读可写。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的 默认值为`3`。
- 不同引擎对应的解码特性不同，详情联系开发
#TODO:解码引擎特性后续补充

9.[qr_mode](#qr_mode_back)
- 该字段可配置对 qr 码的单独设置，默认不对外开放。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的 默认值为`15`。
- 该字段是根据bit位值生效的标志位，其bit位定义如下：
  1. bit1: 使能该 bit 控制位，可使解码引擎支持对`图像占比较小的qr码的支持`  
  2. bit2: 使能该 bit 控制位，可使解码引擎支持`定位符不是方形的qr码`，该字段默认可不开
  3. bit3: 使能该 bit 控制位，可使解码引擎支持`qr码识别增强`，针对医疗、异常、拉丝场景，普通场景可不开
  4. bit4: 使能该 bit 控制位，可使解码引擎支持`打点qr码增强（耗时操作）`，普通场景可不开
  5. bit5: 使能该 bit 控制位，可使解码引擎支持`无静区二维码（耗时操作）`，，默认不开
- 默认值 `15`， 即开启了`对图像占比较小的qr码的支持`，`定位符不是方形的qr码`，`qr码识别增强`，`打点qr码增强（耗时操作）`。

10.[decoder_delay](#decoder_delay_back)
- 该字段可配置解码线程的休眠时间，该字段不对外开放。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的 默认值为`1`。

12.[ocr_mode](#ocr_mode_back)
- 该字段可配置扫码器的 ocr 模式，可对外开放，用户具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的默认值为`1`，其有效值及释义如下
  1. 该字段值为`1`时标识配置 ocr 模式为`普通ocr模式` 
  2. 该字段值为`2`时标识配置 ocr 模式为`反色ocr模式`
  3. 该字段值为`3`时标识配置 ocr 模式为 `同时开启普通ocr模式和反色ocr模式`
---

## 6. [云证配置](#title_back)
    该模块的配置为云证模块相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :--------: | :-----: | :--------: | :--------: | :----------------: | :------------------: | :---------------------------------------------: |
| id_active | int | × | - | 云证激活状态 | 0 | [点此跳转](#id_active) |
| id_picture | int | √ | RW | 是否读取身份证照片 | 0 | [点此跳转](#id_picture) |
| id_timeout | int | √ | RW | 云证超时时间 | 2 | 暂无补充说明 |
| id_appid | str[31] | √ | RW | 云证应用的appid | "1621503" | 暂无补充说明 |
| id_envcode | int | √ | RW | 云证环境编码 | 52302 | 暂无补充说明 |
| id_port | int | √ | RW | 云证端口 | 9989 | 暂无补充说明 |
| id_ipaddr | str[63] | √ | RW | 云证ip地址 | "deviceid.dxiot.com" | 暂无补充说明 |

1.[id_active](#id_active_back)
- 该字段可配置云证模块的激活状态，不对外开放。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的默认值为`0`，其有效值及释义如下
   1. 当该字段配置为`0`时，云证模块配置`关闭`
   2. 当该字段配置为`1`时，云证模块配置`开启`
- 该字段用户不可配置，由用户扫描我们给出的激活码进行云证模块的激活

2.[id_picture](#id_picture_back)
- 该字段可配置云证模块是否输出身份证，该字段对外开放，用户具有读写权限。
- 该字段类型为`整型`，大小为`4`字节。
- 该字段的默认值为`0`，其有效值及释义如下
   1. 当该字段配置为`0`时，云证模块不输出身份证照片
   2. 当该字段配置为`1`时，云证模块输出身份证照片
---

## 7. [ISP 配置](#title_back)
    该模块的配置为sensor 的 isp 参数相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :----: | :---: | :--------: | :--------: | :--------------: | :----: | :----------------------------------------------------: |
| ST | int | √ | RO | 标识sensor型号 | 0 | [点此跳转](#isp_explain) |
| A1 | int | √ | RW | isp main func | 0 | [点此跳转](#isp_explain) |
| B1 | int | √ | RW | isp sub func | 2 | [点此跳转](#isp_explain) |
| C1 | int | √ | RW | 图像目标亮度值 | 120 | [点此跳转](#isp_explain) |
| D1 | int | √ | RW | 目标亮度占比 | 90 | [点此跳转](#isp_explain) |
| E1 | int | √ | RW | 计算时的采样间隔 | 32 | [点此跳转](#isp_explain) |
| F1 | int | √ | RW | 最大曝光值 | 1700 | [点此跳转](#isp_explain) |
| G1 | int | √ | RW | 最小曝光值 | 400 | [点此跳转](#isp_explain) |
| H1 | int | √ | RW | 最大增益值 | 512 | [点此跳转](#isp_explain) |
| I1 | int | √ | RW | 最小增益值 | 64 | [点此跳转](#isp_explain) |
| J1 | int | √ | RO | 起始曝光值 | 100 | [点此跳转](#isp_explain) |
| K1 | int | √ | RO | 起始增益值 | 64 | [点此跳转](#isp_explain) |
| L1 | int | √ | RO | - | 120 | [点此跳转](#isp_explain) |
| M1 | int | √ | RO | - | 0 | [点此跳转](#isp_explain) |
| N1 | int | √ | RO | - | 3 | [点此跳转](#isp_explain) |
| O1 | int | √ | RO | - | 0 | [点此跳转](#isp_explain) |
| P1 | int | √ | RO | - | 0 | [点此跳转](#isp_explain) |
| Q1 | int | √ | RO | - | 0 | [点此跳转](#isp_explain) |
| R1 | int | √ | RO | - | 0 | [点此跳转](#isp_explain) |
| S1 | int | √ | RO | - | 0 | [点此跳转](#isp_explain) |
| T1 | int | √ | RO | - | 0 | [点此跳转](#isp_explain) |
| U1 | int | √ | RO | - | 60 | [点此跳转](#isp_explain) |
| V1 | int | √ | RO | - | 2 | [点此跳转](#isp_explain) |
| W1 | int | √ | RO | - | 60 | [点此跳转](#isp_explain) |
| X1 | int | √ | RO | - | 100 | [点此跳转](#isp_explain) |
| Y1 | int | √ | RO | - | 0 | [点此跳转](#isp_explain) |
| Z1 | int | √ | RO | - | 1 | [点此跳转](#isp_explain) |
---

1.[isp 整体参数说明](#isp_explain_back)
- ISP 参数共有 27 个，分别为 `A1` ~ `Z1`, 以及 `ST`。其中 `ST`，`J1` ~ `Z1` 配置工具不可配，其余字段可通过配置工具进行配置。
- 上述配置工具不可配置字段中，`ST`,`J1`,`K1`可通过 app 的 menuconfig 进行配置，其余只能在代码内修改init宏默认值
- `ST` 字段标识的是 sonsor 的型号，现有已经添加的 sensor 型号有以下几种：
  1.  VBAR_B_CAPTURER_SENSOR_TYPE_UNKNOWN，0   
  2.  VBAR_B_CAPTURER_SENSOR_TYPE_SC031GS，1   
  3.  VBAR_B_CAPTURER_SENSOR_TYPE_OV7251， 2   
  4.  VBAR_B_CAPTURER_SENSOR_TYPE_OV7725， 3  
  5.  VBAR_B_CAPTURER_SENSOR_TYPE_SC132GS，4  
  6.  VBAR_B_CAPTURER_SENSOR_TYPE_SC230AI，5  
  7.  VBAR_B_CAPTURER_SENSOR_TYPE_SC201CS，6
- UNKNOWN 标识除以上 6 中之外的所有 sensor，上述表格中的参数默认值均为字段 `ST` = `VBAR_B_CAPTURER_SENSOR_TYPE_UNKNOWN` 时
- 下面表格为 sensor 类型对应参数默认值的对照表。仅为 `A1` ~ `J1` 字段，剩余字段均与上表相同

| 字段名 | SC031GS | OV7251 | OV7725 | SC132GS | SC230AI | SC201CS |
| :----: | :-----: | :----: | :----: | :-----: | :-----: | :-----: |
| A1 | 0 | 0 | 0 | 0 | 0 | 0 |
| B1 | 2 | 2 | 2 | 2 | 2 | 2 |
| C1 | 100 | 100 | 100 | 100 | 100 | 100 |
| D1 | 90 | 90 | 90 | 90 | 90 | 90 |
| E1 | 32 | 32 | 32 | 32 | 32 | 32 |
| F1 | 1700 | 1700 | 1700 | 1700 | 1700 | 1700 |
| G1 | 400 | 400 | 400 | 400 | 400 | 400 |
| H1 | 256 | 256 | 256 | 256 | 256 | 256 |
| I1 | 32 | 32 | 32 | 32 | 32 | 32 |
| J1 | 150 | 150 | 150 | 150 | 150 | 150 |
| K1 | 64 | 64 | 64 | 64 | 64 | 64 |
- 概念补充：
 1. 曝光（Exposure）：指摄像机感光元件（例如传感器）感光时间的长短，通常用来控制摄像头的拍摄亮度。 增大曝光时间可以使得影像更亮，但过度曝光会造成色彩饱和度下降，丢失细节等问题；
 2. 增益（Gain）：指在放大图像信号的过程中，调整的放大倍数。增加增益可提高图像亮度，降低增益可减少噪声，但同时也带来了图像的粗糙度和信噪比下降等问题；
 3. 图像目标亮度（Target luminance）：是一个目标光强值，通常用于ISP算法自动调节曝光和增益，以达到一个最终理想的画面质量。 当目标亮度值调得太低，会导致细节丧失，画面灰暗； 当目标亮度值调得太高，会导致图像曝光过度，细节丢失。
---

## 8. [网络配置](#title_back)
    该模块的配置为网络模块相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :------------------: | :---: | :--------: | :--------: | :----------------: | :-----------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| net_type | int | √ | RW | 网络类型 | 1 | 该字段标识了当前的网络类型，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;1. VBAR_NET_TYPE_NONE = 0x00 &nbsp;&nbsp;&nbsp;&nbsp;2. VBAR_NET_TYPE_ETH = 0x01 &nbsp;&nbsp;&nbsp;&nbsp;3. VBAR_NET_TYPE_WIFI = 0x02 &nbsp;&nbsp;&nbsp;&nbsp;4. VBAR_NET_TYPE_MODEM = 0x04 |
| ip_mode | int | √ | RW | IP 获取模式 | 0 | 该字段标识了当前的 IP 获取类型，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 自动获取 &nbsp;&nbsp;&nbsp;&nbsp;1: 静态 IP |
| net_consum | int | √ | RW | net consum | 0 |  |
| net_consum_outtime | int | √ | RW | net consum outtime | 10 |  |
| ssid | str[] | √ | RW | wifi 名称 | "Vguang_JS" | <div style="text-align: center;">---</div> |
| psk | str[] | √ | RW | wifi 密码 | "vguangjs_o0" | <div style="text-align: center;">---</div> |
| ip | str[] | √ | RW | 静态 IP | "0.0.0.0" | <div style="text-align: center;">配置 IP 获取为静态 IP 时生效</div> |
| mask | str[] | √ | RW | 静态子网掩码 | "0.0.0.0" | <div style="text-align: center;">配置 IP 获取为静态 IP 时生效</div> |
| gateway | str[] | √ | RW | 静态网关 | "0.0.0.0" | <div style="text-align: center;">配置 IP 获取为静态 IP 时生效</div> |
| dns | str[] | √ | RW | 静态 DND | "0.0.0.0" | <div style="text-align: center;">配置 IP 获取为静态 IP 时生效</div> |
| fixed_macaddr_enable | int | √ | RW | mac模式 | 1 | 该字段标识了当前的 MAC 获取类型，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 设备默认 &nbsp;&nbsp;&nbsp;&nbsp;1: 固定 MAC &nbsp;&nbsp;&nbsp;&nbsp;2: 自定义 MAC(自定义值取决于配置字段 macaddr) |
| macaddr | str[] | √ | RW | mac 地址 | "00:00:00:00:00:00" | <div style="text-align: center;">配置 MAC 获取为自定义 MAC 时生效</div> |
---

## 9. [NFC 配置](#title_back)
    该模块的配置为 NFC 模块相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :----------------------: | :---: | :--------: | :--------: | :-------------------------------: | :------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| nfc | int | √ | RW | nfc 开关 | 1 | 该字段标识了当前的 NFC 工作状态，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 使能 NFC &nbsp;&nbsp;&nbsp;&nbsp;1: 禁用 NFC |
| nfc_work_mode | int | √ | RW | nfc 工作模式 | 1 | 该字段标识了当前的 NFC 工作模式，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 用户交互模式 &nbsp;&nbsp;&nbsp;&nbsp;1: 主动模式 |
| nfc_14443p4_enable | int | √ | RW | 是否使能 NFC 支持 ISO14443-4 协议 | 0 |  |
| nfc_afi | int | √ | RW | 应用族识别符，应用的卡预选准则 | 0 |  |
| nfc_afi_enable | int | √ | RW | -- | 0 |  |
| nfc_identity_card_enable | int | √ | RW | 配置是否读取身份证物理卡号 | 1 | 该字段标识了当前的 NFC 是否读取身份证物理卡号，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 使能 NFC 读取身份证物理卡号 &nbsp;&nbsp;&nbsp;&nbsp;1: 禁用 NFC 读取身份证物理卡号 |
| nfc_card_braud_tx | int | √ | RW | nfc 发送波特率 | 1 | 猜测！！！NFC 波特率有 106 kbps、212 kbps 和 424kbps 三种 |
| nfc_card_braud_rx | int | √ | RW | nfc 接收波特率 | 1 |  |
| nfc_f_braud | int | √ | RW | RFID 位传输速率 | 8 |  |
| nfc_f_scode | int | √ | RW | -- | 65535 |  |
| nfc_f_reqcode | int | √ | RW | -- | 0 |  |
| nfc_card_protocol | int | √ | RW | 使能的卡协议 | 1 | 该字段标识了当前的 NFC 支持的协议，该字段为 flag 标志位，其有效 bit 位有以下几个: &nbsp;&nbsp;&nbsp;&nbsp;bit0: ISO14443-A 106kbps &nbsp;&nbsp;&nbsp;&nbsp;bit1: ISO14443-B 106kbps &nbsp;&nbsp;&nbsp;&nbsp;bit3: ISO15693 |
| nfc_timeout_ms | int | √ | RW | 读卡超时时间 | 200 | <div style="text-align: center;">当前 NFC 读取卡数据的超时时间，单位为`毫秒（ms）`</div> |
| nfc_m1_sec0_key | str | √ | RW | -- | "ffffffffffff" |  |
| nfc_m1_blk0s | str | √ | RW | -- | "" |  |
| check_m1 | int | √ | RW | -- | 0 |  |
| nfc_sak28 | int | √ | RW | -- | 0 |  |
| nfc_version | str | √ | RW | nfc 版本 | "" | <div style="text-align: center;">当前 NFC 版本</div> |
---

## 10. [NTP 配置](#title_back)
    该模块的配置为 NTP 模块相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :----------: | :---: | :--------: | :--------: | :----------------: | :----------: | :----------------------------------------------------------------------------------------------------------------------------------------------------- |
| ntp_en | char | √ | RW | 使能/禁用 NTP 服务 | 1 | 该字段位 NTP 服务`启用/禁用`控制字段，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 禁用 NTP 服务 &nbsp;&nbsp;&nbsp;&nbsp;1: 启用 NTP 服务 |
| ntp_addr | str | √ | RW | ntp服务器地址 | 182.92.12.11 | <div style="text-align: center;">---</div> |
| ntp_port | int | √ | RW | ntp服务器端口 | 123 | <div style="text-align: center;">---</div> |
| ntp_timeout | int | √ | RW | ntp同步超时时间 | 5 | <div style="text-align: center;">单位为`秒（s）`</div> |
| ntp_interval | int | √ | RW | ntp同步间隔 | 43200 | <div style="text-align: center;">单位为`秒（s）`</div> |
| ntp_hour | char | √ | RW | ntp 固定时间同步 | 23 | <div style="text-align: center;">定时同步，23 即为每天 23：00 自动同步时间</div> |
---

## 11. [OUTPUT 配置](#title_back)
    该模块的配置为 NTP 模块相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :--------------: | :------: | :--------: | :--------: | :-------------------------------------: | :--------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `通用配置` | -------- | ---------- | ---------- | ---------- | ---------- | --------- |
| w_mode | int | √ | RW | 设备工作模式 | 1 | [点此跳转](#w_mode) |
| owifi | int | √ | RW | wifi 或者以太网输出端口选择 | 1 | [点此跳转](#owifi) |
| eth | int | √ | RW | 有线网络输出端口选择 | 1 | [点此跳转](#eth) |
| wifipra | str[300] | √ | RW | wifi 协议参数 | "" | <div style="text-align: center;">即 wifi 协议中，字段 otherparams 的值</div> |
| vg | int | √ | RW | 韦根输出端口选择 | 1 | 该字段标识了当前韦根输出端口，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;1: 以`韦根26`输出数据 &nbsp;&nbsp;&nbsp;&nbsp;2: 以`韦根34`输出数据 |
| `云证配置` | -------- | ---------- | ---------- | ---------- | ---------- | --------- |
| nfc_otag | int | √ | RW | 配置云证选择输出身份证信息 | 0 | [点此跳转](#nfc_otag) |
| online_id_format | int | √ | RW | 配置身份证信息输出格式 | 1 | 该字段标识了当前身份证信息输出格式，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;1: OL_ID_ASCII -- 以 ASCII 格式输出身份证信息 &nbsp;&nbsp;&nbsp;&nbsp;2: OL_ID_JSON -- 以 JSON 格式输出身份证信息 &nbsp;&nbsp;&nbsp;&nbsp;3: OL_ID_TLV -- 以 TLV 格式输出身份证信息(3.1代码暂未实现) |
| `扫码配置` | -------- | ---------- | ---------- | ---------- | ---------- | --------- |
| ochannel | int | √ | RW | 普通模式输出端口 | 1 | [点此跳转](#ochannel) |
| dchannel | int | √ | RW | 二次开发模式和升级模式输出端口 | 1 | [点此跳转](#dchannel) |
| chorc | int | √ | RW | 二维码前后缀格式 | 1 | 该字段标识了当前二维码数据的输出格式，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;1: APP_OUTPUT_SYMBOL_FIX_FORMAT_STRING -- 以字符串格式输出二维码数据 &nbsp;&nbsp;&nbsp;&nbsp;2: APP_OUTPUT_SYMBOL_FIX_FORMAT_HEX -- 以十六进制格式输出二维码数据 |
| prefix | str[300] | √ | RW | 二维码输出前缀 | "" | 字段值为二维码输出的前缀，最大长度为300字节 |
| postfix | str[300] | √ | RW | 二维码输出后缀 | "" | 字段值为二维码输出的后缀，最大长度为300字节 |
| ft | int | √ | RW | 二维码数据输出格式 | 0 | [点此跳转](#ft) |
| nl | int | √ | RW | 输出二维码是否添加回车 | 0 | 该字段配置输出的二维码数据是否添加回车，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 输出的二维码数据不添加回车 &nbsp;&nbsp;&nbsp;&nbsp;1: 输出的二维码数据添加回车 |
| cr | int | √ | RW | 输出二维码是否添加换行 | 0 | 该字段配置输出的二维码数据是否添加换行，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 输出的二维码数据不添加换行 &nbsp;&nbsp;&nbsp;&nbsp;1: 输出的二维码数据添加换行 |
| `刷卡配置` | -------- | ---------- | ---------- | ---------- | ---------- | --------- |
| nochannel | int | √ | RW | 普通模式下nfc数据输出端口选择 | 1 | [同扫码配置 ochannel 字段，点此跳转](#ochannel) |
| ndchannel | int | √ | RW | 开发模式下nfc数据输出端口选择 | 1 | [同扫码配置 dchannel 字段，点此跳转](#dchannel) |
| ord | int | √ | RW | 配置NFC数据顺序为正序/反序 | 1 | 该字段配置输出的NFC数据为正序或者反序，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 输出的NFC数据为正序 &nbsp;&nbsp;&nbsp;&nbsp;1: 输出的NFC数据为反序 |
| idord | int | √ | RW | 身份证数据端序 | 1 | 该字段配置输出的身份证数据为正序或者反序，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;1: 输出的NFC数据为正序 &nbsp;&nbsp;&nbsp;&nbsp;0: 输出的NFC数据为反序  |
| st | int | √ | RW | NFC输出数据起始位 | 1 | 该值范围为 `1` ~ `8` |
| len | int | √ | RW | NFC输出数据长度 | 8 | 该值范围为 `1` ~ `8` |
| nft_add_zero | int | √ | RW | 配置是否补全数据到10位（unit_test字段） | 1 | 该字段配置输出的 NFC 数据为是否用0补全至10位，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;1: 补全数据至10位 &nbsp;&nbsp;&nbsp;&nbsp;0：不补全 eg: 数据为0x42 &nbsp;&nbsp;&nbsp;&nbsp;如果配置为1，输出数据为：00 00 00 00 00 00 00 00 00 42 &nbsp;&nbsp;&nbsp;&nbsp;如果配置为0，输出数据为：42  |
| nft | int | √ | RW | 配置nfc数据输出格式（unit_test字段） | 2 | 该字段配置输出的 NFC 数据输出格式，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;1: 原始二进制字符转换成16进制格式的字符 ：0x86 --> 0x3836 &nbsp;&nbsp;&nbsp;&nbsp;2：原始二进制字符转换成10进制格式的字符 ：0x12233846 --> 0x333034323938303534 &nbsp;&nbsp;&nbsp;&nbsp;4：在韦根26下输出低3个字节 |
| horc | int | √ | RW | 配置nfc的前后缀格式 | 1 | 该字段标识了当前NFC数据前后缀的输出格式，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: APP_OUTPUT_NFC_FIX_FORMAT_STRING -- 以字符串格式输出NFC数据前后缀 &nbsp;&nbsp;&nbsp;&nbsp;1: APP_OUTPUT_NFC_FIX_FORMAT_HEX -- 以十六进制格式输出NFC数据前后缀 |
| pri | str[300] | √ | RW | NFC数据前缀 | "" | 字段值为 NFC 输出数据的前缀，最大长度为300字节 |
| pos | str[300] | √ | RW | NFC数据后缀 | "" | 字段值为 NFC 输出数据的后缀，最大长度为300字节 |
| nnl | int | √ | RW | 输出的 NFC 数据是否添加回车 | 0 | 该字段配置输出的 NFC 数据是否添加回车，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 输出的 NFC 数据不添加回车 &nbsp;&nbsp;&nbsp;&nbsp;1: 输出的 NFC 数据添加回车 |
| ncr | int | √ | RW | 输出的 NFC 数据是否添加换行 | 0 | 该字段配置输出的 NFC 数据是否添加换行，其有效值分别有以下几种: &nbsp;&nbsp;&nbsp;&nbsp;0: 输出的 NFC 数据不添加换行 &nbsp;&nbsp;&nbsp;&nbsp;1: 输出的 NFC 数据添加换行 |
| `蓝牙配置` | -------- | ---------- | ---------- | ---------- | ---------- | --------- |
| blochannel | int | √ | RW | | |  |
| bldchannel | int | √ | RW | | |  |
| blhorc | int | √ | RW | | |  |
| blpri | str[300] | √ | RW | | |  |
| blpos | str[300] | √ | RW | | |  |
| blft | int | √ | RW | | |  |
| blnl | int | √ | RW | | |  |
| blcr | int | √ | RW | | |  |
| `指纹配置` | -- | -- | -- | -- | -- | -- |
| frochannel | int | √ | RW | 普通输出通道 | 1 | [同 ochannel 字段，点此跳转](#ochannel) |
| frdchannel | int | √ | RW | 开发协议输出通道 | 1 | [同 dchannel 字段，点此跳转](#dchannel) |
| frhorc | int | √ | RW | 前后缀格式 | 1：以字符串格式输出数据 2：以十六进制格式输出二维码数据 | 
| frpri | string | √ | RW | 前缀（字符串） | |
| frpos | string | √ | RW | 后缀（字符串） | |
| frft | int | √ | RW | 输出数据格式 |0：原始数据（810字节十六进制字节） 1：转16进制字符串
| frnl | int | √ | RW | 加回车 | |
| frcr | int | √ | RW | 加换行 | |

1.[w_mode](#w_mode_back)
- 该字段配置设备的工作模式，默认为普通模式，下面为该字段的有效值及说明：
  1.  WORK_MODE_NORMAL     = CFGBIT(0)  = `1`,         设备处于`普通模式`
  2.  WORK_MODE_PROTOCOL   = CFGBIT(1)  = `2`,         设备处于`开发模式`
  3.  WORK_MODE_TOOL       = CFGBIT(2)  = `4`,         设备处于`工具模式`
  4.  WORK_MODE_CALL       = CFGBIT(4)  = `16`,        设备处于`拷机模式`
  5.  WORK_MODE_UPDATE     = CFGBIT(5)  = `32`,        设备处于`升级模式`
  6.  WORK_MODE_SENS       = CFGBIT(6)  = `64`,        设备处于`感应模式`
  7.  WORK_MODE_PAY        = CFGBIT(7)  = `128`,       设备处于`支付模式`
  8.  WORK_MODE_SCAN       = CFGBIT(8)  = `256`,       设备处于`扫码枪模式`
  9.  WORK_MODE_RESTART    = CFGBIT(9)  = `512`,       设备处于`开关机模式`
  10. WORK_MODE_ACCESS_CTL = CFGBIT(10) = `1024`,      设备处于`访客模式`
  11. WORK_MODE_FACTORY    = CFGBIT(28) = `268435456`, 设备处于`工厂模式`
- 设备同一时间只能处于一种工作模式下，不可同时将多个bit位置1

2.[owifi](#owifi_back)
- 该字段配置设备的wifi或者以太网的输出模式，下面为该字段的有效值及说明：
  1. OUTPUT_OWIFI_HTTP     = CFGBIT(0) | CFGBIT(4), = `17`， wifi的输出模式为同时处于 `普通HTTP`，`普通HTTPS` 模式
  2. OUTPUT_OWIFI_HTTP_PRO = CFGBIT(1) | CFGBIT(5), = `34`， wifi的输出模式为同时处于 `协议HTTP`，`协议HTTPS` 模式
  3. OUTPUT_OWIFI_TCP      = CFGBIT(2),             = `4`，  wifi的输出模式为 `普通TCP` 模式
  4. OUTPUT_OWIFI_TCP_PRO  = CFGBIT(3),             = `8`，  wifi的输出模式为 `协议TCP` 模式
  5. OUTPUT_OWIFI_HTTPS    = CFGBIT(4),             = `16`， wifi的输出模式为 `普通HTTPS` 模式
  6. OUTPUT_OWIFI_HTTPS_PRO= CFGBIT(5),             = `32`， wifi的输出模式为 `协议HTTPS` 模式
- 该字段默认值为 `1`，即仅处于普通http模式下

3.[eth](#eth_back)（该字段已经弃用）
- 该字段配置设备的有线网络的输出模式，下面为该字段的有效值及说明：
  1. OUTPUT_TTL2NET_TCP      = CFGBIT(0) = `1`， 有线网络的输出模式为 `普通TCP` 模式
  2. OUTPUT_TTL2NET_TCP_PRO  = CFGBIT(1) = `2`， 有线网络的输出模式为 `协议TCP` 模式
  3. OUTPUT_TTL2NET_HTTP     = CFGBIT(2) = `4`， 有线网络的输出模式为 `普通HTTP` 模式
  4. OUTPUT_TTL2NET_HTTP_PRO = CFGBIT(3) = `8`， 有线网络的输出模式为 `协议HTTP` 模式
  5. OUTPUT_TTL2NET_UDP      = CFGBIT(4) = `16`，有线网络的输出模式为 `普通UDP` 模式
- 该字段默认值为 `1`，即仅处于普通 TCP 模式下

4.[nfc_otag](#nfc_otag_back)
- 该字段配置云证输出身份证信息时输出的具体内容。该参数是一个 flag 标志位，其 bit 位定义如下：
  1.  bit0: 姓名               
  2.  bit1: 性别
  3.  bit2: 民族
  4.  bit3: 出生
  5.  bit4: 住址
  6.  bit5: 公民身份号码
  7.  bit6: 签发机关
  8.  bit7: 有效期起始日期
  9.  bit8: 有效期截止日期
  10. bit9: 有效期截止日期
- 该字段上述 bit 位置`1`启用对应输出，置`0`禁用
- 该字段默认值为 `0`，即不输出身份证信息

5.[ochannel](#ochannel_back)
- 该字段配置扫码器处于普通模式下的输出信道。该参数的bit位定义如下：
 1. bit0: CHANNEL_`USBKBW ` = (0x01 << 0) = `1`
 2. bit1: CHANNEL_`RS485 ` = (0x01 << 1) = `2`
 3. bit2: CHANNEL_`TTL ` = (0x01 << 2) = `4`
 4. bit3: CHANNEL_`WIFI ` = (0x01 << 3) = `8`
 5. bit4: CHANNEL_`WIEGAND ` = (0x01 << 4) = `16`
 6. bit5: CHANNEL_`TTL2NET ` = (0x01 << 5) = `32`（该比特位已弃用）
 7. bit6: CHANNEL_`ETH ` = (0x01 << 6) = `64`
 8. bit7: CHANNEL_`USB_VUART` = (0x01 << 7) = `128`
 9. bit8: CHANNEL_`USBHID ` = (0x01 << 8) = `256`
 10. bit9: CHANNEL_`4G ` = (0x01 << 9) = `512`
 11. bit11: CHANNEL_`BLE ` = (0x01 << 11) = `2048` 
- 将该字段的信道对应 bit 置 1 即可使能普通模式下该通道的数据输出，置 0 禁用该通道输出、
- 字段默认值为 1 ，即默认配置普通模式输出通道为 `USBKBW`

6.[dchannel](#dchannel_back)
- 该字段配置扫码器处于开发模式下的输出模式。该参数的bit位定义如下：
 1. DEVELOP_CHANNEL_`VRPC_USBHID ` = (0x01 << 0) = `1`
 2. DEVELOP_CHANNEL_`VRPC_RS485 ` = (0x01 << 1) = `2`
 3. DEVELOP_CHANNEL_`VRPC_TTL ` = (0x01 << 2) = `4`
 4. DEVELOP_CHANNEL_`PRO_RS485 ` = (0x01 << 3) = `8`
 5. DEVELOP_CHANNEL_`PRO_TTL ` = (0x01 << 4) = `16`
 6. DEVELOP_CHANNEL_`PRO_MULT_RS485` = (0x01 << 5) = `32`
 7. DEVELOP_CHANNEL_`VGPRO ` = (0x01 << 6) = `64`
 8. DEVELOP_CHANNEL_`CUSTOMER ` = (0x01 << 7) = `128`
 9. DEVELOP_CHANNEL_`HTTPPRO ` = (0x01 << 8) = `256`
 10. DEVELOP_CHANNEL_`VRPC_OR_VGPRO ` = (0x01 << 0) | (0x01 << 1) | (0x01 << 2) = `7`
- 将该字段的信道对应 bit 置 1 即可使能开发模式下该通道的数据输出，置 0 禁用该模式输出
- 字段默认值为 1 ，即默认配置开发模式输出为 USB 通道 VRPC 协议

6.[ft](#ft_back)
- 该字段配置扫码器处于开发模式下的输出模式。该参数的bit位定义如下：
 1. OUTPUT_SYM_FT_DEC_STR2HEX_BYTE = (0x01 << 0) = `1`
 2. OUTPUT_SYM_FT_DEC_STR2HEX_BYTE_REV = (0x01 << 1) = `2`
 3. OUTPUT_SYM_FT_HEX_STR2HEX_BYTE = (0x01 << 2) = `4`
 4. OUTPUT_SYM_FT_HEX_STR2HEX_BYTE_REV = (0x01 << 3) = `8`
 5. OUTPUT_SYM_FT_PIDVID_DECSTR2HEX_BYTE = (0x01 << 4) = `16`
 6. OUTPUT_SYM_FT_PIDVID_DECSTR2HEX_BYTE_REV = (0x01 << 5) = `32`
 7. OUTPUT_SYM_FT_PIDVID_DECSTR2HEX_LOW3_BYTE = (0x01 << 6) = `64`
- 该字段配置设备输出二维码数据的格式
- 字段默认值为 0 ，即二维码数据不进行任何个数转换，直接输出原数据
---

## 12. [PASSWORD 配置](#title_back)
    该模块的配置为 PASSWORD 模块相关配置
- 配置字段详情如下

|   字段名   |  类型   | 外部可见性 | 外部读写性 | 功能描述 |       默认值       | 补充说明                 |
| :--------: | :-----: | :--------: | :--------: | :------: | :----------------: | :----------------------- |
| com_passwd | str[16] |     √      |     RW     | 管理密码 | "1234567887654321" | 用于对配置信息做安全管理 |
---

## 13. [VERSION 配置](#title_back)
    该模块的配置为 VERSIOB 模块相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :-----: | :---------------------------------------: | :--------: | :--------: | :--------------: | :----: | :----------------------------- |
| version | str | √ | RW | 设备的固件版本号 | "" | 在进行版本号检查时使用此版本号 |
---

## 14. [VG485 配置](#title_back)
    该模块的配置为 vg485 协议 模块相关配置
- 配置字段详情如下

|       字段名       |     类型      | 外部可见性 | 外部读写性 |   功能描述   |      默认值      | 补充说明         |
| :----------------: | :-----------: | :--------: | :--------: | :----------: | :--------------: | :--------------- |
|     rs485_ver      |      int      |     √      |     RW     |   485版本    |        7         |                  |
|      rs485_sn      |    str[10]    |     √      |     RW     | 主设备 SN 号 |     abcdefgh     | 实际sn为8位      |
|      rs485_id      | unsigned char |     √      |     RW     |  主设备 id   |        1         | 从1开始，不能为0 |
|     rs485_key      |    str[20]    |     √      |     RW     |     密钥     | UnQkvNpXMq5yVy7D |                  |
|   rs485_timeout    |      int      |     √      |     RW     |   超时时间   |      86400       |                  |
| rs485_poll_timeout |      int      |     √      |     RW     |   轮询间隔   |        10        |                  |
---

## 15. [VGPRO 配置](#title_back)
    该模块的配置为 vg 通信协议 模块相关配置
- 配置字段详情如下

| 字段名 | 类型  | 外部可见性 | 外部读写性 |   功能描述    | 默认值 | 补充说明 |
| :----: | :---: | :--------: | :--------: | :-----------: | :----: | :------- |
| head1  |  int  |     √      |     RW     | vgpro head[0] |  0x55  |          |
| head2  |  int  |     √      |     RW     | vgpro head[1] |  0xAA  |          |
---

## 16. [按键 配置](#title_back)
		该模块的配置为 m20设备触摸按键 相关配置
- 配置字段详情如下

| 字段名 | 类型  | 外部可见性 | 外部读写性 |   功能描述    | 默认值 | 补充说明 |
| :---: | :--: | :------: | :-------: | :---------: | :----: | :----- |
| tkey_en | int | √ | RW | 按键开关 | 1 | 0关闭 1打开 | 
| tkey_light_en | int | √ | RW | 按键背光灯模式 | 1 | 按键背光灯模式 0常灭 1常亮 2休眠 |
| tkey_interval_s | int | √ | RW | 休眠时间间隔 | 60 | 单位 秒(s) |

| tkey_light_en值 | 功能 | 补充说明 |
| :------------: | :--: | :----- |
| 0 | 常灭 | 开机后背光灯熄灭，被按键亮灯500ms |
| 1 | 常亮 | 开机后背光灯亮起，被按键灭灯500ms |
| 2 | 休眠 | 开机后背光灯亮起，间隔时间（配置）内无键按下，熄灭背光灯 直接按一个键，背光灯亮起，被按键灭灯500ms 同时按下多个按键，点亮所有按键背光灯，不记录按键值 |

## 17. [PSAM 配置](#title_back)
		该模块的配置为 使用微光发卡协议的PSAM 相关配置
- 配置字段详情如下

| 字段名 | 类型  | 外部可见性 | 外部读写性 |   功能描述    | 默认值 | 补充说明 |
| :---: | :--: | :------: | :-------: | :---------: | :----: | :----- |
| psam_en | int | √ | RW | psam功能开关 | 0 | 0关闭 1打开    |
| psam_wmode | int | √ | RW | psam的输出工作模式 | 0 | 非1、2模式时，都当成0模式|

| psam_wmode值 | 成功行为 | 失败行为| 
| :----------: | :--: | :------: | 
| 0 | 加密卡号（认证后读取内部文件）| 物理卡号|
| 1 | 加密卡号（认证后读取内部文件）| 无 |
| 2 | 物理卡号（仅做外部认证）| 无 |

## 18. [安全模块配置](#title_back)
    该模块的配置为安全模块相关配置
- 配置字段详情如下

| 字段名 | 类型 | 外部可见性 | 外部读写性 | 功能描述 | 默认值 | 补充说明 |
| :--------------: | :----: | :--------: | :--------: | :-----------------------: | :----------------------------------------------------------: | :----------------------------: |
| safe_open | int | √ | RW | 安全模块使能 | 0 | 0：关闭 1：打开 |
| safe_keytype | int | √ | RW | 安全模块所有密钥类型 | 1 | 1：AES 2：SM2 4：SM4 |
| safe_key_pub | string | √ | RW | 密钥或SM2的公钥 | 5de3dd7f5b7 25c7d27f360 19a2ddd94f3 866e0d383c9 3bd51780e93 8a2ddda4f | 暂无补充说明 |
| safe_iv_pri | string | √ | RW | 向量或SM2的私钥 | 39fe007b83c 92bd527f360 19a2ddd94f5 da3dd7f1780 e93828e3601 a1d8cb9f8 | 暂无补充说明 |
| old_safe_key_pub | string | √ | - | 上一次旧的密钥或SM2的公钥 | 5de3dd7f5b7 25c7d27f360 19a2ddd94f3 866e0d383c9 3bd51780e93 8a2ddda4f | 暂无补充说明 |
| old_safe_iv_pri | string | √ | - | 上一次旧的向量或SM2的私钥 | 39fe007b83c 92bd527f360 19a2ddd94f5 da3dd7f1780 e93828e3601 a1d8cb9f8 | 暂无补充说明 |

-----
#         扫码器配置字段说明V3.0

## 一、sysinfo
| 字段 | 类型 | 属性 | 说明 |
| :-------- | :------- | :--- | :------------------------------------------- |
| uuid | char[16] | RW | 说明：设备唯一id,由设备根据硬件信息自动生成 |
| user_id | char[16] | RW | 说明：用户自定义id, 根据业务需求由户自己配置 |
| free_mem | uint64_t | R | 说明：剩余内存，单位：字节 |
| free_disk | uint64_t | R | 说明：剩余存储空间，单位：字节 |
| status | char[32] | RW | 说明：门禁设备的状态 0测试(未激活) 1正常 2禁用 |
## 二、passwd
| 字段 | 类型 | 属性 | 说明 |
| :----- | :------- | :--- | :---------------------------------- |
| passwd | char[16] | W | 说明：设备root管理密码,可用于配置等 |
## 三、decoder
| 字段 | 类型 | 属性 | 说明 |
| :------------- | :------- | :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| decoder | uint32_t | RW | 说明：解码引擎类型 默认 decoder = 1 |
| de_type | uint32_t | RW | 说明：码制类型 默认 de_type = 1 bit0 : VBAR_SYM_QRCODE bit1 : VBAR_SYM_EAN8 bit2 : VBAR_SYM_EAN13 bit3 : VBAR_SYM_ISBN13 bit4 : VBAR_SYM_CODE39 bit5 : VBAR_SYM_CODE93 bit6 : VBAR_SYM_CODE128 bit7 : VBAR_SYM_DATABAR bit8 : VBAR_SYM_DATABAR_EXP bit9 : VBAR_SYM_PDF417 bit10 : VBAR_SYM_DATAMATRIX bit11 : VBAR_SYM_ITF bit12 : VBAR_SYM_ISBN10 bit13 : VBAR_SYM_UPCE bit14 : VBAR_SYM_UPCA bit15 : VBAR_SYM_AZTEC bit16 : VBAR_SYM_CODABAR bit17 : VBAR_SYM_CODE11 bit18 : VBAR_SYM_TRIOPTIC bit19 : VBAR_SYM_TELEPEN bit20 : VBAR_SYM_STRT25 bit21 : VBAR_SYM_MATRIX25 bit22 : VBAR_SYM_CHINAPOST bit23 : VBAR_SYM_MSI bit24 : VBAR_SYM_CODABLOCK bit25 : VBAR_SYM_MAXICODE bit26 : VBAR_SYM_RSS |
| s_mode | uint32_t | RW | 说明：根据码内容的过滤策略 默认 s_mode = 0 0 : 间隔模式 1 : 单次模式 |
| interval | uint32_t | RW | 说明：间隔模式下的间隔时间 默认 interval = 200 单位：ms |
| qr_mode | uint32_t | RW | 说明：qr码的参数配置，默认不对外开放 默认 qr_mode = 15 bit0 : 支持图像占比较小的qr码 bit1 : 支持定位符不是方形的qr码，默认可不开 bit2 : qr码识别增强，针对医疗、异常、拉丝场景，普通场景可不开 bit3 : 打点qr码增强（耗时操作），普通场景可不开 bit4 : 支持无静区二维码（耗时操作），默认不开 |
| search_timeout | uint32_t | RW | 说明：检索码的超时时间，默认不对外开放，单位：ms 默认 search_timeout = 80 |
| decoder_timout | uint32_t | RW | 说明：解码的超时时间，默认不对外开放，单位：ms 默认 decoder_timeout = 100 |
| search_mode | uint32_t | RW | 说明：解码引擎对应的策略，默认不对外开放 不同引擎支持策略不同，详情联系具体开发 默认 search_mode = 0 |
| decoder_mode | uint32_t | RW | 说明：解码引擎特性配置 默认：decoder_mode = 3 bit0 : |
| ocr_template | string | RW | 说明：ocr识别模板 默认：ocr_template = "1&8&14&30&2&8&14&30&2&8&14&30&2&0" 详情参见解码引擎说明 |
| ocr_mode | uint32_t | RW | 说明：ocr模式 默认：ocr_mode = 1 1 : 开启普通ocr 2 : 开启反色ocr 3 : 同时开启正色和反色ocr 详情参见解码引擎说明 |
## 四、audio
| 字段 | 类型 | 属性 | 说明 |
| :--------- | :------- | :--- | :------------------------------------------------- |
| volume | uint16_t | RW | 说明：设备声音大小,0~256 默认 volume = 20 |
| beep | uint32_t | RW | 说明：设备声音开关,0-关，1-开 默认 beep = 1 |
| beep_delay | uint32_t | RW | 说明：设备声音动作延时时间 默认 beep_delay = 30 |
## 五、led
| 字段 | 类型 | 属性 | 说明 |
| :--------- | :------- | :--- | :----------------------------------------------------------------------------- |
| leds | uint32_t | RW | 说明：灯配置, 0x01-白灯，0x02-红灯， 0x04-绿灯， 0x08-蓝灯 默认 leds = 0x01 |
| brightness | uint32_t | RW | 说明：亮度, 默认 brightness = 200 |
| led_delay | uint32_t | RW | 说明：亮灯动作延时时间 默认 led_delay = 200 |