Voltmeter

The Voltmeter component handles the monitoring of device's voltmeter sensors. Voltmeter components are identified with voltmeter:<id> in objects containing multiple component payloads.

The Voltmeter component uses Voltmeter as RPC namespace and implements the minimal component interface:

• Voltmeter.GetConfig to obtain the component's configuration
• Voltmeter.SetConfig to update the component's configuration
• Voltmeter.GetStatus to obtain the component's status

Methods

Voltmeter.SetConfig

Properties:

Property	Type	Description
id	number	Id of the Voltmeter component instance
config	object	Configuration that the method takes

Find more about the config properties in config section

Voltmeter.GetConfig

Properties:

Property	Type	Description
id	number	Id of the Voltmeter component instance

Find the Voltmeter.GetConfig response properties in config section

Voltmeter.GetStatus

Properties:

Property	Type	Description
id	number	Id of the Voltmeter component instance

Find more about the status response properties in status section

Voltmeter.CheckExpression

Request

Property	Type	Description
expr	string	JS expression to evaluate
inputs	array	Input values on which to apply expr. Elements are allowed to be null

Response

results or error if any of the request parameters is missing or of the wrong type

Property	Type	Description
results	array	Array of 2-tuples, each containing an input and an output value: [input, output]. Input values are those from the request, but after processing into a number internally and back to string. Outputs are corresponding results of the evaluated expression, and can be null. If the JS interperter fails to parse or evaluate the expression a third element is added to the array, so it becomes [input, output, error message]

Configuration

The configuration of the Voltmeter component allows to adjust the voltage report threshold value. To Get/Set the configuration of the Voltmeter component its id must be specified.

Properties:

Property	Type	Description
id	number	Id of the Voltmeter component instance
name	string or null	Name of the Voltmeter instance. name length should not exceed 64 chars
report_thr	number	Voltmeter report threshold in volts. Accepted range is device-specific
range	number	Input range, which is device-specific. See the table below.
xvoltage	object	Value transformation config for status.voltage Property Type Description expr string or null JS expression containg x, where x is the raw value to be transformed (status.voltage), for example "x+1". Accepted range: null or [0..100] chars. Both null and "" mean value transformation is disabled. unit string or null Unit of the transformed value (status.xvoltage), for example "m/s". Accepted range: null or [0..20] chars. Both null and "" mean value transformation is disabled.

Valid range values depend of device.

range	0	1
PlusUni	0-15VDC (default)	0-30VDC

Status

The status of the Voltmeter component represents the measurement of the associated voltmeter sensor. To obtain the status of the Voltmeter component its id must be specified.

Property	Type	Description
id	number	Id of the Voltmeter component instance
voltage	number or null	Voltage in volts (null if valid value could not be obtained)
xvoltage	number or null	voltage transformed with config.xvoltage.expr. Present only when both config.xvoltage.expr and config.xvoltage.unit are set to non-empty values. null if config.xvoltage.expr can not be evaluated.
errors	array of type string	Shown only if at least one error is present. May contain out_of_range, read when there is problem reading sensor

Webhook Events

There are two events related to the Voltmeter component that can trigger webhooks:

• voltmeter.change - produced when voltage delta between two measurements is greater than report_thr
• voltmeter.measurement - produced on a monotonic measurement period (60s)

voltmeter.change and voltmeter.measurement support two attributes, that can be used to compose conditional webhooks:

Property	Type	Description
voltage	number	New voltage
xvoltage	number	voltage transformed with config.xvoltage.expr

Examples

Voltmeter.SetConfig example

Voltmeter.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Voltmeter.SetConfig?id=0&config={"name":"Voltmeter0","report_thr":2.5,"range":0,"xvoltage":{"expr":"x+1","unit":"m/s"}}

Voltmeter.SetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Voltmeter.SetConfig","params":{"id":0,"config":{"name":"Voltmeter0","report_thr":2.5,"range":0,"xvoltage":{"expr":"x+1","unit":"m/s"}}}}' http://${SHELLY}/rpc

