[JavaScript知识库]Electron 标准式系列软件统一API文档记录

标准式系列软件统一API

(点击跳转)

获取IP地址

请求接口：/ip
请求方法：GET
携带参数：无
请求示例：

CsszMethod('ip').then((res) => {
	console.log(res)
})

获取串口端口列表

请求接口：/getPortName
请求方法：GET
携带参数：无

请求示例：

CsszMethod('getPortName').then((res) => {
    console.log(res)
})

重启程序

请求接口：/reload
请求方法：GET
携带参数：无
请求示例：

CsszMethod('reload')

重启程序到某页面

请求接口：/reloadToPage
请求方法：GET
携带参数：

请求示例：

CsszMethod('reloadToPage',{
	mode:'view'
})

配置信息更新

请求接口：/setConfig
请求方法：GET
携带参数：

请求示例：

CsszMethod('setConfig',{
    config:'{"isOpenUDP":"0","sonPort":"8680",koaPort":"本地服务器端口"}}'
}).then((res) => {
    console.log(res)
})

配置信息获取

请求接口：/getConfig
请求方法：GET
携带参数：无

请求示例：

CsszMethod('getConfig').then((res) => {
    console.log(res)
})

打开配置信息界面

请求接口：/openConfig
请求方法：GET
携带参数：无

请求示例：

CsszMethod('openConfig')

关闭配置信息界面

请求接口：/closeConfig
请求方法：GET
携带参数：无

请求示例：

CsszMethod('closeConfig')

获取软件序列号

请求接口：/appuid
请求方法：GET
携带参数：无

请求示例：

CsszMethod('appuid').then((res) => {
    console.log(res)
})

激活软件

请求接口：/reg
请求方法：GET
携带参数：

请求示例：

CsszMethod('reg',{
    key:'56216asfasgsg5a2gas6g62asf'
})

查看软件激活状态

请求接口：/regStatus
请求方法：GET
携带参数：无

请求示例：

CsszMethod('regStatus').then((res) => {
    console.log(res)
})

退出程序

请求接口：/quit
请求方法：GET
携带参数：无

请求示例：

CsszMethod('quit')

切换页面

请求接口：/pageMode
请求方法：GET
携带参数：

请求示例：

CsszMethod('pageMode',{
	mode:'view'
})

打开工具

请求接口：/opendev
请求方法：GET
携带参数：

请求示例：

CsszMethod('opendev',{
	mode:'left'
})

关闭工具

请求接口：/closedev
请求方法：GET
携带参数：无

请求示例：

CsszMethod('closedev')

视频流播放

请求接口：/video
请求方法：GET
携带参数：（文件路径）
请求示例：

//原路径：
<video src="/upload/视频/demo.mp4">
//更改路径：
<video src="/video/视频/demo.mp4">

创建/打开文件目录

请求接口：/openDirFile
请求方法：GET
携带参数：

请求示例：

CsszMethod('openDirFile',{
    name:"demo",
    mode:"others",
}).then((res) => {
    console.log(res)
})

获取模板数据

请求接口：/getPreset
请求方法：GET
携带参数：无

请求示例：

CsszMethod('getPreset').then((res) => {
    console.log(res)
})

创建模板文件

请求接口：/savePreset
请求方法：GET
携带参数：

请求示例：

CsszMethod('savePreset',{ data: obj }).then((res) => {
    console.log(res)
})

重新编辑 删除模板文件

请求接口：/resetPreset
请求方法：GET
携带参数：无

请求示例：

CsszMethod('resetPreset')

读取文件内容

请求接口：/readFiles
请求方法：GET
携带参数：

请求示例：

CsszMethod('readFiles',{
    filePath:'/upload/demo.txt'
}).then((res) => {
    console.log(res)
})

获取路径文件与目录

请求接口：/getFiles
请求方法：GET
携带参数：

请求示例：

CsszMethod('getFiles',{
    path:'/upload/图片',
    mode:'fileUrl'
}).then((res) => {
    console.log(res)
})

统一上传

请求接口：/upload
请求方法：POST
携带参数：

请求示例：

<!-- <input multiple onchange="uploadDir(this,this.files)" type="file" accept="image/png,image/jpg,image/jpeg" /> -->

let data = new FormData();
for (let i = 0; i < file.length; i++) {
	data.append("myfile" + i, file[i]);
}
CsszMethodPost('upload', data).then(res => {
	console.log(res)
})

发送UDP指令

请求接口：/sendUdp
请求方法：GET
携带参数：

请求示例：

CsszMethod('sendUdp',{
    data: 'videoPlay'
})

公共功能代码备注

指令接收器

数组内的字符串代表自行封装的控制函数名称，函数无参则只写名称，有参数则使用 | 隔开，形式为：函数名称 | 参数。

只要中控发出指令，中控将发给后端，后端通知前端 orderName 函数并自动执行指令。

// 指令接收
function orderName(order) {
	console.log(order);
	[
		//跳转播放图片页面
		'playImgOrVideo|img',
		//跳转播放视频页面
		'playImgOrVideo|video',
		// 返回主界面
		'home',
		//上一张图
		'prevSlideImg',
		//下一张图
		'nextSlideImg',
		//暂停播放当前图片
		'pauseImg',
		//继续播放当前图片
		'resumeImg',
		//设置为自动轮播图片
		'autoPlayImg|true',
		//设置为手动轮播图片
		'autoPlayImg|false',
		//继续播放当前视频
		'videoPlay',
		//暂停播放当前视频
		'videoStop',
		//停止播放当前视频，进度条归初始化
		'videoStops',
		//增加音量
		'videoAddVolume',
		//减少音量
		'videoSubVolume',
		//上一个视频
		'prevVideo',
		//下一个视频
		'nextVideo',
		// //设置视频播放模式为单视频循环
		'videoModes|loop',
		//设置视频播放模式为列表视频循环
		'videoModes|next',
		//设置视频播放模式为当前视频播放结束返回主页
		'videoModes|stop'
	].forEach(item => {
		// 执行方法
		if (item == order) {
			if (order.indexOf('|') > -1) {
				if (item.split('|')[1] == 'true' || item.split('|')[1] == 'false') {
					eval(`${item.split('|')[0]}(${item.split('|')[1]})`)
				} else {
					eval(`${item.split('|')[0]}('${item.split('|')[1]}')`)
				}
			} else {
				eval(`${item}()`)
			}
		}
	})
}

统一上传进度监听器

使用统一上传的接口后，可在前端写好 uploading 函数，上传过程中后端将自动执行函数并返回当前进度数，进度从0-100。

function uploading(loadnum){
	console.log(loadnum)//20
}

全局服务监听

键盘功能监听

• 按 F4 重新注册
• 按 F5 刷新界面
• 按 F6 切换展示模式
• 按 F7 切换编辑模式
• 按 F8 打开配置文件
• 按 F9 切换开发模式
• 按 F10 重新编辑
• 按 F11 查看软件激活状态
• 按 F12 切换开发工具

预配置功能服务

UDP通信服务

UDP通信服务是一个非常特殊的通信方式，它既可以当作客户端通信使用，也可以当作服务端使用，基本属于“双性人”了，所以解释起来也挺绕口。

既可以称作被控端，也可以称作中控端。

通信端口及通信IP地址用作发送数据设置，本地开放通信端口用作接收数据。

（开启服务才可使用）

本地开放通信端口：顾名思义，本地开放端口，是为了让另一端远程控制使用本机功能的必要操作，只有开放端口窗才能让另一端数据指令接收进来并由程序函数自动执行控制。一般设置端口号为8000-9000的安全范围。

通信端口：发送数据给另一端接收时需要设置对方开放的本地开放通信端口。若该端需要发送指令数据等信息给另一端，就必须填写对方端的本地开放通信端口。

通信IP地址：发送数据给另一端接收时需要设置对方的IP地址。若该端需要发送指令数据等信息给另一端，就必须填写对方端的IP地址。

串口通讯服务

（开启服务才可使用）

端口、波特率、数据位、校验位、停止位预设数据一般按照硬件设备说明书填写。

其余快捷服务

设置日志打印：为了技术开发人员软件维护便利，最好一直开启日志服务。

设置独显运行：假如程序需要加载大量动画元素，最好开启独显运行，减少CPU的压力，但没有显卡的机器则不建议开启，因为有几率会程序闪退无法运行。一般便于现场维护开启。

设置副屏显示：便于技术开发者双屏测试软件，又或者项目需求特殊。一般便于开发者调试，现场维护不改。

设置开机自启：便于展厅开机自启程序，无需手动打开程序。一般便于现场维护开启。

本地服务器端口：程序加载的资源需要内部服务器进行读取，且重复运行程序逻辑也是由此端口是否重复开启作为判断标准。一般便于开发者调试，现场维护不改。

创作打卡挑战赛

赢取流量/现金/CSDN周边激励大奖