/config/modbus/client/map/{name}/reg/{idx}/unit

For register of the analog kind, this defines the physical unit of the register value. This must be one of the following:

  • #3: Unit-less number with 3 decimal digits of precision.
  • %: Percentage.
  • A: Electric current in amperes.
  • Ah: Electric charge in ampere-hours.
  • As: Electric charge in ampere-seconds.
  • C: Temperature in degree celsius.
  • Degrees: Angle in degrees.
  • Hz: Frequency in hertz.
  • Ohm: Resistance in ohm.
  • Pa: Pressure in pascals.
  • Pct: Percentage.
  • RH: Relative humidity.
  • Tmd: Time in days.
  • Tmh: Time in hours.
  • Tms: Time in seconds.
  • VA: Apparent power in volt-amperes.
  • VAh: Apparent energy in volt-ampere-hours.
  • V: Electric potential in volts.
  • W/m2: Irradiance in watts-per-square-meter.
  • W/m^2: Irradiance in watts-per-square-meter.
  • W: Power in watts.
  • Wh: Energy in watt-hours.
  • degC: Temperature in degree celsius.
  • deg: Angle in degrees.
  • g: Mass in grams.
  • hPa: Pressure in hecto-pascals.
  • h: Time in hours.
  • kAh: Electric charge in kilo-ampere-hours.
  • kO: Resistance in kilo-ohms.
  • kPa: Pressure in kilo-pascals.
  • kVAh: Apparent energy in kilo-volt-ampere-hours.
  • kW: Power in kilo-watts.
  • kWh: Energy in kilo-watt-hours.
  • kg: Mass in kilo-grams.
  • kvarh: Reactive energy in kilo-volt-ampere-hours.
  • m/s: Speed in meters-per-second.
  • m3/s: Volume flow in cubic-meters-per-second.
  • m3: Volume in cubic-meters.
  • mA: Electric current in milli-amperes.
  • mAh: Electric charge in milli-ampere-hours.
  • mSecs: Time in milli-seconds.
  • mV: Electric potential in milli-volts.
  • mV: Electric potential in milli-volts.
  • m^3/s: Volume flow in cubic-meters-per-second.
  • m^3: Volume in cubic-meters.
  • meters: Distance in meters.
  • mm: Distance in milli-meters.
  • mps: Speed in meters-per-second.
  • ms: Time in milli-seconds.
  • ohms: Resistance in ohm.
  • ppm: Parts-per-million.
  • s: Time in seconds.
  • secs: Time in seconds.
  • var: Reactive power in volt-ampere.
  • varh: Reactive energy in volt-ampere-hours.
  • °C: Temperature in degree celsius.

Get /config/modbus/client/map/{name}/reg/{idx}/unit

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
idx
required
string

The index of a Modbus map register.

Responses
200

Normal response.

401

Unauthorized response.

get/config/modbus/client/map/{name}/reg/{idx}/unit
Request samples
Response samples
application/json
{
  • "result": "W",
  • "error": "Error message (present if an error occurred)."
}

Replace /config/modbus/client/map/{name}/reg/{idx}/unit

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
idx
required
string

The index of a Modbus map register.

Request Body schema: application/json
string (configModbusClientMapNameRegItemUnit)

For register of the analog kind, this defines the physical unit of the register value. This must be one of the following:

  • #3: Unit-less number with 3 decimal digits of precision.
  • %: Percentage.
  • A: Electric current in amperes.
  • Ah: Electric charge in ampere-hours.
  • As: Electric charge in ampere-seconds.
  • C: Temperature in degree celsius.
  • Degrees: Angle in degrees.
  • Hz: Frequency in hertz.
  • Ohm: Resistance in ohm.
  • Pa: Pressure in pascals.
  • Pct: Percentage.
  • RH: Relative humidity.
  • Tmd: Time in days.
  • Tmh: Time in hours.
  • Tms: Time in seconds.
  • VA: Apparent power in volt-amperes.
  • VAh: Apparent energy in volt-ampere-hours.
  • V: Electric potential in volts.
  • W/m2: Irradiance in watts-per-square-meter.
  • W/m^2: Irradiance in watts-per-square-meter.
  • W: Power in watts.
  • Wh: Energy in watt-hours.
  • degC: Temperature in degree celsius.
  • deg: Angle in degrees.
  • g: Mass in grams.
  • hPa: Pressure in hecto-pascals.
  • h: Time in hours.
  • kAh: Electric charge in kilo-ampere-hours.
  • kO: Resistance in kilo-ohms.
  • kPa: Pressure in kilo-pascals.
  • kVAh: Apparent energy in kilo-volt-ampere-hours.
  • kW: Power in kilo-watts.
  • kWh: Energy in kilo-watt-hours.
  • kg: Mass in kilo-grams.
  • kvarh: Reactive energy in kilo-volt-ampere-hours.
  • m/s: Speed in meters-per-second.
  • m3/s: Volume flow in cubic-meters-per-second.
  • m3: Volume in cubic-meters.
  • mA: Electric current in milli-amperes.
  • mAh: Electric charge in milli-ampere-hours.
  • mSecs: Time in milli-seconds.
  • mV: Electric potential in milli-volts.
  • mV: Electric potential in milli-volts.
  • m^3/s: Volume flow in cubic-meters-per-second.
  • m^3: Volume in cubic-meters.
  • meters: Distance in meters.
  • mm: Distance in milli-meters.
  • mps: Speed in meters-per-second.
  • ms: Time in milli-seconds.
  • ohms: Resistance in ohm.
  • ppm: Parts-per-million.
  • s: Time in seconds.
  • secs: Time in seconds.
  • var: Reactive power in volt-ampere.
  • varh: Reactive energy in volt-ampere-hours.
  • °C: Temperature in degree celsius.
