Shelly API Documentation

https://shelly-api-docs.shelly.cloud
Admin
Comprehensive API documentation for Shelly smart home devices, including generation 1 and 2+...
Tokens:822,289
Snippets:5,947
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Complete Example: Basic GET Endpoint

Source: https://shelly-api-docs.shelly.cloud/gen2/Scripts/APIs/HTTPServer

This example shows how to create a basic GET endpoint that returns device information and system status, including error handling for incorrect methods.

```javascript
// Simple GET endpoint that returns device information  
Httpserver.registerEndpoint("info", function(request, response) {  
  if (request.method !== "GET") {  
    response.code = 405; // Method Not Allowed  
    response.body = "Only GET method is allowed";  
    response.send();  
    return;  
  }  
    
  let deviceInfo = Shelly.getDeviceInfo();  
  let status = Shelly.getComponentStatus("sys");  
    
  response.body = JSON.stringify({  
    device: {  
      id: deviceInfo.id,  
      model: deviceInfo.model,  
      fw_version: deviceInfo.fw_id  
    },  
    system: {  
      uptime: status.uptime,  
      ram_free: status.ram_free,  
      ram_size: status.ram_size  
    }  
  });  
    
  response.headers = [["Content-Type", "application/json"]];  
  response.code = 200;  
  response.send();  
});  

```

--------------------------------

### Start BLE Associations

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/BLE

Examples for initiating BLE associations with specified parameters using HTTP GET, cURL, and the mos tool. Parameters include target, param, duration, and RSSI threshold.

```http
http://192.168.33.1/rpc/BLE.StartAssociations?target=8&param=200&duration=120&rssi_thr=-80
```

```bash
curl -X POST -d '{"id":1,"method":"BLE.StartAssociations","params":{"target":8,"param":200,"duration":120,"rssi_thr":-80}}' http://${SHELLY}/rpc
```

```bash
mos --port ${PORT} call BLE.StartAssociations '{"target":8,"param":200,"duration":120,"rssi_thr":-80}'
```

--------------------------------

### SetConfig Request Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/Devices/ShellyX/XT1

Examples of how to set the configuration for a service. These demonstrate HTTP GET, Curl, and Mos commands.

```http
http://192.168.33.1/rpc/Service.SetConfig?id=0&config={"name":"Water valve"}
```

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

```shell
mos --port ${PORT} call Service.SetConfig '{"id":0,"config":{"name":"Water valve"}}'
```

--------------------------------

### GetStatus Request Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/Devices/ShellyX/XT1

Examples of how to get the status of a service. These demonstrate HTTP GET, Curl, and Mos commands.

```http
http://192.168.33.1/rpc/Service.GetStatus?id=0
```

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

```shell
mos --port ${PORT} call Service.GetStatus '{"id":0}'
```

--------------------------------

### AddOn.GetInfo HTTP GET Response Example

Source: https://shelly-api-docs.shelly.cloud/gen2/Addons/ShellyProSensorAddon

Example of a successful HTTP GET response for AddOn.GetInfo, detailing the addon's type, hardware version, firmware version, and supported IOs.

```json
{
  "type": "ProSensorAddon",
  "hw_ver": "1.0",
  "fw_ver": "1.0.0",
  "supported_ios": {
    "digital_in": [
      0,
      1
    ],
    "analog_in": [
      0,
      1
    ],
    "digital_out": [
      0
    ],
    "ds18b20": [
      0,
      1
    ],
    "dht22": [
      0,
      1
    ]
  }
}
```

--------------------------------

### BTHomeDevice.GetKnownObjects RPC Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome/BTHomeDevice

Examples for retrieving known objects associated with a BTHomeDevice. Includes HTTP GET, cURL, and mos commands.

```http
http://192.168.33.1/rpc/BTHomeDevice.GetKnownObjects?id=200
```

```bash
curl -X POST -d '{"id":1,"method":"BTHomeDevice.GetKnownObjects","params":{"id":200}}' http://${SHELLY}/rpc
```

```bash
mos --port ${PORT} call BTHomeDevice.GetKnownObjects '{"id":200}'
```

--------------------------------

### Shelly HTTP GET Request Example

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/HTTP

Demonstrates how to perform an HTTP GET request to a Shelly device. This example shows the direct URL format for the request.

```http
http://192.168.33.1/rpc/HTTP.GET?url="http://10.33.53.21/rpc/Shelly.GetDeviceInfo"
```

--------------------------------

### HTTP.GET With Authentication Example

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/HTTP

This example demonstrates how to perform an HTTP GET request including authentication credentials. The URL includes the username and password.

```http
http://192.168.33.1/rpc/HTTP.GET?url="http://admin:supersecretpassword@10.33.53.21/rpc/Shelly.Reboot"
```

