Skip to main content

OpenData

1. Introduction​

OpenData is a lightweight communication framework designed for WiFi-based Solarman IoT devices (such as smart plug, meters, P1 readers, etc.). Devices connect to the local network via WiFi, supporting both data push and external query response mechanisms.

Core Features​

  • Device Data Acquisition: Real-time retrieval of device basic information (model, firmware version, etc.) and measurement data.
  • Device Configuration Update: Dynamic adjustment of device parameters and settings.

Use Cases​

  1. Push Device Data (UDP)

    • UDP broadcast to 255.255.255.255
    • Device Key Encrypted: UDP broadcast to 255.255.255.255 (Coming soon)

  2. Receive External Query Requests (HTTP/HTTPS)

    • HTTP
    • HTTP + Digest
    • HTTPS (Coming soon)

2. Preparation​

2.1 Install Tools​

  • For receiving UDP broadcasts: Any network debugging tool (such as NetAssist) can be used.
  • For sending HTTP requests: The Postman GUI tool or the cURL command-line tool can be used.

2.2 Enable API​

Device API functionality is disabled by default and must be manually enabled before use.

2.3 Obtain IP Address​

Choose one of the following four methods:

  • Query via router admin interface
  • View device details in Solarman Smart APP
  • Check device info in Energy Ease
Obtain IP via UDP broadcast

  1. Ensure the device and computer are on the same LAN.

  2. Open the network debugging tool.

  3. Select UDP protocol.

  4. Select Local Host Address.

  5. Set Port to 10000.

  6. Click Open.

  7. Set remote host to broadcast address: 255.255.255.255:8099.

  8. Enter AT command in message box: AT+IGDEVICEIP.

  9. Click Send.

  10. Solarman devices on the same LAN will reply with their IP and SN.

2.4 Check Firmware Version​

To confirm whether the firmware version of the device meets the requirements based on the device model, you can view the firmware version information through any of the following methods:

  • Go to SOLARMAN Smart / Energy Ease App and check device info.
  • Send HTTP request and call Sys.GetConfig to get configuration info.
DeviceModelFirmware Version (Minimum)
P1 Meter ReaderP1-2WV1.3.0A_R003.001_MP12W_00000013
Smart PlugSP-2W-EUV1.3.0A_R002.001_MSP2W_00000010
Smart MeterMR1-D5-WR
MR1-D5-W		V1.3.0A_R00B.032_M051A_00000015
MR1-D4-WRE
MR3-D4-WRE
MR1-D4-WE
MR3-D4-WE		V1.3.0A_R009.002_M0000_00000016
MR1-D3-W
MR3-D3-W		V1.3.07_R00A.002_M0515_00000017
IR ReaderNIR-1
NIR-3		V1.4.01_R016.052_M0000_00000013

3. UDP Usage Guide​

Enable Functionality​

UDP is disabled by default and must be manually enabled.

UDP​

For devices supporting UDP broadcast, receive UDP packets to obtain device information.

DeviceBroadcast Address & PortFrequency (ms)
P1 ReaderAddress: 255.255.255.255; Port: 8088500
Smart PlugAddress: 255.255.255.255; Port: 8088500
MeterAddress: 255.255.255.255; Port: 8088200

Steps:

  1. Ensure device and computer are on the same LAN.

  2. Open network debugging tool.

  3. Select UDP protocol.

  4. Select your computer's IP address in the LAN.

  5. Set local port to 8088.

  6. Click Open to start listening.

  7. Select packet display format: ASCII/Hex.

  8. Received packets will display in the receive area. receice_udp_packet.png

Note

If no data is received, verify device and computer are on the same LAN and ensure firewall allows communication.

UDP Device Key Encryption​

Coming soon

4. HTTP Usage Guide​

Request Structure​

Request Methods

  • GET: Request specified resource from server.
  • POST: Request server to perform an action.

Request Address

http://{IP_ADDRESS}:8080/rpc/{API}

where:

  • {IP_ADDRESS}: Device IP address.
  • {API}: HTTP API to call.

Request Examples

  • Get device info:
GET http://192.168.31.213:8080/rpc/Sys.GetConfig
  • Modify device name:
POST http://192.168.31.213:8080/rpc/Sys.SetConfig?config={"device":{"hostname":"admin"}}

cURL Command Example

  • Obtain device info:
curl http://192.168.31.213:8080/rpc/Sys.GetConfig
  • Modify device name:
curl -g -X POST -H "Content-Type: application/json" "http://192.168.31.213:8080/rpc/Sys.SetConfig?config={\"device\":{\"hostname\":\"admin\"}}"