Responses
200

Normal response.

401

Unauthorized response.

put/config/modbus/client/map/{name}/reg/{idx}/unit
Request samples
application/json
"W"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/modbus/client/map/{name}/reg/{idx}/unit

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
idx
required
string

The index of a Modbus map register.

Request Body schema: application/json
string (configModbusClientMapNameRegItemUnit)

For register of the analog kind, this defines the physical unit of the register value. This must be one of the following:

  • #3: Unit-less number with 3 decimal digits of precision.
  • %: Percentage.
  • A: Electric current in amperes.
  • Ah: Electric charge in ampere-hours.
  • As: Electric charge in ampere-seconds.
  • C: Temperature in degree celsius.
  • Degrees: Angle in degrees.
  • Hz: Frequency in hertz.
  • Ohm: Resistance in ohm.
  • Pa: Pressure in pascals.
  • Pct: Percentage.
  • RH: Relative humidity.
  • Tmd: Time in days.
  • Tmh: Time in hours.
  • Tms: Time in seconds.
  • VA: Apparent power in volt-amperes.
  • VAh: Apparent energy in volt-ampere-hours.
  • V: Electric potential in volts.
  • W/m2: Irradiance in watts-per-square-meter.
  • W/m^2: Irradiance in watts-per-square-meter.
  • W: Power in watts.
  • Wh: Energy in watt-hours.
  • degC: Temperature in degree celsius.
  • deg: Angle in degrees.
  • g: Mass in grams.
  • hPa: Pressure in hecto-pascals.
  • h: Time in hours.
  • kAh: Electric charge in kilo-ampere-hours.
  • kO: Resistance in kilo-ohms.
  • kPa: Pressure in kilo-pascals.
  • kVAh: Apparent energy in kilo-volt-ampere-hours.
  • kW: Power in kilo-watts.
  • kWh: Energy in kilo-watt-hours.
  • kg: Mass in kilo-grams.
  • kvarh: Reactive energy in kilo-volt-ampere-hours.
  • m/s: Speed in meters-per-second.
  • m3/s: Volume flow in cubic-meters-per-second.
  • m3: Volume in cubic-meters.
  • mA: Electric current in milli-amperes.
  • mAh: Electric charge in milli-ampere-hours.
  • mSecs: Time in milli-seconds.
  • mV: Electric potential in milli-volts.
  • mV: Electric potential in milli-volts.
  • m^3/s: Volume flow in cubic-meters-per-second.
  • m^3: Volume in cubic-meters.
  • meters: Distance in meters.
  • mm: Distance in milli-meters.
  • mps: Speed in meters-per-second.
  • ms: Time in milli-seconds.
  • ohms: Resistance in ohm.
  • ppm: Parts-per-million.
  • s: Time in seconds.
  • secs: Time in seconds.
  • var: Reactive power in volt-ampere.
  • varh: Reactive energy in volt-ampere-hours.
  • °C: Temperature in degree celsius.
Responses
200

Normal response.

401

Unauthorized response.

post/config/modbus/client/map/{name}/reg/{idx}/unit
Request samples
application/json
"W"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/modbus/client/map/{name}/reg/{idx}/unit

Reset to empty string.

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
idx
required
string

The index of a Modbus map register.

Responses
200

Normal response.

401

Unauthorized response.

delete/config/modbus/client/map/{name}/reg/{idx}/unit
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}