```curl
curl -X POST -d '{"id":1,"method":"HTTP.GET","params":{"url":"http://admin:supersecretpassword@10.33.53.21/rpc/Shelly.Reboot"}}' http://${SHELLY}/rpc
```

```mos
mos --port ${PORT} call HTTP.GET '{"url":"http://admin:supersecretpassword@10.33.53.21/rpc/Shelly.Reboot"}'
```

--------------------------------

### Group.GetConfig Example

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/Virtual/Group

Demonstrates how to retrieve the configuration of a Group component. Includes examples for HTTP GET, cURL, and mos requests, along with their corresponding responses.

```http
http://192.168.33.1/rpc/Group.GetConfig?id=200
```

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

```mos
mos --port ${PORT} call Group.GetConfig '{"id":200}'
```

```json
{
  "id": 200,
  "name": "Thermostat"
}
```

```json
{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "id": 200,
    "name": "Thermostat"
  }
}
```

```json
{
  "id": 200,
  "name": "Thermostat"
}
```

--------------------------------

### Shelly Cury GetConfig Request Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/Devices/PoweredByShelly/ShellyCury

Examples for requesting the Cury configuration. Includes HTTP GET, cURL, and mos commands.

```http
http://192.168.33.1/rpc/Cury.GetConfig?id=0

```

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

```

```bash
mos --port ${PORT} call Cury.GetConfig '{"id":0}'

```

--------------------------------

### RGBCCT.GetStatus Request Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/RGBCCT

Examples for requesting the current status of an RGBCCT device. Supports HTTP GET, cURL, and mos commands.

```http
http://192.168.33.1/rpc/RGBCCT.GetStatus?id=0
```

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

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

--------------------------------

### Read Coils with MbRtuClient

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/MbRtuClient

Examples for reading Modbus Coils using HTTP GET, cURL, and mos. Requires specifying device ID, slave ID, starting address, and quantity.

```http
http://192.168.33.1/rpc/MbRtuClient.ReadCoils?id=0&sid=2&addr=10&qty=5
```

```curl
curl -X POST -d '{"id":1,"method":"MbRtuClient.ReadCoils","params":{"id":0,"sid":2,"addr":10,"qty":5}}' http://${SHELLY}/rpc
```

```mos
mos --port ${PORT} call MbRtuClient.ReadCoils '{"id":0,"sid":2,"addr":10,"qty":5}'
```

--------------------------------

### BTHomeControl.StartLearning

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome/BTHomeControl

Initiates the learning process to add new BLU device mappings.

```APIDOC
## BTHomeControl.StartLearning

### Description
Starts the process of adding a BLU device and mapping its buttons to outputs. Requires an `input_id` parameter.
```

--------------------------------

### Group.GetStatus Example

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/Virtual/Group

Demonstrates how to retrieve the status of a Group component. Includes examples for HTTP GET, cURL, and mos requests, along with their corresponding responses.

```http
http://192.168.33.1/rpc/Group.GetStatus?id=200
```

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

```mos
mos --port ${PORT} call Group.GetStatus '{"id":200}'
```

```json
{
  "value": [
    "boolean:200",
    "enum:200"
  ],
  "source": "rpc",
  "last_update_ts": 1700864253
}
```

```json
{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "value": [
      "boolean:200",
      "enum:200"
    ],
    "source": "rpc",
    "last_update_ts": 1700864253
  }
}
```

```json
{
  "value": [
    "boolean:200",
    "enum:200"
  ],
  "source": "rpc",
  "last_update_ts": 1700864253
}
```

--------------------------------

### Shelly Core Quick Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/Scripts/APIs/Shelly

Demonstrates basic device control, event handling for inputs, and reading component status.

```javascript
// Control a switch  
Shelly.call("Switch.Set", {id: 0, on: true}, function(result, error_code) {  
  if (error_code === 0) {  
    console.log("Switch turned on");  
  }  
});  
  
// Listen for button presses  
Shelly.addEventHandler(function(event) {  
  if (event.component === "input:0" && event.info.event === "single_push") {  
    console.log("Button pressed!");  
    // React to button press  
    Shelly.call("Switch.Toggle", {id: 0});  
  }  
});  
  