Digest Authentication​

Digest authentication verifies user identity without transmitting plaintext passwords.

Note

In HTTP+Digest mode, devices after first use or factory reset require default password change before using other APIs.

Change Password​

  1. In Postman, select Authorization tab.

  2. Select Digest Auth from Auth Type dropdown.

  3. Use online AES tools to generate Base64-encoded password and tag:

    • Required Tools:
      • ASCII to Hex
      • Hex to Base64
      • AES_GCM Encryptor
    • Parameters:
      • Plaintext: New password
      • Key: Current password (Hex format, pad with 00 to 16 bytes). Example: e7171fc41 → 65373137316663343100000000000000
      • Nonce: Random value (Hex format, pad with 00 to 12 bytes). Example: 123456 → 313233343536000000000000
      • Padding: NoPadding aes_encrypt.png

  4. Authentication parameters:

    FieldValue
    UsernameDefault: opend
    PasswordDefault device KEY
    RealmAES128-GCM generated Tag (Base64)
    NonceSame random value used in AES
    AlgorithmMD5
    qopauth
    Nonce CountRandom value
    Client NonceRandom value
    Opaque(Leave empty)

  5. Select POST method.

  6. Request address:

http://{IP_ADDRESS}:8080/rpc/User.SetConfig?config={"Password":"{PASSWORD}"}

where:

  • {IP_ADDRESS}：Device IP address.
  • {PASSWORD}: AES128-GCM encrypted ciphertext (Base64). post_request.png
  1. Click Send. success.png

✅ Success

Returns {"result": true} if password changed successfully.

Request Other APIs​

  1. Select Authorization tab in Postman.

  2. Choose Digest Auth.

  3. Fill parameters:

FieldValue
Usernameopend
PasswordNew password
RealmRandom value
NonceNonce from AES encryption
AlgorithmMD5
qopauth
Nonce CountRandom value
Client NonceRandom value
OpaqueLeave empty

HTTPS​

Coming soon

Error Codes​

CodeDescriptionExplanation
400Bad RequestServer cannot understand request format.
401UnauthorizedAuthentication required. Provide valid credentials.
403ForbiddenServer refuses action (typically permission issue).
404Not FoundResource not found or deleted.
405Method Not AllowedIncompatible method (e.g., write operation on read-only resource).
408Request TimeoutServer timed out waiting for request. Retry later.
409ConflictRequest conflicts with current resource state (e.g., concurrent edits).
410GoneResource permanently deleted.
500Internal Server ErrorServer encountered unexpected error.
501Not ImplementedServer does not support requested method.
502Bad GatewayInvalid response received from upstream server.
503Service UnavailableServer temporarily overloaded or in maintenance.
504Gateway TimeoutUpstream server response timeout.
505HTTP Version Not SupportedServer does not support HTTP version in request.

5. HTTP API​

ComponentDescription
SysDevice model, firmware version, etc.
P1Read gas/electricity data from P1 meter reader.
PlugRead power metrics and control smart sockets.
MeterRead the electricity meter data.

Sys​

Get Device Info​

  • Request Example
GET http://192.168.31.213:8080/rpc/Sys.GetConfig
  • Response Example
{
    "device": {
        "hostname": "admin",
        "timezone": 480,
        "type": "",
        "sn": "2730890019",
        "mac": "E8FDF8DD9A76",
        "fw": "LSW3_01_E030_SS_00_00.00.00.03",
        "time": "2024-11-26 19:14:23",
        "time_stamp": 1732648463,
        "run_time": 839
    }
}

Method: Sys.GetConfig

  • Returns
ParameterTypeDescription
deviceobjectSee Config table.

Set Device Name/Timezone​

  • Request Example
POST http://192.168.31.213:8080/rpc/Sys.SetConfig?config={"device":{"hostname":"admin"}}
  • Response Example
{"result": true}

Method: Sys.SetConfig

  • Parameters
ParameterTypeDescription
configobjectOnly hostname and timezone are writable. See Config table.
  • Returns
ParameterTypeDescription
resultbooltrue: success, false: failure.

Config​

ParameterTypeDescription
deviceobjectDevice config. See below.

device

ParameterTypeDescriptionR/W
hostnamestringDevice nameR/W
timezoneintTimezoneR/W
typestringDevice modelR
snstringSerial numberR
macstringMAC addressR
fwstringFirmware versionR
timestringCurrent time (YYYY-MM-DD HH:mm:ss)R
time_stampintUnix timestampR
run_timeintUptime (seconds)R

P1​

Get Meter Data (JSON)​

  • Request Example
