inSona API 开发者文档

总览

快速开始

1. 获取网关IP地址，通过inSona APP操作添加网关设备
2. 进入网关页面，查看网关设备IP
3. 通过控制TCP连接与网关建立会话

建立TCP连接

通过TCP建立网络连接，网关端口号为：8091

Python示例

from socket import *

HOST = '127.0.0.1'  # 或 'localhost'
PORT = 8091
BUFSIZ = 1024
ADDR = (HOST, PORT)

tcpCliSock = socket(AF_INET, SOCK_STREAM)
tcpCliSock.connect(ADDR)

控制协议

消息内容

客户端和网关之间使用JSON格式的消息进行交互，消息基于TCP协议进行传递；消息之间以"\r\n"作分隔

请求消息的基本格式：

{
    "version": 1,
    "uuid": 1234,
    "type": "all",
    "method": "c.query"
}

字段定义

支持的消息方法

设备同步

客户端发起同步请求

{
    "version": 1,
    "uuid": 1234,
    "type": "all",
    "method": "c.query"
}

服务端返回设备信息

设备功能类型

完整响应示例

{
    "version": 1,
    "uuid": 1234,
    "method": "s.query",
    "result": "ok",
    "rooms": [{
        "roomId": 6,
        "name": "办公区"
    }, {
        "roomId": 14,
        "name": "会议室"
    }],
    "devices": [{
        "did": "ECC57F10015800",
        "pid": 3,
        "ver": "61719",
        "type": 1984,
        "alive": 1,
        "roomId": 2,
        "name": "左",
        "func": 0,
        "funcs": [],
        "value": []
    }, {
        "did": "ECC57F1003E000",
        "pid": 3,
        "ver": "61719",
        "type": 1984,
        "alive": 1,
        "roomId": 2,
        "name": "右",
        "func": 0,
        "funcs": [],
        "value": []
    }]
}

设备控制

客户端发起控制设备请求

Action 和 Value 说明

控制示例

{
    "version": 1,
    "uuid": 1,
    "method": "c.control",
    "did": "F0ACD777770300",
    "action": "onoff",
    "value": [0],
    "transition": 0
}

表示把设备"F0ACD777770300"设为关闭

{
    "version": 1,
    "uuid": 1,
    "method": "c.control",
    "did": "a0",
    "action": "level",
    "value": [30],
    "transition": 0
}

表示把组设备"a0"设为亮度30%

服务器主动上报Event

设备状态改变示例

{
    "version": 1,
    "uuid": 14,
    "method": "s.event",
    "evt": "status",
    "did": "F0ACD777770300",
    "func": 2,
    "value": [0]
}

表示设备"F0ACD777770300"被关了

{
    "version": 1,
    "uuid": 16,
    "method": "s.event",
    "evt": "status",
    "did": "F0ACD777770300",
    "func": 4,
    "value": [15, 50]
}

表示设备"F0ACD777770300"亮度色温被调到15%,50%

场景控制

同步场景数据

{
    "version": 1,
    "uuid": 1234,
    "method": "c.query.scene"
}

服务端返回场景信息

{
    "version": 1,
    "uuid": 0,
    "method": "s.query.scene",
    "scenes": [{
            "sceneId": 2,
            "name": "喝茶"
        },
        {
            "sceneId": 4,
            "name": "会议"
        }
    ]
}

场景控制请求

{
    "version": 1,
    "uuid": 1,
    "method": "c.control",
    "action": "scene",
    "value": [33],    // 此value为上面同步获取的场景ID 
    "transition": 0
}

代码示例

# 连接网关
import socket
import json

def connect_gateway(ip, port=8091):
    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    sock.connect((ip, port))
    return sock

# 发送查询请求
def send_query(sock, uuid):
    query = {
        "version": 1,
        "uuid": uuid,
        "type": "all",
        "method": "c.query"
    }
    sock.send(json.dumps(query).encode() + b'\r\n')

// TCP连接示例 (Node.js)
const net = require('net');

const client = new net.Socket();
client.connect(8091, '127.0.0.1', () => {
    console.log('Connected to gateway');
    
    const query = {
        version: 1,
        uuid: Date.now(),
        type: 'all',
        method: 'c.query'
    };
    
    client.write(JSON.stringify(query) + '\r\n');
});