// Get temperature reading  
let temp = Shelly.getComponentStatus("temperature:0");  
if (temp) {  
  console.log("Temperature:", temp.tC, "°C");  
}
```

--------------------------------

### Read Discrete Inputs with MbRtuClient

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/MbRtuClient

Examples for reading Modbus Discrete Inputs using HTTP GET, cURL, and mos. Requires specifying device ID, slave ID, starting address, and quantity.

```http
http://192.168.33.1/rpc/MbRtuClient.ReadDiscreteInputs?id=0&sid=2&addr=0&qty=4
```

```curl
curl -X POST -d '{"id":1,"method":"MbRtuClient.ReadDiscreteInputs","params":{"id":0,"sid":2,"addr":0,"qty":4}}' http://${SHELLY}/rpc
```

```mos
mos --port ${PORT} call MbRtuClient.ReadDiscreteInputs '{"id":0,"sid":2,"addr":0,"qty":4}'
```

--------------------------------

### Complete Manifest Example

Source: https://shelly-api-docs.shelly.cloud/gen2/Devices/ShellyX/FirmwareExtension/manifest

A full example of a manifest file for a light device with power and brightness controls.

```json
{
  "handlers": [],
  "vc": {
    "state": {
      "type": "boolean",
      "access": "crw",
      "config": {
        "name": "Power",
        "default_value": false,
        "meta": { "ui": { "view": "toggle", "titles": ["Off", "On"] } }
      }
    },
    "brightness": {
      "type": "number",
      "access": "crw",
      "config": {
        "name": "Brightness",
        "default_value": 100,
        "min": 0,
        "max": 100,
        "meta": { "ui": { "view": "slider", "step": 1, "unit": "%" } }
      }
    }
  },
  "meta": {
    "groups": [{ "type": "switch" }, { "type": "light" }],
    "integrations": {
      "aa": [{ "class": "light:bulb" }],
      "st": [{ "class": "light:bulb" }],
      "gh": [{ "class": "light:bulb" }]
    }
  }
}
```

--------------------------------

### Read Input Registers with MbRtuClient

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/MbRtuClient

Examples for reading Modbus Input Registers using HTTP GET, cURL, and mos. Requires specifying device ID, slave ID, starting address, and quantity.

```http
http://192.168.33.1/rpc/MbRtuClient.ReadInputRegisters?id=0&sid=1&addr=300&qty=3
```

```curl
curl -X POST -d '{"id":1,"method":"MbRtuClient.ReadInputRegisters","params":{"id":0,"sid":1,"addr":300,"qty":3}}' http://${SHELLY}/rpc
```

```mos
mos --port ${PORT} call MbRtuClient.ReadInputRegisters '{"id":0,"sid":1,"addr":300,"qty":3}'
```

--------------------------------

### Read Holding Registers with MbRtuClient

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/MbRtuClient

Examples for reading Modbus Holding Registers using HTTP GET, cURL, and mos. Requires specifying device ID, slave ID, starting address, and quantity.

```http
http://192.168.33.1/rpc/MbRtuClient.ReadHoldingRegisters?id=0&sid=1&addr=100&qty=2
```

```curl
curl -X POST -d '{"id":1,"method":"MbRtuClient.ReadHoldingRegisters","params":{"id":0,"sid":1,"addr":100,"qty":2}}' http://${SHELLY}/rpc
```

```mos
mos --port ${PORT} call MbRtuClient.ReadHoldingRegisters '{"id":0,"sid":1,"addr":100,"qty":2}'
```

--------------------------------

### BTHomeControl.StartLearning

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome/BTHomeControl

Initiates the learning mode for a specific input.

```APIDOC
## BTHomeControl.StartLearning

### Description
Starts the learning process for a given input ID.

