API ของ WPC3700

คำย่อ WPC: ตัวควบคุมพลังงาน Wi-Fi

API ของตัวควบคุมพลังงานรุ่น WPC

บทความนี้แนะนำ API ที่มีให้โดย ตัวควบคุมพลังงานรุ่น WPC เป็นหลัก ผ่าน API เหล่านี้ ผู้ใช้สามารถดำเนินการต่อไปนี้:

กำหนดค่าพารามิเตอร์ของ WPC
ควบคุมกำลังไฟฟ้าขาออกของ WPC

ใครควรอ่านบทความนี้

ส่วนนี้ถูกวางไว้ที่จุดเริ่มต้นเพราะถึงแม้ว่าเราเขียนบทความนี้ขึ้นมา แต่มันก็ไม่เกี่ยวข้องกับผู้ใช้ WPC ส่วนใหญ่

หากคุณมีตัวควบคุมพลังงานรุ่น WPC อยู่แล้ว มีโหมดการทำงานที่เป็นไปได้สองสามแบบ:

คุณได้ติดตั้งมิเตอร์ IAMMETER ที่ฝั่งกริดแล้วและใช้ WPC3700 โดยตรงร่วมกับ มิเตอร์ IAMMETER (WPC3700 ทำงานในโหมดอัตโนมัติ) ทำให้ WPC3700 ทำงานอย่างต่อเนื่องภายใต้การขับเคลื่อนของพลังงานแสงอาทิตย์ส่วนเกิน ซึ่งเป็นโซลูชัน IAMMETER ระบบควบคุมเครื่องทำความร้อนพลังงานแสงอาทิตย์
คุณไม่มีมิเตอร์ IAMMETER แต่คุณคุ้นเคยกับ Home Assistant หรือ Node-RED และได้รวม WPC3700 เข้ากับระบบอัตโนมัติของ HA หรือ Node-RED (เปิดใช้งาน MQTT discovery ใน Home Assistant ด้วยเฟิร์มแวร์ IAMMETER ล่าสุด (i.76.058.8))
คุณต้องเรียก API เพื่อรวม WPC3700 เข้ากับระบบของคุณเอง

เฉพาะผู้ใช้ที่ต้องการโหมดการทำงานแบบที่สามเท่านั้นที่ควรอ่านบทความนี้

/api/setpower

/api/setpower?x=100

คำแนะนำ

API นี้ควบคุมกำลังไฟฟ้าขาออกของ WPC

หมายเหตุ: พารามิเตอร์นี้สามารถแก้ไขได้ผ่าน API setadv (เรียก HTTP POST, พารามิเตอร์ setPower) เช่นกัน

เนื่องจากพารามิเตอร์ setPower อาจต้องถูกปรับเปลี่ยนบ่อยครั้งตามค่ากำลังไฟฟ้าของกริดแบบเรียลไทม์ จึงมีอินเทอร์เฟซ API แบบ HTTP GET เพิ่มเติมนี้ให้

URL และ Method

URL: http://{{IP}}/api/setpower

Method: HTTP GET

Parameter Name	Example Value	Unit	Required	Type	Description
x	100	W	Yes	int	แสดงถึงกำลังไฟฟ้าขาออกของ WPC ซึ่งเป็นพารามิเตอร์เดียวกับ `setPower` ใน `setadv`

/api/setadv

คำแนะนำ

API นี้ใช้สำหรับตั้งค่าพารามิเตอร์ของ WPC

หมายเหตุ: พารามิเตอร์ทั้งหมดสามารถตั้งค่าได้โดยตรงผ่าน UI มีเพียงลูกค้าจำนวนน้อยที่ต้องการรวมผลิตภัณฑ์รุ่น WPC เข้ากับระบบของตนเองเท่านั้นที่จะใช้ API นี้

URL และ Method

URL: http://{{Local IP of the WPC}}/api/setadv
Method: HTTP POST

พารามิเตอร์คำขอ

ด้านล่างนี้คือตัวอย่างของพารามิเตอร์ setadv

หมายเหตุ: เมื่อดำเนินการ setadv ไม่จำเป็นต้องส่งพารามิเตอร์ทั้งหมด มีเพียงพารามิเตอร์ที่ต้องการแก้ไขเท่านั้นที่ควรส่ง พารามิเตอร์ที่ไม่ต้องการแก้ไขไม่จำเป็นต้องส่ง คุณสามารถใช้ getadv อ่านการกำหนดค่าปัจจุบันก่อน แล้วจึงส่งเฉพาะพารามิเตอร์ที่ต้องการแก้ไข

{
  "maxPower": 3500,
  "setPower": 0,
  "restorePower": 0,
  "setPowerMode": 0,
  "meterAddress": "10.10.30.35",
  "threshold": 30,
  "hysteresis": 50,
  "startHour": 8,
  "stopHour": 18,
  "tzOffset": 8,
  "meterType": 0,
  "meterConfig": "3,2,1",
  "ntpServer": "ntp.aliyun.com",
  "haDiscovery": 1,
  "mqttEnabled": 1,
  "mqttAddress": "10.10.30.89:1883",
  "mqttUsername": "test",
  "mqttPassword": "123456",
  "uploadInterval": 6
}

