Nayota SuperService SDK

这个SDK提供了与Nayota超级服务(SuperService)进行交互的接口，用于系统管理、网络配置和服务管理等功能。

安装

npm install nayota-superService-sdk

使用方法

初始化

import superServiceSDK from 'nayota-superService-sdk'

// 配置SDK
superServiceSDK.config({
  superServiceServer: 'http://your-server-url/api/super-service' // 设置服务器地址
})

// 监听错误事件
superServiceSDK.on('error', (errorMessage) => {
  console.error('API错误:', errorMessage)
})

功能模块

网络管理

提供网络接口信息查询和配置功能。

// 获取所有网络接口信息
superServiceSDK.network.getAllInterfaces().then(res => {
  console.log('网络接口列表:', res.data)
})

// 获取特定网络接口的详细信息
superServiceSDK.network.getInterfaceDetails('eth0').then(res => {
  console.log('eth0接口信息:', res.data)
})

// 更新网络接口配置 - 静态IP
superServiceSDK.network.updateInterfaceConfig('eth0', {
  ipMethod: 'static',
  ip4: '192.168.1.100',
  gateway4: '192.168.1.1',
  dns: ['8.8.8.8', '8.8.4.4']
}).then(res => {
  console.log('更新成功:', res.data)
})

// 更新网络接口配置 - DHCP
superServiceSDK.network.updateInterfaceConfig('eth0', {
  ipMethod: 'dhcp'
}).then(res => {
  console.log('更新成功:', res.data)
})

WiFi管理

提供WiFi网络连接和配置功能。

// 获取WiFi配置信息（包含扫描到的网络列表）
superServiceSDK.network.getWifiConfig().then(res => {
  console.log('WiFi配置:', res.data)
  console.log('当前连接的网络:', res.data.ssid)
  console.log('扫描到的网络:', res.data.networks)
})

// 连接到WiFi网络
superServiceSDK.network.setWifiConfig({
  ssid: 'MyWifiNetwork',
  password: 'mypassword123'
}).then(res => {
  console.log('WiFi连接成功:', res.data)
})

AP热点管理

提供AP热点的创建、配置和控制功能。

// 获取AP热点状态
superServiceSDK.network.getAPStatus().then(res => {
  console.log('AP状态:', res.data)
  console.log('是否运行:', res.data.isRunning)
  console.log('热点名称:', res.data.ssid)
})

// 启动AP热点
superServiceSDK.network.controlAP('start').then(res => {
  console.log('AP热点已启动:', res.data)
})

// 停止AP热点
superServiceSDK.network.controlAP('stop').then(res => {
  console.log('AP热点已停止:', res.data)
})

// 重启AP热点
superServiceSDK.network.controlAP('restart').then(res => {
  console.log('AP热点已重启:', res.data)
})

// 设置AP热点配置
superServiceSDK.network.setAPConfig({
  ssid: 'MyHotspot',
  password: 'mypassword123'
}).then(res => {
  console.log('AP配置已更新:', res.data)
})

// 启用AP热点开机自启
superServiceSDK.network.setAPAutoStart(true).then(res => {
  console.log('AP开机自启已启用:', res.data)
})

// 禁用AP热点开机自启
superServiceSDK.network.setAPAutoStart(false).then(res => {
  console.log('AP开机自启已禁用:', res.data)
})

API文档

详细的API文档请参考各模块的JSDoc注释。

错误处理

所有API调用都会返回Promise，可以使用then/catch进行处理：

superServiceSDK.network.getAllInterfaces()
  .then(res => {
    console.log('成功:', res)
  })
  .catch(err => {
    console.error('错误:', err)
  })

也可以使用事件监听统一处理错误：

superServiceSDK.on('error', (errorMessage) => {
  console.error('API错误:', errorMessage)
})