GET http://192.168.31.213:8080/rpc/P1.JsonData
  • Response Example
{
    "SN": "E0036003765928016",
    "Device_Version ": "50",
    "Device_Type": 0,
    "Electricity delivered to client_low tariff": 53754.58,
    "Electricity delivered to client_normal tariff": 9818.93,
    "Electricity delivered by client_low tariff": 53754.58,
    "Electricity delivered by client_normal tariff": 9818.93,
    "AC_Phase-A_Current ": 12,
    "AC_Phase-B_Current": 0,
    "AC_Phase-C_Current": 0,
    "AC_Phase-A_Voltage": 237,
    "AC_Phase-B_Voltage": 237,
    "AC_Phase-C_Voltage": 236,
    " Actual electricity power delivered +P ": 0,
    " Actual electricity power received -P ": 2.94,
    "Instantaneous active power L1 +P": 0,
    "Instantaneous active power L2 +P": 0,
    "Instantaneous active power L3 +P": 0,
    "Instantaneous active power L1 -P": 2.95,
    "Instantaneous active power L2 -P": 0,
    "Instantaneous active power L3 -P": 0
}

Method: P1.JsonData

  • Returns: JSON-formatted meter data.
ParameterDescriptionUnit
SNMeter SN-
Device_VersionMeter version-
Device_TypeMeter model-
Electricity delivered to client_low tariffForward energy (low tariff)kWh
Electricity delivered to client_normal tariffForward energy (normal tariff)kWh
Electricity delivered by client_low tariffReverse energy (low tariff)kWh
Electricity delivered by client_normal tariffReverse energy (normal tariff)kWh
AC_Phase-L1_CurrentPhase A currentA
AC_Phase-L2_CurrentPhase B currentA
AC_Phase-L3_CurrentPhase C currentA
AC_Phase-L1_VoltagePhase A voltageV
AC_Phase-L2_VoltagePhase B voltageV
AC_Phase-L3_VoltagePhase C voltageV
Actual electricity power delivered +PTotal forward active powerkW
Actual electricity power received -PTotal reverse active powerkW
Instantaneous active power L1 +PPurchased power L1kW
Instantaneous active power L2 +PPurchased power L2kW
Instantaneous active power L3 +PPurchased power L3kW
Instantaneous active power L1 -PGrid feed-in power L1kW
Instantaneous active power L2 -PGrid feed-in power L2kW
Instantaneous active power L3 -PGrid feed-in power L3kW
Total Gas ConsumptionTotal gas consumptionm³

Get Raw Meter Data​

  • Request Example
GET http://192.168.31.213:8080/rpc/P1.GetData
  • Response Example
{
    3:0.2.8(50)
    0-0:1.0.0(181106140429W)
    0-0:96.1.1(31333631353032362020202020202020)
    1-0:1.8.1(10830.511*kWh)
    1-0:1.8.2(002948.827*kWh)
    1-0:2.8.1(001285.951*kWh)
    1-0:2.8.2(002876.514*kWh)
    0-0:96.14.0(0002)
    1-0:1.7.0(21.100*kW)
    1-0:2.7.0(00.000*kW)
    0-0:96.7.21(00006)
    0-0:96.7.9(00003)
    1-0:99.97.0(1)(0-0:96.7.19)(180529135630S)(0000002451*s)
    1-0:32.32.0(00003)
    1-0:52.32.0(00002)
    1-0:72.32.0(00002)
    1-0:32.36.0(00001)
    1-0:52.36.0(00001)
    1-0:72.36.0(00001)
    0-0:96.13.0()
    1-0:32.7.0(236.0*V)
    1-0:52.7.0(232.6*V)
    1-0:72.7.0(235.1*V)
    1-0:31.7.0(002*A)
    1-0:51.7.0(000*A)
    1-0:71.7.0(000*A)
    1-0:21.7.0(00.000*kW)
    1-0:41.7.0(00.033*kW)
    1-0:61.7.0(00.132*kW)
    1-0:22.7.0(00.676*kW)
    1-0:42.7.0(00.000*kW)
    1-0:62.7.0(00.000*kW)
    0-1:24.1.0(003)
    0-1:96.1.0(4730303339303031373030343630313137)
    0-1:24.2.1(210606140010W)(02569.646*m3)
    !1F28
}

Method: P1.GetData

  • Returns: Raw meter data.

Plug​

Get Power Consumption​

  • Request Example
GET http://192.168.31.213:8080/rpc/Plug.GetData
  • Response Example
{
    "voltage": 230,
    "electric_current": 0,
    "positive_active_energy": 1.730654,
    "reverse_active_energy": 0.000000,
    "power": 1.217517
}