### Parameters
#### Query Parameters
- **input_id** (integer) - Required - The ID of the input to start learning on.
```

--------------------------------

### BTHomeDevice.GetConfig RPC Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome/BTHomeDevice

Examples for retrieving the configuration of a BTHomeDevice. Includes HTTP GET, cURL, and mos commands. The configuration includes device ID, address, name, and meta information.

```http
http://192.168.33.1/rpc/BTHomeDevice.GetConfig?id=200
```

```bash
curl -X POST -d '{"id":1,"method":"BTHomeDevice.GetConfig","params":{"id":200}}' http://${SHELLY}/rpc
```

```bash
mos --port ${PORT} call BTHomeDevice.GetConfig '{"id":200}'
```

--------------------------------

### Write Holding Registers with MbRtuClient

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/MbRtuClient

Examples for writing Modbus Holding Registers using HTTP GET, cURL, and mos. Requires specifying device ID, slave ID, starting address, and values to write.

```http
http://192.168.33.1/rpc/MbRtuClient.WriteHoldingRegisters?id=0&sid=3&addr=400&values=[1000,2000]
```

```curl
curl -X POST -d '{"id":1,"method":"MbRtuClient.WriteHoldingRegisters","params":{"id":0,"sid":3,"addr":400,"values":[1000,2000]}}' http://${SHELLY}/rpc
```

```mos
mos --port ${PORT} call MbRtuClient.WriteHoldingRegisters '{"id":0,"sid":3,"addr":400,"values":[1000,2000]}'
```

--------------------------------

### BTHomeDevice.SetConfig RPC Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome/BTHomeDevice

Examples for setting the configuration of a BTHomeDevice. Includes HTTP GET, cURL, and mos commands. The configuration can include the device name.

```http
http://192.168.33.1/rpc/BTHomeDevice.SetConfig?id=200&config={"name":"Bathroom temperature"}
```

```bash
curl -X POST -d '{"id":1,"method":"BTHomeDevice.SetConfig","params":{"id":200,"config":{"name":"Bathroom temperature"}}}' http://${SHELLY}/rpc
```

```bash
mos --port ${PORT} call BTHomeDevice.SetConfig '{"id":200,"config":{"name":"Bathroom temperature"}}'
```

--------------------------------

### RGBCCT.Toggle Example

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/RGBCCT

Demonstrates how to toggle the RGBCCT light. Includes HTTP GET, cURL, and mos tool requests.

```http
http://192.168.33.1/rpc/RGBCCT.Toggle?id=0
```

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

```mos
mos --port ${PORT} call RGBCCT.Toggle '{"id":0}'
```

--------------------------------

### Get Matter Setup Code via HTTP GET

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Matter

Use this endpoint to retrieve the Matter setup code for a device. No specific setup is required beyond network access.

```http
http://192.168.33.1/rpc/Matter.GetSetupCode?  
```

--------------------------------

### Start Script - HTTP GET

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Script

Starts a specified script using an HTTP GET request. The script ID is provided in the URL.

```http
http://192.168.33.1/rpc/Script.Start?id=1

```

--------------------------------

### Shelly HTTP GET Response Example

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/HTTP

Provides an example of the expected JSON response from a Shelly HTTP GET request. It includes status code, headers, and the response body.

```json
{
  "code": 200,
  "message": "OK",
  "headers": {
    "Server": "ShellyHTTP/1.0.0",
    "Content-Type": "application/json",
    "Content-Length": "232",
    "Connection": "close"
  },
  "body": "{\"id\":\"shellydev1-f008d1e2cb4c\", \"mac\":\"F008D1E2CB4C\", \"model\":\"SNSW-devX16EU\", \"gen\":2, \"fw_id\":\"20210908-124312/0.7.0-29-g0df1661-145-rpc-http-get-improvements-2\", \"ver\":\"0.7.0\", \"app\":\"Dev1\", \"auth_en\":false,\"auth_domain\":null}
"
}
```

--------------------------------

### RGBCCT.Set Request Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/RGBCCT

Examples for setting parameters of an RGBCCT device, including on/off state, brightness, RGB color, color temperature, and transition duration. Supports HTTP GET, cURL, and mos commands.

```http
http://192.168.33.1/rpc/RGBCCT.Set?id=0&on=true&brightness=50&rgb=[20,30,40]&ct=4000&transition_duration=20
```

```curl
curl -X POST -d '{"id":1,"method":"RGBCCT.Set","params":{"id":0,"on":true,"brightness":50,"rgb":[20,30,40],"ct":4000,"transition_duration":20}}' http://${SHELLY}/rpc
```

```mos
mos --port ${PORT} call RGBCCT.Set '{"id":0,"on":true,"brightness":50,"rgb":[20,30,40],"ct":4000,"transition_duration":20}'
```

--------------------------------

### Enable Auto-Start via HTTP GET

Source: https://shelly-api-docs.shelly.cloud/gen2/Scripts/Overview

Use this HTTP GET request to configure a script to automatically start on device boot. The script ID and configuration are provided in the URL.

```http
http://192.168.33.1/rpc/Script.SetConfig?id=1&config={"enable":true}
```

--------------------------------

### Input.SetConfig Example

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Input

Demonstrates how to set the configuration for an Input component. Supports HTTP GET, Curl, and Mos requests. Note that some configuration changes may require a device restart.

```http
http://192.168.33.1/rpc/Input.SetConfig?id=0&config={"name":"Input0"}
```

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

```mos
mos --port ${PORT} call Input.SetConfig '{"id":0,"config":{"name":"Input0"}}'
```

```json
{
  "restart_required": false
}
```

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

```json
{
  "restart_required": false
}
```

--------------------------------

### Get Remote Device Info Request Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/Devices/Gen3/ShellyBluGwG3

Examples for requesting remote device information using HTTP GET, cURL, and mos. The 'id' parameter specifies the target device.

```http
http://192.168.33.1/rpc/BluTrv.GetRemoteDeviceInfo?id=200

```

```bash
curl -X POST -d '{"id":1,"method":"BluTrv.GetRemoteDeviceInfo","params":{"id":200}}' http://${SHELLY}/rpc

```

```bash
mos --port ${PORT} call BluTrv.GetRemoteDeviceInfo '{"id":200}'

```

--------------------------------

### Initialize PKI and Build CA with easy-rsa

Source: https://shelly-api-docs.shelly.cloud/gen2/General/CustomHTTPSCertificates

Sets up the Public Key Infrastructure (PKI) directory and builds the Certificate Authority (CA). Use `make-cadir` on Debian/Ubuntu or manual setup with `export EASYRSA_PKI` for other systems.

```shell
# Debian/Ubuntu (apt) — has the make-cadir helper  
make-cadir ~/shelly-ca  
cd ~/shelly-ca  

# macOS (Homebrew) or any setup without make-cadir  
mkdir -p ~/shelly-ca && cd ~/shelly-ca  
export EASYRSA_PKI="$PWD/pki"  

```

```shell
easyrsa init-pki  

# Build the CA. You will be prompted for a Common Name (e.g. "Shelly Home CA")  
# and asked to set a passphrase on the CA private key. *Use a strong one* —  
# this key signs every certificate the CA issues.  
# Add --batch and --req-cn=... to skip the interactive prompt for scripts.  
easyrsa build-ca  

```

--------------------------------

### Start BTHome Device Discovery via mos tool

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome

Start BTHome device discovery using the mos tool. Specify the port and the duration for the discovery process.

```bash
mos --port ${PORT} call BTHome.StartDeviceDiscovery '{"duration":25}'
```

--------------------------------

### Button.GetConfig Example

Source: https://shelly-api-docs.shelly.cloud/gen2/Devices/ShellyX/XT1

Example of how to get the configuration for a Button component using different methods.

```APIDOC
## Button.GetConfig Example

### Description
Examples for retrieving the configuration of a Button component.

### HTTP GET Request
`http://192.168.33.1/rpc/Button.GetConfig?owner="service:0"&role="open"`

### Curl Request
```bash
curl -X POST -d '{"id":1,"method":"Button.GetConfig","params":{"owner":"service:0","role":"open"}}' http://${SHELLY}/rpc
```

### Mos Request
```bash
mos --port ${PORT} call Button.GetConfig '{"owner":"service:0","role":"open"}'
```

### Response Example
```json
{
  "id": 201,
  "name": "Open",
  "meta": {
    "ui": {
      "view": "button"
    }
  },
  "owner": "service:0",
  "access": "crw"
}
```
```

--------------------------------

### Zigbee.GetStatus Example

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Zigbee

Use these examples to get the current network status of the Zigbee component.

```http
http://192.168.33.1/rpc/Zigbee.GetStatus
```

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

```mos
mos --port ${PORT} call Zigbee.GetStatus
```

--------------------------------

### BTHomeDevice.GetConfig Response Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome/BTHomeDevice

Response examples for the BTHomeDevice.GetConfig RPC call, showing device details like ID, address, name, and meta.

```json
{
  "id": 200,
  "addr": "3c:2e:f5:71:d5:2a",
  "name": "Bathroom temperature",
  "meta": null
}
```

```json
{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "id": 200,
    "addr": "3c:2e:f5:71:d5:2a",
    "name": "Bathroom temperature",
    "meta": null
  }
}
```

```json
{
  "id": 200,
  "addr": "3c:2e:f5:71:d5:2a",
  "name": "Bathroom temperature",
  "meta": null
}
```

--------------------------------

### Zigbee.WriteAttr HTTP GET Response

Source: https://shelly-api-docs.shelly.cloud/gen2/Integrations/Zigbee/ZigbeeRPC

Example response for a Zigbee.WriteAttr HTTP GET request.

```json
{
  "success": true,
  "status_str": "ZB_ZCL_STATUS_SUCCESS"
}
```

--------------------------------

### Quick Example: Registering a status endpoint

Source: https://shelly-api-docs.shelly.cloud/gen2/Scripts/APIs/HTTPServer

This example demonstrates how to register a simple status endpoint that returns device information.

```javascript
// Register a simple status endpoint  
Httpserver.registerEndpoint("status", function(request, response) {  
  // Set response body  
  response.body = JSON.stringify({  
    message: "Device is online",  
    timestamp: Date.now(),  
    uptime: Shelly.getUptimeMs()  
  });  
    
  // Set response headers  
  response.headers = [  
    ["Content-Type", "application/json"],  
    ["X-Device-Id", Shelly.getDeviceInfo().id]  
  ];  
    
  // Set HTTP status code  
  response.code = 200;  
    
  // Send the response  
  response.send();  
});  
  
