Overview

เอกสารนี้อธิบายมาตรฐานการเชื่อมต่อ (API Specification) สำหรับนักพัฒนาในการเชื่อมระบบเข้ากับ CORNTROL โดยมีตัวอย่างการใช้งานหลัก เช่น การยืนยันตัวตนด้วย x-api-key, เรียกดูรายการอุปกรณ์, รายละเอียดอุปกรณ์ และรายงานอุณหภูมิ

สร้าง API Key (ผ่านแอปฯ CORNTROL)

ผู้ใช้งานจำเป็นต้องติดตั้งแอปพลิเคชัน CORNTROL บนอุปกรณ์ (เช่น สมาร์ตโฟนหรือแท็บเล็ต) และเข้าสู่ระบบด้วยบัญชีผู้ใช้งานที่ถูกต้องก่อน จึงจะสามารถสร้างและจัดการ API Key ได้

ขั้นตอน

Authentication

ส่ง API Key ของคุณใน HTTP header x-api-key ทุกครั้งที่มีการเรียกใช้งาน (request)

Copyx-api-key: YOUR_API_KEY

Devices

เรียกดูรายการอุปกรณ์ — GET /devices

พารามิเตอร์สำหรับ Query:

Copycurl -X GET "https://YOUR_BASE_URL/devices?page=1&limit=20"   -H "x-api-key: YOUR_API_KEY"

Copy JSON{
    "code": 200,
    "message": "ok",
    "data": {
        "page": 1,
        "limit": 20,
        "totalPages": 1,
        "totalResults": 1,
        "results": [
            {
                "deviceInfo": {
                    "name": "Device No.1",
                    "description": "Testing Equipment in the Laboratory",
                    "macAddress": "AABBCCDD11",
                    "imageUrl": null
                },
                "lineVoltage": 231,
                "subscriptionPlan": "professional",
                "status": "normal",
                "mode": "automationSchedule",
                "timeZone": "Asia/Bangkok",
                "location": {
                    "placeName": "Shop 1",
                    "latitude": null,
                    "longitude": null
                },
                "temperature": {
                    "setPoint": 22,
                    "hightTempAlarmThreshold": 35,
                    "lowTempAlarmThreshold": 0.5,
                    "temperatureUnit": "°C",
                    "sensors": [
                        {
                            "id": "sensor1",
                            "value": 29.7,
                            "instantValue": 29.7
                        },
                        {
                            "id": "sensor2",
                            "value": 28.8,
                            "instantValue": 28.8
                        }
                    ]
                },
                "actuators": {
                    "isPowerOn": true,
                    "isDefrostOn": false,
                    "isLightOn": false,
                    "isFanOn": true,
                    "isWifiEnabled": true,
                    "isCompressorOn": true,
                    "isDoorOpen": false,
                    "isAlarmActive": false,
                    "auxRelay1": false,
                    "flashing": {
                        "isDefrostFlashing": false,
                        "isFanFlashing": false,
                        "isCompressorFlashing": false,
                        "isAlarmFlashing": false
                    }
                },
                "wifi": {
                    "ssid": "Matherchip_WiFi_2.4G",
                    "rssi": -63
                },
                "firmware": {
                    "mainVersion": "0.2.7",
                    "mainUpdatedAt": "2024-07-22T11:16:57.000Z",
                    "wifiVersion": "1.2.2",
                    "wifiUpdatedAt": "2025-02-27T04:33:13.000Z",
                    "configVersion": "0.1.6"
                },
                "alarm": {
                    "isBuzzerEnabled": false,
                    "hasActiveAlarm": false,
                    "activeCodes": []
                },
                "createdAt": "2025-02-14T09:01:30.793Z",
                "updatedAt": "2025-09-08T04:22:01.538Z"
            }
        ]
    }
}

เรียกดูข้อมูลอุปกรณ์ (Get Device) — GET /devices/{deviceMacAddress}

พารามิเตอร์สำหรับ Query:

Copycurl -X GET "https://YOUR_BASE_URL/devices/AABBCCDD11"   -H "x-api-key: YOUR_API_KEY"

