DevicePower

The DevicePower component handles the monitoring of device's battery charge and is only available on battery-operated devices. DevicePower components are identified with devicepower:<id> in objects containing multiple component payloads.

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

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

Methods

DevicePower.SetConfig

Properties:

Property	Type	Description
id	number	Id of the DevicePower component instance
config	object	Empty object

Find more about the config properties in config section

DevicePower.GetConfig

Properties:

Property	Type	Description
id	number	Id of the DevicePower component instance

Find the DevicePower.GetConfig response properties in config section

DevicePower.GetStatus

Properties:

Property	Type	Description
id	number	Id of the DevicePower component instance

Configuration

The DevicePower component does not own any configuration properties.

Status

The status of the DevicePower component contains information about the battery charge and the presence of an external power source, if such is supported. To obtain the status of the DevicePower component its id must be specified.

Properties:

Property	Type	Description
id	number	Id of the DevicePower component instance
battery	object	Information about the battery charge Property Type Description V number or null Battery voltage in Volts (null if valid value could not be obtained) percent number or null Battery charge level in % (null if valid value could not be obtained)
external	object	Information about the external power source (only available if external power source is supported)	present	bool	Whether external power source is connected
errors	array of type string	Whether external power source is connected

Examples

DevicePower.SetConfig example

DevicePower.SetConfig HTTP GET Request

http://192.168.33.1/rpc/DevicePower.SetConfig?id=0&config={}

DevicePower.SetConfig Curl Request

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

DevicePower.SetConfig Mos Request

mos --port ${PORT} call DevicePower.SetConfig '{"id":0,"config":{}}'

Response

DevicePower.SetConfig HTTP GET Response

null

DevicePower.SetConfig Curl Response

{
  "id": 1,
  "src": "shellyplusht-441793cc9d30",
  "params": null
}

DevicePower.SetConfig Mos Response

null

DevicePower.GetConfig example

DevicePower.GetConfig HTTP GET Request

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

DevicePower.GetConfig Curl Request

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

DevicePower.GetConfig Mos Request

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

Response

DevicePower.GetConfig HTTP GET Response

null

DevicePower.GetConfig Curl Response

{
  "id": 1,
  "src": "shellyplusht-441793cc9d30",
  "params": null
}

DevicePower.GetConfig Mos Response

null

DevicePower.GetStatus example

DevicePower.GetStatus HTTP GET Request

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

DevicePower.GetStatus Curl Request

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

DevicePower.GetStatus Mos Request

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

Response

DevicePower.GetStatus HTTP GET Response

{
  "id": 0,
  "battery": {
    "V": 4.87,
    "percent": 50
  },
  "external": {
    "present": false
  }
}

DevicePower.GetStatus Curl Response

{
  "id": 1,
  "src": "shellyplusht-441793cc9d30",
  "params": {
    "id": 0,
    "battery": {
      "V": 4.87,
      "percent": 50
    },
    "external": {
      "present": false
    }
  }
}

DevicePower.GetStatus Mos Response

{
  "id": 0,
  "battery": {
    "V": 4.87,
    "percent": 50
  },
  "external": {
    "present": false
  }
}