console.log("Endpoint registered at /script/<id>/status");  
```

--------------------------------

### Zigbee.StartNetworkSteering Example

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Zigbee

Initiate network steering for the Zigbee component using these examples. This method does not take parameters.

```http
http://192.168.33.1/rpc/Zigbee.StartNetworkSteering
```

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

```mos
mos --port ${PORT} call Zigbee.StartNetworkSteering
```

--------------------------------

### Zigbee.ReadAttr HTTP GET Response

Source: https://shelly-api-docs.shelly.cloud/gen2/Integrations/Zigbee/ZigbeeRPC

Example response for a Zigbee.ReadAttr HTTP GET request.

```json
{
  "success": true,
  "type": 16,
  "value": "01",
  "len": 1
}
```

--------------------------------

### BluTrv.GetConfig HTTP GET Response

Source: https://shelly-api-docs.shelly.cloud/gen2/Devices/Gen3/ShellyBluGwG3

Example response for BluTrv.GetConfig via HTTP GET.

```json
{
  "id": 200,
  "addr": "28:68:47:f0:2a:b9",
  "name": null,
  "trv": "bthomedevice:200",
  "temp_sensors": [
    "bthomesensor:200"
  ],
  "dw_sensors": [],
  "meta": null
}
```

--------------------------------

### BTHome.StartDeviceDiscovery

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome

Starts the discovery process for BTHome devices.

```APIDOC
## BTHome.StartDeviceDiscovery

### Description
Starts active scan for discovery of BTHome devices. During the scanning process, `device_discovered` events are emitted, providing information about the discovered device. Upon completion of the scanning process, a `discovery_done` event is dispatched.

### Method
POST

### Endpoint
/rpc/BTHome.StartDeviceDiscovery

### Parameters
#### Request Body
- **duration** (number) - Optional - Duration for the scan in seconds, default value is 30s.

### Request Example
```json
{
  "duration": 60
}
```

### Response
#### Success Response (200)
- **result** (null) - Indicates success.

