Query Device List

Query Devices

Request Format

GET ecos-hub/v1/devices HTTP/1.1

Request Parameters

Request Query Parameters

Parameter NameTypeRequiredExampleDescription
pageintNo1Pagination parameter, default is 1
sizeintNo10Page size for pagination, default is 10, maximum is 500
device_namestringNo"dddd"Device name
wifi_snstringNo"dddd"

Response Parameters

Response Body Parameters

Parameter NameTypeExampleDescription
request_idstring"ddddd"Request ID
dataArray[Object]["ddd","ddd"]Query results
totalint64100Total devices
current_pageint100Page number

data

Query Result Array

Parameter NameTypeExampleDescription
device_snstring"SHA6021312021CL001"Device SN
wifi_snstring"6c9536a0fd2f0e56bd6oao"WiFi SN
device_modelstring"SPHA3.68H-10.24k"Device model
device_namestring"SHA6021312021CL001"Device name
first_installint64"ddd"First installation timestamp
agent_namestring"ddd"Agent
dealer_namestring"ddd"Dealer
retailer_namestring"ddd"Retailer
aliasstring"ddd"Alias
power_board_hardware_versionstring"210-20004-00"Power board hardware version
dsp1_software_versionstring"510-00001-15"DSP1 software version
dsp1_sub_versionstring"3-205"DSP1 software sub-version
dsp2_software_versionstring"510-10001-15"DSP2 software version
dsp2_sub_versionstring"3-115"DSP2 software sub-version
ems_software_versionstring"511-00007-04"EMS software version
ems_hardware_versionstring"01"EMS hardware version
ems_sub_versionstring"21926-003R"EMS hardware sub-version
wifi_hardware_versionstring"AEW4-0004-01"WiFi hardware version
wifi_software_versionstring"4770E22225R"WiFi stick software version
bms_gauge_versionstring"4770E22225R"BMS gauge version
bms_snstring"BXA0010001020CB001"BMS serial number
bms_vendorstring"WEIHENG"BMS vendor
bms_software_versionstring"511-00006-13"BMS software version
bms_hardware_versionstring"4770E22225R"BMS hardware version
factorystring"WeiHeng"Manufacturer
brandstring"eCactus"Brand
stateint3Device state: -5 Unknown; -4: Disabled; -3: Not activated; -1: Offline; 0: Standby; 1: On-grid; 2: EPS; 3: Fault; 4: Reserved; 5: Self-check

Request Example

GET /ecos-hub/v1/devices HTTP/1.1



/* response_body */
{
	"code": 200,
	"requestId": "dbed6342-f5da-4fef-b0f3-213d0a9a0732",
	"data": [
		{
			"id": "1724300677246750720",
			"alias": "ED电池测试dd",
			"device_name": "THA11111000239J025",
			"wifi_sn": "6ccc8ad201507a309cc3xk",
			"device_sn": "THA11111000239J025",
			"state": 1,
			"data_source": 1,
			"tsdb_source": 1,
			"longitude": 120.205794,
			"latitude": 31.625507,
			"vpp_mode": 1,
			"device_model": "THA13.0H",
			"brand": "eCactus",
			"factory": "WeiHeng",
			"power_board_hardware_version": "210-20008-00",
			"dsp1_software_version": "510-00004-03",
			"dsp1_sub_version": "1-80",
			"dsp2_software_version": "510-10004-03",
			"dsp2_sub_version": "1-40",
			"ems_software_version": "511-00009-02",
			"ems_hardware_version": "210-60005-00",
			"ems_sub_version": "231115-Y03R",
			"wifi_hardware_version": "210-10000-00",
			"wifi_software_version": "515-00002-00",
			"bms_gauge_version": "",
			"bms_sn": "52081529",
			"bms_vendor": "ED",
			"bms_software_version": "",
			"bms_hardware_version": "",
			"first_install": 1699940578133,
			"country_id": 248,
			"datacenter_id": 226,
			"agent_name": "--",
			"dealer_name": "--",
			"retailer_name": "--",
			"sale_name": "--"
		}
	],
	"total": 278,
	"current_page": 1
}

Query Device Details

Query device information.

Request Format

GET ecos-hub/v1/devices{device_id} HTTP/1.1