Copy JSON{
    "code": 200,
    "message": "ok",
    "data": {
        "deviceInfo": {
            "name": "Device No.1",
            "description": "Testing Equipment in the Laboratory",
            "macAddress": "AABBCCDD11",
            "imageUrl": null
        },
        "lineVoltage": 232,
        "subscriptionPlan": "professional",
        "status": "normal",
        "mode": "automationSchedule",
        "timeZone": "Asia/Bangkok",
        "location": {
            "placeName": "Shop 1",
            "latitude": null,
            "longitude": null
        },
        "temperature": {
            "setPoint": 22,
            "hightTempAlarmThreshold": 35,
            "lowTempAlarmThreshold": 0.5,
            "temperatureUnit": "°C",
            "sensors": [
                {
                    "id": "sensor1",
                    "value": 29.5,
                    "instantValue": 29.5
                },
                {
                    "id": "sensor2",
                    "value": 28.7,
                    "instantValue": 28.7
                }
            ]
        },
        "actuators": {
            "isPowerOn": true,
            "isDefrostOn": false,
            "isLightOn": false,
            "isFanOn": true,
            "isWifiEnabled": true,
            "isCompressorOn": true,
            "isDoorOpen": false,
            "isAlarmActive": false,
            "auxRelay1": false,
            "flashing": {
                "isDefrostFlashing": false,
                "isFanFlashing": false,
                "isCompressorFlashing": false,
                "isAlarmFlashing": false
            }
        },
        "wifi": {
            "ssid": "Matherchip_WiFi_2.4G",
            "rssi": -63
        },
        "firmware": {
            "mainVersion": "0.2.7",
            "mainUpdatedAt": "2024-07-22T11:16:57.000Z",
            "wifiVersion": "1.2.2",
            "wifiUpdatedAt": "2025-02-27T04:33:13.000Z",
            "configVersion": "0.1.6"
        },
        "alarm": {
            "isBuzzerEnabled": false,
            "hasActiveAlarm": false,
            "activeCodes": []
        },
        "createdAt": "2025-02-14T09:01:30.793Z",
        "updatedAt": "2025-09-08T05:17:00.530Z"
    }
}

📘 สถานะของอุปกรณ์ (status field)

📘 รหัสการแจ้งเตือน (activeCodes)

ใช้สำหรับแสดงรายการ "รหัสการแจ้งเตือน (Alarm Codes)" ที่อุปกรณ์กำลังทำงานอยู่ ณ ขณะนั้น

Copy JSON"alarm": {
  "activeCodes": ["E0", "E1"]
}

Temperature Report

ดึงข้อมูลอุณหภูมิแบบต่อเนื่องตามช่วงเวลาของอุปกรณ์

เรียกดูรายงานอุณหภูมิ — GET /device-report/{deviceMacAddress}/temperature

พารามิเตอร์สำหรับ Query:

Copycurl -G "https://YOUR_BASE_URL/device-report/{deviceMacAddress}/temperature?from=2025-09-01 02:00:00&to=2025-09-01 03:20:00&limit=20&cursor=2025-09-01T02:19:00.000Z&order=asc"   -H "x-api-key: YOUR_API_KEY"  --data-urlencode "deviceMacAddress=AABBCCDD11"

Copy JSON{
    "code": 200,
    "message": "ok",
    "data": {
        "limit": 20,
        "nextCursor": "2025-09-01T02:39:00.000Z",
        "hasMore": true,
        "results": [
            {
                "timestamp": "2025-09-01T02:20:00.000Z",
                "setpoint": 22,
                "highTempAlarmThreshold": 35,
                "lowTempAlarmThreshold": 0.5,
                "sensors": [
                    {
                        "id": "sensor1",
                        "value": 30.2,
                        "instantValue": 30.2
                    },
                    {
                        "id": "sensor2",
                        "value": 29.4,
                        "instantValue": 29.4
                    }
                ]
            },
            {
                "timestamp": "2025-09-01T02:21:00.000Z",
                "setpoint": 22,
                "highTempAlarmThreshold": 35,
                "lowTempAlarmThreshold": 0.5,
                "sensors": [
                    {
                        "id": "sensor1",
                        "value": 30.2,
                        "instantValue": 30.2
                    },
                    {
                        "id": "sensor2",
                        "value": 29.3,
                        "instantValue": 29.3
                    }
                ]
            }
        ]
    }
}

ตัวอย่างตารางการตอบกลับเมื่อเกิดข้อผิดพลาด (Error Responses)