#### Response Example
```json
{
  "result": null
}
```
```

--------------------------------

### EMData.GetStatus HTTP GET Response

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/EMData

Example response for an EMData.GetStatus HTTP GET request.

```json
{
  "id": 0,
  "a_total_act_energy": 0,
  "a_total_act_ret_energy": 0,
  "b_total_act_energy": 0,
  "b_total_act_ret_energy": 0,
  "c_total_act_energy": 0,
  "c_total_act_ret_energy": 0,
  "total_act": 0,
  "total_act_ret": 0
}
```

--------------------------------

### BTHomeDevice.SetConfig Response Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome/BTHomeDevice

Response examples for the BTHomeDevice.SetConfig RPC call, indicating whether a restart is required.

```json
{
  "restart_required": false
}
```

```json
{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "restart_required": false
  }
}
```

```json
{
  "restart_required": false
}
```

--------------------------------

### Webhook.Update HTTP GET Response

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Webhook

Example response for a successful Webhook.Update HTTP GET request.

```json
{
  "rev": 4
}
```

--------------------------------

### Start BTHome Device Discovery via HTTP GET

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome

Initiate BTHome device discovery using an HTTP GET request. Specify the duration in seconds for how long the discovery should run.

```http
http://192.168.33.1/rpc/BTHome.StartDeviceDiscovery?duration=25
```

--------------------------------

### Webhook.Create HTTP GET Response

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Webhook

Example response for a successful Webhook.Create HTTP GET request.

```json
{
  "id": 3,
  "rev": 1
}
```

--------------------------------

### RGBCCT.DimUp Example

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/RGBCCT

Demonstrates how to increase the brightness of the RGBCCT light. Includes HTTP GET, cURL, and mos tool requests with fade rate.

```http
http://192.168.33.1/rpc/RGBCCT.DimUp?id=0&fade_rate=3
```

```curl
curl -X POST -d '{"id":1,"method":"RGBCCT.DimUp","params":{"id":0,"fade_rate":3}}' http://${SHELLY}/rpc
```

```mos
mos --port ${PORT} call RGBCCT.DimUp '{"id":0,"fade_rate":3}'
```

--------------------------------

### RGBW.GetStatus HTTP GET Request

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/RGBW

Example HTTP GET request to retrieve RGBW status.

```http
http://192.168.33.1/rpc/RGBW.GetStatus?id=0
```

--------------------------------

### RGBW.GetConfig HTTP GET Request

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/RGBW

Example HTTP GET request to retrieve RGBW configuration.

```http
http://192.168.33.1/rpc/RGBW.GetConfig?id=0
```

--------------------------------

### BTHomeDevice.GetStatus RPC Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/BTHome/BTHomeDevice

Examples for retrieving the status of a BTHomeDevice. Includes HTTP GET, cURL, and mos commands. Status includes RSSI, battery level, packet ID, and firmware version.

```http
http://192.168.33.1/rpc/BTHomeDevice.GetStatus?id=200
```

```bash
curl -X POST -d '{"id":1,"method":"BTHomeDevice.GetStatus","params":{"id":200}}' http://${SHELLY}/rpc
```

```bash
mos --port ${PORT} call BTHomeDevice.GetStatus '{"id":200}'
```

--------------------------------

### RGB.GetConfig HTTP GET Response

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/RGB

Example response structure for an HTTP GET request to RGB.GetConfig.

```json
{
  "id": 0,
  "name": null,
  "in_mode": "dim",
  "initial_state": "restore_last",
  "auto_on": true,
  "auto_on_delay": 60,
  "auto_off": true,
  "auto_off_delay": 60,
  "transition_duration": 3,
  "min_brightness_on_toggle": 3,
  "button_presets": {
    "button_doublepush": {
      "brightness": 100,
      "rgb": [
        255,
        255,
        255
      ]
    }
  },
  "night_mode": {
    "enable": true,
    "brightness": 50,
    "rgb": [
      255,
      255,
      255
    ],
    "active_between": [
      "21:45",
      "05:30"
    ]
  },
  "button_fade_rate": 3
}
```

--------------------------------

### Shelly XT1 Boolean.SetConfig Example

Source: https://shelly-api-docs.shelly.cloud/gen2/Devices/ShellyX/XT1

Demonstrates how to set a boolean configuration on Shelly XT1 devices using HTTP GET, Curl, and Mos. Includes examples of successful and permission denied responses.

```http
http://192.168.33.1/rpc/Boolean.SetConfig?id=200&config={"owner":"service:0","role":"has_power","name":"Has Power","meta":{"ui":{"titles":["Close","Open"]}}}
```

```bash
curl -X POST -d '{"id":1,"method":"Boolean.SetConfig","params":{"id":200,"config":{"owner":"service:0","role":"has_power","name":"Has Power","meta":{"ui":{"titles":["Close","Open"]}}}}}' http://${SHELLY}/rpc
```

```bash
mos --port ${PORT} call Boolean.SetConfig '{"id":200,"config":{"owner":"service:0","role":"has_power","name":"Has Power","meta":{"ui":{"titles":["Close","Open"]}}}}'
```

--------------------------------

### EMData.SetConfig HTTP GET Request

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/EMData

Example of an HTTP GET request to configure the EMData component.

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

--------------------------------

### LNM.Call Request Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/DynamicComponents/LNM

Examples of invoking LNM.Call using HTTP GET, curl, and mos CLI.

```http
http://192.168.33.1/rpc/LNM.Call?id=200&method="Switch.Set"&params={"id":0,"on":true}
```

```bash
curl -X POST -d '{"id":1,"method":"LNM.Call","params":{"id":200,"method":"Switch.Set","params":{"id":0,"on":true}}}' http://${SHELLY}/rpc
```

```bash
mos --port ${PORT} call LNM.Call '{"id":200,"method":"Switch.Set","params":{"id":0,"on":true}}'
```

--------------------------------

### Get Device State Example Request

Source: https://shelly-api-docs.shelly.cloud/cloud-control-api/communication-v2

Example of fetching the 'sys' status and 'ble' settings for a specific device. Ensure your device ID and host are correctly substituted.

```curl
curl -X POST 'https://<HOST>/v2/devices/api/get?auth_key=<AUTH_KEY>'
    -H 'Content-Type: application/json'
    -d '{"ids":["b48a0a1cd978"],"select":["status","settings"],"pick":{"status":["sys"],"settings":["ble"]}}'
```

--------------------------------

### Temperature.GetStatus HTTP GET Request

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Temperature

Example of an HTTP GET request to retrieve the status of the Temperature component.

```http
http://192.168.33.1/rpc/Temperature.GetStatus?id=0
```

--------------------------------

### DALI.StartScan RPC Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/DALI

Examples demonstrating how to initiate a DALI bus scan using HTTP GET, cURL, and the 'mos' tool. The expected successful response is null.

```http
http://192.168.33.1/rpc/DALI.StartScan
```

```shell
curl -X POST -d '{"id":1,"method":"DALI.StartScan"}' http://${SHELLY}/rpc
```

```shell
mos --port ${PORT} call DALI.StartScan
```

--------------------------------

### RGBW.GetConfig HTTP GET Response

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/RGBW

Example HTTP GET response containing RGBW configuration details.

```json
{
  "id": 0,
  "name": null,
  "in_mode": "dim",
  "initial_state": "restore_last",
  "auto_on": true,
  "auto_on_delay": 60,
  "auto_off": true,
  "auto_off_delay": 60,
  "transition_duration": 3,
  "min_brightness_on_toggle": 3,
  "button_presets": {
    "button_doublepush": {
      "brightness": 100,
      "rgb": [
        255,
        255,
        255
      ],
      "white": 255
    }
  },
  "night_mode": {
    "enable": true,
    "brightness": 50,
    "rgb": [
      255,
      255,
      255
    ],
    "white": 127,
    "active_between": [
      "21:45",
      "05:30"
    ]
  },
  "button_fade_rate": 3
}
```

--------------------------------

### EM.GetStatus HTTP GET Request

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/EM

Example HTTP GET request to retrieve the status of the EM component.

```http
http://192.168.33.1/rpc/EM.GetStatus?id=0

