Ethernet

The Ethernet component handles the ethernet interface of devices and uses Eth for RPC method namespace. It uses the key eth when enumerated in objects including multiple component payloads, like Shelly.GetStatus. Provides the minimal component interface:

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

Methods

Eth.SetConfig

Properties:

Property	Type	Description
config	object	Configuration that the method takes

Find more about the config properties in config section

Eth.GetConfig

The Eth.GetConfig method does not own any request properties.Find the response properties in config section

Eth.GetStatus

The Eth.GetStatus method does not own any request properties.Find the response properties in status section

Configuration

The configuration of the Ethernet component shows the current settings of the ethernet connection. Changing any parameter requires restart.

Property	Type	Description
enable	boolean	true if the connection is enabled, false otherwise
ipv4mode	string	IPv4 mode. Range of values: dhcp, static. Can be omitted if once set
ip	string or null	IP in the network when ipv4mode is static. Required for static mode if not already set
netmask	string or null	Netmask of the network when ipv4mode is static. Optional, defaults to 255.255.255.0
gw	string or null	Gateway of the network when ipv4mode is static. Optional, set to null to clear
nameserver	string or null	Nameserver to use when ipv4mode is static. Optional, set to null to clear

Status

The status of the Ethernet component contains the IP address which can be used to access the device over ethernet.

Property	Type	Description
ip	string or null	IP of the device in the network

Examples

Eth.SetConfig example

Eth.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Eth.SetConfig?config={"enable":true}

Eth.SetConfig Curl Request

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

Eth.SetConfig Mos Request

mos --port ${PORT} call Eth.SetConfig '{"config":{"enable":true}}'

Response

Eth.SetConfig HTTP GET Response

{
  "restart_required": false
}

Eth.SetConfig Curl Response

{
  "id": 1,
  "src": "shellypro1-84cca87c1f90",
  "params": {
    "restart_required": false
  }
}

Eth.SetConfig Mos Response

{
  "restart_required": false
}

Eth.GetConfig example

Eth.GetConfig HTTP GET Request

http://192.168.33.1/rpc/Eth.GetConfig

Eth.GetConfig Curl Request

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

Eth.GetConfig Mos Request

mos --port ${PORT} call Eth.GetConfig

Response

Eth.GetConfig HTTP GET Response

{
  "enable": true,
  "ipv4mode": "dhcp",
  "ip": null,
  "netmask": null,
  "gw": null,
  "nameserver": null
}

Eth.GetConfig Curl Response

{
  "id": 1,
  "src": "shellypro1-84cca87c1f90",
  "params": {
    "enable": true,
    "ipv4mode": "dhcp",
    "ip": null,
    "netmask": null,
    "gw": null,
    "nameserver": null
  }
}

Eth.GetConfig Mos Response

{
  "enable": true,
  "ipv4mode": "dhcp",
  "ip": null,
  "netmask": null,
  "gw": null,
  "nameserver": null
}

Eth.GetStatus example

Eth.GetStatus HTTP GET Request

http://192.168.33.1/rpc/Eth.GetStatus

Eth.GetStatus Curl Request

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

Eth.GetStatus Mos Request

mos --port ${PORT} call Eth.GetStatus

Response

Eth.GetStatus HTTP GET Response

{
  "ip": null
}

Eth.GetStatus Curl Response

{
  "id": 1,
  "src": "shellypro1-84cca87c1f90",
  "params": {
    "ip": null
  }
}

Eth.GetStatus Mos Response

{
  "ip": null
}