Wake-on-LAN utilities for node.js 技术文档

1. 安装指南

在您的项目中安装 wake-on-lan 库，您可以使用以下 npm 命令：

npm install wake_on_lan --save  # 使用库

如果您希望全局安装 wake 实用工具，可以使用以下命令：

npm install wake_on_lan -g      # 可选的全局 wake 实用工具

2. 项目使用说明

本项目提供了一种在 Node.js 中发送 Wake-on-LAN (WOL) 魔术包的方法，用于远程开启或唤醒支持网络开机的设备。

发送魔术包

要唤醒具有给定 MAC 地址的设备，请执行以下操作：

var wol = require('wake_on_lan');

wol.wake('20:DE:20:DE:20:DE');

// 或者使用回调函数来处理完成或错误
wol.wake('20:DE:20:DE:20:DE', function(error) {
  if (error) {
    // 处理错误
  } else {
    // 所有数据包发送完毕
  }
});

// 创建一个魔术包并发送
var magic_packet = wol.createMagicPacket('20:DE:20:DE:20:DE');

MAC 地址字符串可以使用多种分隔符或无分隔符：

'20:DE:20:DE:20:DE'
'20-DE-20-DE-20-DE'
'20DE20DE20DE'

3. 项目API使用文档

本项目提供了以下两个主要函数：

函数 wake()

wake(mac, [options, callback])
```

向指定的 MAC 地址发送一系列 Wake-on-LAN 魔术包。当所有数据包发送完毕或发生错误时，将调用回调函数。`options` 对象可以包含以下属性：

| 属性 | 描述 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `address` | 目标地址 | 字符串 | 255.255.255.255 |
| `num_packets` | 发送的数据包数量 | 数值 | 3 |
| `interval` | 数据包发送间隔，单位为毫秒 | 数值 | 100 |
| `port` | 目标端口号 | 数值 | 9 |

### 函数 createMagicPacket()

createMagicPacket(mac)

返回一个包含给定 MAC 地址的魔术包的 Buffer。

## 4. 项目安装方式

请参考上述安装指南部分，使用 npm 命令安装 wake-on-lan 库。