Voltmeter.SetConfig Mos Request

mos --port ${PORT} call Voltmeter.SetConfig '{"id":0,"config":{"name":"Voltmeter0","report_thr":2.5,"range":0,"xvoltage":{"expr":"x+1","unit":"m/s"}}}'

Response

Voltmeter.SetConfig HTTP GET Response

{
  "restart_required": false
}

Voltmeter.SetConfig Curl Response

{
  "id": 1,
  "params": {
    "restart_required": false
  }
}

Voltmeter.SetConfig Mos Response

{
  "restart_required": false
}

Voltmeter.GetConfig example

Voltmeter.GetConfig HTTP GET Request

http://192.168.33.1/rpc/Voltmeter.GetConfig?id=0

Voltmeter.GetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Voltmeter.GetConfig","params":{"id":0}}' http://${SHELLY}/rpc

Voltmeter.GetConfig Mos Request

mos --port ${PORT} call Voltmeter.GetConfig '{"id":0}'

Response

Voltmeter.GetConfig HTTP GET Response

{
  "id": 0,
  "name": null,
  "report_thr": 2.5,
  "range": 0,
  "xvoltage": {
    "expr": "x+1",
    "unit": "m/s"
  }
}

Voltmeter.GetConfig Curl Response

{
  "id": 1,
  "params": {
    "id": 0,
    "name": null,
    "report_thr": 2.5,
    "range": 0,
    "xvoltage": {
      "expr": "x+1",
      "unit": "m/s"
    }
  }
}

Voltmeter.GetConfig Mos Response

{
  "id": 0,
  "name": null,
  "report_thr": 2.5,
  "range": 0,
  "xvoltage": {
    "expr": "x+1",
    "unit": "m/s"
  }
}

Voltmeter.GetStatus example

Voltmeter.GetStatus HTTP GET Request

http://192.168.33.1/rpc/Voltmeter.GetStatus?id=0

Voltmeter.GetStatus Curl Request

curl -X POST -d '{"id":1,"method":"Voltmeter.GetStatus","params":{"id":0}}' http://${SHELLY}/rpc

Voltmeter.GetStatus Mos Request

mos --port ${PORT} call Voltmeter.GetStatus '{"id":0}'

Response

Voltmeter.GetStatus HTTP GET Response

{
  "id": 0,
  "voltage": 3.5,
  "xvoltage": 4.5
}

Voltmeter.GetStatus Curl Response

{
  "id": 1,
  "params": {
    "id": 0,
    "voltage": 3.5,
    "xvoltage": 4.5
  }
}

Voltmeter.GetStatus Mos Response

{
  "id": 0,
  "voltage": 3.5,
  "xvoltage": 4.5
}

Voltmeter.CheckExpression example

Voltmeter.CheckExpression HTTP GET Request

http://192.168.33.1/rpc/Voltmeter.CheckExpression?expr="(x/3)+4"&inputs=[1,2,3]

Voltmeter.CheckExpression Curl Request

curl -X POST -d '{"id":1,"method":"Voltmeter.CheckExpression","params":{"expr":"(x/3)+4","inputs":[1,2,3]}}' http://${SHELLY}/rpc

Voltmeter.CheckExpression Mos Request

mos --port ${PORT} call Voltmeter.CheckExpression '{"expr":"(x/3)+4","inputs":[1,2,3]}'

Response

Voltmeter.CheckExpression HTTP GET Response

{
  "results": [
    [
      1,
      4.333333
    ],
    [
      2,
      4.666667
    ],
    [
      3,
      5
    ]
  ]
}

Voltmeter.CheckExpression Curl Response

{
  "id": 1,
  "params": {
    "results": [
      [
        1,
        4.333333
      ],
      [
        2,
        4.666667
      ],
      [
        3,
        5
      ]
    ]
  }
}

Voltmeter.CheckExpression Mos Response

{
  "results": [
    [
      1,
      4.333333
    ],
    [
      2,
      4.666667
    ],
    [
      3,
      5
    ]
  ]
}