/config/register/physical/{reg}/value

Defines the how the register value is obtained or calculated. For register where dev is local, this is one of:

  • A local sensor name: L1-L3, Ldc, or S1-S30.

  • A power formula written as a sum of products of sensors. For example, S1*L1+S2*L2 would indicate that the register value is calculated as the real power measured by current sensor S1 and line-voltage L1 plus the real power measured by current sensor S2 and line-voltage L2. Note that even though the real power calculation is indicated by an asterisk, it is actually calculated by averaging the product of the instantaneous current and voltage samples, not by multiplying the RMS voltages of S1 and L1. The first factor of each real power calculation may also be negated. For example, -S1*L2 would yield the negative of the real power calculated by S1*L2.

  • An equal sign (=) followed by an eScript expression. The register value is obtained by evaluating the eScript expression once per update interval. Non-finite numbers (e.g., not-a-number, or infinities) are silently converted to 0 before recording the register value.

For registers where dev is not local, so-called remote registers, the value is interpreted in a way that is specific to the particular remote device in use. Commonly, the value is some sort of register name or identifier. For example, for Modbus remote devices, the value is a register name defined by the Modbus map of the remote device.

Get /config/register/physical/{reg}/value

SecurityApiKey
Request
path Parameters
reg
required
string
Responses
200

Normal response.

401

Unauthorized response.

get/config/register/physical/{reg}/value
Request samples
Response samples
application/json
{
  • "result": "S16*L1+S17*L2",
  • "error": "Error message (present if an error occurred)."
}

Replace /config/register/physical/{reg}/value

SecurityApiKey
Request
path Parameters
reg
required
string
Request Body schema: application/json
string (configRegisterPhysicalRegValue)

Defines the how the register value is obtained or calculated. For register where dev is local, this is one of:

  • A local sensor name: L1-L3, Ldc, or S1-S30.

  • A power formula written as a sum of products of sensors. For example, S1*L1+S2*L2 would indicate that the register value is calculated as the real power measured by current sensor S1 and line-voltage L1 plus the real power measured by current sensor S2 and line-voltage L2. Note that even though the real power calculation is indicated by an asterisk, it is actually calculated by averaging the product of the instantaneous current and voltage samples, not by multiplying the RMS voltages of S1 and L1. The first factor of each real power calculation may also be negated. For example, -S1*L2 would yield the negative of the real power calculated by S1*L2.

  • An equal sign (=) followed by an eScript expression. The register value is obtained by evaluating the eScript expression once per update interval. Non-finite numbers (e.g., not-a-number, or infinities) are silently converted to 0 before recording the register value.

For registers where dev is not local, so-called remote registers, the value is interpreted in a way that is specific to the particular remote device in use. Commonly, the value is some sort of register name or identifier. For example, for Modbus remote devices, the value is a register name defined by the Modbus map of the remote device.

Responses
200

Normal response.

401

Unauthorized response.

put/config/register/physical/{reg}/value
Request samples
application/json
"S16*L1+S17*L2"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/register/physical/{reg}/value

SecurityApiKey
Request
path Parameters
reg
required
string
Request Body schema: application/json
string (configRegisterPhysicalRegValue)

Defines the how the register value is obtained or calculated. For register where dev is local, this is one of:

  • A local sensor name: L1-L3, Ldc, or S1-S30.

  • A power formula written as a sum of products of sensors. For example, S1*L1+S2*L2 would indicate that the register value is calculated as the real power measured by current sensor S1 and line-voltage L1 plus the real power measured by current sensor S2 and line-voltage L2. Note that even though the real power calculation is indicated by an asterisk, it is actually calculated by averaging the product of the instantaneous current and voltage samples, not by multiplying the RMS voltages of S1 and L1. The first factor of each real power calculation may also be negated. For example, -S1*L2 would yield the negative of the real power calculated by S1*L2.

  • An equal sign (=) followed by an eScript expression. The register value is obtained by evaluating the eScript expression once per update interval. Non-finite numbers (e.g., not-a-number, or infinities) are silently converted to 0 before recording the register value.

For registers where dev is not local, so-called remote registers, the value is interpreted in a way that is specific to the particular remote device in use. Commonly, the value is some sort of register name or identifier. For example, for Modbus remote devices, the value is a register name defined by the Modbus map of the remote device.

Responses
200

Normal response.

401

Unauthorized response.

post/config/register/physical/{reg}/value
Request samples
application/json
"S16*L1+S17*L2"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/register/physical/{reg}/value

Reset to empty string.

SecurityApiKey
Request
path Parameters
reg
required
string
Responses
200

Normal response.

401

Unauthorized response.

delete/config/register/physical/{reg}/value
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}