1.0.7 • Published 1 year ago
electroniclabel v1.0.7
ElectronicLabel
一个用于控制 ST203(AT703)拣货标签的 Node.js 项目。
安装
运行以下命令以安装该包:
npm install electroniclabel
配置
在使用 electroniclabel
包之前,请根据 config.example.js
文件创建一个 config.js
文件,并配置控制器的IP地址和端口。
// config.example.js
export const HOST = '10.0.50.100'; // ST203控制器的IP地址
export const PORT = 4660; // ST203控制器的端口
将上述代码复制到一个新的 config.js
文件中,并根据实际情况修改 IP 地址和端口。
使用方法
以下是如何在项目中使用 electroniclabel
包的示例:
import { ST203Controller } from 'electroniclabel';
import { HOST, PORT } from './config.js'; // 确保config.js在项目中存在并配置正确
const controller = new ST203Controller(HOST, PORT);
(async () => {
try {
await controller.connect();
// 控制LED灯
await controller.turnOnLight(0x01, 'red');
await controller.turnOffLight(0x01);
await controller.blinkLight(0x01, 'green');
await controller.stopBlinkLight(0x01);
await controller.displayNumber(0x01, 123);
await controller.clearDisplay(0x01); // 清除显示内容
// 注册按钮按下事件监听器
controller.on('buttonPress', (address, buttonCode) => {
console.log(`标签 ${address} 上的按钮被按下: 按钮代码 ${buttonCode}`);
});
// 保持程序运行
setInterval(() => {}, 1000);
// 程序退出时关闭控制器
process.on('SIGINT', () => {
controller.close();
process.exit();
});
} catch (err) {
console.error('Failed to connect to the controller: ', err);
}
})();
功能
控制LED灯
- 打开LED灯并指定颜色(红色、绿色、蓝色、黄色、紫色、青色)
- 关闭LED灯
- 使LED灯闪烁并指定颜色
- 停止LED灯闪烁
在拣货标签上显示数字
- 显示任意3位数字
清除显示内容
- 清除7段式LED显示内容或清除所有消息缓冲
区
监听按钮按下事件
- 处理按钮按下事件并相应地调整显示的数字
关闭控制器
- 关闭与ST203控制器的连接并释放资源
API
ST203Controller
构造函数
new ST203Controller(host, port)
- 创建一个新的ST203控制器实例。
host
- ST203控制器的IP地址。port
- ST203控制器的端口。
方法
async connect()
- 连接到ST203控制器。
async turnOnLight(address, color)
- 打开指定地址设备的LED灯并指定颜色。
address
- 设备的地址。color
- LED灯的颜色(可选:'red', 'green', 'blue', 'yellow', 'purple', 'cyan')。
async turnOffLight(address)
- 关闭指定地址设备的LED灯。
address
- 设备的地址。
async blinkLight(address, color)
- 使指定地址设备的LED灯闪烁并指定颜色。
address
- 设备的地址。color
- LED灯的颜色(可选:'red', 'green', 'blue', 'yellow', 'purple', 'cyan')。
async stopBlinkLight(address)
- 停止指定地址设备的闪烁LED灯。
address
- 设备的地址。
async displayNumber(address, number)
- 在指定地址设备上显示一个3位数字。
address
- 设备的地址。number
- 要显示的数字。
async clearDisplay(address)
- 清除指定地址设备的7段式LED显示内容或清除所有消息缓冲区。
address
- 设备的地址。
close()
- 关闭与ST203控制器的连接并释放资源。
事件
buttonPress
- 当设备上的按钮被按下时触发。
address
- 设备的地址。buttonCode
- 被按下的按钮代码。
许可证
MIT