Method: Plug.GetData

  • Returns
ParameterTypeDescriptionUnit
voltageintVoltageV
electric_currentintCurrentA
positive_active_energyfloatForward active energykWh
reverse_active_energyfloatReverse active energykWh
powerfloatActive powerW

Get Plug Status​

  • Request Example
GET http://192.168.31.213:8080/rpc/Plug.GetStatus
  • Response Example
{"switch_status": "on"}

Method: Plug.GetStatus

  • Returns
ParameterTypeDescription
switch_statusstringon: open, off: closed

Set Plug Status​

Request Example

POST http://192.168.31.213:8080/rpc/Plug.SetStatus?config={"switch_status":"on"}
  • Response Example
{"result": true}

Method: Plug.SetStatus

  • Parameters
ParameterTypeDescription
configobjectSets socket status. See Config.
  • Returns
ParameterTypeDescription
resultbooltrue: success, false: failure.

Config​

ParameterTypeDescriptionUnitR/W
voltageintVoltageVR
currentintCurrentAR
Electricity delivered to clientfloatForward active energykWhR
Electricity delivered by clientfloatReverse active energykWhR
Active powerfloatActive powerWR
switch_statusstringon: open, off: closed-R/W

Meter​

Get Meter Data (JSON)​

  • Request Example
GET http://192.168.31.213:8080/rpc/Meter.JsonData
  • Response Example
{
    "SN": "3310500113",
    "voltage": 229.87,
    "current": 0.66,
    "active power": 133.50,
    "apparent power": 209.60,
    "reactive power": -29.80,
    "power factor": 0.63,
    "frequency": 50.03,
    "total_act_energy": 3.53,
    "total_act_ret_energy": 0.18
}

Method: Meter.JsonData

  • Returns: JSON-formatted meter data.
ParameterDescriptionUnit
SNDevice SN-
currentCurrentA
voltageVoltageV
frequencyAC frequencyHz
power factorPower factor-
active PowerForward/Reverse active powerW
apparent powerForward/Reverse apparent powerW
reactive powerForward/Reverse reactive powerW
total_act_energyTotal forward active energykWh
total_act_ret_energyTotal reverse active energykWh
info

The data obtained by the IR Reader comes directly from the device itself, and its specific content and format depend entirely on the device model, communication protocol, and manufacturer.

6. Devices​

P1 Reader​

The P1 Reader (P1-2W) connects directly to a single P1 meter via RJ12 interface, continuously collecting meter status and electricity data for long-term monitoring. It transmits data over WiFi to local/cloud platforms, visualizing real-time status and historical trends.

ModelSupported API
P1-2WSys
P1

Smart Plug​

The Smart Plug (SP-2W-EU) supports home energy monitoring with bidirectional metering and remote control. It uploads energy data via WiFi, allowing users to remotely control appliances and monitor usage via apps.

ModelSupported API
SP-2W-EUSys
Plug

Meter​

The meter is designed for residential/small commercial bidirectional metering. It is installed on DIN rails (35mm) using split-core CTs and uploads data via WiFi/Ethernet for detailed energy analysis.

ModelSupported API
MR1-D5-WR
MR1-D5-W
MR1-D4-WRE
MR3-D4-WRE
MR1-D4-WE
MR3-D4-WE
MR1-D3-W
MR3-D3-W		Sys
Meter

Note: MR1 corresponds to single-phase meters, and MR3 corresponds to three-phase meters.

IR Reader​

The IR Reader primarily monitor the electricity system long-term and effectively by collecting data on the operating status and consumption data. Connecting to a single infrared meter via an infrared interface, the IR Reader receive various consumption information from the meter and transmit the data to a local or remote software platform via WiFi. The meter's real-time status and historical data are presented in graphical form, making them intuitive, clear, and easy to understand. Users can monitor the meter system anytime, anywhere, greatly simplifying maintenance.

ModelSupported API
NIR-1
NIR-3		Sys
Meter

7. FAQ​

QuestionsReasons and solutions
HTTP access returns 401 Unauthorized.1. Check whether the Digest authentication username and password are correct.
2. Devices on first use or after factory reset can only access the User.SetConfig interface. See Digest authentication. Once you change the password successfully, full access to all interfaces is restored.
The device did not return the IP address after sending the broadcast command.The OpenData API has not yet been enabled, resulting in this feature being unavailable. For details, please refer to Enable API.
Failed to retrieve data.1. Check whether the device is turned on.
2. Check whether the device is connected to the same local area network as the computer.