Command Input.GetStatusRequest input status
Status Active
Command description
Use this method to obtain a device input status. The status of the Input component contains information about the state of the chosen input instance. To obtain the status of the Input component its id must be specified. The Input component handles the external digital or analog input terminals of a device.
Inputs can support one of three modes:
Digital inputs sense discrete HIGH / LOW input states and can be configured to work with attached momentary buttons or toggle switches.
Analog inputs can be configured to work as discrete inputs, but also support reading the analog value of the input, represented as a range between 0 and 100%.
Counter inputs report accumulated counts and frequency.
Parameters id – Id of the Input component instance (number) Response Response in JSON format:
{"id":0,"state":false} Examples HTTP GET request:
http://<Device IP>/rpc/Input.GetStatus?id=0 Compatible devices AAE-3302 Can be used for reading Yes
Command Switch.SetSet the output to on or off
Status Active
Command description This method sets the output of the device to on or off. Parameters id – Id of the output (number). Required
on – true for switch on, false otherwise. Required
toggle_after – flip-back timer in seconds (number). Optional
tag – up to 20 characters used to identify the origin of a state change (string or null). Optional Response Response in JSON format:
{"was_on":true} Examples HTTP GET request:
http://<Device IP>/rpc/Switch.Set?id=0&on=false Compatible devices AAE-3302 Can be used for reading
Command Sys.GetConfigRequest the device system configuration
Status Active
Command description Use this method to obtain the system configuration. System configuration contains information about device's identifiers, location, debug logs, UI data, and communication over udp. Parameters no parameters Response Response in JSON format:
{"device":{"name":null,"mac":"8C4F00A6D898","fw_id":"20240223-142029/1.2.2-g7c39781","discoverable":true,"eco_mode":false},"location":{"tz":"America/New_York","lat":25.992000,"lon":-80.270200},"debug":{"level":2,"file_level":null,"mqtt":{"enable":false},"websocket":{"enable":false},"udp":{"addr":null}},"ui_data":{},"rpc_udp":{"dst_addr":null,"listen_port":null},"sntp":{"server":"time.google.com"},"cfg_rev":3} Examples HTTP GET request:
http://<Device IP>/rpc/Sys.GetConfig Compatible devices AAE-3302 Can be used for reading Yes
Command Sys.SetConfigUpdate the device system configuration
Status Active
Command description Use this method to update the system configuration. System configuration contains information about device's identifiers, location, debug logs, UI data, and communication over udp. Parameters config – object (JSON) containing information about the device. Response Response in JSON format:
{"restart_required":false} Examples HTTP GET request to update a device's timezone:
http://<Device IP>/rpc/Sys.SetConfig?config={"location":{"tz":"America/New_York"}} Compatible devices AAE-3302 Can be used for reading
Command WiFi.GetConfigRequest the device WiFi configuration
Status Active
Command description Use this method to obtain the WiFi configuration. The configuration of the WiFi component contains information about the access point of the device, the network stations and the roaming settings. Parameters no parameters Response Response in JSON format:
{"ap":{"ssid":"ShellyPlusUni-8C4F00A6D898","is_open":true, "enable":false, "range_extender": {"enable":false}},"sta":{"ssid":"Mia3","is_open":false, "enable":true,"ipv4mode":"dhcp","ip":null,"netmask":null,"gw":null,"nameserver":null},"sta1": {"ssid":null,"is_open":true, "enable":false, "ipv4mode":"dhcp","ip":null,"netmask":null,"gw":null,"nameserver":null},"roam": {"rssi_thr":-80,"interval":60}} Examples HTTP GET request:
http://<Device IP>/rpc/WiFi.GetConfig Compatible devices AAE-3302 Can be used for reading Yes