0.2.5 • Published 4 years ago
jarvis-server v0.2.5
Jarvis Server
Jarvis 服务器端, 查看演示项目
安装
$ npm i jarvis-server
使用
const JarvisServer = require('jarvis-server')
const server = new JarvisServer({
port: 3000,
secrets: '5r9b4vto246doa9hwk55rr'
})
参数说明:
并支持 ws 的所有参数
参数名 | 说明 | 类型 | 必填 |
---|---|---|---|
port | 端口号 | number | true |
secrets | 链接密码 | string | true |
sendToReplica 接口
当没有控制端时, 我们可以通过 server.sendToReplica(command, args)
接口, 直接从服务器端向受控端发送指令
参数说明:
参数名 | 说明 | 类型 | 必填 |
---|---|---|---|
command | 指令名称 | number | true |
args | 参数 | number | string | object | true |
接收http指令
server
支持直接接收 http
请求, 并将指令派发给受控端
需指定请求路径为 /command
, 请求类型为 POST
设置请求头(secrets
为服务端约定的密钥):
Content-Type 'application/json'
Authorization Bearer <secrets>
参数格式:
{
type: 'custom command',
args: object | number | string
}
其他
服务端和受控端的使用方式, 可查阅下方文档