```

--------------------------------

### Input.GetConfig Example

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Input

Demonstrates how to retrieve the configuration of an Input component. Supports HTTP GET, Curl, and Mos requests.

```http
http://192.168.33.1/rpc/Input.GetConfig?id=0
```

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

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

```json
{
  "id": 0,
  "name": "name",
  "type": "switch",
  "enable": true,
  "invert": false
}
```

```json
{
  "id": 1,
  "src": "shellypro1-84cca87c1f90",
  "params": {
    "id": 0,
    "name": "name",
    "type": "switch",
    "enable": true,
    "invert": false
  }
}
```

```json
{
  "id": 0,
  "name": "name",
  "type": "switch",
  "enable": true,
  "invert": false
}
```

--------------------------------

### mos HTTP GET Request Example

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/HTTP

Illustrates how to make an HTTP GET request to a Shelly device using the 'mos' command-line tool. This is convenient for testing and debugging.

```bash
mos --port ${PORT} call HTTP.GET '{"url":"http://10.33.53.21/rpc/Shelly.GetDeviceInfo"}'
```

--------------------------------

### EM.GetConfig HTTP GET Request

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/EM

Example HTTP GET request to retrieve the configuration of the EM component.

```http
http://192.168.33.1/rpc/EM.GetConfig?id=0

```

--------------------------------

### Light.GetConfig Response Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Light

Responses containing the configuration details of a light component.

```json
{
  "id": 0,
  "name": null,
  "initial_state": "restore_last",
  "auto_on": true,
  "auto_on_delay": 60,
  "auto_off": true,
  "auto_off_delay": 60,
  "transition_duration": 3,
  "min_brightness_on_toggle": 3,
  "button_presets": {
    "button_doublepush": {
      "brightness": 100
    }
  },
  "night_mode": {
    "enable": true,
    "brightness": 50,
    "active_between": [
      "21:45",
      "05:30"
    ]
  }
}
```

```json
{
  "id": 1,
  "src": "shellypluswdus-30839809eac0",
  "params": {
    "id": 0,
    "name": null,
    "initial_state": "restore_last",
    "auto_on": true,
    "auto_on_delay": 60,
    "auto_off": true,
    "auto_off_delay": 60,
    "transition_duration": 3,
    "min_brightness_on_toggle": 3,
    "button_presets": {
      "button_doublepush": {
        "brightness": 100
      }
    },
    "night_mode": {
      "enable": true,
      "brightness": 50,
      "active_between": [
        "21:45",
        "05:30"
      ]
    }
  }
}
```

```json
{
  "id": 0,
  "name": null,
  "initial_state": "restore_last",
  "auto_on": true,
  "auto_on_delay": 60,
  "auto_off": true,
  "auto_off_delay": 60,
  "transition_duration": 3,
  "min_brightness_on_toggle": 3,
  "button_presets": {
    "button_doublepush": {
      "brightness": 100
    }
  },
  "night_mode": {
    "enable": true,
    "brightness": 50,
    "active_between": [
      "21:45",
      "05:30"
    ]
  }
}
```

--------------------------------

### SensorAddon.AddPeripheral HTTP GET Response

Source: https://shelly-api-docs.shelly.cloud/gen2/Addons/ShellySensorAddon

Example HTTP GET response for SensorAddon.AddPeripheral when adding a DS18B20 sensor.

```json
{
  "temperature:101": {
    "io": 0
  }
}
```

--------------------------------

### Light.GetConfig Request Examples

Source: https://shelly-api-docs.shelly.cloud/gen2/ComponentsAndServices/Light

Requests to retrieve the current configuration of a light component.

```http
http://192.168.33.1/rpc/Light.GetConfig?id=0
```

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

```bash
mos --port ${PORT} call Light.GetConfig '{"id":0}'
```
Tokens:
Raw