Bluetooth Low Energy

The Bluetooth Low Energy component is called BLE. It handles bluetooth services of a device. The Bluetooth Low Energy component uses BLE as RPC namespace and provides the methods:

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

It uses the key ble when enumerated in objects including multiple component payloads, like Shelly.GetStatus.

Observer

To support Shelly Bluetooth peripheral devices, the BLE component can act as a perpetual BT LE Observer. When enabled via the observer.enable configuration flag, the device will run a constant passive Bluetooth LE scan and relay received advertisement packets to Shelly Cloud service, to enable scene triggers.

note

Enabling the observer relay functionality might impact BLE advertisement scanner in scripts. A requested interval and window for scanning in scripting might get adjusted to allow for the coexistence of both functionalities.

Methods

BLE.SetConfig

Properties:

Property	Type	Description
config	object	Configuration that the method takes

Find more about the config properties in config section

BLE.GetConfig

Find the BLE.GetConfig response properties in config section

BLE.GetStatus

Find more about the status response properties in status section

Configuration

The configuration of the Bluetooth Low Energy component shows whether the bluetooth connection is enabled.

Property	Type	Description
enable	boolean	True if bluetooth is enabled, false otherwise
rpc	object	Configuration of the rpc service Property Type Description enable boolean True if rpc service is enabled, false otherwise
observer	object	Configuration of the BT LE observer Property Type Description enable boolean True if BT LE observer is enabled, false otherwise

note

Currently only rpc service is implemented, but a global enable flag is maintained for possible other future BLE functionality implementation. If either of the enable flags is set to false the device is not advertised. Changing the configuration requires restart.

Status

The status of the BLE component contains information about the bluetooth on/off state and does not own any status properties.

Examples

BLE.GetStatus example

BLE.GetStatus HTTP GET Request

http://192.168.33.1/rpc/BLE.GetStatus

BLE.GetStatus Curl Request

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

BLE.GetStatus Mos Request

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

Response

BLE.GetStatus HTTP GET Response

{}

BLE.GetStatus Curl Response

{
  "id": 1,
  "src": "shellyplus1pm-441793ce3f08",
  "params": {}
}

BLE.GetStatus Mos Response

{}

BLE.GetConfig example

BLE.GetConfig HTTP GET Request

http://192.168.33.1/rpc/BLE.GetConfig

BLE.GetConfig Curl Request

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

BLE.GetConfig Mos Request

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

Response

BLE.GetConfig HTTP GET Response

{
  "enable": true,
  "rpc": {
    "enable": true
  }
}

BLE.GetConfig Curl Response

{
  "id": 1,
  "src": "shellyplus1pm-441793ce3f08",
  "params": {
    "enable": true,
    "rpc": {
      "enable": true
    }
  }
}

BLE.GetConfig Mos Response

{
  "enable": true,
  "rpc": {
    "enable": true
  }
}

BLE.SetConfig example

BLE.SetConfig HTTP GET Request

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

BLE.SetConfig Curl Request

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

BLE.SetConfig Mos Request

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

Response

BLE.SetConfig HTTP GET Response

{
  "restart_required": true
}

BLE.SetConfig Curl Response

{
  "id": 1,
  "src": "shellyplus1pm-441793ce3f08",
  "params": {
    "restart_required": true
  }
}

BLE.SetConfig Mos Response

{
  "restart_required": true
}