Request Parameters

Request Path Parameters

Parameter NameTypeRequiredExampleDescription
device_snstringYesasdfdftdf34Device SN

Response Parameters

Response Body Parameters

Parameter NameTypeExampleDescription
request_idstring"ddddd"request id
dataObject{"ddd","ddd}Query results

data

Query Result Array

Parameter NameTypeExampleDescription
device_snstring"SHA6021312021CL001"Device SN
wifi_snstring"6c9536a0fd2f0e56bd6oao"WiFi SN
device_modelstring"SPHA3.68H-10.24k"Device model
device_namestring"SHA6021312021CL001"Device name
first_installint64"ddd"First installation timestamp
agent_namestring"ddd"Agent
dealer_namestring"ddd"Dealer
retailer_namestring"ddd"Retailer
aliasstring"ddd"Alias
power_board_hardware_versionstring"210-20004-00"Power board hardware version
dsp1_software_versionstring"510-00001-15"DSP1 software version
dsp1_sub_versionstring"3-205"DSP1 software sub-version
dsp2_software_versionstring"510-10001-15"DSP2 software version
dsp2_sub_versionstring"3-115"DSP2 software sub-version
ems_software_versionstring"511-00007-04"EMS software version
ems_hardware_versionstring"01"EMS hardware version
ems_sub_versionstring"21926-003R"EMS hardware sub-version
wifi_hardware_versionstring"AEW4-0004-01"WiFi hardware version
wifi_software_versionstring"4770E22225R"WiFi stick software version
bms_gauge_versionstring"4770E22225R"BMS gauge version
bms_snstring"BXA0010001020CB001"BMS serial number
bms_vendorstring"WEIHENG"BMS vendor
bms_software_versionstring"511-00006-13"BMS software version
bms_hardware_versionstring"4770E22225R"BMS hardware version
factorystring"WeiHeng"Manufacturer
brandstring"eCactus"Brand
stateint3Device state: -5 Unknown; -4: Disabled; -3: Not activated; -1: Offline; 0: Standby; 1: On-grid; 2: EPS; 3: Fault; 4: Reserved; 5: Self-check

Request Example

GET /ecos-hub/v1/devices HTTP/1.1



/* response_body */
{
	"code": 200,
	"requestId": "dbed6342-f5da-4fef-b0f3-213d0a9a0732",
	"data": 
		{
			"id": "1724300677246750720",
			"alias": "ED电池测试dd",
			"device_name": "THA11111000239J025",
			"wifi_sn": "6ccc8ad201507a309cc3xk",
			"device_sn": "THA11111000239J025",
			"state": 1,
			"data_source": 1,
			"tsdb_source": 1,
			"longitude": 120.205794,
			"latitude": 31.625507,
			"vpp_mode": 1,
			"device_model": "THA13.0H",
			"brand": "eCactus",
			"factory": "WeiHeng",
			"power_board_hardware_version": "210-20008-00",
			"dsp1_software_version": "510-00004-03",
			"dsp1_sub_version": "1-80",
			"dsp2_software_version": "510-10004-03",
			"dsp2_sub_version": "1-40",
			"ems_software_version": "511-00009-02",
			"ems_hardware_version": "210-60005-00",
			"ems_sub_version": "231115-Y03R",
			"wifi_hardware_version": "210-10000-00",
			"wifi_software_version": "515-00002-00",
			"bms_gauge_version": "",
			"bms_sn": "52081529",
			"bms_vendor": "ED",
			"bms_software_version": "",
			"bms_hardware_version": "",
			"first_install": 1699940578133,
			"country_id": 248,
			"datacenter_id": 226,
			"agent_name": "--",
			"dealer_name": "--",
			"retailer_name": "--",
			"sale_name": "--"
		}
}

Query Device Inverter Information

Retrieve device inverter information based on the device ID.

Request Format

GET ecos-hub/v1/devices{device_id}/inverter HTTP/1.1

Request Parameters

Request Path Parameters

Parameter NameTypeRequiredExampleDescription
device_snstringYesasdfdftdf34Device SN

Response Parameters

Response Body Parameters

Parameter NameTypeExampleDescription
request_idstring"ddddd"request id
dataObject{"ddd","ddd}Query results

data

Query Results

Parameter NameTypeExampleDescription
acDataobject{}AC side data
dcDataobject{}DC side data
runDataobject{}Operational data

AC Side Data Description (acData)

Parameter NameTypeExampleDescription
acFreqRstring"50Hz"R-phase AC frequency
acFreqSstring"0Hz"S-phase AC frequency
acFreqTstring"0Hz"T-phase AC frequency
acIacRstring"0.3A"R-phase AC current
acIacSstring"0A"S-phase AC current
acIacTstring"0A"T-phase AC current
acPacRstring"-11W"R-phase active power
acPacSstring"0W"S-phase active power
acPacTstring"0W"T-phase active power
acVacRstring"231.6V"R-phase AC voltage
acVacSstring"0V"S-phase AC voltage
acVacTstring"0V"T-phase AC voltage
pfstring"0.15"AC power factor
powerstring"-11W"Total active power
reactivePowerstring"57VA"Total reactive power

DC Side Data Description (dcData)

Parameter NameTypeExampleDescription
dciPv1string"0.4A"PV1 DC current
dciPv2string"0A"PV2 DC current
dcpPv1string"0W"PV1 DC power
dcpPv2string"0W"PV2 DC power
dcvBusstring"382.4V"DC bus voltage
dcvBusMstring"0V"DC bus voltage (minimum)
dcvBusPstring"0V"DC bus voltage (maximum)
dcvPv1string"6.4V"PV1 DC voltage
dcvPv2string"6.5V"PV2 DC voltage

Operational Data Description (runData)

Parameter NameTypeExampleDescription
airTempstring"0℃"Ambient temperature
armErrorCodestring"0"ARM error code
batteryErrorCodestring"0"Battery error code
batterySinkTempstring"17.7℃"Battery heatsink temperature
capTempstring"0℃"Capacitor temperature
error1string"0"Error code 1
error2string"0"Error code 2
error3string"0"Error code 3
inverterErrorCodestring"0"Inverter error code
inverterSinkTempstring"23.1℃"Inverter heatsink temperature
runModestring"1"Operational mode
waitTimestring"0s"Wait time

Request Example

GET ecos-hub/v1/devices/SHA60213120223S006/inverter HTTP/1.1



/* response_body */
{
	"code": 200,
	"requestId": "f5fc55d6-c297-42c1-93ae-929104db2c9f",
	"data": {
		"acData": {
			"acFreqR": "50Hz",
			"acFreqS": "0Hz",
			"acFreqT": "0Hz",
			"acIacR": "0.3A",
			"acIacS": "0A",
			"acIacT": "0A",
			"acPacR": "-11W",
			"acPacS": "0W",
			"acPacT": "0W",
			"acVacR": "231.6V",
			"acVacS": "0V",
			"acVacT": "0V",
			"pf": "0.15",
			"power": "-11W",
			"reactivePower": "57VA"
		},
		"dcData": {
			"dciPv1": "0.4A",
			"dciPv2": "0A",
			"dcpPv1": "0W",
			"dcpPv2": "0W",
			"dcvBus": "382.4V",
			"dcvBusM": "0V",
			"dcvBusP": "0V",
			"dcvPv1": "6.4V",
			"dcvPv2": "6.5V"
		},
		"runData": {
			"airTemp": "0℃",
			"armErrorCode": "0",
			"batteryErrorCode": "0",
			"batterySinkTemp": "17.7℃",
			"capTemp": "0℃",
			"error1": "0",
			"error2": "0",
			"error3": "0",
			"inverterErrorCode": "0",
			"inverterSinkTemp": "23.1℃",
			"runMode": "1",
			"waitTime": "0s"
		}
	}
}

Query Device Meter Information

Retrieve device meter information based on the device SN.

Request Format

GET ecos-hub/v1/devices{device_id}/ammeter HTTP/1.1

Request Parameters

Request Path Parameters

Parameter NameTypeRequiredExampleDescription
device_snstringYesasdfdftdf34Device SN

Response Parameters

Response Body Parameters

Parameter NameTypeExampleDescription
request_idstring"ddddd"request id
dataObject{"ddd","ddd}Query results

data

Query Result

Parameter NameTypeExampleDescription
activePowerstring""Active power of the system
freqRstring""AC frequency of phase R
freqSstring""AC frequency of phase S
freqTstring""AC frequency of phase T
iacRstring""AC current of phase R
iacSstring""AC current of phase S
iacTstring""AC current of phase T
pacRstring""Active power of phase R
pacSstring""Active power of phase S
pacTstring""Active power of phase T
pfstring""Power factor of the system
reactivePowerstring""Reactive power of the system
vacRstring""AC voltage of phase R
vacSstring""AC voltage of phase S
vacTstring""AC voltage of phase T

Request Example

GET ecos-hub/v1/devices/SHA60213120223S006/ammeter HTTP/1.1



/* response_body */
{
	"code": 200,
	"requestId": "1493d154-262d-42b5-b0a2-14f2ee04b16e",
	"data": {
		"activePower": "",
		"freqR": "",
		"freqS": "",
		"freqT": "",
		"iacR": "",
		"iacS": "",
		"iacT": "",
		"pacR": "",
		"pacS": "",
		"pacT": "",
		"pf": "",
		"reactivePower": "",
		"vacR": "",
		"vacS": "",
		"vacT": ""
	}
}

Query Device EPS Information

Query device EPS information based on the device SN

Request Format

GET ecos-hub/v1/devices{device_id}/eps HTTP/1.1

Request Parameters

Request Path Parameters

Parameter NameTypeRequiredExampleDescription
device_snstringYesasdfdftdf34Device SN

Response Parameters

Response Body Parameters

Parameter NameTypeExampleDescription
request_idstring"ddddd"request id
dataObject{"ddd","ddd}Query results

data

Query Result

Parameter NameTypeExampleDescription
currentRstring""Current of phase R
currentSstring""Current of phase S
currentTstring""Current of phase T
freqRstring""Frequency of phase R
freqSstring""Frequency of phase S
freqTstring""Frequency of phase T
prstring""Active power of phase R
psstring""Active power of phase S
ptstring""Active power of phase T
qrstring""Reactive power of phase R
qsstring""Reactive power of phase S
qtstring""Reactive power of phase T
voltageRstring""Voltage of phase R
voltageSstring""Voltage of phase S
voltageTstring""Voltage of phase T

Request Example

GET ecos-hub/v1/devices/SHA60213120223S006/eps HTTP/1.1



/* response_body */
{
	"code": 200,
	"requestId": "1493d154-262d-42b5-b0a2-14f2ee04b16e",
	"data":{
		"currentR": "",
		"currentS": "",
		"currentT": "",
		"freqR": "",
		"freqS": "",
		"freqT": "",
		"pr": "",
		"ps": "",
		"pt": "",
		"qr": "",
		"qs": "",
		"qt": "",
		"voltageR": "",
		"voltageS": "",
		"voltageT": ""
	}
}

Query Device Battery Information

Query device battery information based on the device SN

Request Format

GET ecos-hub/v1/devices{device_id}/battery HTTP/1.1

Request Parameters

Request Path Parameters

Parameter NameTypeRequiredExampleDescription
device_snstringYesasdfdftdf34Device SN

Response Parameters

Response Body Parameters

Parameter NameTypeExampleDescription
request_idstring"ddddd"request id
dataObject{"ddd","ddd}Query results

data

Query Result

Parameter NameTypeExampleDescription
alarmCollectionobject
alarmL16string"0"Alarm L16
basicStatusstring"12"Basic status
batSerialNumberstring"BXA0010001020CB001"Battery serial number
bateTotalChargestring"256.6kWh"Total battery charge
bateTotalDischargestring"227.1kWh"Total battery discharge
bmsLaterChgCapacitystring"0"BMS subsequent charge capacity
bmsLaterDischgCapacitystring"0"BMS subsequent discharge capacity
cellMaxTempstring"19℃"Maximum temperature of battery cell
cellMaxTempIdstring"11"Maximum temperature cell ID
cellMaxVoltagestring"3.103V"Maximum voltage of battery cell
cellMaxVoltageIdstring"55"Maximum voltage cell ID
cellMinTempstring"17.7℃"Minimum temperature of battery cell
cellMinTempIdstring"13"Minimum temperature cell ID
cellMinVoltagestring"3.079V"Minimum voltage of battery cell
cellMinVoltageIdstring"14"Minimum voltage cell ID
currentBmsstring"0A"BMS current
currentDspstring"0A"DSP current
cycleTimesstring"43"Cycle times
errorCollectionobject
errorH32string"0"Error H32
faultCollectionobject
faultH16string"0"Fault H16
maxCurrentChargestring"10.2A"Maximum charging current
maxCurrentDischargestring"25A"Maximum discharging current
maxVoltageChargestring"227.1V"Maximum charging voltage
minVoltageDischargestring"176V"Minimum discharging voltage
powerBmsstring"0W"BMS power
powerDspstring"0W"DSP power
remainCapacitystring"459Wh"Remaining capacity
socstring"10%"State of Charge (SOC)
sohstring"98%"State of Health (SOH)
switchStatusstring"0"Switch status
temperaturestring"0℃"Temperature
voltageBmsstring"196.5V"BMS voltage
voltageDspstring"197.7V"DSP voltage

alarmCollection errorCollection faultCollection

Parameter NameTypeDescription
bitChineseParseList[]string
bitEnglishParseList[]string
bitPosList[]string
bitValueList[]string

Request Example

GET ecos-hub/v1/devices/SHA60213120223S006/battery HTTP/1.1



/* response_body */
{
    "code": 200,
    "requestId": "4d583889-2305-49f0-9c5d-d185abf6252b",
    "data": {
        "alarmCollection": {
            "bitChineseParseList": null,
            "bitEnglishParseList": null,
            "bitPosList": null,
            "bitValueList": null
        },
        "alarmL16": "",
        "basicStatus": "",
        "batSerialNumber": "",
        "bateTotalCharge": "",
        "bateTotalDischarge": "",
        "bmsLaterChgCapacity": "",
        "bmsLaterDischgCapacity": "",
        "cellMaxTemp": "",
        "cellMaxTempId": "",
        "cellMaxVoltage": "",
        "cellMaxVoltageId": "",
        "cellMinTemp": "",
        "cellMinTempId": "",
        "cellMinVoltage": "",
        "cellMinVoltageId": "",
        "currentBms": "",
        "currentDsp": "",
        "cycleTimes": "",
        "errorCollection": {
            "bitChineseParseList": null,
            "bitEnglishParseList": null,
            "bitPosList": null,
            "bitValueList": null
        },
        "errorH32": "",
        "faultCollection": {
            "bitChineseParseList": null,
            "bitEnglishParseList": null,
            "bitPosList": null,
            "bitValueList": null
        },
        "faultH16": "",
        "maxCurrentCharge": "",
        "maxCurrentDischarge": "",
        "maxVoltageCharge": "",
        "minVoltageDischarge": "",
        "powerBms": "",
        "powerDsp": "",
        "remainCapacity": "",
        "soc": "",
        "soh": "",
        "switchStatus": "",
        "temperature": "",
        "voltageBms": "",
        "voltageDsp": ""
    }
}

Get Device Weiheng Battery Information

Get device Weiheng battery information based on the device SN

Request Format

GET ecos-hub/v1/devices{device_id}/weiheng-battery HTTP/1.1

Request Parameters

Request Path Parameters

Parameter NameTypeRequiredExampleDescription
device_snstringYesasdfdftdf34Device SN

Response Parameters

Response Body Parameters

Parameter NameTypeExampleDescription
request_idstring"ddddd"request id
dataObject{"ddd","ddd}Query results

data

Query Result

Parameter NameTypeExampleDescription
accumulativeInputChargestring"1193765"Accumulative charge ampere-hour
accumulativeInputEnergystring"256613"Accumulative input energy
accumulativeOutputChargestring"1093957"Accumulative discharge ampere-hour
accumulativeOutputEnergystring"227176"Accumulative discharge energy
availableEnergystring"4540"Available energy
batteryInSerialstring"64"Battery series number
brandstring""Brand
cellFaultBitsstring"0"Battery fault bits
chargeCurrentLimitstring"10.2"Charge current limit
chargeVoltageLimitstring"227.1"Charge voltage limit
contactorOcCountstring"0"Contactor overcurrent count
currentstring"0"Current
currentCodestring"0"Current code
currentCodeCollectionobject
cycleCountstring"43"Cycle count
dischargeCurrentLimitstring"25"Discharge current limit
dischargeVoltageLimitstring"176"Discharge voltage limit
eocStatusstring"0"EOC status
faultSaveCodestring"0"Fault save code
faultSaveCodeCollectionobject
fullChargeCapacitystring"24.5"Full charge capacity
hardwareVersionstring""Hardware version
hardwareVersionCodestring"1"Hardware version code
highestCellTemperaturestring"19"Highest cell temperature
highestCellTemperatureIdstring"11"Highest cell temperature ID
highestCellVoltagestring"3.083"Highest cell voltage
highestCellVoltageIdstring"50"Highest cell voltage ID
internalBatteryPackTypestring"1"Internal battery pack type
internalTemperaturestring"15.8"Internal temperature
lowestCellTemperaturestring"17.7"Lowest cell temperature
lowestCellTemperatureIdstring"13"Lowest cell temperature ID
lowestCellVoltagestring"3.056"Lowest cell voltage
lowestCellVoltageIdstring"14"Lowest cell voltage ID
modelstring""Model
remainingCapacitystring"2.3"Remaining capacity
requireForceChargestring"0"Requires force charge
resistorUpdateCountstring"0"Resistor update count
snstring""Serial number
socstring"10"State of Charge (SOC)
softwareVersionstring""Software version
softwareVersionCodestring"0"Software version code
sohstring"98"State of Health (SOH)
sohReadystring"1"SOH ready status
systemStatestring"12"System state
systemUptimestring"1547353"System uptime (s)
temperatureChannelsstring"24"Number of temperature channels
voltagestring"195.1"Voltage
z100SoftwareVersionstring""

currentCodeCollection faultSaveCodeCollection

currentCodeCollection,faultSaveCodeCollection

Parameter NameTypeDescription
bitChineseParseList[]string
bitEnglishParseList[]string
bitPosList[]string
bitValueList[]string

Request Example

GET ecos-hub/v1/devices/SHA60213120223S006/weiheng-battery HTTP/1.1



/* response_body */
{
    "code": 200,
    "requestId": "92ee0114-d28f-4049-bab3-76b34d52ebbf",
    "data": {
        "accumulativeInputCharge": "",
        "accumulativeInputEnergy": "",
        "accumulativeOutputCharge": "",
        "accumulativeOutputEnergy": "",
        "availableEnergy": "",
        "batteryInSerial": "",
        "brand": "",
        "cellFaultBits": "",
        "chargeCurrentLimit": "",
        "chargeVoltageLimit": "",
        "contactorOcCount": "",
        "current": "",
        "currentCode": "",
        "currentCodeCollection": {
            "bitChineseParseList": null,
            "bitEnglishParseList": null,
            "bitPosList": null,
            "bitValueList": null
        },
        "cycleCount": "",
        "dischargeCurrentLimit": "",
        "dischargeVoltageLimit": "",
        "eocStatus": "",
        "faultSaveCode": "",
        "faultSaveCodeCollection": {
            "bitChineseParseList": null,
            "bitEnglishParseList": null,
            "bitPosList": null,
            "bitValueList": null
        },
        "fullChargeCapacity": "",
        "hardwareVersion": "",
        "hardwareVersionCode": "",
        "highestCellTemperature": "",
        "highestCellTemperatureId": "",
        "highestCellVoltage": "",
        "highestCellVoltageId": "",
        "internalBatteryPackType": "",
        "internalTemperature": "",
        "lowestCellTemperature": "",
        "lowestCellTemperatureId": "",
        "lowestCellVoltage": "",
        "lowestCellVoltageId": "",
        "model": "",
        "remainingCapacity": "",
        "requireForceCharge": "",
        "resistorUpdateCount": "",
        "sn": "",
        "soc": "",
        "softwareVersion": "",
        "softwareVersionCode": "",
        "soh": "",
        "sohReady": "",
        "systemState": "",
        "systemUptime": "",
        "temperatureChannels": "",
        "voltage": "",
        "z100SoftwareVersion": ""
    }
}
Last Updated: