ShellyApi (OpenEMS Javadoc)

java.lang.Object

io.openems.edge.io.shelly.common.ShellyApi

public class ShellyApi extends Object

Implements the local Shelly REST Api.

See https://shelly-api-docs.shelly.cloud

Constructor Summary

Constructors

Constructor

Description

ShellyApi(String ip)
Method Summary

Modifier and Type

Method

Description

boolean

getRelayIson(int index)

Gets the "ison" state of the relay with the given index.

com.google.gson.JsonObject

getStatus()

Gets the status of the device.

void

setRelayTurn(int index, boolean value)

Turns the relay with the given index on or off.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ShellyApi
  
  public ShellyApi(String ip)
Method Details
- getStatus
  
  public com.google.gson.JsonObject getStatus() throws OpenemsError.OpenemsNamedException
  
  Gets the status of the device.
  See https://shelly-api-docs.shelly.cloud/#shelly2-5-status
  
  Returns:
  
  the status as JsonObject according to Shelly docs
  
  Throws:
  
  OpenemsError.OpenemsNamedException - on error
- getRelayIson
  
  public boolean getRelayIson(int index) throws OpenemsError.OpenemsNamedException
  
  Gets the "ison" state of the relay with the given index.
  See https://shelly-api-docs.shelly.cloud/#shelly2-5-relay-index
  
  Parameters:
  
  index - the index of the relay
  
  Returns:
  
  the boolean value
  
  Throws:
  
  OpenemsError.OpenemsNamedException - on error
- setRelayTurn
  
  public void setRelayTurn(int index, boolean value) throws OpenemsError.OpenemsNamedException
  
  Turns the relay with the given index on or off.
  
  Parameters:
  
  index - the index of the relay
  
  value - true to turn on; false to turn off
  
  Throws:
  
  OpenemsError.OpenemsNamedException - on error