การตอบกลับ

{
  "successful": 1,
  "message": "ok"
}

คำอธิบายพารามิเตอร์

Parameter Name	Type	Unit	Description
maxPower	int	W	กำลังไฟฟ้าสูงสุดของโหลดที่ถูกควบคุม ต้องน้อยกว่า 3700
setPower	int	W	กำลังไฟฟ้าขาออกของ WPC
restorePower	int	W	กำลังไฟฟ้าหลังจากออกจากการควบคุมโหมดอัตโนมัติ
setPowerMode	int		การเลือกโหมดการทำงาน: 0: Manual, 1: Auto
threshold	int	W	ในโหมดอัตโนมัติ นี่คือเกณฑ์สำหรับการปรับตามกำลังไฟฟ้าของกริด
hysteresis	int	W	ในโหมดอัตโนมัติ นี่คือค่าฮิสเทอรีซิสสำหรับการปรับตามกำลังไฟฟ้าของกริด
startHour	int	hour	เวลาเริ่มต้นของโหมดอัตโนมัติ
stopHour	int	hour	เวลาสิ้นสุดของโหมดอัตโนมัติ
tzOffset	int		ค่าชดเชยเขตเวลา
meterType	int		ตัวเลือกยี่ห้อมิเตอร์สำหรับการวัดกริดในโหมดอัตโนมัติ: 0:iMeter, 1:virtualTCP
meterConfig	string		ตัวเลือกรุ่นมิเตอร์สำหรับการวัดกริดในโหมดอัตโนมัติ: 3:three phase, 2:use phaseB, 1:ratio
ntpServer	string		ที่อยู่เซิร์ฟเวอร์ NTP
haDiscovery	int		เปิดใช้งาน Home Assistant MQTT auto discovery: 0: disable, 1: enable
mqttEnabled	int		เปิดใช้งาน MQTT: 0: disable, 1: enable
meterAddress	string		ที่อยู่ MQTT broker จำเป็นเมื่อรวมเข้ากับ Home Assistant: 192.168.1.22:1833
mqttUsername	string		ชื่อผู้ใช้ MQTT
mqttPassword	string		รหัสผ่าน MQTT
uploadInterval	int	s	ระยะเวลาการอัปโหลด

/api/getadv

คำแนะนำ

API นี้อ่านค่าพารามิเตอร์ทั้งหมดของ WPC (พารามิเตอร์ทั้งหมดจาก API setadv สามารถอ่านได้ที่นี่)

URL และ Method

URL: http://{{Local IP of the WPC}}/api/getadv
Method: HTTP GET

การตอบกลับ

{
  "maxPower": 3500,
  "setPower": 0,
  "restorePower": 0,
  "setPowerMode": 0,
  "setPowerModeList": "Manual,Auto",
  "meterAddress": "10.10.30.35",
  "threshold": 20,
  "hysteresis": 30,
  "startHour": 8,
  "stopHour": 18,
  "tzOffset": 8,
  "meterType": 0,
  "meterConfig": "3,2,1",
  "meterList": "iMeter,virtualTCP",
  "ntpServer": "ntp.aliyun.com",
  "haDiscovery": 0,
  "mqttEnabled": 0,
  "mqttAddress": "192.168.1.22:1833",
  "mqttUsername": "test",
  "mqttPassword": "123456",
  "uploadInterval": 60
}

อ้างอิงคำอธิบายพารามิเตอร์ใน setadv

/api/setwifiadv

คำแนะนำ

API นี้กำหนดค่าพารามิเตอร์ Wi-Fi สำหรับอุปกรณ์ WPC/WEM

URL และ Method

URL: http://{{Local IP of the WPC}}/api/setwifiadv
Method: HTTP POST

พารามิเตอร์คำขอ

{
    "ssid":"xxxx",
    "pwd":"xxxx",
    "ip":"xxxx",
    "netmask":"xxxxx",  
    "gw":"xxxx",
    "dns":"192.168.1.1",
    "dhcp":true,
    "runMode":"cloud", // cloud, tcp, http
    "uploadAddress":"http://myserver.com/upload" // Useful only if runMode is non-cloud
}

การตอบกลับ

{
    "successful": true,
    "message": "ok"
}

คำอธิบายพารามิเตอร์

Parameter Name	Type	Description
ssid	string	ชื่อ AP Wi-Fi สำหรับการเชื่อมต่อ WLAN
pwd	string	รหัสผ่าน Wi-Fi สำหรับการเชื่อมต่อ WLAN
ip	string	IP แบบคงที่ ไม่จำเป็นหากใช้โหมด DHCP
netmask	string	Netmask ไม่จำเป็นหากใช้โหมด DHCP
gw	string	Gateway ไม่จำเป็นหากใช้โหมด DHCP
dns	string	เซิร์ฟเวอร์ DNS ไม่จำเป็นหากใช้โหมด DHCP
dhcp	bool	false: ปิดการใช้งาน DHCP, true: เปิดการใช้งาน DHCP